bats tests for static build

2025-05-11 12:25:53 +02:00 · 2022-09-06 10:23:04 +02:00 · 2022-09-06 10:23:04 +02:00 · 1a51bc44a5
commit 1a51bc44a5
parent 2829f5e2e4
7 changed files with 298 additions and 0 deletions
--- a/.github/workflows/bats-mysql-static.yml
+++ b/.github/workflows/bats-mysql-static.yml
@ -0,0 +1,96 @@
+name: Functional tests (MySQL - Static Build)
+
+on:
+  workflow_call:
+    inputs:
+      database_image:
+        required: true
+        type: string
+
+env:
+  PREFIX_TEST_NAMES_WITH_FILE: true
+
+jobs:
+
+  build:
+    name: "Build + tests"
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    services:
+      database:
+        image: ${{ inputs.database_image }}
+        env:
+          MYSQL_ROOT_PASSWORD: "secret"
+        ports:
+          - 3306:3306
+
+    steps:
+
+    - name: "Force machineid"
+      run: |
+          sudo chmod +w /etc/machine-id
+          echo githubciXXXXXXXXXXXXXXXXXXXXXXXX | sudo tee /etc/machine-id
+
+    - name: "Set up Go 1.19"
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.19
+      id: go
+
+    - name: "Check out CrowdSec repository"
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+        submodules: true
+
+    - name: "Install bats dependencies"
+      run: |
+        sudo apt -qq -y -o=Dpkg::Use-Pty=0 install build-essential daemonize jq netcat-openbsd
+        go install github.com/mikefarah/yq/v4@latest
+        go install github.com/cloudflare/cfssl/cmd/cfssl@master
+        go install github.com/cloudflare/cfssl/cmd/cfssljson@master
+        sudo cp -u ~/go/bin/yq ~/go/bin/cfssl ~/go/bin/cfssljson /usr/local/bin/
+
+    - name: "Build crowdsec and fixture"
+      run: |
+        make clean bats-build-static bats-fixture
+      env:
+        DB_BACKEND: mysql
+        MYSQL_HOST: 127.0.0.1
+        MYSQL_PORT: 3306
+        MYSQL_PASSWORD: "secret"
+        MYSQL_USER: root
+
+    - name: "Run tests"
+      run: make bats-test
+      env:
+        DB_BACKEND: mysql
+        MYSQL_HOST: 127.0.0.1
+        MYSQL_PORT: 3306
+        MYSQL_PASSWORD: "secret"
+        MYSQL_USER: root
+
+    #
+    # In case you need to inspect the database status after the failure of a given test
+    #
+    # - name: "Run specified tests"
+    #   run: ./tests/run-tests tests/bats/<filename>.bats -f "<test name>"
+
+    - name: Show database dump
+      run: ./tests/instance-db dump /dev/fd/1
+      env:
+        DB_BACKEND: mysql
+        MYSQL_HOST: 127.0.0.1
+        MYSQL_PORT: 3306
+        MYSQL_PASSWORD: "secret"
+        MYSQL_USER: root
+      if: ${{ always() }}
+
+    - name: "Show crowdsec logs"
+      run:
+        for file in $(find ./tests/local/var/log -type f); do echo ">>>>> $file"; cat $file; echo; done
+      if: ${{ always() }}
+
+    - name: "Show database logs"
+      run: docker logs "${{ job.services.database.id }}"
+      if: ${{ always() }}
--- a/.github/workflows/bats-postgres-static.yml
+++ b/.github/workflows/bats-postgres-static.yml
@ -0,0 +1,99 @@
+name: Functional tests (Postgres - Static Build)
+
+on:
+  workflow_call:
+
+env:
+  PREFIX_TEST_NAMES_WITH_FILE: true
+
+jobs:
+
+  build:
+    name: "Build + tests"
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    services:
+      database:
+        image: postgres:latest
+        env:
+          POSTGRES_PASSWORD: "secret"
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready -u postgres
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+
+    - name: "Force machineid"
+      run: |
+          sudo chmod +w /etc/machine-id
+          echo githubciXXXXXXXXXXXXXXXXXXXXXXXX | sudo tee /etc/machine-id
+
+    - name: "Set up Go 1.19"
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.19
+      id: go
+
+    - name: "Check out CrowdSec repository"
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+        submodules: true
+
+    - name: "Install bats dependencies"
+      run: |
+        sudo apt -qq -y -o=Dpkg::Use-Pty=0 install build-essential daemonize jq netcat-openbsd
+        go install github.com/mikefarah/yq/v4@latest
+        go install github.com/cloudflare/cfssl/cmd/cfssl@master
+        go install github.com/cloudflare/cfssl/cmd/cfssljson@master
+        sudo cp -u ~/go/bin/yq ~/go/bin/cfssl ~/go/bin/cfssljson /usr/local/bin/
+
+    - name: "Build crowdsec and fixture (DB_BACKEND: pgx)"
+      run: |
+        make clean bats-build-static bats-fixture
+      env:
+        DB_BACKEND: pgx
+        PGHOST: 127.0.0.1
+        PGPORT: 5432
+        PGPASSWORD: "secret"
+        PGUSER: postgres
+
+    - name: "Run tests (DB_BACKEND: pgx)"
+      run: make bats-test
+      env:
+        DB_BACKEND: pgx
+        PGHOST: 127.0.0.1
+        PGPORT: 5432
+        PGPASSWORD: "secret"
+        PGUSER: postgres
+
+    - name: "Build crowdsec and fixture (DB_BACKEND: postgres)"
+      run: make clean bats-build bats-fixture
+      env:
+        DB_BACKEND: postgres
+        PGHOST: 127.0.0.1
+        PGPORT: 5432
+        PGPASSWORD: "secret"
+        PGUSER: postgres
+
+    - name: "Run tests (DB_BACKEND: postgres)"
+      run: make bats-test
+      env:
+        DB_BACKEND: postgres
+        PGHOST: 127.0.0.1
+        PGPORT: 5432
+        PGPASSWORD: "secret"
+        PGUSER: postgres
+
+    - name: "Show crowdsec logs"
+      run:
+        for file in $(find ./tests/local/var/log -type f); do echo ">>>>> $file"; cat $file; echo; done
+      if: ${{ always() }}
+
+    - name: "Show database logs"
+      run: docker logs "${{ job.services.database.id }}"
+      if: ${{ always() }}
--- a/.github/workflows/bats-sqlite-coverage-static.yml
+++ b/.github/workflows/bats-sqlite-coverage-static.yml
@ -0,0 +1,80 @@
+name: Functional tests (sqlite - Static Build)
+
+on:
+  workflow_call:
+
+env:
+  PREFIX_TEST_NAMES_WITH_FILE: true
+  TEST_COVERAGE: true
+
+jobs:
+
+  build:
+    name: "Build + tests"
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+
+    steps:
+
+    - name: "Force machineid"
+      run: |
+          sudo chmod +w /etc/machine-id
+          echo githubciXXXXXXXXXXXXXXXXXXXXXXXX | sudo tee /etc/machine-id
+
+    - name: "Set up Go 1.19"
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.19
+      id: go
+
+    - name: "Check out CrowdSec repository"
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+        submodules: true
+
+    - name: "Install bats dependencies"
+      run: |
+        sudo apt -qq -y -o=Dpkg::Use-Pty=0 install build-essential daemonize jq netcat-openbsd
+        go install github.com/mikefarah/yq/v4@latest
+        go install github.com/cloudflare/cfssl/cmd/cfssl@master
+        go install github.com/cloudflare/cfssl/cmd/cfssljson@master
+        sudo cp -u ~/go/bin/yq ~/go/bin/cfssl ~/go/bin/cfssljson /usr/local/bin/
+        go install github.com/wadey/gocovmerge@latest
+        sudo cp -u ~/go/bin/gocovmerge /usr/local/bin/
+
+    - name: "Build crowdsec and fixture"
+      run: |
+        make clean bats-build-static bats-fixture
+
+    - name: "Run tests"
+      run: make bats-test
+
+    #
+    # In case you need to inspect the database status after the failure of a given test
+    #
+    # - name: "Run specified tests"
+    #   run: ./tests/run-tests tests/bats/<filename>.bats -f "<test name>"
+
+    - name: "Show database dump"
+      run: |
+        ./tests/instance-crowdsec stop
+        sqlite3 ./tests/local/var/lib/crowdsec/data/crowdsec.db '.dump'
+      if: ${{ always() }}
+
+    - name: "Show crowdsec logs"
+      run:
+        for file in $(find ./tests/local/var/log -type f); do echo ">>>>> $file"; cat $file; echo; done
+      if: ${{ always() }}
+
+    - name: Upload crowdsec coverage to codecov
+      uses: codecov/codecov-action@v2
+      with:
+        files: ./tests/local/var/lib/coverage/coverage-crowdsec.out
+        flags: func-crowdsec
+
+    - name: Upload cscli coverage to codecov
+      uses: codecov/codecov-action@v2
+      with:
+        files: ./tests/local/var/lib/coverage/coverage-cscli.out
+        flags: func-cscli
--- a/6
+++ b/6
@ -118,12 +118,18 @@ cscli: goversion
 cscli-bincover: goversion
 	@GOARCH=$(GOARCH) GOOS=$(GOOS) $(MAKE) -C $(CSCLI_FOLDER) build-bincover --no-print-directory

