actuator-lint 0.4.2__tar.gz

actuator_lint-0.4.2/.github/ISSUE_TEMPLATE/wrong-result.md

@@ -0,0 +1,19 @@
+---
+name: Wrong or missing finding
+about: The tool reported something that is not a problem, or missed one
+---
+
+**Parameter file**
+
+Attach the file or paste the `CA_*` lines.
+
+**Command and output**
+
+```
+actuator-lint --version
+actuator-lint <file>
+```
+
+**What you expected**
+
+**PX4 version of the vehicle** (the report shows the PX4 version of the engine)

actuator_lint-0.4.2/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # keep the actions used by the workflows current
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly

actuator_lint-0.4.2/.github/workflows/action-check.yml

@@ -0,0 +1,95 @@
+name: action check
+
+# Uses the GitHub Action of this repository the way another repository would:
+# it installs a published release and checks files of examples/.
+#
+# The action installs the release named by the default of its version input,
+# which is set to the next release before that release is tagged. Until the
+# release is published, a push to main cannot check the action and says so;
+# publishing the release runs the check in full.
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - action.yml
+      - action/**
+      - .github/workflows/action-check.yml
+  pull_request:
+    paths:
+      - action.yml
+      - action/**
+      - .github/workflows/action-check.yml
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  action:
+    name: ${{ matrix.runner }}
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        runner: [ubuntu-24.04, ubuntu-24.04-arm, macos-26]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: The release the action installs
+        id: release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          EVENT: ${{ github.event_name }}
+        run: |
+          version="$(awk '/^  version:/ { input = 1 } input && /default:/ { gsub(/[" ]|default:/, ""); print; exit }' action.yml)"
+          echo "the action installs release ${version}"
+          test -n "${version}"
+
+          if [ "${EVENT}" = release ] \
+            || [ "$(gh release view "v${version}" -R "${GITHUB_REPOSITORY}" --json isDraft --jq .isDraft 2> /dev/null)" = false ]; then
+            echo "published=true" >> "${GITHUB_OUTPUT}"
+          else
+            echo "::notice::release ${version} is not published yet, so the action is not checked; publishing it runs this check"
+            echo "published=false" >> "${GITHUB_OUTPUT}"
+          fi
+      - name: Files without error findings
+        id: good
+        if: steps.release.outputs.published == 'true'
+        uses: ./
+        with:
+          files: |
+            examples/fixed_wing.params
+            examples/tilt*.params
+      - name: A file with an error finding
+        id: bad
+        if: steps.release.outputs.published == 'true'
+        continue-on-error: true
+        uses: ./
+        with:
+          files: examples/quad_rotor_down.params
+          summary: "false"
+      - name: The same file, findings allowed
+        id: allowed
+        if: steps.release.outputs.published == 'true'
+        uses: ./
+        with:
+          files: examples/quad_rotor_down.params
+          fail-on: never
+          summary: "false"
+      - name: Check the results
+        if: steps.release.outputs.published == 'true'
+        env:
+          GOOD_FILES: ${{ steps.good.outputs.files }}
+          GOOD_FAILED: ${{ steps.good.outputs.failed }}
+          BAD_OUTCOME: ${{ steps.bad.outcome }}
+          BAD_FAILED: ${{ steps.bad.outputs.failed }}
+          ALLOWED_FAILED: ${{ steps.allowed.outputs.failed }}
+        run: |
+          echo "good: $GOOD_FILES files, $GOOD_FAILED failed; bad: $BAD_OUTCOME, $BAD_FAILED failed; allowed: $ALLOWED_FAILED failed"
+          test "$GOOD_FILES" = 3
+          test "$GOOD_FAILED" = 0
+          test "$BAD_OUTCOME" = failure
+          test "$BAD_FAILED" = 1
+          test "$ALLOWED_FAILED" = 0

actuator_lint-0.4.2/.github/workflows/install-check.yml

@@ -0,0 +1,91 @@
+name: install check
+
+# Follows the install steps of the README with the files of a published
+# release, on clean runners, and runs the tool on an example.
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Release to check, without the leading v
+        required: true
+        default: "0.4.2"
+
+permissions:
+  contents: read
+
+jobs:
+  install:
+    name: ${{ matrix.platform }} on ${{ matrix.runner }}, ${{ matrix.installer }}
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [linux-x86_64, linux-arm64, macos-arm64]
+        installer: [uv, venv]
+        include:
+          - platform: linux-x86_64
+            runner: ubuntu-24.04
+          - platform: linux-arm64
+            runner: ubuntu-24.04-arm
+          - platform: macos-arm64
+            runner: macos-26
+    env:
+      VERSION: ${{ inputs.version || github.event.release.tag_name }}
+      PLATFORM: ${{ matrix.platform }}
+      GH_TOKEN: ${{ github.token }}
+    steps:
+      - name: Version without the leading v
+        run: echo "VERSION=${VERSION#v}" >> "$GITHUB_ENV"
+      # only the examples are taken from the repository
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: v${{ env.VERSION }}
+          sparse-checkout: examples
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        if: matrix.installer == 'uv'
+      - name: Install the Python package with uv
+        if: matrix.installer == 'uv'
+        run: uv tool install "https://github.com/Abtektas/actuator-lint/releases/download/v${VERSION}/actuator_lint-${VERSION}-py3-none-any.whl"
+      - name: Install the Python package in a virtual environment
+        if: matrix.installer == 'venv'
+        run: |
+          python3 --version
+          python3 -m venv "$RUNNER_TEMP/venv"
+          "$RUNNER_TEMP/venv/bin/pip" install "https://github.com/Abtektas/actuator-lint/releases/download/v${VERSION}/actuator_lint-${VERSION}-py3-none-any.whl"
+          echo "$RUNNER_TEMP/venv/bin" >> "$GITHUB_PATH"
+      - name: Install the engine
+        working-directory: ${{ runner.temp }}
+        run: |
+          BASE="https://github.com/Abtektas/actuator-lint/releases/download/v${VERSION}"
+          curl -fLO "$BASE/SHA256SUMS"
+          NAME="$(grep -o "actuator_lint_engine-.*-${PLATFORM}" SHA256SUMS)"
+          curl -fLO "$BASE/$NAME.tar.gz"
+          shasum -a 256 --ignore-missing -c SHA256SUMS
+          gh attestation verify "$NAME.tar.gz" -R Abtektas/actuator-lint
+          tar -xzf "$NAME.tar.gz"
+          mkdir -p ~/.local/share/actuator-lint
+          cp "$NAME/actuator_lint_engine" ~/.local/share/actuator-lint/
+      - name: Run the tool
+        run: |
+          actuator-lint --version
+          actuator-lint examples/standard_vtol.params
+          actuator-lint examples/standard_vtol_pusher_offset.params
+      - name: Check the result
+        run: |
+          actuator-lint --format json examples/standard_vtol_pusher_offset.params > report.json
+          python3 - <<'EOF'
+          import json
+          report = json.load(open("report.json"))
+          rules = sorted(finding["rule"] for finding in report["findings"])
+          gain = report["matrices"][0]["mix"][4]["thrust_x"]
+          print(report["px4"]["version"], rules, gain)
+          assert rules == ["CA010", "CA011"], rules
+          assert abs(gain - 4.0) < 1e-3, gain
+          EOF
+          status=0
+          actuator-lint --fail-on warning examples/standard_vtol_pusher_offset.params > /dev/null || status=$?
+          test "$status" -eq 1
+          actuator-lint diff examples/standard_vtol.params examples/standard_vtol_pusher_offset.params

actuator_lint-0.4.2/.github/workflows/pypi.yml

@@ -0,0 +1,48 @@
+name: pypi
+
+# Uploads the Python package of a published release to the Python Package
+# Index, with the files of that release. An upload cannot be undone, so the
+# workflow does nothing until the repository variable PYPI_PUBLISH is set to
+# "true"; docs/versioning.md says what has to be set up on pypi.org before.
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Release to upload, without the leading v
+        required: true
+
+permissions:
+  contents: read
+
+jobs:
+  upload:
+    name: Upload to PyPI
+    if: vars.PYPI_PUBLISH == 'true'
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/project/actuator-lint/
+    permissions:
+      contents: read
+      # the package index trusts this workflow by its identity; there is no stored password or token
+      id-token: write
+    env:
+      VERSION: ${{ inputs.version || github.event.release.tag_name }}
+      GH_TOKEN: ${{ github.token }}
+    steps:
+      - name: Download the Python package of the release
+        run: |
+          VERSION="${VERSION#v}"
+          mkdir dist
+          gh release download "v${VERSION}" -R "${GITHUB_REPOSITORY}" -D . \
+            -p "actuator_lint-${VERSION}-py3-none-any.whl" -p "actuator_lint-${VERSION}.tar.gz" -p SHA256SUMS
+          sha256sum --ignore-missing -c SHA256SUMS
+          # the files were built by the release workflow of this repository
+          gh attestation verify "actuator_lint-${VERSION}-py3-none-any.whl" -R "${GITHUB_REPOSITORY}"
+          gh attestation verify "actuator_lint-${VERSION}.tar.gz" -R "${GITHUB_REPOSITORY}"
+          mv "actuator_lint-${VERSION}-py3-none-any.whl" "actuator_lint-${VERSION}.tar.gz" dist/
+          ls -l dist
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

actuator_lint-0.4.2/.github/workflows/release.yml

@@ -0,0 +1,85 @@
+name: release
+
+# A tag vX.Y.Z runs every test, then creates a draft GitHub Release with the
+# Python package, the engine archives, checksums and build provenance.
+# The draft is published by hand after it has been looked at.
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+  # a manual run is a rehearsal: it builds everything and uploads the files as
+  # a workflow artifact, but makes no release
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    uses: ./.github/workflows/tests.yml
+
+  release:
+    name: Draft release
+    needs: tests
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+      id-token: write
+      attestations: write
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.13"
+      - name: Check that the tag matches the package version
+        if: github.event_name == 'push'
+        run: |
+          version="$(python -c 'import actuator_lint; print(actuator_lint.__version__)')"
+          if [ "v${version}" != "${GITHUB_REF_NAME}" ]; then
+            echo "tag ${GITHUB_REF_NAME} does not match package version ${version}" >&2
+            exit 1
+          fi
+          if ! grep -q "^## ${version} " CHANGELOG.md; then
+            echo "CHANGELOG.md has no section for ${version}" >&2
+            exit 1
+          fi
+      - name: Build the Python package
+        run: |
+          python -m pip install build==1.6.1 twine==7.0.0
+          python -m build --outdir dist
+          # what the Python Package Index checks at an upload: metadata and the rendering of its page
+          python -m twine check --strict dist/*
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          pattern: actuator_lint_engine-*
+          path: dist
+          merge-multiple: true
+      - name: Checksums and release notes
+        run: |
+          cd dist
+          ls -l
+          # one file with every checksum; the per-archive files are not needed
+          rm -f ./*.sha256
+          sha256sum ./* | sed 's| \./| |' > SHA256SUMS
+          cat SHA256SUMS
+          cd ..
+          python tools/release_notes.py "$(python -c 'import actuator_lint; print(actuator_lint.__version__)')" > notes.md
+          cat notes.md
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        if: github.event_name != 'push'
+        with:
+          name: release-rehearsal
+          path: |
+            dist/
+            notes.md
+          if-no-files-found: error
+      - uses: actions/attest-build-provenance@4d101475d8b20a2381f78447822ac1eab6504dd8 # v4.2.2
+        if: github.event_name == 'push'
+        with:
+          subject-path: dist/*
+      - name: Create the draft release
+        if: github.event_name == 'push'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release create "${GITHUB_REF_NAME}" dist/* --draft --verify-tag --title "${GITHUB_REF_NAME}" --notes-file notes.md

actuator_lint-0.4.2/.github/workflows/tests.yml

@@ -0,0 +1,110 @@
+name: tests
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+  # the release workflow runs these jobs before it makes a release
+  workflow_call:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  # the PX4 release the engine is built against, see docs/versioning.md
+  PX4_REF: v1.17.0
+
+jobs:
+  python:
+    name: Python ${{ matrix.python }}
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: ${{ matrix.python }}
+      # tests that need the engine are skipped in this job
+      - run: python -m unittest discover -s tests -t .
+      - name: Install and run the command
+        run: |
+          python -m pip install .
+          actuator-lint --version
+
+  engine-linux:
+    name: Engine, Linux ${{ matrix.arch }}
+    runs-on: ${{ matrix.runner }}
+    container: px4io/px4-dev:v1.17.0
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - arch: x86_64
+            runner: ubuntu-24.04
+          - arch: arm64
+            runner: ubuntu-24.04-arm
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: Get PX4
+        run: |
+          git config --global --add safe.directory '*'
+          git clone --depth 1 --branch "$PX4_REF" https://github.com/PX4/PX4-Autopilot.git "$RUNNER_TEMP/px4"
+      - name: Build the engine
+        run: engine/build.sh "$RUNNER_TEMP/px4"
+      - name: Tests with the engine and golden tests
+        env:
+          ACTUATOR_LINT_ENGINE: build/engine/actuator_lint_engine
+        run: ACTUATOR_LINT_PX4_DIR="$RUNNER_TEMP/px4" python3 -m unittest discover -s tests -t .
+      # the cross-check does not depend on the processor architecture
+      - name: Build PX4 SITL
+        if: matrix.arch == 'x86_64'
+        run: engine/build_sitl.sh "$RUNNER_TEMP/px4"
+      - name: SITL cross-check
+        if: matrix.arch == 'x86_64'
+        env:
+          ACTUATOR_LINT_ENGINE: build/engine/actuator_lint_engine
+          ACTUATOR_LINT_SITL_BUILD: build/sitl
+        run: python3 -m unittest -v tests.test_sitl
+      - name: Package the engine
+        run: engine/package.sh build/engine/actuator_lint_engine "$RUNNER_TEMP/px4" "linux-${{ matrix.arch }}" dist
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: actuator_lint_engine-linux-${{ matrix.arch }}
+          path: dist/
+          if-no-files-found: error
+
+  engine-macos:
+    name: Engine, macOS arm64
+    runs-on: macos-26
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.13"
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+      - name: Get PX4 and its build requirements
+        run: |
+          git clone --depth 1 --branch "$PX4_REF" https://github.com/PX4/PX4-Autopilot.git "$RUNNER_TEMP/px4"
+          uv venv --python "$(command -v python)" "$RUNNER_TEMP/venv"
+          uv pip install --python "$RUNNER_TEMP/venv/bin/python" -r "$RUNNER_TEMP/px4/Tools/setup/requirements.txt"
+          command -v ninja || brew install ninja
+      - name: Build the engine
+        run: ACTUATOR_LINT_PYTHON="$RUNNER_TEMP/venv/bin/python" engine/build.sh "$RUNNER_TEMP/px4"
+      - name: Tests with the engine and golden tests
+        env:
+          ACTUATOR_LINT_ENGINE: build/engine/actuator_lint_engine
+        run: ACTUATOR_LINT_PX4_DIR="$RUNNER_TEMP/px4" python -m unittest discover -s tests -t .
+      - name: Package the engine
+        run: engine/package.sh build/engine/actuator_lint_engine "$RUNNER_TEMP/px4" macos-arm64 dist
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: actuator_lint_engine-macos-arm64
+          path: dist/
+          if-no-files-found: error

actuator_lint-0.4.2/.gitignore

@@ -0,0 +1,4 @@
+build/
+__pycache__/
+*.pyc
+.venv/