fix: save config and env on plugins enable/disable
#957
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
before this, after enabling/disabling any plugins we should re-generate all files with tutor config save.
regisb
force-pushed
the
fix/save-configs
branch
2 times, most recently
from
e34734f to
55d466e
Compare
Also, update docs on `tutor config save`. Note that we had to fix an issue where the plugin unload callback was being called too late.
regisb
force-pushed
the
fix/save-configs
branch
from
55d466e to
3fb44cf
Compare
4 tasks
fghaas
added a commit
to hastexo/tutor-contrib-s3
that referenced
this pull request
Dec 14, 2023
Until Tutor 17, just enabling a plugin with "tutor plugin enable" would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty. As of overhangio/tutor#957, however, "tutor plugin enable" does automatically also run "tutor config save", generating a full Tutor configuration. This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin. Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.
This was referenced Dec 14, 2023
fghaas
added a commit
to fghaas/tutor-contrib-backup
that referenced
this pull request
Dec 14, 2023
Until Tutor 17, just enabling a plugin with "tutor plugin enable" would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty. As of overhangio/tutor#957, however, "tutor plugin enable" does automatically also run "tutor config save", generating a full Tutor configuration. This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin. Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.
fghaas
added a commit
to fghaas/tutor-contrib-retirement
that referenced
this pull request
Dec 14, 2023
Until Tutor 17, just enabling a plugin with "tutor plugin enable" would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty. As of overhangio/tutor#957, however, "tutor plugin enable" does automatically also run "tutor config save", generating a full Tutor configuration. This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin. Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.
fghaas
added a commit
to fghaas/tutor-contrib-enrollmentreports
that referenced
this pull request
Dec 14, 2023
Until Tutor 17, just enabling a plugin with "tutor plugin enable" would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty. As of overhangio/tutor#957, however, "tutor plugin enable" does automatically also run "tutor config save", generating a full Tutor configuration. This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin. Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.
fghaas
added a commit
to fghaas/tutor-contrib-openstack
that referenced
this pull request
Dec 14, 2023
Until Tutor 17, just enabling a plugin with "tutor plugin enable" would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty. As of overhangio/tutor#957, however, "tutor plugin enable" does automatically also run "tutor config save", generating a full Tutor configuration. This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin. Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.
fghaas
added a commit
to fghaas/tutor-contrib-webhook-receiver
that referenced
this pull request
Dec 14, 2023
Until Tutor 17, just enabling a plugin with "tutor plugin enable" would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty. As of overhangio/tutor#957, however, "tutor plugin enable" does automatically also run "tutor config save", generating a full Tutor configuration. This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin. Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.
fghaas
added a commit
to fghaas/tutor-contrib-hastexo
that referenced
this pull request
Dec 14, 2023
Until Tutor 17, just enabling a plugin with "tutor plugin enable" would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty. As of overhangio/tutor#957, however, "tutor plugin enable" does automatically also run "tutor config save", generating a full Tutor configuration. This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin. Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.
|
Please note: plugin authors may need to be aware of the impact this change may have on their unit and integration tests. See the PRs referenced from here. |
|
@fghaas Would it make sense to add a |
|
Good question. Most of the time, users would want automatic Would a toggle to turn it off be useful, or would it be more likely to be a footgun? I really don't know. |
|
Let's do nothing for now. If you (or anyone else) later think it's important we can decide to add a toggle. |
|
That works for me! |
mrtmm
pushed a commit
to mrtmm/tutor-contrib-registry
that referenced
this pull request
Jan 11, 2024
Until Tutor 17, just enabling a plugin with "tutor plugin enable" would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty. As of overhangio/tutor#957, however, "tutor plugin enable" does automatically also run "tutor config save", generating a full Tutor configuration. This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin. Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.
mrtmm
pushed a commit
to mrtmm/tutor-contrib-registry
that referenced
this pull request
Jan 11, 2024
Until Tutor 17, just enabling a plugin with "tutor plugin enable" would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty. As of overhangio/tutor#957, however, "tutor plugin enable" does automatically also run "tutor config save", generating a full Tutor configuration. This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin. Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This replaces #917