+cscli-bincover_static: goversion
+	@GOARCH=$(GOARCH) GOOS=$(GOOS) $(MAKE) -C $(CSCLI_FOLDER) build-bincover_static --no-print-directory
+
 crowdsec: goversion
 	@$(MAKE) -C $(CROWDSEC_FOLDER) build --no-print-directory GOARCH=$(GOARCH) GOOS=$(GOOS) RM="$(RM)" WIN_IGNORE_ERR="$(WIN_IGNORE_ERR)" CP="$(CP)" CPR="$(CPR)" MKDIR="$(MKDIR)"

 crowdsec-bincover: goversion
 	@GOARCH=$(GOARCH) GOOS=$(GOOS) $(MAKE) -C $(CROWDSEC_FOLDER) build-bincover --no-print-directory

+crowdsec-bincover_static: goversion
+	@GOARCH=$(GOARCH) GOOS=$(GOOS) $(MAKE) -C $(CROWDSEC_FOLDER) build-bincover_static --no-print-directory
+
 http-plugin: goversion
 	@$(MAKE) -C $(HTTP_PLUGIN_FOLDER) build --no-print-directory GOARCH=$(GOARCH) GOOS=$(GOOS) RM="$(RM)" WIN_IGNORE_ERR="$(WIN_IGNORE_ERR)" CP="$(CP)" CPR="$(CPR)" MKDIR="$(MKDIR)"

