Skip to content

Conversation

@neisw
Copy link
Contributor

@neisw neisw commented Dec 15, 2025

Adds tests data type

Produces test_summaries.json

Need to review the importance of this if we are pivoting to openshift/origin#30604

@openshift-ci-robot
Copy link
Contributor

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: automatic mode

@coderabbitai
Copy link

coderabbitai bot commented Dec 15, 2025

Walkthrough

Adds TestSummaryByPeriodRow (including FirstSampleDate) and a BigQuery-backed ListTestSummaryByPeriod API with retry and mock support; introduces a "tests" data-type path in the historical analyzer that fetches, formats, and writes test summaries; adds CLI validation and helper utilities for test-summary files.

Changes

Cohort / File(s) Summary
Core data model
pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go
New exported struct TestSummaryByPeriodRow with bigquery tags. Fields: Release, TestName, TotalTestCount, TotalFailureCount, TotalFlakeCount, FailureRate, AvgDurationMs, PeriodStart (civil.Date), PeriodEnd (civil.Date), DaysWithData, and FirstSampleDate (civil.Date).
CI data client + retry + mock + const
pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go, pkg/jobrunaggregator/jobrunaggregatorlib/retrying_ci_data_client.go, pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client_mock.go, pkg/jobrunaggregator/jobrunaggregatorlib/util.go
Added interface method ListTestSummaryByPeriod(ctx, suiteName, releaseName string, daysBack, minTestCount int) ([]jobrunaggregatorapi.TestSummaryByPeriodRow, error) and implemented it using a BigQuery aggregation (including earliest first_sample_date CTE); added retry wrapper on retryingCIDataClient; extended gomock mock and recorder; added const bigQueryLabelValueTestSummaryByPeriod.
Historical analyzer: tests flow, CLI, helpers
pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/analyzer.go, pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/cmd.go, pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/util.go
Added "tests" to supported data types and adjusted validation rules; introduced runTestsDataType which calls ListTestSummaryByPeriod (hardcoded suite/params), formats output via formatTestOutput, and writes the output file; added helpers formatTestOutput, readTestSummaryFile, and hasSufficientDaysOfData.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

✨ Finishing touches
  • 📝 Generate docstrings

Comment @coderabbitai help to get the list of available commands and usage tips.

@neisw
Copy link
Contributor Author

neisw commented Dec 15, 2025

/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 15, 2025
@openshift-ci openshift-ci bot requested review from dgoodwin and xueqzhan December 15, 2025 12:12
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Dec 15, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: neisw

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 15, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/analyzer.go (1)

25-52: New data-type=tests flow is cleanly separated; consider future configurability

The early branch in Run and runTestsDataType cleanly bypass the comparison logic for data-type=tests, fetching summaries once and writing them directly via formatTestOutput, without disturbing the alerts/disruptions path. The hardcoded suiteName, daysBack, and minTestCount are reasonable defaults, but if this grows beyond a single use case, promoting them to flags or config would improve long‑term flexibility.

Also applies to: 100-132

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between f0f4b3b and c5366f4.

📒 Files selected for processing (7)
  • pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go (1 hunks)
  • pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go (2 hunks)
  • pkg/jobrunaggregator/jobrunaggregatorlib/retrying_ci_data_client.go (1 hunks)
  • pkg/jobrunaggregator/jobrunaggregatorlib/util.go (1 hunks)
  • pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/analyzer.go (2 hunks)
  • pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/cmd.go (2 hunks)
  • pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/util.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity.

Files:

  • pkg/jobrunaggregator/jobrunaggregatorlib/util.go
  • pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go
  • pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go
  • pkg/jobrunaggregator/jobrunaggregatorlib/retrying_ci_data_client.go
  • pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/analyzer.go
  • pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/cmd.go
  • pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/util.go
🧬 Code graph analysis (3)
pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go (1)
pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go (1)
  • TestSummaryByPeriodRow (9-20)
