# Setting up testing actions, generate unit tests for the projects, correct clippy warnings and format according rustfmt

.github/changelog_configuration.json

@@ -0,0 +1,72 @@
+{
+    "categories": [
+      {
+        "title": "## 🚀 Features",
+        "labels": ["feature"]
+      },
+      {
+        "title": "## 🐛 Fixes",
+        "labels": ["fix"]
+      },
+      {
+        "title": "## 🧪 Tests",
+        "labels": ["test"]
+      },
+      {
+        "title": "## 🧪 Tests and some 🪄 Magic",
+        "labels": ["test", "magic"],
+        "exclude_labels": ["no-magic"],
+        "exhaustive": true,
+        "empty_content": "- no matching PRs"
+      }
+    ],
+    "ignore_labels": [
+      "ignore"
+    ],
+    "sort": {
+      "order": "ASC",
+      "on_property": "mergedAt"
+    },
+    "template": "${{CHANGELOG}}\n\n<details>\n<summary>Uncategorized</summary>\n\n${{UNCATEGORIZED}}\n</details>",
+    "pr_template": "- ${{TITLE}}\n   - PR: #${{NUMBER}}",
+    "empty_template": "- no changes",
+    "label_extractor": [
+      {
+        "pattern": "(.) (.+)",
+        "target": "$1",
+        "flags": "gu"
+      },
+      {
+        "pattern": "\\[Issue\\]",
+        "on_property": "title",
+        "method": "match"
+      }
+    ],
+    "duplicate_filter": {
+      "pattern": "\\[ABC-....\\]",
+      "on_property": "title",
+      "method": "match"
+    },
+    "transformers": [
+      {
+        "pattern": "[\\-\\*] (\\[(...|TEST|CI|SKIP)\\])( )?(.+?)\n(.+?[\\-\\*] )(.+)",
+        "target": "- $4\n  - $6"
+      }
+    ],
+    "max_tags_to_fetch": 200,
+    "max_pull_requests": 200,
+    "max_back_track_time_days": 365,
+    "exclude_merge_branches": [
+      "Owner/qa"
+    ],
+    "tag_resolver": {
+      "method": "semver",
+      "filter": {
+        "pattern": "api-(.+)",
+        "flags": "gu"
+      }
+    },
+    "base_branches": [
+      "dev"
+    ]
+}

.github/workflows/code-coverage.yml

@@ -0,0 +1,71 @@
+name: Linux CI && Code Coverage
+
+on:
+  push:
+    tags:        
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+rc[0-9]+'
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  code-coverage:
+    permissions:
+      contents: write
+    env:
+      CARGO_INCREMENTAL: '0'
+      RUSTFLAGS: '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests'
+      RUSTDOCFLAGS: '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use nightly toolchain
+        run: |
+          rustup toolchain install nightly
+          rustup override set nightly
+
+      - name: Caching cargo dependencies
+        id: project-cache
+        uses: Swatinem/rust-cache@v2
+
+      - if: ${{ steps.cache-cargo.outputs.cache-hit != 'true' }}
+        name: Install grcov
+        run: cargo install grcov
+
+      - name: Make the USER own the working directory
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: sudo chown -R $USER:$USER ${{ github.workspace }}
+
+      - name: Waking up docker
+        run: docker-compose -f ./docker/docker-compose.yml up -d 
+
+      - name: Run tests
+        run: |
+          cargo test --all-features --no-fail-fast --target=x86_64-unknown-linux-gnu -- --show-output --test-threads=1
+
+      - name: Waking up docker
+        run: |
+          docker-compose -f ./docker/docker-compose.yml down
+          sudo chown -R $USER:$USER ${{ github.workspace }}
+          rm -rf ./docker/postgres-data
+
+      - name: Generate code coverage report
+        run: |
+          grcov . -s . --binary-path ./target/debug/ -t html --branch --ignore-not-existing -o ./target/debug/coverage
+          grcov . -s . --binary-path ./target/debug/ -t cobertura --branch --ignore-not-existing -o ./target/debug/coverage/code_cov.xml
+
+      - name: Publish Test Results
+        uses: actions/upload-artifact@v3
+        with:
+          name: Unit Test Results
+          path: |
+            ./target/debug/coverage/code_cov.xml
+            ./target/debug/coverage/index.html
+
+      - name: Publish coverage report to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: ./target/debug/coverage
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/code-quality.yml

