fix(notediscovery): align template standards#672
Open
mberlofa wants to merge 3 commits into
Open
Conversation
Contributor
Standards Check (GR-079) — PASSEvery changed chart fully passes standards-check. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (14)
✅ Files skipped from review due to trivial changes (4)
🚧 Files skipped from review as they are similar to previous changes (9)
📝 WalkthroughWalkthroughThis PR adds ChangesNoteDiscovery Chart Updates
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
🟢 Security Scan:
|
| Framework | Score |
|---|---|
| MITRE + NSA + SOC2 | 87.37374% |
✅ Security posture acceptable.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Move the Helm test pod back under templates
Because this hook manifest was moved to charts/notediscovery/tests/, Helm treats it as an ordinary chart file instead of a rendered template; I checked helm template review charts/notediscovery --show-only tests/test-connection.yaml, which reports it cannot find that template, while Helm renders test hooks from templates/tests/. In installs from this chart, the helm.sh/hook: test pod is never created, so the helm test command in NOTES has nothing to run.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
charts/notediscovery/templates/_helpers.tpl (1)
164-170: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueConsider consolidating the two selector-label override checks.
Both blocks repeat the same
hasKey/failpattern forapp.kubernetes.io/nameandapp.kubernetes.io/instance. Arangeover a list of protected keys would reduce duplication and make it easier to add more protected labels later.♻️ Optional refactor
{{- $podLabels := .Values.podLabels | default dict -}} -{{- if hasKey $podLabels "app.kubernetes.io/name" -}} -{{- fail "podLabels must not override the selector label app.kubernetes.io/name" -}} -{{- end -}} -{{- if hasKey $podLabels "app.kubernetes.io/instance" -}} -{{- fail "podLabels must not override the selector label app.kubernetes.io/instance" -}} -{{- end -}} +{{- range $key := (list "app.kubernetes.io/name" "app.kubernetes.io/instance") -}} +{{- if hasKey $podLabels $key -}} +{{- fail (printf "podLabels must not override the selector label %s" $key) -}} +{{- end -}} +{{- end -}}🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@charts/notediscovery/templates/_helpers.tpl` around lines 164 - 170, The two pod label override guards in _helpers.tpl duplicate the same hasKey/fail pattern for app.kubernetes.io/name and app.kubernetes.io/instance; refactor this check into a single range over a list of protected selector keys. Keep the existing fail behavior in the shared loop so any protected key in $podLabels is rejected, and make the helper easier to extend by adding future protected labels in one place.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@charts/notediscovery/templates/_helpers.tpl`:
- Around line 164-170: The two pod label override guards in _helpers.tpl
duplicate the same hasKey/fail pattern for app.kubernetes.io/name and
app.kubernetes.io/instance; refactor this check into a single range over a list
of protected selector keys. Keep the existing fail behavior in the shared loop
so any protected key in $podLabels is rejected, and make the helper easier to
extend by adding future protected labels in one place.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 225328ed-83e3-4b02-b3c7-c8cdd4074ff3
📒 Files selected for processing (13)
charts/notediscovery/README.mdcharts/notediscovery/templates/NOTES.txtcharts/notediscovery/templates/_helpers.tplcharts/notediscovery/templates/deployment.yamlcharts/notediscovery/templates/ingress.yamlcharts/notediscovery/templates/networkpolicy.yamlcharts/notediscovery/tests/networkpolicy_test.yamlcharts/notediscovery/tests/podlabels-selector-instance-values.yamlcharts/notediscovery/tests/podlabels-selector-name-values.yamlcharts/notediscovery/tests/test-connection.yamlcharts/notediscovery/tests/validation_test.yamlcharts/notediscovery/values.schema.jsoncharts/notediscovery/values.yaml
mberlofa
force-pushed
the
fix/notediscovery-template-standards
branch
from
9112435 to
dc7172e
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (1)
charts/notediscovery/tests/test_connection_test.yaml (1)
16-18: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winConsider asserting
helm.sh/hook-delete-policytoo.The template also sets
helm.sh/hook-delete-policy: before-hook-creation,hook-succeeded, which isn't covered here. Adding an assertion would tighten coverage of the hook lifecycle behavior.♻️ Suggested addition
- equal: path: metadata.annotations["helm.sh/hook"] value: test + - equal: + path: metadata.annotations["helm.sh/hook-delete-policy"] + value: before-hook-creation,hook-succeeded🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@charts/notediscovery/tests/test_connection_test.yaml` around lines 16 - 18, The Helm test coverage in the connection test should also verify the hook delete policy set by the template. Update the test in test_connection_test.yaml to assert metadata.annotations["helm.sh/hook-delete-policy"] matches before-hook-creation,hook-succeeded, alongside the existing helm.sh/hook check, so the lifecycle behavior of the test hook is covered by the test.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@charts/notediscovery/tests/test_connection_test.yaml`:
- Around line 16-18: The Helm test coverage in the connection test should also
verify the hook delete policy set by the template. Update the test in
test_connection_test.yaml to assert
metadata.annotations["helm.sh/hook-delete-policy"] matches
before-hook-creation,hook-succeeded, alongside the existing helm.sh/hook check,
so the lifecycle behavior of the test hook is covered by the test.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 7bbb8aa9-14d3-40b5-9a09-ad8515a138f0
📒 Files selected for processing (3)
charts/notediscovery/tests/networkpolicy-extra-egress-values.yamlcharts/notediscovery/tests/networkpolicy_test.yamlcharts/notediscovery/tests/test_connection_test.yaml
🚧 Files skipped from review as they are similar to previous changes (2)
- charts/notediscovery/tests/networkpolicy-extra-egress-values.yaml
- charts/notediscovery/tests/networkpolicy_test.yaml
mberlofa
force-pushed
the
fix/notediscovery-template-standards
branch
from
dc7172e to
7fa0924
Compare
Contributor
Author
|
Addressed both remaining CodeRabbit nitpicks from the review bodies. What changed:
Validation:
These CodeRabbit items were posted in review bodies/top-level summaries, not as unresolved review threads. The only thread on the PR was already resolved/outdated, so there is no new thread ID to reply to or resolve. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
templates/tests/sohelm testrenders and executes it, with unittest coverage for the hook pod.podLabels.ingress.ingressClassNamerendering and add fail-fast validation for enabled ingress without hosts.networkPolicy.extraEgresssupport with DNS and HTTPS baseline egress allowances before user rules.NOTES.txtwith numbered HelmForge operational sections.Validation
helm template test charts/notediscovery | rg -n "helm.sh/hook|test-connection"(hook rendered fromtemplates/tests/test-connection.yaml)helm unittest charts/notediscovery(33 tests, 8 suites)make template-standards-check CHART=notediscoverynode scripts/charts/validate-chart.js --chart notediscovery --no-k3dmake validate-chart CHART=notediscovery TIMEOUT=900(FULLY VALIDATED, 19 layers)make standards-check CHART=notediscoverymake standards-guard CHART=notediscoverymake site-sync-check CHART=notediscoverymake release-check REPO=chartspassed with expected post-merge release warningmake attribution-check REPO=chartsSite Sync
Site PR: helmforgedev/site#350
Summary by CodeRabbit
networkPolicy.extraEgressto support custom outbound egress rules while preserving built-in DNS (53) and HTTPS (443) access.ingressClassName.podLabelsselector, and Helm test hook coverage.