From 190fa112dd8cd323d8798ee9bf55c7d9a0d8c5ac Mon Sep 17 00:00:00 2001
From: "Thibault \"bui\" Koechlin" <thibault@crowdsec.net>
Date: Fri, 19 Mar 2021 16:28:55 +0100
Subject: [PATCH] Debian package auto-testing (#701)

* add dispatch to debian CI

* test dispatch

* keep only master

* push+mr

* document the functional tests
---
 .github/workflows/ci_functests-install.yml  |  2 +-
 .github/workflows/dispatch_test_debpkg.yaml | 20 ++++++++
 scripts/func_tests/README.md                | 53 +++++++++++++++++++++
 3 files changed, 74 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/dispatch_test_debpkg.yaml
 create mode 100644 scripts/func_tests/README.md

diff --git a/.github/workflows/ci_functests-install.yml b/.github/workflows/ci_functests-install.yml
index ce124a1ac..4edf75f00 100644
--- a/.github/workflows/ci_functests-install.yml
+++ b/.github/workflows/ci_functests-install.yml
@@ -10,7 +10,7 @@ on:
 
 jobs:
   build:
-    name: Install generated release and perform upgrade tests
+    name: Install generated release and perform functional tests
     runs-on: ubuntu-latest
     steps:
     - name: Set up Go 1.13
diff --git a/.github/workflows/dispatch_test_debpkg.yaml b/.github/workflows/dispatch_test_debpkg.yaml
new file mode 100644
index 000000000..4042d7196
--- /dev/null
+++ b/.github/workflows/dispatch_test_debpkg.yaml
@@ -0,0 +1,20 @@
+name: Dispatch to deb pkg repo for tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  dispatch:
+    name: dispatch to deb pkg repo
+    runs-on: ubuntu-latest
+    steps:
+      - name: Repository Dispatch
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.DISPATCH_TOKEN }}
+          event-type: test_package_from_master
+          repository: crowdsecurity/packaging
+          client-payload: '{"branch": "master"}'
diff --git a/scripts/func_tests/README.md b/scripts/func_tests/README.md
new file mode 100644
index 000000000..5aa18a1b5
--- /dev/null
+++ b/scripts/func_tests/README.md
@@ -0,0 +1,53 @@
+## Functional testing
+
+This directory contains scripts for functional testing of crowdsec, to unify testing across packages (ie. tgz, deb, rpm).
+
+Each package system tests the installation/removal, and the scripts here cover basic functional testing.
+
+### cscli
+
+| Feature       | Covered     | Note     |
+| :------------- | :----------: | -----------: |
+| `cscli alerts` |  🟢 | 99ip_mgmt.sh |
+| `cscli bouncers` |  🟢 | 1bouncers.sh |
+| `cscli capi` |  ❌  | 0base.sh : `status` only |
+| `cscli collections` |  🟢 | 2collections.sh |
+| `cscli config` | ❌  | 0base.sh : minimal testing (no crash) |
+| `cscli dashboard` | ❌   | docker inside docker 😞    |
+| `cscli decisions` |  🟢 | 99ip_mgmt.sh |
+| `cscli hub` |  ❌ | TBD |
+| `cscli lapi` |  🟢 | 3machines.sh  |
+| `cscli machines` |  🟢 | 3machines.sh |
+| `cscli metrics` |  ❌ | TBD |
+| `cscli parsers` |  ❌ | TBD |
+| `cscli postoverflows` |  ❌ | TBD |
+| `cscli scenarios` |  ❌ | TBD |
+| `cscli simulation` |  ❌ | TBD |
+| `cscli version` |  🟢 | 0base.sh |
+
+### crowdsec
+
+| Feature       | Covered     | Note     |
+| :------------- | :----------: | -----------: |
+| `systemctl` start/stop/restart | 🟢 | 0base.sh |
+| agent behaviour | 🟢 | 4cold-logs.sh : minimal testing  (simple ssh-bf detection) |
+| forensic mode  | 🟢  | 4cold-logs.sh : minimal testing (simple ssh-bf detection) |
+| starting only LAPI  | ❌  | TBD |
+| starting only agent  | ❌  | TBD |
+| prometheus testing  | ❌  | TBD |
+
+### API
+
+
+| Feature       | Covered     | Note     |
+| :------------- | :----------: | -----------: |
+| alerts GET/POST | 🟢 | 99ip_mgmt.sh |
+| decisions GET/POST | 🟢 | 99ip_mgmt.sh |
+
+
+## Automation
+
+https://github.com/crowdsecurity/crowdsec/ uses dispatch to triggers tests in the other packages build repositories.
+
+
+