chore: Update templated files (ca104d6)

.dockerignore

@@ -1,3 +1,6 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 debug/
 target/
 **/*.rs.bk

.envrc.sample

@@ -1,3 +1,6 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 # vim: syntax=conf
 #
 # If you use direnv, you can autoload the nix shell:

.gitattributes

@@ -1,3 +1,6 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 nix/** linguist-generated
 Cargo.nix linguist-generated
 crate-hashes.json linguist-generated

.github/ISSUE_TEMPLATE/01-normal-issue.md

@@ -1,4 +1,6 @@
 ---
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 name: Normal issue
 about: This is just a normal empty issue with a simple checklist
 title: ''

.github/ISSUE_TEMPLATE/02-bug_report.yml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 name: "🐛 Bug Report"
 description: "If something isn't working as expected 🤔."

.github/ISSUE_TEMPLATE/config.yml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 blank_issues_enabled: true
 contact_links:

.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md

@@ -1,3 +1,8 @@
+<!--
+This file is automatically generated from the templates in stackabletech/operator-templating
+DO NOT MANUALLY EDIT THIS FILE
+-->
+
 ## Check and Update Getting Started Script
 
 <!--

.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md

@@ -1,3 +1,8 @@
+<!--
+This file is automatically generated from the templates in stackabletech/operator-templating
+DO NOT MANUALLY EDIT THIS FILE
+-->
+
 ## Bump Rust Dependencies for Stackable Release YY.M.X
 
 <!--

.github/actionlint.yaml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 self-hosted-runner:
   # Ubicloud machines we are using

.github/pull_request_template.md

@@ -1,3 +1,8 @@
+<!--
+This file is automatically generated from the templates in stackabletech/operator-templating
+DO NOT MANUALLY EDIT THIS FILE
+-->
+
 ## Description
 
 *Please add a description here. This will become the commit message of the merge request later.*

.github/workflows/integration-test-custom.yaml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 name: Integration Test (Custom)
 

.github/workflows/integration-test-profile.yaml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 name: Integration Test (Profile + Schedule)
 

.github/workflows/pr_prek.yaml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 name: prek
 

.gitignore

@@ -1,3 +1,6 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 tests/_work/
 debug/
 target/

.hadolint.yaml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 ignored:
   # Warning: Use the -y switch to avoid manual input dnf install -y <package>

.markdownlint.yaml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 # All defaults or options can be checked here:
 # https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml

.pre-commit-config.yaml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 exclude: ^(Cargo\.nix|crate-hashes\.json|nix/.*)$
 
@@ -66,6 +68,19 @@ repos:
 
   - repo: local
     hooks:
+      - id: script-tests
+        name: script-tests
+        language: system
+        entry: python3 -m unittest discover --start-directory scripts --pattern '*.py'
+        pass_filenames: false
+        files: ^scripts/.*\.py$
+
+      - id: check-namespaced-defines
+        name: check-namespaced-defines
+        language: system
+        entry: python3 scripts/check_namespaced_defines.py
+        files: ^deploy/helm/[^/]+/templates/
+
       - id: regenerate-charts
         name: regenerate-charts
         language: system

.pylintrc

@@ -1,3 +1,6 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 [MESSAGES CONTROL]
 
 # These rules are for missing docstrings which doesn't matter much for most of our simple scripts

.vscode/DO_NOT_EDIT.md

@@ -0,0 +1,9 @@
+# DO NOT EDIT
+
+The files in this directory are automatically generated from the templates in stackabletech/operator-templating
+
+DO NOT MANUALLY EDIT THESE FILES
+
+> [!NOTE]
+> This file only exists because VS Code currently doesn't support JSONC files.
+> See <https://github.com/microsoft/vscode/issues/269824>

.yamllint.yaml

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 extends: default
 

Tiltfile

@@ -1,3 +1,6 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 # Load the metadata first, so that we immediately get access to the operator name
 meta = read_json('nix/meta.json')
 operator_name = meta['operator']['name']

deny.toml

@@ -1,6 +1,9 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 # This file is the source of truth for all our repos!
 # This includes repos not templated by operator-templating, please copy/paste the file for this repos.
-
+#
 # TIP: Use "cargo deny check" to check if everything is fine
 
 [graph]

rust-toolchain.toml

@@ -1,4 +1,6 @@
-# DO NOT EDIT, this file is generated by operator-templating
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 [toolchain]
 channel = "1.97.1"
 profile = "default"

rustfmt.toml

@@ -1,3 +1,6 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 # This file includes unstable features, so you need to run "cargo +nightly fmt" to format your code.
 # It's also ok to use the stable toolchain by simple running "cargo fmt", but using the nightly formatter is preferred.
 

scripts/auto-retry-tests.py

@@ -1,4 +1,8 @@
 #!/usr/bin/env python3
+
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 """
 Automated test suite runner with intelligent retry logic for flaky integration tests.
 

scripts/check_namespaced_defines.py

@@ -0,0 +1,95 @@
+"""
+Fails when a Helm defined template, or a call to one, is not prefixed with the
+name of the chart it lives in.
+
+To run tests for this script:
+    python3 -m unittest check_namespaced_defines.py
+"""
+
+import re
+import unittest
+from pathlib import Path
+
+NAME_PATTERN = r'\b(?:define|include|template)\s+"([^"]+)"'
+CHART_PATTERN = r"(?:^|/)deploy/helm/(?P<chart>[^/]+)/templates/"
+
+
+def chart_of(path):
+    """The chart whose templates directory holds path, or None if it is outside one."""
+    found = re.search(CHART_PATTERN, Path(path).as_posix())
+    return found.group("chart") if found else None
+
+
+def unprefixed(file_contents, chart_name):
+    """The defined template names in file_contents, and the calls to them, lacking the chart prefix."""
+    names = re.findall(NAME_PATTERN, file_contents)
+    return sorted({name for name in names if not name.startswith(f"{chart_name}.")})
+
+
+# Run these with: python3 -m unittest check_namespaced_defines.py
+class TestCoreMethods(unittest.TestCase):
+    def test_chart_of(self):
+        self.assertEqual(
+            chart_of("deploy/helm/trino-operator/templates/x.yaml"), "trino-operator"
+        )
+        # An absolute path has to give the same answer, or a manual run invents a chart name.
+        self.assertEqual(
+            chart_of("/tmp/wt/deploy/helm/secret-operator/templates/a/b.yaml"),
+            "secret-operator",
+        )
+        self.assertIsNone(chart_of("deploy/helm/trino-operator/values.yaml"))
+        self.assertIsNone(chart_of("README.md"))
+
+    def test_prefixed_is_accepted(self):
+        text = '{{- define "trino-operator.labels" -}}\n{{ include "trino-operator.chart" . }}\n'
+        self.assertEqual(unprefixed(text, "trino-operator"), [])
+
+    def test_unprefixed_define_is_reported(self):
+        self.assertEqual(
+            unprefixed('{{- define "helper.thing" -}}', "trino-operator"),
+            ["helper.thing"],
+        )
+
+    def test_unprefixed_call_is_reported(self):
+        # A renamed definition whose call sites did not move with it stops the chart rendering.
+        text = (
+            '{{ include "operator.fullname" . }}\n{{ template "operator.labels" . }}\n'
+        )
+        self.assertEqual(
+            unprefixed(text, "trino-operator"), ["operator.fullname", "operator.labels"]
+        )
+
+    def test_keyword_must_stand_alone(self):
+        # Without a word boundary any identifier ending in the keyword matches.
+        self.assertEqual(
+            unprefixed('{{ .Values.xinclude "bar.baz" }}', "foo-operator"), []
+        )
+
+
+if __name__ == "__main__":
+    import sys
+
+    if not sys.argv[1:]:
+        print(f"usage: {sys.argv[0]} deploy/helm/<chart>/templates/*", file=sys.stderr)
+        sys.exit(2)
+
+    failed = False
+    for path in sys.argv[1:]:
+        chart_name = chart_of(path)
+        if chart_name is None:
+            print(
+                f"{sys.argv[0]}: {path} is not inside deploy/helm/<chart>/templates/",
+                file=sys.stderr,
+            )
+            sys.exit(2)
+        file_contents = Path(path).read_text(encoding="utf-8")
+        unprefixed_names = unprefixed(file_contents, chart_name)
+        if unprefixed_names:
+            failed = True
+            print(
+                f"{path}: defined templates and the calls to them must be prefixed with '{chart_name}.'"
+            )
+            for name in unprefixed_names:
+                print(f"  {name}")
+
+    sys.exit(1 if failed else 0)

scripts/docs_templating.sh

@@ -1,4 +1,8 @@
 #!/usr/bin/env bash
+
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 set -euo pipefail
 
 # Reads a file with variables to insert into templates, and templates all .*.j2 files

scripts/ensure_one_trailing_newline.py

@@ -1,3 +1,6 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 """
 Given the location of a file, trims all trailing blank lines and
 places a single one. Used as post-processing step for README rendering.

scripts/render_readme.sh

@@ -1,4 +1,8 @@
 #!/usr/bin/env bash
+
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 set -euo pipefail
 
 # Check if jinja2 is there

scripts/run-tests

@@ -1,6 +1,9 @@
 #!/usr/bin/env python
 # vim: filetype=python syntax=python tabstop=4 expandtab
 
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 import argparse
 import collections.abc
 import contextlib

scripts/run_tests.sh

@@ -1,3 +1,6 @@
 #!/usr/bin/env bash
 
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 ./scripts/run-tests "$@"

shell.nix

@@ -1,3 +1,6 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
+
 let
   self = import ./. {};
   inherit (self) sources pkgs meta;

tests/README-templating.md

@@ -1,3 +1,8 @@
+<!--
+This file is automatically generated from the templates in stackabletech/operator-templating
+DO NOT MANUALLY EDIT THIS FILE
+-->
+
 # Test Scenario Templating
 
 ## Introduction

tests/kuttl-test.yaml.jinja2

@@ -1,3 +1,5 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE
 ---
 apiVersion: kuttl.dev/v1beta1
 kind: TestSuite

tests/templates/.gitkeep

@@ -0,0 +1,2 @@
+# This file is automatically generated from the templates in stackabletech/operator-templating
+# DO NOT MANUALLY EDIT THIS FILE