Merge remote-tracking branch 'origin/main'

.github/workflows/release-package.yml

@@ -0,0 +1,138 @@
+name: Release Python package and docs pages
+
+on:
+
+ push:
+ tags:
+ - 'v*.*.*'
+
+jobs:
+
+ release:
+ runs-on: ubuntu-latest
+ steps:
+
+ - name: Checkout repository
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: Get previous tag
+ id: previousTag
+ run: |
+ name=$(git --no-pager tag --sort=creatordate --merged ${{ github.ref_name }} | tail -2 | head -1)
+ echo "previousTag: $name"
+ echo "previousTag=$name" >> $GITHUB_ENV
+
+ - name: Update changelog
+ id: changelog
+ uses: requarks/changelog-action@v1
+ with:
+ token: ${{ github.token }}
+ fromTag: ${{ github.ref_name }}
+ toTag: ${{ env.previousTag }}
+ writeToFile: false
+
+ - name: Create release
+ uses: ncipollo/release-action@v1
+ with:
+ allowUpdates: true
+ draft: false
+ makeLatest: true
+ name: ${{ github.ref_name }}
+ body: ${{ steps.changelog.outputs.changes }}
+ token: ${{ secrets.GITHUB_TOKEN }}
+
+ docs:
+ runs-on: ubuntu-latest
+ steps:
+
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Install packages
+ run: sudo apt-get install libpoppler-cpp-dev libzbar0 tesseract-ocr yara
+
+ - name: Set up Python 3.12
+ uses: actions/setup-python@v5
+ with:
+ python-version: 3.12
+
+ - name: Install poetry
+ run: python -m pip install poetry
+
+ - name: Build docs
+ run: make generate_docs
+
+ - name: Setup pages
+ uses: actions/configure-pages@v5
+
+ - name: Upload documentation artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: site/
+
+ deploy-gh-pages:
+ runs-on: ubuntu-latest
+ needs: docs
+
+ permissions:
+ pages: write
+ id-token: write
+
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4
+
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Install packages
+ run: sudo apt-get install libpoppler-cpp-dev libzbar0 tesseract-ocr yara
+
+ - name: Set up Python 3.12
+ uses: actions/setup-python@v5
+ with:
+ python-version: 3.12
+
+ - name: Install poetry
+ run: python -m pip install poetry
+
+ - name: Install dependencies
+ run: poetry install --with unstable
+
+ - name: Build package
+ run: poetry build
+
+ - name: Upload package artifact
+ uses: actions/upload-artifact@v4
+ with:
+ name: python-package-distributions
+ path: dist/
+
+ publish-to-pypi:
+ runs-on: ubuntu-latest
+ needs: build
+
+ permissions:
+ id-token: write
+
+ steps:
+ - name: Download dist files
+ uses: actions/download-artifact@v4
+ with:
+ name: python-package-distributions
+ path: dist/
+
+ - name: Publish to PyPI
+ uses: pypa/gh-action-pypi-publish@release/v1
+ with:
+ skip-existing: true

.github/workflows/test-package.yml

@@ -0,0 +1,114 @@
+name: Test Python package
+
+on:
+
+ push:
+ branches: [ main ]
+
+ pull_request:
+ branches: [ main ]
+
+jobs:
+
+ docs:
+ runs-on: ubuntu-latest
+ steps:
+
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Install packages
+ run: sudo apt-get install libpoppler-cpp-dev libzbar0 tesseract-ocr yara
+
+ - name: Set up Python 3.12
+ uses: actions/setup-python@v5
+ with:
+ python-version: 3.12
+
+ - name: Install poetry
+ run: python -m pip install poetry
+
+ - name: Build docs
+ run: make generate_docs
+
+ test:
+ runs-on: ubuntu-latest
+
+ strategy:
+ fail-fast: false
+ matrix:
+ python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+ steps:
+
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Install packages
+ run: sudo apt-get install libpoppler-cpp-dev libzbar0 tesseract-ocr yara
+
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v5
+ with:
+ python-version: ${{ matrix.python-version }}
+
+ - name: Install poetry
+ run: python -m pip install poetry
+
+ - name: Install dependencies
+ run: poetry install --with test,unstable
+
+ - name: Build package
+ run: poetry build
+
+ - name: Lint with flake8
+ run: |
+ # stop the build if there are Python syntax errors or undefined names
+ poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+ # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+ poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+ - name: Run server in background
+ run: poetry run misp-modules -l 127.0.0.1 -s 2>error.log &
+
+ - name: Sleep for 10 seconds
+ run: sleep 10s
+ shell: bash
+
+ - name: Check if server is running
+ run: curl -sS localhost:6666/healthcheck
+
+ - name: Test package
+ run: poetry run pytest
+
+ - name: Show error log
+ if: always()
+ run: cat error.log
+
+ - name: Upload package artifcat
+ if: ${{ matrix.python-version == '3.12' }}
+ uses: actions/upload-artifact@v4
+ with:
+ name: python-package-distributions
+ path: dist/
+
+ publish-to-test-pypi:
+ runs-on: ubuntu-latest
+ needs: test
+
+ permissions:
+ id-token: write
+
+ steps:
+ - name: Download dist files
+ uses: actions/download-artifact@v4
+ with:
+ name: python-package-distributions
+ path: dist/
+
+ - name: Publish to Test PyPI
+ if: ${{ github.event_name == 'push' }}
+ uses: pypa/gh-action-pypi-publish@release/v1
+ with:
+ skip-existing: true
+ repository-url: https://test.pypi.org/legacy/

.gitignore

@@ -7,18 +7,20 @@ dist/
 misp_modules.egg-info/
 
 # For MKDOCS
-docs/expansion*
-docs/import_mod*
-docs/export_mod*
-site*
+docs
+docs/*
+site
+site/*
 
 #pycharm env
 .idea/*
 
 #venv
 venv*
+.venv/
 
 #vscode
 .vscode*
 *.sqlite
 website/conf/config.cfg
+wheels