document and reorganize integration and unit tests

Author: cognifloyd

.github/workflows/unit-tests.yaml

@@ -42,4 +42,4 @@ jobs:
     - name: Run helm-unittest
       # by default looks for tests/*_test.yaml
       run: |
-        helm unittest --color --helm3 .
+        helm unittest --color --helm3 -f tests/unit/*_test.yaml .

templates/tests/st2tests-configmap.yaml

@@ -11,4 +11,4 @@ metadata:
     heritage: {{ .Release.Service }}
 data:
   st2tests.sh: |
-{{ .Files.Get "tests/st2tests.sh" | indent 4 }}
+{{ .Files.Get "tests/integration/st2tests.sh" | indent 4 }}

tests/README.md

@@ -1,6 +1,35 @@
 # `stackstorm-ha` Helm chart Tests
 
-This directory contains Helm chart tests, powered by [BATS](https://github.com/sstephenson/bats) Bash Automated Testing System.
+This directory contains Helm chart integration and unit tests (under `tests/integration/` and `tests/unit/` respectively).
+
+## Unit tests
+
+Unit tests (under `tests/unit/`) use [`helm-unittest`](https://github.com/quintush/helm-unittest).
+`helm-unittest` uses a yaml-based test file to ensure that the templates generate expected features.
+For example, they can ensure that custom annotations are applied consistently to all of the deployments.
+Unit tests do not require a running kubernetes cluster.
+
+Before running unit tests, install the `helm-unittest` plugin and ensure you have sub-charts installed:
+```
+helm plugin install https://github.com/quintush/helm-unittest
+helm dependency update
+```
+
+To run the tests manually from the chart's root dir:
+```
+helm unittest --helm3 tests/unit/*_test.yaml .
+```
+
+Note that `helm-unittest` still defaults to helm 2, so you must pass `--helm3` or `-3` for short.
+You must also tell it where the unit tests are with `-f` because we keep unit tests in the `tests/unit` directory.
+
+See https://github.com/quintush/helm-unittest/blob/master/DOCUMENT.md for details on writing unit tests.
+
+## Integration tests
+
+Integration tests (under `tests/integration/`) use `helm-test` and are powered by [BATS](https://github.com/sstephenson/bats) (Bash Automated Testing System).
+As integratin tests, these require a running kubernetes cluster where helm can do test deployments of this chart.
+
 Despite the minimum amount of smoke tests written, they ensure that StackStorm was really deployed,
 works correctly at its core and alive end-to-end without checking deeply specific functionality or configuration.
 If something is terribly wrong, - it'll show up via failed tests.
@@ -18,4 +47,4 @@ To show the test results:
 kubectl logs <release-name>-st2tests
 ```
 
-See https://helm.sh/docs/developing_charts/#chart-tests with more information about Helm chart tests.
+See https://helm.sh/docs/topics/chart-tests/ with more information about Helm chart tests.