-
Notifications
You must be signed in to change notification settings - Fork 56
feat(EC-1816): add multi-component stress benchmark #3331
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
Draft
dheerajodha
wants to merge
1
commit into
conforma:main
Choose a base branch
from
dheerajodha:EC-1816
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.
+223
−0
Draft
Changes from all commits
Commits
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,48 @@ | ||
| #!/bin/bash | ||
| # Copyright The Conforma Contributors | ||
| # | ||
| # 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. | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| # Creates the files in the data directory that should contain all the data | ||
| # needed to run the benchmark, uses the ../offliner for images and plain git | ||
| # clone for the git data dependency. Uses the same golden-container image as the | ||
| # simple benchmark -- the stress benchmark duplicates it across components at | ||
| # runtime. | ||
| set -o errexit | ||
| set -o nounset | ||
| set -o pipefail | ||
|
|
||
| offliner="$(git rev-parse --show-toplevel)/benchmark/offliner" | ||
|
|
||
| dir="$(mktemp -d)" | ||
| trap 'rm -rf "${dir}"' EXIT | ||
|
|
||
| ( | ||
| cd "${dir}" | ||
|
|
||
| imgs=( | ||
| quay.io/redhat-user-workloads/rhtap-contract-tenant/golden-container/golden-container@sha256:166e38c156fa81d577a7ba7a948b68c79005a06e302779d1bebc7d31e8bea315 | ||
| quay.io/konflux-ci/tekton-catalog/data-acceptable-bundles@sha256:1e70b8f672388838f20a7d45e145e31e99dab06cefa1c5514d6ce41c8bbea1b0 | ||
| quay.io/enterprise-contract/ec-release-policy@sha256:64617f0c45689ef7152c5cfbd4cd5709a3126e4ab7482eb6acd994387fe2d4ba | ||
| ) | ||
|
|
||
| for img in "${imgs[@]}"; do | ||
| go run -C "${offliner}" . "${img}" "${dir}/data/registry/data" | ||
| done | ||
|
|
||
| git clone --no-checkout https://github.com/release-engineering/rhtap-ec-policy.git data/git/rhtap-ec-policy.git | ||
| ) | ||
|
|
||
| tar czf data.tar.gz -C "${dir}" . |
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,175 @@ | ||
| // Copyright The Conforma Contributors | ||
| // | ||
| // 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. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| // Stress benchmark validating a multi-component snapshot with a configurable | ||
| // number of workers, simulating real-world release pipeline workloads. The | ||
| // component count and worker count are controlled via the EC_STRESS_COMPONENTS | ||
| // and EC_STRESS_WORKERS environment variables respectively. Uses the same | ||
| // golden-container image data as the simple benchmark, duplicated across | ||
| // components to create memory pressure. The prepare_data.sh script can be used | ||
| // to re-populate the data directory. | ||
| package main | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "os" | ||
| "path" | ||
| "strconv" | ||
|
|
||
| "golang.org/x/benchmarks/driver" | ||
|
|
||
| "github.com/conforma/cli/benchmark/internal/registry" | ||
| "github.com/conforma/cli/benchmark/internal/suite" | ||
| "github.com/conforma/cli/benchmark/internal/untar" | ||
| ) | ||
|
|
||
| const ( | ||
| defaultComponents = 10 | ||
| defaultWorkers = 35 | ||
| ) | ||
|
|
||
| func main() { | ||
| driver.Main("Stress", benchmark) | ||
| } | ||
|
|
||
| func envInt(name string, fallback int) int { | ||
| v, ok := os.LookupEnv(name) | ||
| if !ok { | ||
| return fallback | ||
| } | ||
| n, err := strconv.Atoi(v) | ||
| if err != nil { | ||
| panic(fmt.Sprintf("invalid %s value %q: %v", name, v, err)) | ||
| } | ||
| return n | ||
| } | ||
|
|
||
| func setup() (string, suite.Closer) { | ||
| dir, err := untar.UnTar("data.tar.gz") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| closer, err := registry.Launch(path.Join(dir, "data/registry/data")) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| return dir, func() { | ||
| closer() | ||
| os.RemoveAll(dir) | ||
| } | ||
| } | ||
|
|
||
| type component struct { | ||
| Name string `json:"name"` | ||
| ContainerImage string `json:"containerImage"` | ||
| Source *source `json:"source,omitempty"` | ||
| } | ||
|
|
||
| type source struct { | ||
| Git gitSource `json:"git"` | ||
| } | ||
|
|
||
| type gitSource struct { | ||
| URL string `json:"url"` | ||
| Revision string `json:"revision"` | ||
| } | ||
|
|
||
| type snapshot struct { | ||
| Components []component `json:"components"` | ||
| } | ||
|
|
||
| func buildSnapshot(n int) string { | ||
| s := snapshot{Components: make([]component, n)} | ||
| for i := range s.Components { | ||
| s.Components[i] = component{ | ||
| Name: fmt.Sprintf("golden-container-%d", i), | ||
| ContainerImage: "quay.io/redhat-user-workloads/rhtap-contract-tenant/golden-container/golden-container@sha256:166e38c156fa81d577a7ba7a948b68c79005a06e302779d1bebc7d31e8bea315", | ||
| Source: &source{ | ||
| Git: gitSource{ | ||
| URL: "https://github.com/conforma/golden-container", | ||
| Revision: "2dec8f515a64ef2f21ee3e7b1ed41da77a5c5a9a", | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| data, err := json.Marshal(s) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| return string(data) | ||
| } | ||
|
|
||
| func benchmark() driver.Result { | ||
| dir, closer := setup() | ||
| defer closer() | ||
|
|
||
| components := envInt("EC_STRESS_COMPONENTS", defaultComponents) | ||
| workers := envInt("EC_STRESS_WORKERS", defaultWorkers) | ||
|
|
||
| return driver.Benchmark(run(dir, components, workers)) | ||
| } | ||
|
|
||
| func ec(dir string, components, workers int) func() { | ||
| snap := buildSnapshot(components) | ||
|
|
||
| policy := fmt.Sprintf(`{ | ||
| "publicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEZP/0htjhVt2y0ohjgtIIgICOtQtA\nnaYJRuLprwIv6FDhZ5yFjYUEtsmoNcW7rx2KM6FOXGsCX3BNc7qhHELT+g==\n-----END PUBLIC KEY-----", | ||
| "sources": [ | ||
| { | ||
| "data": [ | ||
| "git::file://%s/data/git/rhtap-ec-policy.git//data?ref=a524ee2f2f7774f6f360eb64c4cb24004de52aae", | ||
| "oci::quay.io/konflux-ci/tekton-catalog/data-acceptable-bundles@sha256:1e70b8f672388838f20a7d45e145e31e99dab06cefa1c5514d6ce41c8bbea1b0" | ||
| ], | ||
| "policy": [ | ||
| "oci::quay.io/enterprise-contract/ec-release-policy@sha256:64617f0c45689ef7152c5cfbd4cd5709a3126e4ab7482eb6acd994387fe2d4ba" | ||
| ], | ||
| "config": { | ||
| "include": [ | ||
| "@redhat" | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| }`, dir) | ||
|
|
||
| return func() { | ||
| if err := suite.Execute([]string{ | ||
| "validate", | ||
| "image", | ||
| "--json-input", | ||
| snap, | ||
| "--policy", | ||
| policy, | ||
| "--ignore-rekor", | ||
| "--workers", | ||
| strconv.Itoa(workers), | ||
| "--effective-time", | ||
| "2024-12-10T00:00:00Z", | ||
| }); err != nil { | ||
| panic(err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func run(dir string, components, workers int) func(n uint64) { | ||
| return func(n uint64) { | ||
| driver.Parallel(n, 1, ec(dir, components, workers)) | ||
| } | ||
| } | ||
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.
[low] edge-case
envInt does not validate that the returned integer is positive. Setting EC_STRESS_COMPONENTS=0 produces a snapshot with zero components, and EC_STRESS_WORKERS=0 or a negative value is passed directly to --workers. These degenerate inputs silently produce meaningless benchmark results rather than failing fast.
Suggested fix: Add a lower-bound check after parsing: if n < 1 { panic(fmt.Sprintf("%s must be >= 1, got %d", name, n)) }