chore: migrate from kuttl to chainsaw

Signed-off-by: Charles-Edouard Brétéché <[email protected]>

Author: eddycharly

.chainsaw.yaml

@@ -0,0 +1,12 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/kyverno/chainsaw/main/.schemas/json/configuration-chainsaw-v1alpha1.json
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Configuration
+metadata:
+  name: configuration
+spec:
+  parallel: 4
+  timeouts:
+    assert: 5m0s
+    cleanup: 5m0s
+    delete: 5m0s
+    error: 5m0s

.github/workflows/e2e.yaml

@@ -12,7 +12,6 @@ concurrency:
 
 jobs:
   e2e-tests:
-    name: End-to-end tests ${{ matrix.group }} on K8s ${{ matrix.kube-version }}
     runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
@@ -25,13 +24,13 @@ jobs:
          - "1.29"
        group:
          - e2e
-         - e2e-instrumentation
-         - e2e-upgrade
          - e2e-autoscale
-         - e2e-pdb
+         - e2e-instrumentation
          - e2e-opampbridge
-         - e2e-targetallocator
+         - e2e-pdb
          - e2e-prometheuscr
+         - e2e-targetallocator
+         - e2e-upgrade
          - e2e-multi-instrumentation
        include:
          - group: e2e-prometheuscr
@@ -42,33 +41,38 @@ jobs:
     steps:
     - name: Check out code into the Go module directory
       uses: actions/checkout@v4
-
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
         go-version: "~1.21.3"
-
     - name: Cache tools
       uses: actions/cache@v4
       with:
         path: bin
         key: ${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('Makefile') }}
-
+    - name: Install chainsaw
+      uses: kyverno/[email protected]
     - name: Install tools
       run: make install-tools
-
-    - name: "run tests"
+    - name: Prepare e2e tests
       env:
         KUBE_VERSION: ${{ matrix.kube-version }}
       run: |
+        set -e
         make ${{ matrix.setup != '' && matrix.setup || 'prepare-e2e' }} KUBE_VERSION=$KUBE_VERSION VERSION=e2e
+    - name: Run e2e tests
+      env:
+        KUBE_VERSION: ${{ matrix.kube-version }}
+      run: |
+        set -e
         make ${{ matrix.group }}
-
     - name: "log operator if failed"
       if: ${{ failure() }}
       env:
         KUBE_VERSION: ${{ matrix.kube-version }}
-      run: make e2e-log-operator KUBE_VERSION=$KUBE_VERSION
+      run: |
+        set -e
+        make e2e-log-operator KUBE_VERSION=$KUBE_VERSION
 
   e2e-tests-check:
     runs-on: ubuntu-22.04

CONTRIBUTING.md

@@ -118,11 +118,11 @@ KUBEBUILDER_ASSETS=$(./bin/setup-envtest use -p path 1.23) go test ./pkg...
 
 ### End to end tests
 
-To run the end-to-end tests, you'll need [`kind`](https://kind.sigs.k8s.io) and [`kuttl`](https://kuttl.dev). Refer to their documentation for installation instructions.
+To run the end-to-end tests, you'll need [`kind`](https://kind.sigs.k8s.io) and [`chainsaw`](https://kyverno.github.io/chainsaw). Refer to their documentation for installation instructions.
 
 Once they are installed, the tests can be executed with `make prepare-e2e`, which will build an image to use with the tests, followed by `make e2e`. Each call to the `e2e` target will setup a fresh `kind` cluster, making it safe to be executed multiple times with a single `prepare-e2e` step.
 
-The tests are located under `tests/e2e` and are written to be used with `kuttl`. Refer to their documentation to understand how tests are written.
+The tests are located under `tests/e2e` and are written to be used with `chainsaw`. Refer to their documentation to understand how tests are written.
 
 To evert the changes made by the `make prepare-e2e` run `make reset`.
 
