HYPERFLEET-486 | fix: adjust labels#13
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
WalkthroughThe change consolidates test labeling into a single Severity dimension (Tier0/Tier1/Tier2), removes several legacy label constants (Stable, Informing, Flaky, HappyPath, Serial, Lifecycle), and renames Scale to Performance. Label validation is simplified from three required dimensions to a single severity check. Tests, e2e suites, and documentation (README, docs/development.md) are updated to use the new labels and CLI examples. Test setup/teardown code was adjusted to initialize helpers directly, source clusterID from cluster.Id, use a WaitForClusterPhase API for readiness, and add guarded cleanup with warning logging. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/development.md`:
- Around line 135-142: The docs conflict: update the earlier "Basic Test
Structure" example to match the "Required labels (1)" rule by removing or
replacing references to labels.Lifecycle, labels.Critical, and labels.HappyPath
so it only uses the required Severity label (Tier0 | Tier1 | Tier2) and any
optional labels listed; ensure the snippet in the Basic Test Structure uses the
same label keys and values as the section that lists required/optional labels.
🧹 Nitpick comments (1)
pkg/labels/labels.go (1)
10-15: Consider removing the commented legacy constants. Keeping deprecated labels in commented code can confuse future readers; consider moving to docs or release notes instead.
fdf66ab to
ec8abc3
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/development.md (1)
83-84: Inconsistent example uses removed labels.The "Basic Test Structure" example at line 84 still references
labels.Lifecycle,labels.Critical, andlabels.HappyPath, which have been removed frompkg/labels/labels.go. This contradicts the updated labeling guidance later in the document.Proposed fix
var _ = ginkgo.Describe(testName, - ginkgo.Label(labels.Lifecycle, labels.Critical, labels.HappyPath), + ginkgo.Label(labels.Tier0), func() {pkg/labels/validate_test.go (1)
15-16: Outdated comment references removed label dimensions.The function comment still mentions "Priority, Stability, and Scenario" dimensions, but validation now only requires the Severity dimension.
Proposed fix
// TestAllE2ETestsHaveRequiredLabels validates that all Ginkgo test specs -// include the three required label dimensions: Priority, Stability, and Scenario +// include the required Severity label dimension (Tier0, Tier1, or Tier2) func TestAllE2ETestsHaveRequiredLabels(t *testing.T) {
🧹 Nitpick comments (2)
pkg/labels/labels.go (2)
10-15: Consider removing commented-out code.If the Stability labels (
Stable,Informing,Flaky) are no longer part of the labeling schema, consider removing this commented block entirely rather than leaving it as dead code. If the intent is to preserve documentation of the prior taxonomy, an ADR or commit history would be more appropriate.♻️ Suggested removal
-// Stability labels - Test quality dimension: determines CI gate policy -// const ( -// Stable = "stable" // Production-ready: stable and reliable, must pass to merge (Blocking) -// Informing = "informing" // Observation period: new test onboarding (Non-blocking) -// Flaky = "flaky" // Known unstable: quarantined for investigation -// )
17-22: Remove commented-outHappyPathconstant.Similar to the Stability labels, if
HappyPathis no longer used, remove the commented line rather than leaving dead code.♻️ Suggested cleanup
// Scenario labels - Test path dimension: describes test design intent const ( - // HappyPath = "happy-path" // Normal workflow: ideal path Negative = "negative" // Error handling: edge cases and failure scenarios Performance = "perf" // Performance: stress tests or large-scale resource scenarios )
update update update update update update update update update update update
ec8abc3 to
56baa53
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/development.md (1)
130-156: Update the CLI label-filter example to match the new severity model.The “Run Your Test” section still uses legacy labels (
critical && lifecycle), which conflicts with the updated Severity-only requirement. Please update that example to use Tier labels (and optional labels if desired).📝 Suggested doc fix (in “Run Your Test” section)
-./bin/hyperfleet-e2e test --label-filter "critical && lifecycle" +./bin/hyperfleet-e2e test --label-filter "tier0"
Summary by CodeRabbit
Documentation
Refactor
Tests
✏️ Tip: You can customize this high-level summary in your review settings.