Merge pull request #1799 from crytic/detector-compilation-artifacts

testing strategy + coverage workflow

.github/actions/upload-coverage/action.yml

@@ -0,0 +1,30 @@
+# Derived from <https://github.com/pyca/cryptography/blob/SOME_REF/.github/actions/upload-coverage/action.yml>
+# Originally authored by the PyCA Cryptography maintainers, and licensed under
+# the terms of the BSD license:
+# <https://github.com/pyca/cryptography/blob/main/LICENSE.BSD>
+
+name: Upload Coverage
+description: Upload coverage files
+
+runs:
+  using: "composite"
+
+  steps:
+    # FIXME(jl): codecov has the option of including machine information in filename that would solve this unique naming
+    # issue more completely.
+    # This method has the limitation of 1 coverage file per run, limiting some coverage between online/offline tests.
+    - run: |
+        COVERAGE_UUID=$(python3 -c "import uuid; print(uuid.uuid4())")
+        echo "COVERAGE_UUID=${COVERAGE_UUID}" >> $GITHUB_OUTPUT
+        if [ -f .coverage ]; then
+          mv .coverage .coverage.${COVERAGE_UUID}
+        fi
+      id: coverage-uuid
+      shell: bash
+    - uses: actions/upload-artifact@v3.1.0
+      with:
+        name: coverage-data
+        path: |
+          .coverage.*
+          *.lcov
+        if-no-files-found: ignore

.github/scripts/integration_test_runner.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# used to pass --cov=$path and --cov-append to pytest
+if [ "$1" != "" ]; then
+    pytest "$1" tests/e2e/ -n auto
+    status_code=$?
+    python -m coverage report
+else
+    pytest tests/e2e/ -n auto
+    status_code=$?
+fi
+
+exit "$status_code"

.github/scripts/tool_test_runner.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# used to pass --cov=$path and --cov-append to pytest
+if [ "$1" != "" ]; then
+    pytest "$1" tests/tools/read-storage/test_read_storage.py
+    status_code=$?
+    python -m coverage report
+else
+    pytest tests/tools/read-storage/test_read_storage.py
+    status_code=$?
+fi
+
+exit "$status_code"

.github/scripts/unit_test_runner.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# used to pass --cov=$path and --cov-append to pytest
+if [ "$1" != "" ]; then
+    pytest "$1" tests/unit/
+    status_code=$?
+    python -m coverage report
+else
+    pytest tests/unit/
+    status_code=$?
+fi
+
+exit "$status_code"

.github/workflows/ci.yml

@@ -58,12 +58,10 @@ jobs:
           python-version: 3.8
       - name: Install dependencies
         run: |
-          pip install ".[dev]"
+          pip install ".[test]"
           solc-select use 0.4.25 --always-install
           solc-select use 0.8.0 --always-install
           solc-select use 0.5.1 --always-install
-          pip install typing_extensions==4.1.1
-          pip install importlib_metadata==4.8.3
 
       - name: Set up nix
         if: matrix.type == 'dapp'

.github/workflows/docs.yml

@@ -23,7 +23,7 @@ jobs:
   # Single deploy job since we're just deploying
   build:
     environment:
-      name: github-pages
+      name: Slither Documentation
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
@@ -34,13 +34,13 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: '3.8'
-      - run: pip install -e ".[dev]"
-      - run: pdoc -o docs/ slither '!slither.tools' #TODO fix import errors on pdoc run
+      - run: pip install -e ".[doc]"
+      - run: pdoc -o html/ slither '!slither.tools' #TODO fix import errors on pdoc run
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
           # Upload the doc
-          path: 'docs/'
+          path: './html/'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v1