Change local_uuid setup parameter #49
Merged
Conversation
This file contains hidden or 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
This flag was a useful development aid, and its presence in the Make command lines impacts generated UUID5s. However, at the end of the patch series adding this output, all of the debug statements will be disabled. A follow-on patch (at the end of the series) will regenerate Make-managed files. Signed-off-by: Alex Nelson <alexander.nelson@nist.gov>
`case_utils.local_uuid` provides a deterministic UUIDv5 generator based
on the execution environment. Unfortunately, its prior implementation
was not behaving correctly when changing environments - a different
operating system, or working in a different rooted directory, would
cause UUID churn.
The issue turned out to be paths embedding in two manners:
1. The prior implementation assumed work happening somewhere under a
user-home directory. This is not always true.
2. The prior implementation did not catch that for a program
`pip`-installed into a virtual environment in editable mode (or,
possibly more generally than that), `sys.argv[0]` is the absolute
path to the installed command in the virtual environment root.
Hence, changing operating systems from macOS to Linux would change
`/Users/me` to `/home/me` within the UUID seeding data.
This patch revises the practice from functionally operating in a
Boolean manner ("Was this special string passed?") to passing an
anchoring directory, preferably the repository's Git-root directory.
Usage of the prior variable `DEMO_UUID_REQUESTING_NONRANDOM` is now
deprecated, raising a warning.
A test is also added to confirm new warnings are raised.
A follow-on patch will regenerate Make-managed files.
Signed-off-by: Alex Nelson <alexander.nelson@nist.gov>
Signed-off-by: Alex Nelson <alexander.nelson@nist.gov>
kchason
requested changes
May 11, 2022
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.
No description provided.