artesian-sdk 4.3.1.dev2__tar.gz → 4.4.0b1__tar.gz

artesian_sdk-4.4.0b1/.github/workflows/python-tests.yml

@@ -0,0 +1,586 @@
+name: "Artesian SDK Python"
+
+on:
+  push:
+    branches: [master]
+    tags:
+      - "v[0-9]*.[0-9]*.[0-9]*"
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  contents: write
+  statuses: write
+  checks: write
+
+jobs:
+  # ---------------------------------------------------------------------------
+  # Pyright
+  # ---------------------------------------------------------------------------
+
+  pyright:
+    name: pyright
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      checks: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+
+          export SETUPTOOLS_SCM_PRETEND_VERSION="0.0.0"
+
+          echo "SETUPTOOLS_SCM_PRETEND_VERSION=$SETUPTOOLS_SCM_PRETEND_VERSION"
+
+          pip install --no-build-isolation -e ".[dev]"
+
+      - name: Run Pyright
+        uses: jordemort/action-pyright@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-check
+          lib:
+          level: warning
+          filter_mode: file
+
+  # ---------------------------------------------------------------------------
+  # Build / Test
+  # ---------------------------------------------------------------------------
+
+  build:
+    name: "build"
+    runs-on: ${{ matrix.os }}
+
+    permissions:
+      contents: read
+
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+
+          TAG="${GITHUB_REF_NAME}"
+
+          export SETUPTOOLS_SCM_PRETEND_VERSION="0.0.0"
+
+          if [[ "$TAG" =~ ^v([0-9]+\.[0-9]+\.[0-9]+)a([0-9]+)\.([0-9]+)$ ]]; then
+            export SETUPTOOLS_SCM_PRETEND_VERSION="${BASH_REMATCH[1]}a${BASH_REMATCH[2]}.post${BASH_REMATCH[3]}"
+          elif [[ "$TAG" =~ ^v([0-9]+\.[0-9]+\.[0-9]+)b([0-9]+)$ ]]; then
+            export SETUPTOOLS_SCM_PRETEND_VERSION="${BASH_REMATCH[1]}b${BASH_REMATCH[2]}"
+          elif [[ "$TAG" =~ ^v([0-9]+\.[0-9]+\.[0-9]+)$ ]]; then
+            export SETUPTOOLS_SCM_PRETEND_VERSION="${BASH_REMATCH[1]}"
+          fi
+
+          echo "SETUPTOOLS_SCM_PRETEND_VERSION=${SETUPTOOLS_SCM_PRETEND_VERSION}"
+
+          pip install -e ".[dev]"
+
+      - name: Run flake8
+        run: |
+          flake8 .
+
+      - name: Test Pytest
+        run: |
+          pytest --junitxml=junit/test-results-${{ matrix.python-version }}-${{ matrix.os }}.xml
+
+      - name: Upload pytest test results
+        uses: actions/upload-artifact@v7
+        if: always()
+        with:
+          name: test-results-build-${{ matrix.python-version }}-${{ matrix.os }}
+          path: junit/test-results-${{ matrix.python-version }}-${{ matrix.os }}.xml
+
+      - name: Upload build coverage
+        uses: actions/upload-artifact@v7
+        if: always()
+        with:
+          name: coverage-build-${{ matrix.python-version }}-${{ matrix.os }}
+          path: coverage.xml
+
+  # ---------------------------------------------------------------------------
+  # Test Report
+  #
+  # Consolidates test results from all jobs (build and publish-preview)
+  # into a single report.
+  # ---------------------------------------------------------------------------
+
+  test-report:
+    name: "Test Report"
+    runs-on: ubuntu-latest
+    needs:
+      - build
+      - publish-preview
+
+    if: always()
+
+    permissions:
+      contents: read
+      checks: write
+
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v7
+
+      - name: "Download test result artifacts"
+        uses: actions/download-artifact@v8
+        if: always()
+        with:
+          pattern: test-results-*
+          path: test-results
+          merge-multiple: true
+
+      - name: "Test Report"
+        uses: dorny/test-reporter@v3
+        if: always()
+        with:
+          name: Python Tests
+          path: "test-results/**/*.xml"
+          reporter: java-junit
+          fail-on-error: "true"
+          use-actions-summary: "false"
+
+  # ---------------------------------------------------------------------------
+  # Code Coverage
+  #
+  # Coverage from all Python/OS combinations and the PR preview merged state
+  # is merged into a single report.
+  # ---------------------------------------------------------------------------
+
+  coverage-report:
+    name: "Code Coverage"
+    runs-on: ubuntu-latest
+    needs:
+      - build
+      - publish-preview
+
+    if: always()
+
+    permissions:
+      contents: read
+      checks: write
+
+    steps:
+      - name: "Download coverage artifacts"
+        uses: actions/download-artifact@v8
+        if: always()
+        with:
+          pattern: coverage-*
+          path: coverage
+
+      - name: "Install dotnet"
+        uses: actions/setup-dotnet@v6
+        with:
+          dotnet-version: 10.x
+
+      - name: "Install reportgenerator"
+        shell: bash
+        run: dotnet tool install -g dotnet-reportgenerator-globaltool
+
+      - name: "Create code coverage report"
+        shell: bash
+        run: |
+          export PATH="$PATH:$HOME/.dotnet/tools"
+          reportgenerator \
+            -reports:"coverage/**/*.xml" \
+            -targetdir:CodeCoverage \
+            -reporttypes:'MarkdownSummaryGithub;Cobertura'
+
+      - name: "Write to Job Summary"
+        if: always()
+        run: cat CodeCoverage/SummaryGithub.md >> "$GITHUB_STEP_SUMMARY"
+
+  # ---------------------------------------------------------------------------
+  # Publish Stable
+  #
+  # Tag:
+  #   v4.3.0
+  #
+  # Python package version:
+  #   4.3.0
+  #
+  # Must originate from:
+  #   master
+  # ---------------------------------------------------------------------------
+
+  publish-stable:
+    name: "Publish Stable"
+    runs-on: ubuntu-latest
+    needs:
+      - pyright
+      - build
+
+    if: >
+      github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/v') &&
+      !contains(github.ref_name, 'a') &&
+      !contains(github.ref_name, 'b')
+
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: "Validate GA release tag"
+        shell: bash
+        run: bash .github/workflows/validate_tag.sh "$GITHUB_REF_NAME" ga
+
+      - name: "Validate release commit is contained in master"
+        shell: bash
+        run: bash .github/workflows/validate_branch.sh "master"
+
+      - name: "Set up Python 3.11"
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.11"
+
+      - name: "Install dependencies"
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+
+      - name: "Build package"
+        shell: bash
+        run: |
+          echo "Building GA package: ${GITHUB_REF_NAME#v}"
+          python -m build
+
+      - name: "Publish package"
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+  # ---------------------------------------------------------------------------
+  # Publish Beta
+  #
+  # Tag:
+  #   v4.3.0b1
+  #   v4.3.0b2
+  #
+  # Python package version:
+  #   4.3.0b1
+  #   4.3.0b2
+  #
+  # Must originate from:
+  #   develop-beta
+  #
+  # Beta version MUST be the next minor version after
+  # the latest GA version on master.
+  #
+  # Example:
+  #
+  #   master       = v4.2.0
+  #   develop-beta = v4.3.0b1
+  #
+  # ---------------------------------------------------------------------------
+
+  publish-beta:
+    name: "Publish Beta"
+    runs-on: ubuntu-latest
+    needs:
+      - pyright
+      - build
+
+    if: >
+      github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/v') &&
+      contains(github.ref_name, 'b')
+
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: "Validate Beta release tag"
+        shell: bash
+        run: bash .github/workflows/validate_tag.sh "$GITHUB_REF_NAME" beta
+
+      - name: "Validate release commit is contained in develop-beta"
+        shell: bash
+        run: bash .github/workflows/validate_branch.sh "develop-beta"
+
+      - name: "Validate next minor version"
+        shell: bash
+        run: |
+          TAG="${GITHUB_REF_NAME}"
+
+          git fetch origin master --tags
+
+          MASTER_VERSION=$(
+            git tag --merged origin/master --sort=-version:refname |
+            grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' |
+            head -n 1 |
+            sed 's/^v//'
+          )
+
+          BETA_VERSION=$(echo "$TAG" | sed -E 's/^v([0-9]+\.[0-9]+\.[0-9]+)b[0-9]+$/\1/')
+
+          echo "Master GA version: $MASTER_VERSION"
+          echo "Beta version:      $BETA_VERSION"
+
+          if [[ -z "$MASTER_VERSION" ]]; then
+            echo "::error::Could not determine the latest GA version on master."
+            exit 1
+          fi
+
+          MASTER_MAJOR=$(echo "$MASTER_VERSION" | cut -d. -f1)
+          MASTER_MINOR=$(echo "$MASTER_VERSION" | cut -d. -f2)
+
+          BETA_MAJOR=$(echo "$BETA_VERSION" | cut -d. -f1)
+          BETA_MINOR=$(echo "$BETA_VERSION" | cut -d. -f2)
+
+          EXPECTED_MAJOR="$MASTER_MAJOR"
+          EXPECTED_MINOR="$((MASTER_MINOR + 1))"
+
+          if [[ "$BETA_MAJOR" != "$EXPECTED_MAJOR" ||
+                "$BETA_MINOR" != "$EXPECTED_MINOR" ]]; then
+            echo "::error::Beta version $BETA_VERSION is not the next minor version after master GA $MASTER_VERSION."
+            echo "::error::Expected: ${EXPECTED_MAJOR}.${EXPECTED_MINOR}.0bN"
+            exit 1
+          fi
+
+          echo "Beta version $BETA_VERSION is the next minor version after master GA $MASTER_VERSION."
+
+      - name: "Set up Python 3.11"
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.11"
+
+      - name: "Install dependencies"
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+
+      - name: "Build package"
+        shell: bash
+        run: |
+          TAG="${GITHUB_REF_NAME}"
+
+          if [[ "$TAG" =~ ^v([0-9]+\.[0-9]+\.[0-9]+)b([0-9]+)$ ]]; then
+            export SETUPTOOLS_SCM_PRETEND_VERSION="${BASH_REMATCH[1]}b${BASH_REMATCH[2]}"
+          fi
+
+          echo "SETUPTOOLS_SCM_PRETEND_VERSION=${SETUPTOOLS_SCM_PRETEND_VERSION}"
+
+          python -m build
+
+      - name: "Publish package"
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+  # ---------------------------------------------------------------------------
+  # Publish PR Preview
+  #
+  # Tag:
+  #   v4.3.0a69.1
+  #   v4.3.0a69.2
+  #
+  # Python package version:
+  #   4.3.0a69.post1
+  #   4.3.0a69.post2
+  #
+  # Where:
+  #   4.3.0 = latest GA version on master
+  #   69    = PR number
+  #   1 / 2 = preview iteration
+  #
+  # The PR Preview version MUST match the latest GA version on master.
+  # The PR must be based on the current master.
+  # ---------------------------------------------------------------------------
+
+  publish-preview:
+    name: "Publish PR Preview"
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      checks: write
+
+    needs:
+      - pyright
+      - build
+
+    if: >
+      github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/v') &&
+      contains(github.ref_name, 'a')
+
+    steps:
+      - name: "Extract PR number"
+        id: pr
+        shell: bash
+        run: |
+          TAG="${GITHUB_REF_NAME}"
+
+          if [[ ! "$TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+a([0-9]+)\.([0-9]+)$ ]]; then
+            echo "::error::Invalid PR preview tag: $TAG"
+            exit 1
+          fi
+
+          PR_NUMBER="${BASH_REMATCH[1]}"
+          ITERATION="${BASH_REMATCH[2]}"
+
+          echo "number=$PR_NUMBER" >> "$GITHUB_OUTPUT"
+          echo "iteration=$ITERATION" >> "$GITHUB_OUTPUT"
+
+          echo "PR number: $PR_NUMBER"
+          echo "Iteration: $ITERATION"
+
+      - name: "Checkout merged PR head"
+        uses: actions/checkout@v7
+        with:
+          ref: refs/pull/${{ steps.pr.outputs.number }}/merge
+          fetch-depth: 0
+
+      - name: "Validate PR Preview tag"
+        shell: bash
+        run: bash .github/workflows/validate_tag.sh "$GITHUB_REF_NAME" preview
+
+      - name: "Validate PR is based on current master"
+        shell: bash
+        run: |
+          git fetch origin master
+
+          CURRENT_MASTER=$(git rev-parse origin/master)
+          MERGE_PARENT=$(git rev-parse HEAD^1)
+
+          echo "Current master: $CURRENT_MASTER"
+          echo "Merge parent:   $MERGE_PARENT"
+
+          if [[ "$MERGE_PARENT" != "$CURRENT_MASTER" ]]; then
+            echo "::error::PR Preview is not based on the current master."
+            exit 1
+          fi
+
+          echo "PR Preview is based on master."
+
+      - name: "Validate preview version"
+        shell: bash
+        run: |
+          TAG="${GITHUB_REF_NAME}"
+
+          git fetch origin master --tags
+
+          MASTER_VERSION=$(
+            git tag --merged origin/master --sort=-version:refname |
+            grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' |
+            head -n 1 |
+            sed 's/^v//'
+          )
+
+          PREVIEW_VERSION=$(echo "$TAG" | sed -E 's/^v([0-9]+\.[0-9]+\.[0-9]+)a[0-9]+\.[0-9]+$/\1/')
+
+          echo "Master GA version: $MASTER_VERSION"
+          echo "Preview version:   $PREVIEW_VERSION"
+
+          if [[ -z "$MASTER_VERSION" ]]; then
+            echo "::error::Could not determine the latest GA version on master."
+            exit 1
+          fi
+
+          if [[ "$PREVIEW_VERSION" != "$MASTER_VERSION" ]]; then
+            echo "::error::PR Preview version $PREVIEW_VERSION does not match current master GA version $MASTER_VERSION."
+            exit 1
+          fi
+
+          echo "PR Preview version matches current master GA version: $MASTER_VERSION"
+
+      - name: "Set up Python 3.11"
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.11"
+
+      - name: "Install dependencies"
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+
+          TAG="${GITHUB_REF_NAME}"
+
+          if [[ "$TAG" =~ ^v([0-9]+\.[0-9]+\.[0-9]+)a([0-9]+)\.([0-9]+)$ ]]; then
+            export SETUPTOOLS_SCM_PRETEND_VERSION="${BASH_REMATCH[1]}a${BASH_REMATCH[2]}.post${BASH_REMATCH[3]}"
+          fi
+
+          echo "SETUPTOOLS_SCM_PRETEND_VERSION=${SETUPTOOLS_SCM_PRETEND_VERSION:-not-set}"
+
+          pip install -e ".[dev]"
+          python -m pip install build
+
+      - name: "Run flake8"
+        run: |
+          flake8 .
+
+      - name: "Test Pytest"
+        run: |
+          pytest --junitxml=junit/test-results-preview.xml
+
+      - name: "Upload pytest test results"
+        uses: actions/upload-artifact@v7
+        if: always()
+        with:
+          name: test-results-preview
+          path: junit/test-results-preview.xml
+
+      - name: "Upload preview coverage"
+        uses: actions/upload-artifact@v7
+        if: always()
+        with:
+          name: coverage-preview
+          path: coverage.xml
+
+      - name: "Build package"
+        shell: bash
+        run: |
+          TAG="${GITHUB_REF_NAME}"
+
+          if [[ "$TAG" =~ ^v([0-9]+\.[0-9]+\.[0-9]+)a([0-9]+)\.([0-9]+)$ ]]; then
+            export SETUPTOOLS_SCM_PRETEND_VERSION="${BASH_REMATCH[1]}a${BASH_REMATCH[2]}.post${BASH_REMATCH[3]}"
+          fi
+
+          echo "SETUPTOOLS_SCM_PRETEND_VERSION=${SETUPTOOLS_SCM_PRETEND_VERSION}"
+
+          python -m build
+
+      - name: "Publish package"
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

artesian_sdk-4.4.0b1/.github/workflows/validate_branch.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+if [[ $# -ne 1 ]]; then
+  echo "::error::Usage: $0 <expected-branch>"
+  exit 2
+fi
+
+EXPECTED_BRANCH="$1"
+
+git fetch origin "$EXPECTED_BRANCH"
+
+COMMIT_SHA="$GITHUB_SHA"
+if [[ "${GITHUB_REF:-}" == refs/tags/* ]]; then
+  COMMIT_SHA="$(git rev-parse "${GITHUB_REF}^{commit}")"
+fi
+
+if ! git merge-base --is-ancestor "$COMMIT_SHA" "origin/$EXPECTED_BRANCH"; then
+  echo "::error::Release tag does not point to a commit contained in $EXPECTED_BRANCH."
+  exit 1
+fi
+
+echo "Release commit is contained in $EXPECTED_BRANCH."

artesian_sdk-4.4.0b1/.github/workflows/validate_tag.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+if [[ $# -ne 2 ]]; then
+  echo "::error::Usage: $0 <tag> <ga|beta|preview>"
+  exit 2
+fi
+
+TAG="$1"
+TYPE="$2"
+
+case "$TYPE" in
+  ga)
+    PATTERN='^v[0-9]+\.[0-9]+\.[0-9]+$'
+    EXPECTED='vX.Y.Z'
+    ;;
+
+  beta)
+    PATTERN='^v[0-9]+\.[0-9]+\.[0-9]+b[0-9]+$'
+    EXPECTED='vX.Y.ZbN'
+    ;;
+
+  preview)
+    PATTERN='^v[0-9]+\.[0-9]+\.[0-9]+a[0-9]+\.[0-9]+$'
+    EXPECTED='vX.Y.Za{PR_NUMBER}.{ITERATION}'
+    ;;
+
+  *)
+    echo "::error::Unknown tag type: $TYPE"
+    exit 1
+    ;;
+esac
+
+if [[ ! "$TAG" =~ $PATTERN ]]; then
+  echo "::error::Invalid $TYPE release tag: $TAG"
+  echo "Expected format: $EXPECTED"
+  exit 1
+fi
+
+echo "Valid $TYPE release tag: $TAG"