Skip to content
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

Aarnq/tests jsonschema2md #2400

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Aarnq/tests jsonschema2md #2400

wants to merge 2 commits into from

Conversation

aarnq
Copy link
Contributor

@aarnq aarnq commented Jan 17, 2025

Warning

This is a public repository, ensure not to disclose:

  • personal data beyond what is necessary for interacting with this pull request, nor
  • business confidential information, such as customer names.

What kind of PR is this?

Required: Mark one of the following that is applicable:

  • kind/feature
  • kind/improvement
  • kind/deprecation
  • kind/documentation
  • kind/clean-up
  • kind/bug
  • kind/other

Optional: Mark one or more of the following that are applicable:

Important

Breaking changes should be marked kind/admin-change or kind/dev-change depending on type
Critical security fixes should be marked with kind/security

  • kind/admin-change
  • kind/dev-change
  • kind/security
  • [kind/adr](set-me)

What does this PR do / why do we need this PR?

Tests a run of jsonschema2md as a unit test.

And I reworked the dockerfile as it was a lot to manage.

Checklist

  • Proper commit message prefix on all commits
  • Change checks:
    • The change is transparent
    • The change is disruptive
    • The change requires no migration steps
    • The change requires migration steps
    • The change updates CRDs
    • The change updates the config and the schema
  • Documentation checks:
  • Metrics checks:
    • The metrics are still exposed and present in Grafana after the change
    • The metrics names didn't change (Grafana dashboards and Prometheus alerts required no updates)
    • The metrics names did change (Grafana dashboards and Prometheus alerts required an update)
  • Logs checks:
    • The logs do not show any errors after the change
  • PodSecurityPolicy checks:
    • Any changed Pod is covered by Kubernetes Pod Security Standards
    • Any changed Pod is covered by Gatekeeper Pod Security Policies
    • The change does not cause any Pods to be blocked by Pod Security Standards or Policies
  • NetworkPolicy checks:
    • Any changed Pod is covered by Network Policies
    • The change does not cause any dropped packets in the NetworkPolicy Dashboard
  • Audit checks:
    • The change does not cause any unnecessary Kubernetes audit events
    • The change requires changes to Kubernetes audit policy
  • Falco checks:
    • The change does not cause any alerts to be generated by Falco
  • Bug checks:
    • The bug fix is covered by regression tests

@aarnq aarnq added kind/improvement Improvement of existing features, e.g. code cleanup or optimizations. test/integration Enable integration testing for a pull request test/regression Enable regression testing for a pull request labels Jan 17, 2025
@aarnq aarnq requested a review from a team January 17, 2025 14:26
@aarnq aarnq self-assigned this Jan 17, 2025
@aarnq aarnq requested review from a team as code owners January 17, 2025 14:26
Copy link
Contributor

@simonklb simonklb left a comment

Choose a reason for hiding this comment

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

Do you not feel it's going to be unnecessary to rebuild the entire image when init.sh changes instead of relying layer caching?

@aarnq
Copy link
Contributor Author

aarnq commented Jan 17, 2025

Do you not feel it's going to be unnecessary to rebuild the entire image when init.sh changes instead of relying layer caching?

A bit. I will check for ways to externalise the dependency list. Perhaps something similar to what we do for requirements.

}

unit-binaries() {
install-from-bin /usr/local/bin/gomplate "https://github.com/hairyhenderson/gomplate/releases/download/v${GOMPLATE_VERSION}/gomplate_linux-amd64"
Copy link
Contributor

Choose a reason for hiding this comment

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

Is saw a REQUIREMENTS file in another repo. Would it make sense to use that concept, i.e., requirements external to the code.

Also -- and this comment might be outside the scope of this PR -- I find it a bit scary to see so many executables being downloaded without checking their SHA. True, all downloads happen via HTTPS, so if anyone manages to spoof or hack https://github.com we have a way bigger problem, but "the Internet" seems to prefer verifying hashes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/improvement Improvement of existing features, e.g. code cleanup or optimizations. test/integration Enable integration testing for a pull request test/regression Enable regression testing for a pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants