refactor!: Rename environment variables for the sake of consistency

[FelixTing]

resolve #399

BREAKING CHANGE:

• EDGEX_CONFIGURTION_PROVIDER is replaced by EDGEX_CONFIG_PROVIDER
• EDGEX_CONF_DIR is replaced by EDGEX_CONFIG_DIR

Signed-off-by: Felix Ting [email protected]

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/go-mod-bootstrap/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

• I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
• I am not introducing a new dependency (add notes below if you are)
• I have added unit tests for the new feature or bug fix (if not, why?)
• I have fully tested (add details below) this the new feature or bug fix (if not, why?)
• I have opened a PR for the related docs change (if not, why?) docs: Update docs for changes to environment variable naming in 3.0 edgex-docs#914

Testing Instructions

1. Download this docker-compose file(https://github.com/edgexfoundry/edgex-compose/blob/main/docker-compose-no-secty.yml) and edit it to remove device-virtual
2. Run EdgeX Foundry with the docker-compose file
3. Download https://github.com/FelixTing/go-mod-bootstrap/tree/issue-399
4. Download device-virtual (https://github.com/edgexfoundry/device-virtual-go), edit go.mod to replace github.com/edgexfoundry/go-mod-bootstrap/v2 with the one downloaded in step 3. For example

replace github.com/edgexfoundry/go-mod-bootstrap/v2 => ../go-mod-bootstrap

5. Build a binary executable for device-virtual

make build

6. Set environment variables, for example:

export EDGEX_CONFIG_PROVIDER=consul.http://localhost:8500
export EDGEX_CONFIG_FILE=my-config.toml

7. Run device-virtual
8. Logs similar to the following are expected to appear:

level=INFO ts=2022-12-07T04:43:41.025805Z app=device-virtual source=variables.go:377 msg="Variables override of '-f/-file' by environment variable: EDGEX_CONFIG_FILE=my-config.toml"
level=INFO ts=2022-12-07T04:43:41.029159Z app=device-virtual source=variables.go:377 msg="Variables override of 'Configuration Provider Information' by environment variable: EDGEX_CONFIG_PROVIDER=consul.http://localhost:8500"

New Dependency Instructions (If applicable)

[codecov-commenter]

Codecov Report

Merging #402 (a16b82a) into main (249f27d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #402   +/-   ##
=======================================
  Coverage   59.52%   59.52%           
=======================================
  Files          24       24           
  Lines        1690     1690           
=======================================
  Hits         1006     1006           
  Misses        640      640           
  Partials       44       44           

Impacted Files	Coverage Δ
bootstrap/environment/variables.go	90.58% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[ejlee3]

Commit message should be refactor!: instead of feat:. This really is a refactor of the code and the ! helps denote the breaking change.

[lenny-goodell]

I think we should also rename the corresponding command line flags

• -c/--confdir to -cd/--configDir
• -f/--file to -cf/--configFile

[cloudxxx8]

I think we should also rename the corresponding command line flags

• -c/--confdir to -cd/--configDir
• -f/--file to -cf/--configFile

the issue edgexfoundry/edgex-go#4248 is opened for this, so we won't make the related change in this PR

[ejlee3]

LGTM - I was able to see the changes with the testing instructions.

[lenny-goodell]

LGTM