--- a/cmd/crowdsec-cli/Makefile
+++ b/cmd/crowdsec-cli/Makefile
@ -26,6 +26,10 @@ build: clean
 build-bincover: clean
 	$(GOTEST) . -tags testrunmain -coverpkg=$(go list github.com/crowdsecurity/crowdsec/... | grep -v -e 'pkg/database' -e 'plugins/notifications' -e 'pkg/protobufs' -e 'pkg/cwversions' -e 'pkg/cstest' -e 'pkg/models') -covermode=atomic $(LD_OPTS) -c -o $(BINARY_NAME_COVER)

+build-bincover_static: clean
+	$(GOTEST) . -tags testrunmain -coverpkg=$(go list github.com/crowdsecurity/crowdsec/... | grep -v -e 'pkg/database' -e 'plugins/notifications' -e 'pkg/protobufs' -e 'pkg/cwversions' -e 'pkg/cstest' -e 'pkg/models') -covermode=atomic $(LD_OPTS_STATIC) -c -o $(BINARY_NAME_COVER)
+
+
 static: clean
 	@$(GOBUILD) $(LD_OPTS_STATIC) -o $(BINARY_NAME) -a

--- a/cmd/crowdsec/Makefile
+++ b/cmd/crowdsec/Makefile
@ -31,6 +31,9 @@ build: clean
 build-bincover: clean
 	$(GOTEST) . -tags testrunmain -coverpkg=$(go list github.com/crowdsecurity/crowdsec/... | grep -v -e 'pkg/database' -e 'plugins/notifications' -e 'pkg/protobufs' -e 'pkg/cwversions' -e 'pkg/cstest' -e 'pkg/models') -covermode=atomic $(LD_OPTS) -c -o $(CROWDSEC_BIN_COVER)

+build-bincover_static: clean
+	$(GOTEST) . -tags testrunmain -coverpkg=$(go list github.com/crowdsecurity/crowdsec/... | grep -v -e 'pkg/database' -e 'plugins/notifications' -e 'pkg/protobufs' -e 'pkg/cwversions' -e 'pkg/cstest' -e 'pkg/models') -covermode=atomic $(LD_OPTS_STATIC) -c -o $(CROWDSEC_BIN_COVER)
+
 static: clean
 	$(GOBUILD) $(LD_OPTS_STATIC) -o $(CROWDSEC_BIN) -a

--- a/tests/bats.mk
+++ b/tests/bats.mk
@ -63,6 +63,8 @@ endef

 bats-all: bats-clean bats-build bats-fixture bats-test bats-test-hub

+bats-all-static: bats-clean bats-build-static bats-fixture bats-test bats-test-hub
+
 # Source this to run the scripts outside of the Makefile
 # Old versions of make don't have $(file) directive
 bats-environment: export ENV:=$(ENV)
@ -82,6 +84,14 @@ bats-build: bats-environment bats-check-requirements
 	@BINCOVER_TESTING=$(BINCOVER_TESTING) DEFAULT_CONFIGDIR=$(CONFIG_DIR) DEFAULT_DATADIR=$(DATA_DIR) $(MAKE) goversion crowdsec-bincover cscli-bincover
 	@install -m 0755 cmd/crowdsec/crowdsec.cover cmd/crowdsec-cli/cscli.cover $(BIN_DIR)/

+bats-build-static: bats-environment bats-check-requirements
+	@mkdir -p $(BIN_DIR) $(LOG_DIR) $(PID_DIR) $(PLUGIN_DIR)
+	@BINCOVER_TESTING=$(BINCOVER_TESTING) DEFAULT_CONFIGDIR=$(CONFIG_DIR) DEFAULT_DATADIR=$(DATA_DIR) $(MAKE) goversion crowdsec_static cscli_static plugins_static
+	@install -m 0755 cmd/crowdsec/crowdsec cmd/crowdsec-cli/cscli $(BIN_DIR)/
+	@install -m 0755 plugins/notifications/*/notification-* $(PLUGIN_DIR)/
+	@BINCOVER_TESTING=$(BINCOVER_TESTING) DEFAULT_CONFIGDIR=$(CONFIG_DIR) DEFAULT_DATADIR=$(DATA_DIR) $(MAKE) goversion crowdsec-bincover_static cscli-bincover_static
+	@install -m 0755 cmd/crowdsec/crowdsec.cover cmd/crowdsec-cli/cscli.cover $(BIN_DIR)/
+
 # Create a reusable package with initial configuration + data
 bats-fixture:
 	@$(TEST_DIR)/instance-data make