tools/read-version refactors and unit tests #4268
Merged
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
* Refactor script into importable functions * Replace 'which' function with shutils * Remove unused "use_long" option * Add unit tests for read-version and add them to default pytest * Move some utility functions out of setup.py so they can be imported and tested
TheRealFalcon
force-pushed
the
read-version-updates
branch
from
56b1286
to
4ae6814
Compare
holmanb
approved these changes
Jul 21, 2023
| @@ -21,6 +21,20 @@ | |||
| from setuptools.command.egg_info import egg_info | |||
| from setuptools.command.install import install | |||
|
|
|||
| sys.path.insert(0, os.path.dirname(os.path.realpath(__file__))) | |||
There was a problem hiding this comment.
Could we please add a comment explaining why?
|
|
||
| validate_version = setuptools.dist.Distribution._validate_version # type: ignore # noqa: E501 | ||
|
|
||
| # Since read-version has a '-' and no .py extension, we have to do this |
| @@ -290,7 +290,7 @@ per-file-ignores = | |||
|
|
|||
| [pytest] | |||
| # TODO: s/--strict/--strict-markers/ once pytest version is high enough | |||
| testpaths = tests/unittests | |||
| testpaths = tests/unittests tools | |||
There was a problem hiding this comment.
Any reason not to add this to github actions (py3 environment, for example)?
There was a problem hiding this comment.
Our tox environment builds our package and then run tests against it. The tools directory isn't included in the package, so it isn't seen by the tox environment.
tools/read-version
Outdated
| arg_use_tags = "--tags" in sys.argv or bool(os.environ.get("CI_RV_TAGS")) | ||
| arg_output_json = "--json" in sys.argv | ||
| output = main(arg_use_tags, arg_output_json) | ||
| sys.stdout.write(output + "\n") |
There was a problem hiding this comment.
Good point. I thought there might be a good reason so I left it, but print can do the job.
| @@ -19,25 +22,6 @@ def tiny_p(cmd): | |||
| ) | |||
|
|
|||
|
|
|||
| def which(program): | |||
TheRealFalcon
added a commit
to TheRealFalcon/cloud-init
that referenced
this pull request
Jul 26, 2023
* Refactor script into importable functions * Replace 'which' function with shutils * Remove unused "use_long" option * Add unit tests for read-version and add them to default pytest * Move some utility functions out of setup.py so they can be imported and tested
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.
Proposed Commit Message