1617 test setup 1618 sample env file#1635
1617 test setup 1618 sample env file#1635kaldun-tech wants to merge 11 commits intohiero-ledger:mainfrom
Conversation
- Add TESTING.md with instructions for running unit and e2e tests - Add .env.sample documenting required environment variables - Update README.md to reference new documentation Closes hiero-ledger#1617, closes hiero-ledger#1618 Signed-off-by: kaldun-tech <tsmereka@protonmail.com>
… to network choice Signed-off-by: kaldun-tech <tsmereka@protonmail.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
|
Would I want to update the CHANGELOG.md file here or is that only done when tagging a release? |
Up to standards ✅🟢 Issues
|
- Remove erroneous diff metadata line from TESTING.md - Update .env.sample to mention all supported private key formats (hex, DER-encoded, PEM-prefixed) Signed-off-by: kaldun-tech <tsmereka@protonmail.com>
Rename .env.sample to setup-env.sh.sample with export statements so users can source the file directly before running tests. - Add export statements to all environment variables - Update README.md and TESTING.md to reference new file - Add .env.sh and env.sh to .gitignore - Add note about HEDERA_NETWORK taking precedence over CONFIG_FILE Signed-off-by: kaldun-tech <tsmereka@protonmail.com>
…ILE precedence - Rename setup-env.sh.sample to env.sh.sample for simplicity (env.sh already in .gitignore) - Clarify that CONFIG_FILE is only used when OPERATOR_ID, OPERATOR_KEY, and HEDERA_NETWORK are all unset - Update references in README.md and TESTING.md Signed-off-by: kaldun-tech <tsmereka@protonmail.com>
.env is the standard convention for environment variable files and will be compatible with godotenv in the future. Updated all documentation references and cleaned up .gitignore. Signed-off-by: kaldun-tech <tsmereka@protonmail.com>
Dosik13
left a comment
There was a problem hiding this comment.
left final comments - you an also think of a way to make the user understand that once he did the source .env the values are exported to the terminal and dont have to do it every time (you can also leave it, i don't think it is a big problem). And I think we will be ready to merge it
Remove trailing newline Co-authored-by: Dosi Kolev <104355829+Dosik13@users.noreply.github.com> Signed-off-by: Taras <tsmereka@protonmail.com>
Clarified language of copying .env.sample to .env Co-authored-by: Dosi Kolev <104355829+Dosik13@users.noreply.github.com> Signed-off-by: Taras <tsmereka@protonmail.com>
Added HEDERA_NETWORK variable export recommendation Co-authored-by: Dosi Kolev <104355829+Dosik13@users.noreply.github.com> Signed-off-by: Taras <tsmereka@protonmail.com>
|
Yes I agree those are good changes. Considered how to communicate that they don't have to |
Description:
TESTING.mdwith instructions for running unit and e2e testsenv.sh.sampledocumenting required environment variables for tests/examples. Users copy the script toenv.sh, update their variables and and source itREADME.mdto reference new documentationRelated issue(s):
Fixes #1617 #1618
Notes for reviewer:
Test plan
env.sh.samplecan be copied toenv.sh, filled in, and sourcedTESTING.mdworks:go test ./sdk -tags="unit" -v -timeout 9999sChecklist