pkg/jobrunaggregator/jobrunaggregatorlib/retrying_ci_data_client.go (1)
pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go (1)
  • TestSummaryByPeriodRow (9-20)
pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/util.go (2)
pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go (1)
  • TestSummaryByPeriodRow (9-20)
pkg/api/types.go (1)
  • Release (452-466)
🔇 Additional comments (6)
pkg/jobrunaggregator/jobrunaggregatorlib/util.go (1)

39-58: BigQuery label addition is consistent and low‑risk

The new bigQueryLabelValueTestSummaryByPeriod constant matches existing naming/usage patterns for query labels; no issues from a maintainability or behavior standpoint.

pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/cmd.go (1)

29-49: data-type=tests wiring and validation look coherent

Adding "tests" to supportedDataTypes and relaxing only the --current / --previous-release requirements (while still enforcing BigQuery auth/coords when --new is empty) matches the new tests path, which fetches directly from BigQuery without doing comparisons. No obvious correctness or UX regressions here.

Also applies to: 51-77

pkg/jobrunaggregator/jobrunhistoricaldataanalyzer/util.go (1)

170-185: Test-summary formatting helper is straightforward and consistent

The in-place sort by release, failure count (desc), then test name mirrors the query’s ordering and existing formatOutput patterns, and json.MarshalIndent keeps output stable for diffs. Behavior for empty input is defensive and safe.

pkg/jobrunaggregator/jobrunaggregatorlib/retrying_ci_data_client.go (1)

188-196: Retry wrapper mirrors existing client behavior

ListTestSummaryByPeriod on the retrying client follows the same retry.OnError(slowBackoff, isReadQuotaError, …) pattern as the other methods, so retry semantics stay consistent and localized to quota-style failures.

If you haven’t already, run a quick integration test hitting the real BigQuery-backed implementation to confirm retry behavior and error wrapping are as expected.

pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go (1)

1-20: Struct shape correctly matches the BigQuery query schema

TestSummaryByPeriodRow’s field names, types, and bigquery tags line up with the ListTestSummaryByPeriod SELECT clause (SUMs as int64, ratios/durations as float64, dates as civil.Date), so decoding should be straightforward.

Please confirm via a small end‑to‑end query (or unit test with a fake RowIterator) that BigQuery scanning into this struct works without field/tag mismatches.

pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go (1)

70-76: Test-summary query is well‑structured and consistent with existing CIDataClient patterns

The new ListTestSummaryByPeriod method is documented clearly on the interface and the implementation’s SQL matches the TestSummaryByPeriodRow schema (field aliases ↔ struct tags). The aggregation logic (SUM/SAFE_DIVIDE/AVG, window via CURRENT_DATE() and daysBack, HAVING SUM(test_count) > @min_test_count) and labeling (bigQueryLabelValueTestSummaryByPeriod) align with how other queries in this client are written, so it should be straightforward to operate and debug.

If possible, run this against a representative dataset to confirm:

  • Parameter binding for days_back / min_test_count is accepted by BigQuery.
  • The DATE_SUB(CURRENT_DATE(), INTERVAL @days_back DAY) filter yields the expected window.
  • The decoded TestSummaryByPeriodRow values (including FailureRate and PeriodStart/End) match manual query results.

Also applies to: 1107-1173

@neisw neisw force-pushed the TRT-2389-test-summaries branch from c5366f4 to cee2982 Compare January 6, 2026 15:40
@neisw
Copy link
Contributor Author

neisw commented Jan 6, 2026

/test images

1 similar comment
@neisw
Copy link
Contributor Author

neisw commented Jan 6, 2026

/test images

@neisw
Copy link
Contributor Author

neisw commented Jan 7, 2026

/hold cancel

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 7, 2026
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go (1)

1107-1107: Consider validating input parameters.

Adding validation for daysBack and minTestCount would prevent unexpected behavior from negative or extreme values.

🛡️ Suggested validation
 func (c *ciDataClient) ListTestSummaryByPeriod(ctx context.Context, suiteName, releaseName string, daysBack, minTestCount int) ([]jobrunaggregatorapi.TestSummaryByPeriodRow, error) {
+	if daysBack < 1 {
+		return nil, fmt.Errorf("daysBack must be at least 1, got %d", daysBack)
+	}
+	if minTestCount < 0 {
+		return nil, fmt.Errorf("minTestCount must be non-negative, got %d", minTestCount)
+	}
+
 	// Query to summarize test results for a specific suite and release over a time period
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 6533fee and 80a9e2b.

📒 Files selected for processing (2)
  • pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go
  • pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity.

Files:

  • pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go
  • pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go
🧬 Code graph analysis (1)
pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go (1)
pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go (1)
  • TestSummaryByPeriodRow (9-21)
🔇 Additional comments (2)
pkg/jobrunaggregator/jobrunaggregatorlib/ci_data_client.go (1)

70-76: LGTM! Well-documented interface addition.

The new method signature is clear and follows existing patterns. The parameter documentation helps callers understand the expected inputs.

pkg/jobrunaggregator/jobrunaggregatorapi/types_row_test_summary.go (1)

1-21: LGTM! Clean data structure definition.

The struct is well-designed with:

  • Appropriate field types (civil.Date for date-only values, int64 for counts, float64 for rates/averages)
  • Correct BigQuery tags matching the query fields
  • Clear documentation including the purpose of FirstSampleDate

Comment on lines +1114 to +1127
WITH earliest_test_dates AS (
-- Pre-compute the earliest date each test was seen across all releases for this suite
SELECT
test_name,
MIN(date) AS first_sample_date
FROM
DATA_SET_LOCATION.TestsSummaryByDate
WHERE
suite = @suite_name
AND date >= DATE_SUB(CURRENT_DATE(), INTERVAL 100 DAY)
AND date <= CURRENT_DATE()
GROUP BY
test_name
)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Hardcoded 100-day window in CTE may cause incomplete first_sample_date.

The CTE uses a fixed 100-day lookback (line 1123), while the main query uses the parametrized @days_back. If daysBack > 100, the first_sample_date will be incomplete because the CTE won't scan beyond 100 days. Consider either:

  • Documenting this as a design constraint (e.g., "first_sample_date is limited to 100 days of history")
  • Making the CTE window configurable (e.g., MAX(100, @days_back) or a separate parameter)
🔧 Possible fix to align CTE window with daysBack
   WHERE
     suite = @suite_name
-    AND date >= DATE_SUB(CURRENT_DATE(), INTERVAL 100 DAY)
+    AND date >= DATE_SUB(CURRENT_DATE(), INTERVAL @days_back DAY)
     AND date <= CURRENT_DATE()
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
WITH earliest_test_dates AS (
-- Pre-compute the earliest date each test was seen across all releases for this suite
SELECT
test_name,
MIN(date) AS first_sample_date
FROM
DATA_SET_LOCATION.TestsSummaryByDate
WHERE
suite = @suite_name
AND date >= DATE_SUB(CURRENT_DATE(), INTERVAL 100 DAY)
AND date <= CURRENT_DATE()
GROUP BY
test_name
)
WITH earliest_test_dates AS (
-- Pre-compute the earliest date each test was seen across all releases for this suite
SELECT
test_name,
MIN(date) AS first_sample_date
FROM
DATA_SET_LOCATION.TestsSummaryByDate
WHERE
suite = @suite_name
AND date >= DATE_SUB(CURRENT_DATE(), INTERVAL @days_back DAY)
AND date <= CURRENT_DATE()
GROUP BY
test_name
)

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jan 9, 2026

@neisw: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/images 80a9e2b link true /test images
ci/prow/breaking-changes 80a9e2b link false /test breaking-changes

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants