Skip to content

feat: allow environment variables to be reset by setting them to the empty string#3497

Merged
jarhodes314 merged 1 commit intothin-edge:mainfrom
jarhodes314:feat/env-var-reset
Mar 21, 2025
Merged

feat: allow environment variables to be reset by setting them to the empty string#3497
jarhodes314 merged 1 commit intothin-edge:mainfrom
jarhodes314:feat/env-var-reset

Conversation

@jarhodes314
Copy link
Copy Markdown
Contributor

@jarhodes314 jarhodes314 commented Mar 21, 2025 •
edited
Loading

Proposed changes

Allow a configuration to be reset to the default by passing an environment variable value of '' (an empty string). Previously, to "undo" the effects of setting a TEDGE_ variable for configuration (so you can use the default value), you would need to unset the value

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@jarhodes314 jarhodes314 added the theme:configuration Theme: Configuration management label Mar 21, 2025
@jarhodes314 jarhodes314 temporarily deployed to Test Pull Request March 21, 2025 12:02 — with GitHub Actions Inactive
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 21, 2025

Codecov Report

Attention: Patch coverage is 87.09677% with 4 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
...ates/common/tedge_config/src/tedge_toml/figment.rs 87.09% 0 Missing and 4 partials ⚠️

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 21, 2025 •
edited
Loading

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
599 0 3 599 100 1h41m26.978551999s

@jarhodes314
feat: allow environment variables to be reset by setting them to ''
43f7336 
Signed-off-by: James Rhodes <jarhodes314@gmail.com>
@jarhodes314 jarhodes314 temporarily deployed to Test Pull Request March 21, 2025 14:03 — with GitHub Actions Inactive
didier-wenzek
didier-wenzek approved these changes Mar 21, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

reubenmiller
reubenmiller approved these changes Mar 21, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@reubenmiller reubenmiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works nicely, and solves the linked ticket.

Simple example showing that the user can ignore the environment variable by setting it to an empty value.

export TEDGE_MQTT_CLIENT_HOST=tedge
TEDGE_MQTT_CLIENT_HOST= tedge mqtt sub '#' --log-level info >/dev/null
2025-03-21T14:19:41.831241Z  INFO MQTT: Connecting to broker: host=127.0.0.1:2883, session_name=Some("tedge-sub-50652")

@jarhodes314 jarhodes314 added this pull request to the merge queue Mar 21, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 21, 2025
@jarhodes314 jarhodes314 added this pull request to the merge queue Mar 21, 2025
Merged via the queue into thin-edge:main with commit 7ab3b29 Mar 21, 2025
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@reubenmiller reubenmiller reubenmiller approved these changes

@didier-wenzek didier-wenzek didier-wenzek approved these changes

@albinsuresh albinsuresh Awaiting requested review from albinsuresh albinsuresh is a code owner

@rina23q rina23q Awaiting requested review from rina23q rina23q is a code owner

Assignees

No one assigned

Labels

theme:configuration Theme: Configuration management

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jarhodes314 @reubenmiller @didier-wenzek