@@ -0,0 +1,60 @@
+name: Code quality and sanity
+
+on:
+  push:
+    branches: '*'
+  pull_request:
+    branches: '*'
+
+jobs:
+  clippy:
+    name: Lint with Clippy
+    runs-on: ubuntu-latest
+    env:
+      RUSTFLAGS: -Dwarnings
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Caching project dependencies
+        id: project-cache
+        uses: Swatinem/rust-cache@v2
+
+      - uses: hecrj/setup-rust-action@v1
+        with:
+          components: clippy
+      - run: cargo clippy --workspace --all-targets --verbose --all-features -- -A clippy::question_mark
+  rustfmt:
+    name: Verify code formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Caching project dependencies
+        id: project-cache
+        uses: Swatinem/rust-cache@v2
+
+      - uses: hecrj/setup-rust-action@v1
+        with:
+          components: rustfmt
+
+      - run: cargo fmt --all -- --check
+
+  check-rustdoc-links:
+    name: Check intra-doc links
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        crate: [canyon_connection, canyon_crud, canyon_macros, canyon_observer, canyon_manager, canyon_observer, canyon_sql]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Caching project dependencies
+        id: project-cache
+        uses: Swatinem/rust-cache@v2
+
+      - uses: hecrj/setup-rust-action@v1
+        with:
+          rust-version: nightly
+
+      - run: cargo rustdoc -p ${{ matrix.crate }} --all-features -- -D warnings

.github/workflows/continuous-integration.yml

@@ -0,0 +1,50 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: 'main'
+  pull_request:
+    branches: 'main'
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  multiplatform-tests:
+    name: Testing on Rust ${{ matrix.rust }} for ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - { rust: stable,            os: ubuntu-latest }
+        - { rust: nightly,           os: ubuntu-latest }
+        - { rust: stable,            os: macos-latest }
+        - { rust: stable,            os: windows-latest }
+
+    steps:
+      - name: Make the USER own the working directory
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: sudo chown -R $USER:$USER ${{ github.workspace }}
+
+      - uses: actions/checkout@v3
+
+      - name: docker-compose
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: docker-compose -f ./docker/docker-compose.yml up -d 
+
+      - name: Caching cargo dependencies
+        id: project-cache
+        uses: Swatinem/rust-cache@v2
+
+      - uses: hecrj/setup-rust-action@v1
+        with:
+          rust-version: ${{ matrix.rust }}
+
+      - name: Run all tests, UNIT and INTEGRATION for Linux targets
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: cargo test --verbose --workspace --all-features --no-fail-fast -- --show-output --test-threads=1
+
+      - name: Run UNIT tests with no external connections for the rest of the defined targets
+        if: ${{ matrix.os != 'ubuntu-latest' }}
+        run: cargo test --verbose --workspace --exclude tests --all-features --no-fail-fast -- --show-output

.github/workflows/macos-tests.yml

@@ -0,0 +1,27 @@
+name: macOS CI
+
+on:
+  push:
+    tags:        
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+rc[0-9]+'
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  linux-tests:
+    runs-on: macos-latest
+    name: Tests for macOS
+    env:
+      CARGO_TERM_COLOR: always
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Caching cargo deps
+        id: ci-cache
+        uses: Swatinem/rust-cache@v2
+
+      - name: Running tests for macOS targets
+        run: |
+          cargo test --all-features --workspace --exclude tests