tidy3d-extras-python-client-tests-integration.yml

name: "public/tidy3d-extras/python-client-integration-tests"

on:
  workflow_dispatch:
    inputs:
      release_tag:
        description: 'Release Tag (v2.10.0, v2.10.0rc1)'
        required: false
        type: string
        default: ''
      test_type:
        description: 'Test type: basic (smoke tests) or full (all platforms)'
        required: false
        type: choice
        options:
          - basic
          - full
        default: 'basic'

  workflow_call:
    inputs:
      release_tag:
        description: 'Release Tag (v2.10.0, v2.10.0rc1)'
        required: false
        type: string
        default: ''
      test_type:
        description: 'Test type: basic (smoke tests) or full (all platforms)'
        required: false
        type: string
        default: 'basic'
    outputs:
      workflow_success:
        description: 'Overall integration test workflow success status'
        value: ${{ jobs.integration-tests-basic.result == 'success' || jobs.integration-tests-full.result == 'success' }}

permissions:
  contents: read

jobs:
  integration-tests-basic:
    name: python-${{ matrix.python-version }}-${{ matrix.name }}
    if: ${{ (github.event.inputs.test_type || inputs.test_type || 'basic') == 'basic' }}
    runs-on: ${{ matrix.runs-on }}
    container: ${{ matrix.container }}
    permissions:
      contents: read
    concurrency:
      group: tidy3d-extras-integration-${{ github.event.pull_request.number || github.sha }}-${{ matrix.name }}
      cancel-in-progress: true
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: linux-x86_64
            runs-on: ubuntu-latest
            python-version: '3.10'
          - name: macos-arm64
            runs-on: macos-latest
            python-version: '3.10'
          - name: windows-x64-3.10
            runs-on: windows-latest
            python-version: '3.10'
          - name: windows-x64-3.13
            runs-on: windows-latest
            python-version: '3.13'
    defaults:
      run:
        shell: bash
    env:
      PIP_ONLY_BINARY: gdstk
      MPLBACKEND: agg
      RELEASE_TAG: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.release_tag || inputs.release_tag }}

    steps:
    - name: checkout-head
      if: ${{ !env.RELEASE_TAG }}
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        fetch-depth: 1
        submodules: false
        persist-credentials: false
        lfs: true

    - name: checkout-tag
      if: ${{ env.RELEASE_TAG }}
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        ref: refs/tags/${{ env.RELEASE_TAG }}
        fetch-depth: 1
        submodules: false
        persist-credentials: false
        lfs: true

    - name: set-python-${{ matrix.python-version }}
      uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
      with:
        python-version: ${{ matrix.python-version }}

    - name: install-poetry
      uses: snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a  # v1.4.1
      with:
        version: 2.1.1
        virtualenvs-create: true
        virtualenvs-in-project: true

    - name: configure-aws-credentials
      uses: aws-actions/configure-aws-credentials@8df5847569e6427dd6c4fb1cf565c83acfa8afa7  # v6.0.0
      with:
        aws-access-key-id: ${{ secrets.AWS_CODEARTIFACT_ACCESS_KEY }}
        aws-secret-access-key: ${{ secrets.AWS_CODEARTIFACT_ACCESS_SECRET }}
        aws-region: us-east-1

    - name: configure-codeartifact-authentication
      run: |
        set -e
        echo "Getting CodeArtifact token..."
        CODEARTIFACT_AUTH_TOKEN=$(aws codeartifact get-authorization-token \
          --domain flexcompute \
          --domain-owner 625554095313 \
          --query authorizationToken \
          --output text)

        echo "Configuring Poetry with CodeArtifact credentials..."
        poetry config http-basic.codeartifact aws $CODEARTIFACT_AUTH_TOKEN
        echo "✅ CodeArtifact authentication configured"

    - name: update-tidy3d-extras-lockfile
      run: |
        set -e
        echo "Updating tidy3d-extras in poetry.lock..."
        poetry update tidy3d-extras --lock
        echo "✅ tidy3d-extras updated in lockfile"

    - name: install-project
      shell: bash
      run: |
        poetry --version
        python --version
        rm -rf .venv
        if [[ "${{ runner.os }}" == "Windows" ]]; then
          python -m venv .venv
          source .venv/Scripts/activate
        else
          echo "DEBUG: pythonLocation=$pythonLocation"
          "$pythonLocation/bin/python" -m venv .venv
          source .venv/bin/activate
          echo "DEBUG: .venv/bin/python --version = $(.venv/bin/python --version)"
          ls -la .venv/bin/python*
        fi
        poetry config virtualenvs.create false --local
        poetry env info
        poetry run pip install --upgrade pip wheel setuptools
        poetry run pip install gdstk --only-binary gdstk
        poetry install -E extras -E dev

    - name: verify-extras-installation
      run: |
        export SIMCLOUD_APIKEY=${{ secrets.TIDY3D_API_KEY }}
        poetry run tidy3d configure --apikey ${{ secrets.TIDY3D_API_KEY }}
        poetry run python -c "import tidy3d; print(f'tidy3d version: {tidy3d.__version__}')"
        poetry run python -c "import tidy3d_extras; print(f'tidy3d-extras version: {tidy3d_extras.__version__}')"
        cd tests/
        poetry run pytest _test_tidy3d_extras

    - name: run-doctests
      run: |
        export SIMCLOUD_APIKEY=${{ secrets.TIDY3D_API_KEY }}
        poetry run tidy3d configure --apikey ${{ secrets.TIDY3D_API_KEY }}
        poetry run pytest -rF --tb=short tidy3d

    - name: run-tests-coverage
      env:
        PYTHONUNBUFFERED: "1"
      run: |
        export SIMCLOUD_APIKEY=${{ secrets.TIDY3D_API_KEY }}
        poetry run tidy3d configure --apikey ${{ secrets.TIDY3D_API_KEY }}
        poetry run pytest --cov=tidy3d -rF --tb=short tests/_test_data/_test_datasets_no_vtk.py
        poetry run pytest --cov=tidy3d -rF --tb=short tests
        poetry run coverage report -m
        TOTAL_COVERAGE=$(poetry run coverage report --format=total)
        echo "total=$TOTAL_COVERAGE" >> "$GITHUB_ENV"
        echo "### Total coverage: ${TOTAL_COVERAGE}%"

  integration-tests-full:
    name: python-${{ matrix.python-version }}-${{ matrix.name }}
    if: ${{ (github.event.inputs.test_type || inputs.test_type || 'basic') == 'full' }}
    runs-on: ${{ matrix.runs-on }}
    permissions:
      contents: read
    concurrency:
      group: tidy3d-extras-integration-${{ github.event.pull_request.number || github.sha }}-${{ matrix.name }}
      cancel-in-progress: true
    strategy:
      fail-fast: false
      matrix:
        include: # TODO finish container setup with Casey
          - name: linux-x86_64-3.10
            runs-on: ubuntu-latest
            python-version: '3.10'
          - name: linux-x86_64-3.13
            runs-on: ubuntu-latest
            python-version: '3.13'
          - name: macos-arm64-3.10
            runs-on: macos-latest
            python-version: '3.10'
          - name: macos-arm64-3.13
            runs-on: macos-latest
            python-version: '3.13'
          - name: windows-x64-3.10
            runs-on: windows-latest
            python-version: '3.10'
          - name: windows-x64-3.13
            runs-on: windows-latest
            python-version: '3.13'
    defaults:
      run:
        shell: bash
    env:
      PIP_ONLY_BINARY: gdstk
      MPLBACKEND: agg
      RELEASE_TAG: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.release_tag || inputs.release_tag }}

    steps:
    - name: checkout-head
      if: ${{ !env.RELEASE_TAG }}
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        fetch-depth: 1
        submodules: false
        persist-credentials: false
        lfs: true

    - name: checkout-tag
      if: ${{ env.RELEASE_TAG }}
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        ref: refs/tags/${{ env.RELEASE_TAG }}
        fetch-depth: 1
        submodules: false
        persist-credentials: false
        lfs: true

    - name: set-python-${{ matrix.python-version }}
      uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
      with:
        python-version: ${{ matrix.python-version }}

    - name: install-poetry
      uses: snok/install-poetry@76e04a911780d5b312d89783f7b1cd627778900a  # v1.4.1
      with:
        version: 2.1.1
        virtualenvs-create: true
        virtualenvs-in-project: true

    - name: configure-aws-credentials
      uses: aws-actions/configure-aws-credentials@8df5847569e6427dd6c4fb1cf565c83acfa8afa7  # v6.0.0
      with:
        aws-access-key-id: ${{ secrets.AWS_CODEARTIFACT_ACCESS_KEY }}
        aws-secret-access-key: ${{ secrets.AWS_CODEARTIFACT_ACCESS_SECRET }}
        aws-region: us-east-1

    - name: configure-codeartifact-authentication
      run: |
        set -e
        echo "Getting CodeArtifact token..."
        CODEARTIFACT_AUTH_TOKEN=$(aws codeartifact get-authorization-token \
          --domain flexcompute \
          --domain-owner 625554095313 \
          --query authorizationToken \
          --output text)

        echo "Configuring Poetry with CodeArtifact credentials..."
        poetry config http-basic.codeartifact aws $CODEARTIFACT_AUTH_TOKEN
        echo "✅ CodeArtifact authentication configured"

    - name: update-tidy3d-extras-lockfile
      run: |
        set -e
        echo "Updating tidy3d-extras in poetry.lock..."
        poetry update tidy3d-extras --lock
        echo "✅ tidy3d-extras updated in lockfile"

    - name: install-project
      shell: bash
      run: |
        poetry --version
        python --version
        rm -rf .venv
        if [[ "${{ runner.os }}" == "Windows" ]]; then
          python -m venv .venv
          source .venv/Scripts/activate
        else
          echo "DEBUG: pythonLocation=$pythonLocation"
          "$pythonLocation/bin/python" -m venv .venv
          source .venv/bin/activate
          echo "DEBUG: .venv/bin/python --version = $(.venv/bin/python --version)"
          ls -la .venv/bin/python*
        fi
        poetry config virtualenvs.create false --local
        poetry env info
        poetry run pip install --upgrade pip wheel setuptools
        poetry run pip install gdstk --only-binary gdstk
        poetry install -E extras -E dev

    - name: verify-extras-installation
      run: |
        export SIMCLOUD_APIKEY=${{ secrets.TIDY3D_API_KEY }}
        poetry run tidy3d configure --apikey ${{ secrets.TIDY3D_API_KEY }}
        poetry run python -c "import tidy3d; print(f'tidy3d version: {tidy3d.__version__}')"
        poetry run python -c "import tidy3d_extras; print(f'tidy3d-extras version: {tidy3d_extras.__version__}')"
        cd tests/
        poetry run pytest _test_tidy3d_extras

    - name: run-doctests
      run: |
        export SIMCLOUD_APIKEY=${{ secrets.TIDY3D_API_KEY }}
        poetry run tidy3d configure --apikey ${{ secrets.TIDY3D_API_KEY }}
        poetry run pytest -rF --tb=short tidy3d

    - name: run-tests-coverage
      env:
        PYTHONUNBUFFERED: "1"
      run: |
        export SIMCLOUD_APIKEY=${{ secrets.TIDY3D_API_KEY }}
        poetry run tidy3d configure --apikey ${{ secrets.TIDY3D_API_KEY }}
        poetry run pytest --cov=tidy3d -rF --tb=short tests/_test_data/_test_datasets_no_vtk.py
        poetry run pytest --cov=tidy3d -rF --tb=short tests
        poetry run coverage report -m
        TOTAL_COVERAGE=$(poetry run coverage report --format=total)
        echo "total=$TOTAL_COVERAGE" >> "$GITHUB_ENV"
        echo "### Total coverage: ${TOTAL_COVERAGE}%"