justfile

# SPDX-FileCopyrightText: AISEC Pentesting Team
#
# SPDX-License-Identifier: Apache-2.0

default:
    @just --list

[private]
lint-mypy:
    mypy --pretty src tests

[private]
lint-ruff-check:
    ruff check

[private]
lint-ruff-format:
    ruff format --check

[private]
lint-shellcheck:
    find tests/bats \( -iname "*.bash" -or -iname "*.bats" -or -iname "*.sh" \) | xargs shellcheck

[private]
lint-reuse:
    reuse lint

[private]
lint-ty:
    ty check

lint: lint-mypy lint-ruff-check lint-ruff-format lint-ruff-format lint-shellcheck lint-reuse

win32-lint-mypy:
    mypy --platform win32 --exclude "gallia\/log\.py" --exclude "hr" src tests

fmt:
    ruff check --fix-only
    ruff format
    find tests/bats \( -iname "*.bash" -or -iname "*.bats" -or -iname "*.sh" \) | xargs shfmt -w

run-tests: run-test-pytest run-test-bats

run-test-matrix:
    #!/usr/bin/env bash

    set -eu

    matrix=("3.11" "3.12" "3.13" "3.14")
    for version in "${matrix[@]}"; do
        echo "running tests with python version: $version"
        uv sync --all-extras -p "$version"
        uv run -p "$version" just run-tests
    done

run-test-pytest:
    python -m pytest -v --cov={{ justfile_directory() }} --cov-report html tests/pytest

run-test-bats:
    ./tests/bats/run_bats.sh

gen-constants: && fmt
    #!/usr/bin/env python

    import socket

    TEMPLATE = f"""# This file has been autogenerated by `just gen-constants`.
    # !! DO NOT CHANGE MANUALLY !!

    # SPDX-FileCopyrightText: AISEC Pentesting Team
    #
    # SPDX-License-Identifier: Apache-2.0

    import struct


    CANFD_MTU = 72
    CAN_MTU = 16

    # https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/can.h
    CAN_HEADER_FMT = struct.Struct("=IBB2x")

    CANFD_BRS = 0x01
    CANFD_ESI = 0x02

    CAN_EFF_FLAG = {socket.CAN_EFF_FLAG:#x}
    CAN_ERR_FLAG = {socket.CAN_ERR_FLAG:#x}
    CAN_RTR_FLAG = {socket.CAN_RTR_FLAG:#x}

    CAN_EFF_MASK = {socket.CAN_EFF_MASK:#x}
    CAN_INV_FILTER = 0x20000000  # TODO: Add to CPython
    CAN_SFF_MASK = {socket.CAN_SFF_MASK:#x}

    CAN_RAW = {socket.CAN_RAW:#x}
    CAN_RAW_FD_FRAMES = {socket.CAN_RAW_FD_FRAMES:#x}
    CAN_RAW_FILTER = {socket.CAN_RAW_FILTER:#x}
    CAN_RAW_JOIN_FILTERS = {socket.CAN_RAW_JOIN_FILTERS:#x}
    SOL_CAN_RAW = {socket.SOL_CAN_RAW:#x}

    # Socket Constants not available in the socket module,
    # see linux/can/isotp.h
    # TODO: This is now available in Python 3.15+.
    # https://github.com/python/cpython/pull/23794
    SOL_CAN_ISOTP = {socket.SOL_CAN_BASE + socket.CAN_ISOTP}

    # Valuetypes for SOL_CAN_ISOTP
    CAN_ISOTP_OPTS = 1
    CAN_ISOTP_RECV_FC = 2
    CAN_ISOTP_TX_STMIN = 3
    CAN_ISOTP_RX_STMIN = 4
    CAN_ISOTP_LL_OPTS = 5

    # Flags for setsockopt CAN_ISOTP_OPTS
    CAN_ISOTP_LISTEN_MODE = 0x001
    CAN_ISOTP_EXTEND_ADDR = 0x002
    CAN_ISOTP_TX_PADDING = 0x004
    CAN_ISOTP_RX_PADDING = 0x008
    CAN_ISOTP_CHK_PAD_LEN = 0x010
    CAN_ISOTP_CHK_PAD_DATA = 0x020
    CAN_ISOTP_HALF_DUPLEX = 0x040
    CAN_ISOTP_FORCE_TXSTMIN = 0x080
    CAN_ISOTP_FORCE_RXSTMIN = 0x100
    CAN_ISOTP_RX_EXT_ADDR = 0x200
    """

    with open("src/gallia/transports/_can_constants.py", "w") as f:
        f.write(TEMPLATE)


[private]
print_debian_hint:
    @echo "-----------------------------------------------------------------------"
    @echo "Next, please update and build the Debian package from this repository:"
    @echo ""
    @echo "  https://salsa.debian.org/rumpelsepp/gallia"
    @echo ""
    @echo "with the following command:"
    @echo ""
    @echo "  $ gbp buildpackage --git-upstream-tag=$(uv version --short)"
    @echo ""
    @echo "Note that this will change once gallia is accepted in Debian."
    @echo ""
    @echo "Upload the package to the release with:"
    @echo ""
    @echo "  $ gh release upload v$(uv version --short) DEB_FILE"

release increment: && print_debian_hint
    uv version --bump {{ increment }}

    git commit -a -m "$(uv version)"
    git tag -a -m "$(uv version)" v"$(uv version --short)"
    git push --follow-tags

    gh release create "v$(uv version --short)"

pre-release premode increment="": && print_debian_hint
    #!/usr/bin/env bash

    increment="{{ increment }}"
    premode="{{ premode }}"

    if [[ "$increment" == "" ]]; then
        uv version --bump "$premode"
    else
        uv version --bump "$premode" --bump "$increment"
    fi

    git commit -a -m "$(uv version)"
    git tag -a -m "$(uv version)" v"$(uv version --short)"
    git push --follow-tags

    gh release create --prerelease "v$(uv version --short)"