Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support default version for env version source #1854

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Support default version for env version source #1854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2be608d
add tests for default on env version source
abrahammurciano Dec 15, 2024
f006cae
use default version if env var is not set in env version source
abrahammurciano Dec 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions backend/src/hatchling/version/source/env.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ def get_version_data(self) -> dict:
raise TypeError(message)

if variable not in os.environ:
default = self.config.get('default', '')
if default:
return {'version': default}
message = f'environment variable `{variable}` is not set'
raise RuntimeError(message)

Expand Down
14 changes: 14 additions & 0 deletions tests/backend/version/source/test_env.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,22 @@ def test_variable_not_available(isolation):
source.get_version_data()


def test_variable_not_available_with_default(isolation):
source = EnvSource(str(isolation), {'variable': 'ENV_VERSION', 'default': '0.0.0'})

with EnvVars(exclude=['ENV_VERSION']):
assert source.get_version_data()['version'] == '0.0.0'


def test_variable_contains_version(isolation):
source = EnvSource(str(isolation), {'variable': 'ENV_VERSION'})

with EnvVars({'ENV_VERSION': '0.0.1'}):
assert source.get_version_data()['version'] == '0.0.1'


def test_variable_contains_version_with_default(isolation):
source = EnvSource(str(isolation), {'variable': 'ENV_VERSION', 'default': '0.0.0'})

with EnvVars({'ENV_VERSION': '0.0.1'}):
assert source.get_version_data()['version'] == '0.0.1'