-
Notifications
You must be signed in to change notification settings - Fork 7
(Chore): Reorganize report tests #1099
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.
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
Open
TylerJang27
wants to merge
2
commits into
main
Choose a base branch
from
tyler/reorganize-report-tests
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+557
−570
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| use std::env; | ||
|
|
||
| use constants::{ | ||
| TRUNK_ALLOW_EMPTY_TEST_RESULTS_ENV, TRUNK_API_CLIENT_RETRY_COUNT_ENV, TRUNK_API_TOKEN_ENV, | ||
| TRUNK_CODEOWNERS_PATH_ENV, TRUNK_DISABLE_QUARANTINING_ENV, TRUNK_DRY_RUN_ENV, | ||
| TRUNK_ORG_URL_SLUG_ENV, TRUNK_PR_NUMBER_ENV, TRUNK_PUBLIC_API_ADDRESS_ENV, | ||
| TRUNK_QUARANTINED_TESTS_DISK_CACHE_TTL_SECS_ENV, TRUNK_REPO_HEAD_AUTHOR_NAME_ENV, | ||
| TRUNK_REPO_HEAD_BRANCH_ENV, TRUNK_REPO_HEAD_COMMIT_EPOCH_ENV, TRUNK_REPO_HEAD_SHA_ENV, | ||
| TRUNK_REPO_ROOT_ENV, TRUNK_REPO_URL_ENV, TRUNK_USE_UNCLONED_REPO_ENV, TRUNK_VARIANT_ENV, | ||
| }; | ||
|
|
||
| /// Cleans up all TRUNK_* and CI-related environment variables to avoid test interference. | ||
| pub fn cleanup_env_vars() { | ||
| unsafe { | ||
| env::remove_var(TRUNK_PUBLIC_API_ADDRESS_ENV); | ||
| env::remove_var(TRUNK_API_TOKEN_ENV); | ||
| env::remove_var(TRUNK_ORG_URL_SLUG_ENV); | ||
| env::remove_var(TRUNK_PR_NUMBER_ENV); | ||
| env::remove_var(TRUNK_REPO_ROOT_ENV); | ||
| env::remove_var(TRUNK_REPO_URL_ENV); | ||
| env::remove_var(TRUNK_REPO_HEAD_SHA_ENV); | ||
| env::remove_var(TRUNK_REPO_HEAD_BRANCH_ENV); | ||
| env::remove_var(TRUNK_REPO_HEAD_COMMIT_EPOCH_ENV); | ||
| env::remove_var(TRUNK_REPO_HEAD_AUTHOR_NAME_ENV); | ||
| env::remove_var(TRUNK_VARIANT_ENV); | ||
| env::remove_var(TRUNK_USE_UNCLONED_REPO_ENV); | ||
| env::remove_var(TRUNK_DISABLE_QUARANTINING_ENV); | ||
| env::remove_var(TRUNK_ALLOW_EMPTY_TEST_RESULTS_ENV); | ||
| env::remove_var(TRUNK_DRY_RUN_ENV); | ||
| env::remove_var(TRUNK_CODEOWNERS_PATH_ENV); | ||
| env::remove_var("CI"); | ||
| env::remove_var("GITHUB_JOB"); | ||
| env::remove_var(TRUNK_QUARANTINED_TESTS_DISK_CACHE_TTL_SECS_ENV); | ||
| env::remove_var(TRUNK_API_CLIENT_RETRY_COUNT_ENV); | ||
| } | ||
| } | ||
|
|
||
| #[allow(dead_code)] | ||
| pub fn clean_up_cache_files() { | ||
| let cache_dir = env::temp_dir().join(constants::CACHE_DIR); | ||
| if let Ok(entries) = std::fs::read_dir(&cache_dir) { | ||
| for entry in entries.flatten() { | ||
| let _ = std::fs::remove_file(entry.path()); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| //! Shared helpers for `test_report` integration tests. | ||
|
|
||
| mod env; | ||
|
|
||
| pub use env::{clean_up_cache_files, cleanup_env_vars}; |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I realize this is an antipattern in rust-world, but it matches the pattern of the rest of this repo, and I didn't want to undertake crate explosion right now. Having these common utils are necessary for the other "integration" tests in this crate.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what about this is an anti-pattern? new to rust
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally you don't define re-usable functions for tests within the
testsdirectory. It forces one to mark the functions asdead_codebecause code (the test functions themselves) withintestsfiles only materializes via compiler options.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The compiler only executes this function inside of tests, which are excluded from the normal compilation cycle, so it thinks this is dead code. The better pattern afaik is to setup separate, flat crates for test_report, test_report_tests, test_report_test_utils, that way the functions are used either directly where they're defined or exposed as public in the crate (and therefore not unused). That's what I tried to do for the rust integration tests in trunk2. But doing so right now in analytics-cli would require a substantial refactor, so I'm just using the macro here to bypass the warning