use tox and set up CRDS caching when server is accessible

[zacharyburnett]

This PR turns the existing dependent-workflow structure back into tox, and caches CRDS data for the same operational context, so it is not downloaded every time. This functionality is not currently useful (it is skipped currently) but will become useful when Roman CRDS becomes publicly available.

Checklist

• added entry in CHANGES.rst under the corresponding subsection
• updated relevant tests
• updated relevant documentation
• updated relevant milestone(s)
• added relevant label(s)

[zacharyburnett]

this should be a draft until the Roman CRDS test server is available outside the VPN (and is used in tests) see #551 (comment)

[codecov]

Codecov Report

Base: 81.83% // Head: 81.83% // No change to project coverage 👍

Coverage data is based on head (6f7ac0c) compared to base (499e9c0).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #551   +/-   ##
=======================================
  Coverage   81.83%   81.83%           
=======================================
  Files          39       39           
  Lines        1167     1167           
=======================================
  Hits          955      955           
  Misses        212      212           

Flag	Coverage Δ		*Carryforward flag
nightly	81.83% <ø> (ø)		Carriedforward from 499e9c0
unit	46.46% <ø> (ø)

*This pull request uses carry forward flags. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[zacharyburnett]

commit 456a3c6 skips CRDS caching if the context retrieval fails, so as soon as Roman CRDS is publicly available it should start caching

[ddavis-stsci]

I think that having the crds sync setup is a good idea but we might want to be a bit careful here. Doing a full crds sync can take a while (several hours?).
We might want to be more targeted and allow sync to a specific context or contexts, e.g.
crds sync --contexts roman_0001.pmap roman_0002.pmap

[zacharyburnett]

Ok, right now it's using the result of crds list --operational-context (so in effect doing crds sync --contexts $(crds list --operational-context)), but is there a set list of contexts that should be used for the tests specifically?

romancal/.github/workflows/roman_ci.yml

Lines 94 to 101 in 456a3c6

	- run: echo "CRDS_CONTEXT=$(crds list --operational-context)" >> $GITHUB_ENV
	- uses: actions/[email protected]
	if: env.CRDS_CONTEXT != ''
	with:
	path: ${{ env.CRDS_PATH }}
	key: crds-${{ env.CRDS_CONTEXT }}
	- run: crds sync --contexts ${{ env.CRDS_CONTEXT }}
	if: env.CRDS_CONTEXT != ''

[ddavis-stsci]

I think for now the operational contect is fine but we may want more flexibility at some point. So for instance if we wanted to test with an early context it seems overkill to have the CRDS server have to go and mark an old version as "operational" The context needed may depend on the test being run. That is why I was thinking it might be good if we could specify the context or override the defaults somehow.

…

On 8/3/22 9:36 AM, Zach Burnett wrote: Ok, right now it's using the result of |--operational-context|, but is there a set list of contexts that should be used for the tests specifically? https://github.com/spacetelescope/romancal/blob/456a3c64ad180c974c95d3406bffd621a867bc39/.github/workflows/roman_ci.yml#L94-L101 <https://urldefense.com/v3/__https://github.com/spacetelescope/romancal/blob/456a3c64ad180c974c95d3406bffd621a867bc39/.github/workflows/roman_ci.yml*L94-L101__;Iw!!CrWY41Z8OgsX0i-WU-0LuAcUu2o!yP4WnRHr1V6fOPWWQr55vhJxc9DKj7-OcB-w11OBSbdJRGrdJgCG1iwgmVN7Ek_OcvtJHohbI3fUdfwp8Z4FDd8b$> — Reply to this email directly, view it on GitHub <https://urldefense.com/v3/__https://github.com/spacetelescope/romancal/pull/551*issuecomment-1203960750__;Iw!!CrWY41Z8OgsX0i-WU-0LuAcUu2o!yP4WnRHr1V6fOPWWQr55vhJxc9DKj7-OcB-w11OBSbdJRGrdJgCG1iwgmVN7Ek_OcvtJHohbI3fUdfwp8YiEiJEQ$>, or unsubscribe <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/ALXCXWIHVGK6YG7GGLVCD7LVXJYVFANCNFSM54Z33GMA__;!!CrWY41Z8OgsX0i-WU-0LuAcUu2o!yP4WnRHr1V6fOPWWQr55vhJxc9DKj7-OcB-w11OBSbdJRGrdJgCG1iwgmVN7Ek_OcvtJHohbI3fUdfwp8VphWiKS$>. You are receiving this because your review was requested.Message ID: ***@***.***>

[zacharyburnett]

That is why I was thinking it might be good if we could specify the context or override the defaults somehow.

Ok, I added a workflow_dispatch: input with 6b1f27d, that should allow manual run (from the website) of a workflow with a specific CRDS context as an override.

romancal/.github/workflows/roman_ci.yml

Lines 17 to 22 in 6b1f27d

	workflow_dispatch:
	inputs:
	crds_context:
	type: string
	description: CRDS context(s) to use with tests (defaults to operational context)
	required: false

romancal/.github/workflows/roman_ci.yml

Lines 100 to 103 in 6b1f27d

	- run: echo "CRDS_CONTEXT=$(crds list --operational-context)" >> $GITHUB_ENV
	if: github.event.inputs.crds_context == ''
	- run: echo "CRDS_CONTEXT=${{ github.event.inputs.crds_context }}" >> $GITHUB_ENV
	if: github.event.inputs.crds_context != ''

[nden]

This looks good to me.
@ddavis-stsci Are all your concerns addressed?

The PR needs a rebase.

[ddavis-stsci]

Yes I'm good with the changes.

[zacharyburnett]

doing some updates to match the JWST workflow; I'll merge when tests pass