-
Notifications
You must be signed in to change notification settings - Fork 62
fix(RELEASE-2685): treat empty cpe label as validation failure #1001
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
Open
davidmogar
wants to merge
1
commit into
main
Choose a base branch
from
release2685
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.
+81
−4
Open
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
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 |
|---|---|---|
|
|
@@ -108,6 +108,18 @@ def test_get_label_value_no_labels_key() -> None: | |
| assert check_labels.get_label_value(comp, "name") is None | ||
|
|
||
|
|
||
| def test_get_label_value_present_but_empty() -> None: | ||
| """Return an empty string when the label is present with an empty value.""" | ||
| comp = _make_component(labels=[_name_label("")]) | ||
| assert check_labels.get_label_value(comp, "name") == "" | ||
|
|
||
|
|
||
| def test_get_label_value_present_but_whitespace() -> None: | ||
| """Return an empty string when the label value is whitespace-only.""" | ||
| comp = _make_component(labels=[_name_label(" ")]) | ||
| assert check_labels.get_label_value(comp, "name") == "" | ||
|
|
||
|
|
||
| # --- is_image_media_type --- | ||
|
|
||
|
|
||
|
|
@@ -195,6 +207,59 @@ def test_no_cpe_label_skips(tmp_path: Path, caplog: pytest.LogCaptureFixture) -> | |
| assert "missing the 'cpe' label" in caplog.text | ||
|
|
||
|
|
||
| def test_empty_cpe_label_enforce(tmp_path: Path) -> None: | ||
| """Fail when the CPE label is present but set to an empty string.""" | ||
|
Comment on lines
+210
to
+211
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 1. Unit tests not co-located The new check_labels unit tests are placed in a nested tests/ directory rather than alongside check_labels.py. This violates the required test placement for source files outside utils/. Agent Prompt
|
||
| snap = tmp_path / "snapshot.json" | ||
| data = tmp_path / "data.json" | ||
| _write_snapshot( | ||
| snap, | ||
| [ | ||
| _make_component( | ||
| labels=[ | ||
| _name_label("openshift-gitops-1/gitops-rhel8-operator"), | ||
| _cpe_label(""), | ||
| ], | ||
| repositories=[ | ||
| { | ||
| "rh-registry-repo": "registry.redhat.io/openshift-gitops-1" | ||
| "/gitops-rhel8-operator" | ||
| } | ||
| ], | ||
| ) | ||
| ], | ||
| ) | ||
| _write_data(data) | ||
| with pytest.raises(check_labels.LabelValidationError, match="empty value"): | ||
| check_labels._check_labels(snap, data, enforce=True) | ||
|
|
||
|
|
||
| def test_empty_cpe_label_warn(tmp_path: Path, caplog: pytest.LogCaptureFixture) -> None: | ||
| """Warn but succeed when the CPE label is empty and enforce is False.""" | ||
| snap = tmp_path / "snapshot.json" | ||
| data = tmp_path / "data.json" | ||
| _write_snapshot( | ||
| snap, | ||
| [ | ||
| _make_component( | ||
| labels=[ | ||
| _name_label("openshift-gitops-1/gitops-rhel8-operator"), | ||
| _cpe_label(""), | ||
| ], | ||
| repositories=[ | ||
| { | ||
| "rh-registry-repo": "registry.redhat.io/openshift-gitops-1" | ||
| "/gitops-rhel8-operator" | ||
| } | ||
| ], | ||
| ) | ||
| ], | ||
| ) | ||
| _write_data(data) | ||
| with caplog.at_level(logging.WARNING, logger="release"): | ||
| check_labels._check_labels(snap, data, enforce=False) | ||
| assert "'cpe' label is set to an empty value" in caplog.text | ||
|
|
||
|
|
||
| # --- check_labels (name label failures) --- | ||
|
|
||
|
|
||
|
|
||
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.
2. Whitespace bypasses label validation
🐞 Bug≡ CorrectnessAgent Prompt
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools