test-dandi-cli.yml

name: Test against dandi-cli

on:
  push:
    branches:
      - master
  pull_request:
  schedule:
    - cron: '0 6 * * *'

jobs:
  test-dandi-cli:
    runs-on: ${{ matrix.os }}
    env:
      NO_ET: 1
      DANDI_TESTS_PULL_DOCKER_COMPOSE: 0
    strategy:
      fail-fast: false
      matrix:
        os:
          - windows-latest
          - ubuntu-latest
          - macos-latest
        python:
          # Use the only Python which is ATM also used by dandi-api
          # - '3.10'
          - '3.11'
          # - '3.12'
        version:
          - master
          - release
        mode:
          - normal
        vendored_dandiapi:
          # Allow vendor information for the dandi-api instance to default to
          #   the default values specified in
          #   dandi/tests/data/dandiarchive-docker/docker-compose.yml of the dandi-cli
          #   repo.
          - default
        include:
          - os: ubuntu-latest
            python: "3.10"
            mode: dandi-devel
            version: master
          - os: ubuntu-latest
            python: "3.10"
            mode: dandi-devel
            version: release
          - os: ubuntu-latest
            python: "3.11"
            mode: normal
            version: master
            vendored_dandiapi: ember-dandi
            instance_name: EMBER-DANDI
            instance_identifier: 'RRID:SCR_026700'
            doi_prefix: '10.82754'
          - os: ubuntu-latest
            python: "3.11"
            mode: normal
            version: release
            vendored_dandiapi: ember-dandi
            instance_name: EMBER-DANDI
            instance_identifier: 'RRID:SCR_026700'
            doi_prefix: '10.82754'
    steps:
      - name: Set up Python ${{ matrix.python }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python }}

      - name: Update pip & install wheel
        run: python -m pip install --upgrade pip wheel

      - name: Install hdf5 (Ubuntu)
        if: matrix.python == '3.10' && startsWith(matrix.os, 'ubuntu')
        run: sudo apt-get update && sudo apt-get install -y libhdf5-dev

      - name: Install hdf5 (macOS)
        if: matrix.python == '3.10' && startsWith(matrix.os, 'macos')
        run: |
          brew install hdf5@1.8
          brew link hdf5@1.8

      - name: Install master branch of dandi
        if: ${{ matrix.version == 'master' }}
        run: pip install "dandi[test,extras] @ git+https://github.com/dandi/dandi-cli.git"

      - name: Install latest release of dandi
        if: ${{ matrix.version == 'release' }}
        run: pip install "dandi[test,extras]"

      - name: Set DANDI_DEVEL=1
        if: matrix.mode == 'dandi-devel'
        run: echo DANDI_DEVEL=1 >> "$GITHUB_ENV"

      - name: Check out dandischema
        uses: actions/checkout@v6
        with:
          # Fetch all commits so that versioningit will return something
          # compatible with semantic-version
          fetch-depth: 0
          path: dandischema

      - name: Install dandischema
        run: pip install .
        working-directory: dandischema

      - name: Build dandi-api image with this version of dandischema
        if: startsWith(matrix.os, 'ubuntu')
        run: |
          docker build \
            -t dandiarchive/dandiarchive-api \
            -f tools/api-with-schema.Dockerfile \
            .
        working-directory: dandischema

      # Set only if matrix.instance_name is defined
      - name: Set DANDI_TESTS_INSTANCE_NAME
        if: ${{ matrix.instance_name }}
        run: echo "DANDI_TESTS_INSTANCE_NAME=${{ matrix.instance_name }}" >> "$GITHUB_ENV"

      # Set only if matrix.instance_identifier is defined
      - name: Set DANDI_TESTS_INSTANCE_IDENTIFIER
        if: ${{ matrix.instance_identifier }}
        run: echo "DANDI_TESTS_INSTANCE_IDENTIFIER=${{ matrix.instance_identifier }}" >> "$GITHUB_ENV"

      # Set only if matrix.doi_prefix is defined
      - name: Set DANDI_TESTS_DOI_PREFIX
        if: ${{ matrix.doi_prefix }}
        run: echo "DANDI_TESTS_DOI_PREFIX=${{ matrix.doi_prefix }}" >> "$GITHUB_ENV"

      - name: Run dandi-cli tests
        run: python -m pytest -s -v --pyargs dandi