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.

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

refactor: Extract common functionality to test utils pkg #14549

Merged
merged 3 commits into from
Oct 21, 2024

Conversation

salvacorts
Copy link
Contributor

@salvacorts salvacorts commented Oct 21, 2024

What this PR does / why we need it:
This PR extracts some of the functions we use for testing in the planner pkg into a new test_utils pkg so we can reuse them to test the planning strategies w/o duplicating code.

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@salvacorts salvacorts force-pushed the salvacorts/extract-common-testing-utils branch 3 times, most recently from 78648d4 to b504b45 Compare October 21, 2024 10:15
@salvacorts salvacorts force-pushed the salvacorts/extract-common-testing-utils branch from b504b45 to 19e1376 Compare October 21, 2024 10:26
@salvacorts salvacorts marked this pull request as ready for review October 21, 2024 10:58
@salvacorts salvacorts requested a review from a team as a code owner October 21, 2024 10:58
@@ -0,0 +1,137 @@
package testutils
Copy link
Member

Choose a reason for hiding this comment

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

extremely tiny nit: Generally I prefer package names being slightly more descriptive about their domain than utils/testutils.

plannerfakes, plannerutils, or testplanner would all be slightly more descriptive here, in the same vein as the stdlib slogtest package.

That being said, of my opinions about Go, I feel the least strongly about this one, so I don't mind if this stays the same, either.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, renamed to plannertest. Thank you for the tip!

@salvacorts salvacorts merged commit 6aa979d into main Oct 21, 2024
60 checks passed
@salvacorts salvacorts deleted the salvacorts/extract-common-testing-utils branch October 21, 2024 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants