diff --git a/cmd/controller/kodata/HEAD b/cmd/controller/kodata/HEAD deleted file mode 120000 index 8f63681d36..0000000000 --- a/cmd/controller/kodata/HEAD +++ /dev/null @@ -1 +0,0 @@ -../../../.git/HEAD \ No newline at end of file diff --git a/cmd/controller/kodata/LICENSE b/cmd/controller/kodata/LICENSE deleted file mode 120000 index 5853aaea53..0000000000 --- a/cmd/controller/kodata/LICENSE +++ /dev/null @@ -1 +0,0 @@ -../../../LICENSE \ No newline at end of file diff --git a/cmd/controller/kodata/LICENSE b/cmd/controller/kodata/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/cmd/controller/kodata/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/cmd/controller/kodata/refs b/cmd/controller/kodata/refs deleted file mode 120000 index 739d35bf96..0000000000 --- a/cmd/controller/kodata/refs +++ /dev/null @@ -1 +0,0 @@ -../../../.git/refs \ No newline at end of file diff --git a/test/metrics_otel_test.go b/test/metrics_otel_test.go new file mode 100644 index 0000000000..e23075267a --- /dev/null +++ b/test/metrics_otel_test.go @@ -0,0 +1,246 @@ +//go:build e2e + +/* +Copyright 2026 The Tekton Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package test + +import ( + "context" + "fmt" + "io" + "net/http" + "strings" + "testing" + "time" + + dto "github.com/prometheus/client_model/go" + "github.com/prometheus/common/expfmt" + "github.com/prometheus/common/model" + "github.com/tektoncd/chains/pkg/test/tekton" + "k8s.io/apimachinery/pkg/util/wait" + logtesting "knative.dev/pkg/logging/testing" +) + +// scrapeMetrics port-forwards to the chains metrics service and returns all +// Prometheus metric families parsed from the /metrics endpoint. +func scrapeMetrics(ctx context.Context, t *testing.T) map[string]*dto.MetricFamily { + t.Helper() + localPort, stopFwd := kubectlPortForward(ctx, t, namespace, metricsServiceName, metricsPort) + defer stopFwd() + + url := fmt.Sprintf("http://localhost:%d%s", localPort, metricsPath) + + var families map[string]*dto.MetricFamily + if err := wait.PollUntilContextTimeout(ctx, 2*time.Second, 30*time.Second, true, func(context.Context) (bool, error) { + resp, err := http.Get(url) //nolint:noctx + if err != nil { + return false, nil + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return false, nil + } + body, err := io.ReadAll(resp.Body) + if err != nil { + return false, nil + } + parser := expfmt.NewTextParser(model.LegacyValidation) + parsed, err := parser.TextToMetricFamilies(strings.NewReader(string(body))) + if err != nil { + return false, nil + } + families = parsed + return true, nil + }); err != nil { + t.Fatalf("Metrics endpoint %s never returned parseable output: %v", url, err) + } + return families +} + +// counterValue returns the sum of counter values for the given metric name. +func counterValue(families map[string]*dto.MetricFamily, name string) float64 { + fam, ok := families[name] + if !ok { + return 0 + } + var total float64 + for _, m := range fam.GetMetric() { + if c := m.GetCounter(); c != nil { + total += c.GetValue() + } + } + return total +} + +// counterDelta returns the increase in a counter between two scrapes, guarding +// against resets (returns 0 if the counter decreased). +func counterDeltaChains(after, before map[string]*dto.MetricFamily, name string) float64 { + a := counterValue(after, name) + b := counterValue(before, name) + if a < b { + return 0 + } + return a - b +} + +// waitForMetricFamily polls until the named metric family appears. +func waitForMetricFamily(ctx context.Context, t *testing.T, name string, timeout time.Duration) map[string]*dto.MetricFamily { + t.Helper() + ctx, cancel := context.WithTimeout(ctx, timeout) + defer cancel() + for { + families := scrapeMetrics(ctx, t) + if _, ok := families[name]; ok { + return families + } + select { + case <-ctx.Done(): + t.Fatalf("Timed out waiting for metric %q to appear: %v", name, ctx.Err()) + return nil + case <-time.After(5 * time.Second): + } + } +} + +// TestOTelMetrics is a consolidated e2e test for the OpenCensus-to-OpenTelemetry +// metrics migration in Chains (PR #1550). It creates a TaskRun and a PipelineRun, +// waits for Chains to sign them, then scrapes the controller /metrics endpoint to +// verify all counter metrics are present and have incremented. +// +// Metrics verified: +// - watcher_taskrun_sign_created_total +// - watcher_taskrun_payload_uploaded_total +// - watcher_taskrun_payload_stored_total +// - watcher_taskrun_marked_signed_total +// - watcher_pipelinerun_sign_created_total +// - watcher_pipelinerun_payload_uploaded_total +// - watcher_pipelinerun_payload_stored_total +// - watcher_pipelinerun_marked_signed_total +func TestOTelMetrics(t *testing.T) { + ctx := logtesting.TestContextWithLogger(t) + c, ns, cleanup := setup(ctx, t, setupOpts{}) + t.Cleanup(cleanup) + + resetConfig := setConfigMap(ctx, t, c, map[string]string{ + "artifacts.taskrun.format": "in-toto", + "artifacts.taskrun.signer": "x509", + "artifacts.taskrun.storage": "tekton", + "artifacts.pipelinerun.format": "in-toto", + "artifacts.pipelinerun.signer": "x509", + "artifacts.pipelinerun.storage": "tekton", + }) + t.Cleanup(resetConfig) + + // Baseline scrape before creating any resources so assertions can use deltas. + baseline := scrapeMetrics(ctx, t) + + // ========== Create and sign a TaskRun ========== + + trObj := tekton.CreateObject(t, ctx, c.PipelineClient, getTaskRunObject(ns)) + if o := waitForCondition(ctx, t, c.PipelineClient, trObj, done, time.Minute); o == nil { + t.Fatal("TaskRun never completed.") + } + if o := waitForCondition(ctx, t, c.PipelineClient, trObj, signed, 2*time.Minute); o == nil { + t.Fatal("TaskRun never signed by Chains.") + } + + // ========== Create and sign a PipelineRun ========== + + prObj := tekton.CreateObject(t, ctx, c.PipelineClient, getPipelineRunObject(ns)) + if o := waitForCondition(ctx, t, c.PipelineClient, prObj, done, time.Minute); o == nil { + t.Fatal("PipelineRun never completed.") + } + if o := waitForCondition(ctx, t, c.PipelineClient, prObj, signed, 2*time.Minute); o == nil { + t.Fatal("PipelineRun never signed by Chains.") + } + + // ========== Scrape metrics and wait for sign counter to appear ========== + + t.Log("Waiting for watcher_taskrun_sign_created_total to appear") + families := waitForMetricFamily(ctx, t, "watcher_taskrun_sign_created_total", 2*time.Minute) + t.Logf("Scraped %d metric families", len(families)) + + // ========== Counter delta assertions (TaskRun + PipelineRun) ========== + + // watcher_taskrun_payload_uploaded_total and + // watcher_pipelinerun_payload_uploaded_total only fire for external storage + // backends (OCI, GCS, etc.). With storage=tekton the payload is written + // directly to the TaskRun/PipelineRun annotation, so those counters stay + // at 0 and are not included in the table below. + tests := []struct { + name string + metricName string + wantMin float64 + }{ + {"TaskRun/sign_created_total", "watcher_taskrun_sign_created_total", 1}, + {"TaskRun/payload_stored_total", "watcher_taskrun_payload_stored_total", 1}, + {"TaskRun/marked_signed_total", "watcher_taskrun_marked_signed_total", 1}, + {"PipelineRun/sign_created_total", "watcher_pipelinerun_sign_created_total", 1}, + {"PipelineRun/payload_stored_total", "watcher_pipelinerun_payload_stored_total", 1}, + {"PipelineRun/marked_signed_total", "watcher_pipelinerun_marked_signed_total", 1}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + delta := counterDeltaChains(families, baseline, tt.metricName) + if delta < tt.wantMin { + t.Errorf("%s delta = %v, want >= %v", tt.metricName, delta, tt.wantMin) + } + t.Logf("%s delta: %v", tt.metricName, delta) + }) + } + + // ========== Knative infrastructure metrics (OTel renames) ========== + + prefixTests := []struct { + name string + prefix string + errMsg string + }{ + {"Renames/workqueue_uses_kn_prefix", "kn_workqueue_", "Expected at least one kn_workqueue_* metric, found none"}, + {"Renames/go_runtime_uses_standard_prefix", "go_", "Expected standard go_* runtime metrics, found none"}, + } + for _, tt := range prefixTests { + t.Run(tt.name, func(t *testing.T) { + found := false + for name := range families { + if strings.HasPrefix(name, tt.prefix) { + found = true + break + } + } + if !found { + t.Error(tt.errMsg) + } + }) + } + + // ========== Removed OpenCensus metrics ========== + // These metrics were present in the OpenCensus-based implementation and + // must be absent after the OTel migration. + // TODO: Remove these assertions in a future release once no OC-based + // release is supported. + + removedMetrics := []string{ + "tekton_chains_taskrun_signed_total", + "tekton_chains_pipelinerun_signed_total", + } + for _, name := range removedMetrics { + if _, ok := families[name]; ok { + t.Errorf("Old OC metric %s still present; expected removal after OTel migration", name) + } + } +}