@@ -133,7 +133,7 @@ To install the OpenTelemetry operator, please follow the instructions in  [Opera
 
 Once the operator is installed, the tests can be executed using `make e2e-openshift`, which will call to the `e2e-openshift` target. Note that `kind` is disabled for the TestSuite as the requirement is to use an OpenShift cluster for these test cases. 
 
-The tests are located under `tests/e2e-openshift` and are written to be used with `kuttl`.
+The tests are located under `tests/e2e-openshift` and are written to be used with `chainsaw`.
 
 ### Undeploying the operator from the local cluster
 

hack/install-kuttl.sh

@@ -0,0 +1,35 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/kyverno/chainsaw/main/.schemas/json/test-chainsaw-v1alpha1.json
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  creationTimestamp: null
+  name: autoscale
+spec:
+  steps:
+  - name: step-00
+    try:
+    - apply:
+        file: 00-install.yaml
+    - assert:
+        file: 00-assert.yaml
+  - name: step-01
+    try:
+    - apply:
+        file: 01-install.yaml
+    - assert:
+        file: 01-assert.yaml
+  - name: step-02
+    try:
+    - apply:
+        file: 02-install.yaml
+    - assert:
+        file: 02-assert.yaml
+  - name: step-03
+    try:
+    - delete:
+        ref:
+          apiVersion: batch/v1
+          kind: Job
+          name: telemetrygen-set-utilization
+    - assert:
+        file: 03-assert.yaml

kuttl-test-autoscale.yaml

@@ -3,7 +3,6 @@ kind: OpenTelemetryCollector
 metadata:
   name: sidecar
 spec:
-  mode: sidecar
   config: |
     receivers:
       otlp:
@@ -19,13 +18,4 @@ spec:
           receivers: [otlp]
           processors: []
           exporters: [debug]
-
----
-apiVersion: kuttl.dev/v1beta1
-kind: TestStep
-commands:
-  # Annotate the namespace to allow the application to run using an specific group and user in OpenShift
-  # https://docs.openshift.com/dedicated/authentication/managing-security-context-constraints.html
-  # This annotation has no effect in Kubernetes
-  - command: kubectl annotate namespace ${NAMESPACE} openshift.io/sa.scc.uid-range=1000/1000 --overwrite
-  - command: kubectl annotate namespace ${NAMESPACE} openshift.io/sa.scc.supplemental-groups=3000/1000 --overwrite
+  mode: sidecar

kuttl-test-instrumentation.yaml

@@ -0,0 +1,36 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/kyverno/chainsaw/main/.schemas/json/test-chainsaw-v1alpha1.json
+apiVersion: chainsaw.kyverno.io/v1alpha1
+kind: Test
+metadata:
+  creationTimestamp: null
+  name: instrumentation-apache-httpd
+spec:
+  steps:
+  - name: step-00
+    try:
+    - command:
+        args:
+        - annotate
+        - namespace
+        - ${NAMESPACE}
+        - openshift.io/sa.scc.uid-range=1000/1000
+        - --overwrite
+        entrypoint: kubectl
+    - command:
+        args:
+        - annotate
+        - namespace
+        - ${NAMESPACE}
+        - openshift.io/sa.scc.supplemental-groups=3000/1000
+        - --overwrite
+        entrypoint: kubectl
+    - apply:
+        file: 00-install-collector.yaml
+    - apply:
+        file: 00-install-instrumentation.yaml
+  - name: step-01
+    try:
+    - apply:
+        file: 01-install-app.yaml
+    - assert:
+        file: 01-assert.yaml

kuttl-test-multi-instr.yaml

@@ -1,22 +1,22 @@
 # skipping test, see https://github.com/open-telemetry/opentelemetry-operator/issues/1936
-#apiVersion: opentelemetry.io/v1alpha1
-#kind: OpenTelemetryCollector
-#metadata:
-#  name: sidecar
-#spec:
-#  mode: sidecar
-#  config: |
-#    receivers:
-#      otlp:
-#        protocols:
-#          grpc:
-#          http:
-#    processors:
-#    exporters:
-#      debug:
-#    service:
-#      pipelines:
-#        traces:
-#          receivers: [otlp]
-#          processors: []
-#          exporters: [debug]
+apiVersion: opentelemetry.io/v1alpha1
+kind: OpenTelemetryCollector
+metadata:
+  name: sidecar
+spec:
+  mode: sidecar
+  config: |
+    receivers:
+      otlp:
+        protocols:
+          grpc:
+          http:
+    processors:
+    exporters:
+      debug:
+    service:
+      pipelines:
+        traces:
+          receivers: [otlp]
+          processors: []
+          exporters: [debug]

kuttl-test-opampbridge.yaml

@@ -1,18 +1,18 @@
 # skipping test, see https://github.com/open-telemetry/opentelemetry-operator/issues/1936
-#apiVersion: opentelemetry.io/v1alpha1
-#kind: Instrumentation
-#metadata:
-#  name: apache
-#spec:
-#  exporter:
-#    endpoint: http://localhost:4317
-#  propagators:
-#    - jaeger
-#    - b3
-#  sampler:
-#    type: parentbased_traceidratio
-#    argument: "0.25"
-#  apacheHttpd:
-#    attrs:
-#    - name: ApacheModuleOtelMaxQueueSize
-#      value: "4096"
+apiVersion: opentelemetry.io/v1alpha1
+kind: Instrumentation
+metadata:
+  name: apache
+spec:
+  exporter:
+    endpoint: http://localhost:4317
+  propagators:
+    - jaeger
+    - b3
+  sampler:
+    type: parentbased_traceidratio
+    argument: "0.25"
+  apacheHttpd:
+    attrs:
+      - name: ApacheModuleOtelMaxQueueSize
+        value: "4096"