Merge pull request #4 from stackabletech/feat/suites

Add support for test suites

Author: razvan

.github/workflows/lint.yml

@@ -1,4 +1,4 @@
-name: Pylint
+name: Lint
 
 on: [push]
 
@@ -14,14 +14,14 @@ jobs:
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: Install lint dependencies
       run: |
         python -m pip install --upgrade pip
         pip install --editable .
         pip install '.[lint]'
-    - name: Analysing the code with pylint
+    - name: Analysing the code with ruff
       run: |
-        pylint $(git ls-files '*.py')
+        ruff check src/
     - name: Analysing the code with mypy
       run: |
-        mypy --install-types --non-interactive $(git ls-files '*.py')
+        mypy --install-types --non-interactive src/

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install test dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install --editable .
+    - name: Run unit tests
+      run: |
+        python -m unittest discover -v -s src/

.gitignore

@@ -2,3 +2,4 @@
 build
 dist
 src/beku_stackabletech.egg-info
+examples/suites/tests/_work

.pre-commit-config.yaml

@@ -7,28 +7,41 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
+        exclude: examples/
       - id: check-added-large-files
   - repo: https://github.com/Yelp/detect-secrets
     rev: v1.4.0
     hooks:
       - id: detect-secrets
+        exclude: examples/
   - repo: https://github.com/pre-commit/mirrors-autopep8
     rev: v2.0.1
     hooks:
       - id: autopep8
         entry: autopep8
-  - repo: local
-    # These hooks are run from the local virtual env (and it's assumed they are there)
-    # to allow these tools to find project dependencies.
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.0.275
+    hooks:
+      - id: ruff
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.4.0'
     hooks:
-      - id: pylint
-        name: pylint
-        entry: pylint
-        language: system
-        types: [ python ]
       - id: mypy
-        name: mypy
-        entry: mypy
-        language: system
-        types: [ python ]
         args: ['--install-types', '--non-interactive']
+        additional_dependencies:
+          - "Jinja2>=3.1.2"
+          - "PyYAML>=6.0"
+        exclude: examples/
+  - repo: local
+    hooks:
+      - id: unittest
+        name: unittest
+        entry: python -m unittest discover -v -s src/
+        additional_dependencies:
+          - "Jinja2>=3.1.2"
+          - "PyYAML>=6.0"
+        language: python
+        'types': [python]
+        pass_filenames: false
+        stages: [commit]

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+- Add support for Kuttl test suites and improve CI ([#4])
+
+[#4]: https://github.com/stackabletech/beku.py/pull/4)
+
 ## [0.0.6] - 2023-06-21
 
 - Install and run pylint and mypy.
@@ -33,7 +37,8 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
-- Enable `trim_blocks` when processing Jinja templates to avoid spurious new lines. These can lead to broken shell commands.
+- Enable `trim_blocks` when processing Jinja templates to avoid spurious new lines. These can lead to broken shell
+  commands.
 
 ## [0.0.1] - 2022-12-20
 

README.md

@@ -12,6 +12,8 @@ Version: 0.0.7-dev
     rm -rf tests/_work && beku
     cd tests/_work && kubectl kuttl test
 
+Also see the `examples` folder.
+
 ## Description
 
 Fast Kuttl tests expander for Stackable integration tests.
@@ -29,6 +31,7 @@ Update the version in:
 Update the CHANGELOG.
 Commit and tag.
 Build and publish:
+
     rm -rf dist/
     python -m build --wheel .
     twine upload dist/*

examples/README.md

@@ -0,0 +1,32 @@
+# Configuration Examples
+
+This folder contains configuration examples for Beku.
+
+## Test Suites
+
+Test suites are an optional property of the `test-definition.yaml` file. If no test suite is explicitly defined,
+a `default` test suite is generated that selects all test definitons without patching any dimensions.
+
+The folder `suites` contains an example on how to configure test suites.
+
+The file `suites/test/test-definition.yaml` shows example configurations for two test suites:
+
+    suites:
+    - name: latest # this suite will set all dimension values to the latest (last) value
+      patch:
+      - dimensions:
+        - expr: last
+    - name: smoke # this suite will only select the smoke tests
+      select:
+      - smoke
+
+The `latest` suite will execute all tests only with the latest versions of each dimension.
+The `smoke` suite will expand only the `smoke` tests and ignore all others.
+
+To select which suite to expand, use the --suite command line argument. For example:
+
+    cd examples/suites
+    rm -rf tests/_work
+    beku --suite latest
+
+will generate the test cases for the `latest` suite.

examples/suites/tests/kuttl-test.yaml.jinja2

@@ -0,0 +1,11 @@
+---
+apiVersion: kuttl.dev/v1beta1
+kind: TestSuite
+testDirs:
+  {% for testcase in testinput.tests %}
+  - ./tests/{{ testcase.name }}
+  {% endfor %}
+
+startKIND: false
+suppress: ["events"]
+parallel: 2

examples/suites/tests/templates/.gitkeep

@@ -0,0 +1,14 @@
+---
+apiVersion: kuttl.dev/v1beta1
+kind: TestAssert
+metadata:
+  name: test-airflow-postgresql
+timeout: 480
+---
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: airflow-postgresql
+status:
+  readyReplicas: 1
+  replicas: 1