Fix: Update default globbing pattern for collection matching #4177
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
|
Label error. Requires exactly 1 of: bug, enhancement, major, minor, patch, skip-changelog. Found: |
|
So I was curious why $ MOLECULE_GLOB="./extensions/molecule/*/molecule.yml" molecule test
$ MOLECULE_GLOB="$(pwd)/extensions/molecule/*/molecule.yml" molecule test
|
This update:
- restricts the glob matching for `molecule test`
- updates the default value for `MOLECULE_GLOB="**/molecule/*/molecule.yml"`
This allows:
- users to call molecule from the collection folder and molecule will use the
collection name in the ephemeral cache, `.cache/molecule/COLLECTION_NAME`.
WARNING:
If working within the ANSIBLE_COLLECTIONS_PATH directory, e.g.
`~/.ansible/collections/ansible_collections/COLLECTION_NAME` (default), using
the new default setting `MOLECULE_GLOB="**/molecule/*/molecule.yml"` will
globber clobber and delete the collection folder. This occurs in the presence of
a `galaxy.yml` - as molecule calls `ansible_compat.runtime(isolate=False)` and
will run `ansible_compat.runtime.prepare_environment`. However, if you delete
the `galaxy.yml` OR chdir into `COLLECTION_NAME/extensions` and it will not
delete the collection folder.
Currently (v24.2.1):
Calling `molecule list` will find all molecule.yml files within a collection
folder that use a nested dir structure, i.e
`COLLECTION_NAME/extensions/molecule/SCENARIO_NAME/molecule.yml`. As it calls
`base.get_configs` and sets the argument `glob=str"**/molecule/*/molecule.yml"`.
This does not occur with `molecule test`, as it calls to
`base.execute_cmdline_scenarios` and uses
`MOLECULE_GLOB = os.environ.get("MOLECULE_GLOB", "molecule/*/molecule.yml")`.
Attempting to set an env var MOLECULE_GLOB="**/molecule/*/molecule.yml" will
fail, as `test` attempts to insert the scenario name into every wild-card. But,
this fuzzy matching acts as a safe guard against deleting the collection when
working within the same ANSIBLE_COLLECTIONS_PATH directory:
$ MOLECULE_GLOB="**/molecule/*/molecule.yml" molecule test
CRITICAL 'defaultdefault/molecule/default/molecule.yml' glob failed.
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 update:
molecule testMOLECULE_GLOB="**/molecule/*/molecule.yml"This allows:
.cache/molecule/COLLECTION_NAME.WARNING:
If working within the ANSIBLE_COLLECTIONS_PATH directory, e.g.
~/.ansible/collections/ansible_collections/COLLECTION_NAME(default), using the new default settingMOLECULE_GLOB="**/molecule/*/molecule.yml"will globber clobber and delete the collection folder. This occurs in the presence of agalaxy.yml- as molecule callsansible_compat.runtime(isolate=False)and will runansible_compat.runtime.prepare_environment. However, if you delete thegalaxy.ymlOR chdir intoCOLLECTION_NAME/extensionsand it will not delete the collection folder.Currently (v24.2.1):
Calling
molecule listwill find all molecule.yml files within a collection folder that use a nested dir structure, i.eCOLLECTION_NAME/extensions/molecule/SCENARIO_NAME/molecule.yml. As it callsbase.get_configsand sets the argumentglob=str"**/molecule/*/molecule.yml".This does not occur with
molecule test, as it calls tobase.execute_cmdline_scenariosand usesMOLECULE_GLOB = os.environ.get("MOLECULE_GLOB", "molecule/*/molecule.yml").Attempting to set an env var
MOLECULE_GLOB="**/molecule/*/molecule.yml"will fail, astestattempts to insert the scenario name into every wild-card. But, this fuzzy matching acts as a safe guard against deleting the collection when working within the same ANSIBLE_COLLECTIONS_PATH directory: