analysis-coverage.yml

name: Analysis & Coverage

on:
  pull_request:
    paths:
      - '.github/workflows/analysis-coverage.yml'
      - 'nc_py_api/*.*'
      - 'tests/**'
      - 'setup.*'
      - 'pyproject.toml'
      - '.pre-commit-config.yaml'
  push:
    branches: [main]
    paths:
      - '.github/workflows/analysis-coverage.yml'
      - 'pillow_heif/*.*'
      - 'tests/**'
      - 'setup.*'
      - 'pyproject.toml'
      - '.pre-commit-config.yaml'
  workflow_dispatch:

env:
  NEXTCLOUD_URL: "http://localhost:8080"
  APP_ID: "nc_py_api"
  APP_PORT: 9009
  APP_VERSION: "1.0.0"
  APP_SECRET: "tC6vkwPhcppjMykD1r0n9NlI95uJMBYjs5blpIcA1PAdoPDmc5qoAjaBAkyocZ6E"
  NC_AUTH_USER: "admin"
  NC_AUTH_PASS: "adminpassword"

jobs:
  analysis:
    runs-on: macos-12
    name: Analysis

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: "3.9"

      - name: Install from source
        run: python3 -m pip install ".[dev]" wheel

      - name: Run Analysis
        run: python3 -m pylint "setup.py" "nc_py_api/"

  tests-maria:
    needs: [analysis]
    runs-on: ubuntu-22.04
    name: ${{ matrix.nextcloud }} • 🐘${{ matrix.php-version }} • 🐍${{ matrix.python }} • Maria
    strategy:
      fail-fast: false
      matrix:
        nextcloud: [ "26.0.3" ]
        python: [ "3.9" ]
        php-version: [ "8.1" ]
        include:
          - nextcloud: "27.0.0"
            python: "3.10"
            php-version: "8.2"

    services:
      mariadb:
        image: mariadb:11.0
        env:
          MARIADB_ROOT_PASSWORD: rootpassword
          MYSQL_DATABASE: nextcloud
          options: >-
            --health-cmd mysqladmin ping
            --health-interval 10s
            --health-timeout 5s
            --health-retries 5
        ports:
          - 3306:3306

    steps:
      - name: Set up php
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php-version }}
          extensions: mbstring, fileinfo, intl, pdo_mysql, zip, gd

      - uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python }}

      - name: cache-nextcloud
        id: nextcloud_setup
        uses: actions/cache@v3
        with:
          path: nextcloud-${{ matrix.nextcloud }}.tar.bz2
          key: ${{ matrix.nextcloud }}

      - name: Download Nextcloud
        if: steps.nextcloud_setup.outputs.cache-hit != 'true'
        run: wget -q https://download.nextcloud.com/server/releases/nextcloud-${{ matrix.nextcloud }}.tar.bz2

      - name: Set up Nextcloud
        run: |
          tar -xjf nextcloud-${{ matrix.nextcloud }}.tar.bz2 --strip-components 1
          mkdir data
          php occ maintenance:install --verbose --database=mysql --database-name=nextcloud \
            --database-host=127.0.0.1 --database-user=root --database-pass=rootpassword \
            --admin-user admin --admin-pass ${{ env.NC_AUTH_PASS }}
          php occ config:system:set loglevel --value=1 --type=integer
          php occ config:system:set debug --value=true --type=boolean
          php occ config:system:set allow_local_remote_servers --value true
          php -S localhost:8080 &

      - name: Checkout NcPyApi
        uses: actions/checkout@v3
        with:
          path: nc_py_api

      - name: Install NcPyApi
        working-directory: nc_py_api
        run: python3 -m pip -v install ".[dev]"

      - name: Checkout AppEcosystemV2
        uses: actions/checkout@v3
        with:
          path: apps/app_ecosystem_v2
          repository: cloud-py-api/app_ecosystem_v2

      - name: Install AppEcosystemV2
        run: |
          patch -p 1 -i apps/app_ecosystem_v2/base_php.patch
          php occ app:enable app_ecosystem_v2
          cd nc_py_api
          coverage run --data-file=.coverage.ci_install tests/_install.py &
          echo $! > /tmp/_install.pid
          python3 tests/_install_wait.py http://127.0.0.1:$APP_PORT/heartbeat "\"status\":\"ok\"" 15 0.5
          python3 tests/_app_security_checks.py http://127.0.0.1:$APP_PORT
          cd ..
          php occ app_ecosystem_v2:daemon:register manual_install "Manual Install" manual-install 0 0 0
          php occ app_ecosystem_v2:app:register $APP_ID manual_install --json-info \
            "{\"appid\":\"$APP_ID\",\"name\":\"$APP_ID\",\"daemon_config_name\":\"manual_install\",\"version\":\"$APP_VERSION\",\"secret\":\"$APP_SECRET\",\"host\":\"localhost\",\"port\":$APP_PORT,\"protocol\":\"http\",\"system_app\":1}" \
            -e --force-scopes
          kill -15 $(cat /tmp/_install.pid)
          timeout 3m tail --pid=$(cat /tmp/_install.pid) -f /dev/null

      - name: Generate coverage report
        working-directory: nc_py_api
        run: coverage run --data-file=.coverage.ci -m pytest && coverage combine && coverage xml && coverage html

      - name: HTML coverage to artifacts
        uses: actions/upload-artifact@v3
        with:
          name: coverage_maria_${{ matrix.nextcloud }}_${{ matrix.python }}_${{ matrix.php-version }}
          path: nc_py_api/htmlcov
          if-no-files-found: error

      - name: Upload report to Codecov
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          file: nc_py_api/coverage.xml
          fail_ci_if_error: true
          verbose: true

      - name: Upload NC logs
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: nc_log_maria_${{ matrix.nextcloud }}_${{ matrix.python }}_${{ matrix.php-version }}
          path: data/nextcloud.log
          if-no-files-found: warn

  tests-pgsql:
    needs: [analysis]
    runs-on: ubuntu-22.04
    name: ${{ matrix.nextcloud }} • 🐘${{ matrix.php-version }} • 🐍${{ matrix.python }} • PgSQL
    strategy:
      fail-fast: false
      matrix:
        nextcloud: [ "26.0.3" ]
        python: [ "3.11" ]
        php-version: [ "8.1" ]
        include:
          - nextcloud: "27.0.0"
            python: "3.10"
            php-version: "8.2"
    env:
      NC_dbname: nextcloud_abz

    services:
      postgres:
        image: postgres:15
        env:
          POSTGRES_USER: root
          POSTGRES_PASSWORD: rootpassword
          POSTGRES_DB: ${{ env.NC_dbname }}
          options: >-
            --health-cmd pg_isready
            --health-interval 10s
            --health-timeout 5s
            --health-retries 5
        ports:
          - 5432:5432

    steps:
      - name: Set up php ${{ matrix.php-version }}
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php-version }}
          extensions: mbstring, fileinfo, intl, pdo_mysql, zip, gd

      - uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python }}

      - name: cache-nextcloud
        id: nextcloud_setup
        uses: actions/cache@v3
        with:
          path: nextcloud-${{ matrix.nextcloud }}.tar.bz2
          key: ${{ matrix.nextcloud }}

      - name: Download Nextcloud
        if: steps.nextcloud_setup.outputs.cache-hit != 'true'
        run: wget -q https://download.nextcloud.com/server/releases/nextcloud-${{ matrix.nextcloud }}.tar.bz2

      - name: Set up Nextcloud
        run: |
          tar -xjf nextcloud-${{ matrix.nextcloud }}.tar.bz2 --strip-components 1
          mkdir data
          php occ maintenance:install --verbose --database=pgsql --database-name=${{ env.NC_dbname }} \
            --database-host=127.0.0.1 --database-user=root --database-pass=rootpassword \
            --admin-user admin --admin-pass ${{ env.NC_AUTH_PASS }}
          php occ config:system:set loglevel --value=1
          php occ config:system:set debug --value=true --type=boolean
          php occ config:system:set allow_local_remote_servers --value true
          php -S localhost:8080 &

      - name: Checkout NcPyApi
        uses: actions/checkout@v3
        with:
          path: nc_py_api

      - name: Install NcPyApi
        working-directory: nc_py_api
        run: python3 -m pip -v install ".[dev]"

      - name: Checkout AppEcosystemV2
        uses: actions/checkout@v3
        if: ${{ !startsWith(matrix.nextcloud, '26.') }}
        with:
          path: apps/app_ecosystem_v2
          repository: cloud-py-api/app_ecosystem_v2

      - name: Install AppEcosystemV2
        if: ${{ !startsWith(matrix.nextcloud, '26.') }}
        run: |
          patch -p 1 -i apps/app_ecosystem_v2/base_php.patch
          php occ app:enable app_ecosystem_v2
          cd nc_py_api
          coverage run --data-file=.coverage.ci_install tests/_install.py &
          echo $! > /tmp/_install.pid
          python3 tests/_install_wait.py http://127.0.0.1:$APP_PORT/heartbeat "\"status\":\"ok\"" 15 0.5
          python3 tests/_app_security_checks.py http://127.0.0.1:$APP_PORT
          cd ..
          php occ app_ecosystem_v2:daemon:register manual_install "Manual Install" manual-install 0 0 0
          php occ app_ecosystem_v2:app:register $APP_ID manual_install --json-info \
            "{\"appid\":\"$APP_ID\",\"name\":\"$APP_ID\",\"daemon_config_name\":\"manual_install\",\"version\":\"$APP_VERSION\",\"secret\":\"$APP_SECRET\",\"host\":\"localhost\",\"port\":$APP_PORT,\"protocol\":\"http\",\"system_app\":1}" \
            -e --force-scopes
          kill -15 $(cat /tmp/_install.pid)
          timeout 3m tail --pid=$(cat /tmp/_install.pid) -f /dev/null

      - name: Generate coverage report
        working-directory: nc_py_api
        run: coverage run --data-file=.coverage.ci -m pytest && coverage combine && coverage xml && coverage html

      - name: HTML coverage to artifacts
        uses: actions/upload-artifact@v3
        with:
          name: coverage_pgsql_${{ matrix.nextcloud }}_${{ matrix.python }}_${{ matrix.php-version }}
          path: nc_py_api/htmlcov
          if-no-files-found: error

      - name: Upload report to Codecov
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          file: nc_py_api/coverage.xml
          fail_ci_if_error: true
          verbose: true

      - name: Upload NC logs
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: nc_log_pgsql_${{ matrix.nextcloud }}_${{ matrix.python }}_${{ matrix.php-version }}
          path: data/nextcloud.log
          if-no-files-found: warn

  tests-oci:
    needs: [analysis]
    runs-on: ubuntu-22.04
    name: ${{ matrix.nextcloud }} • 🐘${{ matrix.php-version }} • 🐍${{ matrix.python }} • OCI
    strategy:
      fail-fast: false
      matrix:
          nextcloud: [ "27.0.0" ]
          python: [ "3.11" ]
          php-version: [ "8.2" ]

    services:
      oracle:
        image: ghcr.io/gvenzl/oracle-xe:11
        env:
          ORACLE_RANDOM_PASSWORD: true
          APP_USER: useroracle
          APP_USER_PASSWORD: userpassword
        options: >-
          --health-cmd healthcheck.sh
          --health-interval 10s
          --health-timeout 5s
          --health-retries 10
        ports:
          - 1521:1521/tcp

    steps:
      - name: Set up php
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php-version }}
          extensions: bz2, ctype, curl, dom, fileinfo, gd, iconv, intl, json, libxml, mbstring, \
            posix, session, simplexml, xmlreader, xmlwriter, zip, zlib, oci8

      - uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python }}

      - name: cache-nextcloud
        id: nextcloud_setup
        uses: actions/cache@v3
        with:
          path: nextcloud-${{ matrix.nextcloud }}.tar.bz2
          key: ${{ matrix.nextcloud }}

      - name: Download Nextcloud
        if: steps.nextcloud_setup.outputs.cache-hit != 'true'
        run: wget -q https://download.nextcloud.com/server/releases/nextcloud-${{ matrix.nextcloud }}.tar.bz2

      - name: Set up Nextcloud
        run: |
          tar -xjf nextcloud-${{ matrix.nextcloud }}.tar.bz2 --strip-components 1
          mkdir data
          php occ maintenance:install --verbose --database=oci --database-name=XE \
            --database-host=127.0.0.1 --database-port=1521 --database-user=useroracle --database-pass=userpassword \
            --admin-user admin --admin-pass ${{ env.NC_AUTH_PASS }}
          php occ config:system:set loglevel --value=1 --type=integer
          php occ config:system:set debug --value=true --type=boolean
          php occ config:system:set allow_local_remote_servers --value true
          php -S localhost:8080 &

      - name: Checkout NcPyApi
        uses: actions/checkout@v3
        with:
          path: nc_py_api

      - name: Install NcPyApi
        working-directory: nc_py_api
        run: python3 -m pip -v install ".[dev]"

      - name: Checkout AppEcosystemV2
        uses: actions/checkout@v3
        with:
          path: apps/app_ecosystem_v2
          repository: cloud-py-api/app_ecosystem_v2

      - name: Install AppEcosystemV2
        run: |
          patch -p 1 -i apps/app_ecosystem_v2/base_php.patch
          php occ app:enable app_ecosystem_v2
          cd nc_py_api
          coverage run --data-file=.coverage.ci_install tests/_install.py &
          echo $! > /tmp/_install.pid
          python3 tests/_install_wait.py http://127.0.0.1:$APP_PORT/heartbeat "\"status\":\"ok\"" 15 0.5
          python3 tests/_app_security_checks.py http://127.0.0.1:$APP_PORT
          cd ..
          php occ app_ecosystem_v2:daemon:register manual_install "Manual Install" manual-install 0 0 0
          php occ app_ecosystem_v2:app:register $APP_ID manual_install --json-info \
            "{\"appid\":\"$APP_ID\",\"name\":\"$APP_ID\",\"daemon_config_name\":\"manual_install\",\"version\":\"$APP_VERSION\",\"secret\":\"$APP_SECRET\",\"host\":\"localhost\",\"port\":$APP_PORT,\"protocol\":\"http\",\"system_app\":1}" \
            -e --force-scopes
          kill -15 $(cat /tmp/_install.pid)
          timeout 3m tail --pid=$(cat /tmp/_install.pid) -f /dev/null

      - name: Generate coverage report
        working-directory: nc_py_api
        run: coverage run --data-file=.coverage.ci -m pytest && coverage combine && coverage xml && coverage html
        env:
          SKIP_NC_WO_AE: 1

      - name: HTML coverage to artifacts
        uses: actions/upload-artifact@v3
        with:
          name: coverage_oci_${{ matrix.nextcloud }}_${{ matrix.python }}_${{ matrix.php-version }}
          path: nc_py_api/htmlcov
          if-no-files-found: error

      - name: Upload report to Codecov
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          file: nc_py_api/coverage.xml
          fail_ci_if_error: true
          verbose: true

      - name: Upload NC logs
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: nc_log_oci_${{ matrix.nextcloud }}_${{ matrix.python }}_${{ matrix.php-version }}
          path: data/nextcloud.log
          if-no-files-found: warn

  tests-latest:
    needs: [analysis]
    runs-on: ubuntu-22.04
    name: Latest • 🐘8.2 • 🐍3.12 • Maria

    services:
      mariadb:
        image: mariadb:11.0
        env:
          MARIADB_ROOT_PASSWORD: rootpassword
          MYSQL_DATABASE: nextcloud
          options: >-
            --health-cmd mysqladmin ping
            --health-interval 10s
            --health-timeout 5s
            --health-retries 5
        ports:
          - 3306:3306

    steps:
      - name: Set up php
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.2
          extensions: mbstring, fileinfo, intl, pdo_mysql, zip, gd, curl

      - uses: actions/setup-python@v4
        with:
          python-version: 3.11

      - name: Checkout server
        uses: actions/checkout@v3
        with:
          submodules: true
          repository: nextcloud/server
          ref: "master"

      - name: Set up & run Nextcloud
        env:
          DB_PORT: 4444
        run: |
          mkdir data
          ./occ maintenance:install --verbose --database=mysql --database-name=nextcloud \
            --database-host=127.0.0.1 --database-user=root --database-pass=rootpassword \
            --admin-user admin --admin-pass ${{ env.NC_AUTH_PASS }}
          ./occ config:system:set loglevel --value=0 --type=integer
          ./occ config:system:set debug --value=true --type=boolean
          ./occ config:system:set allow_local_remote_servers --value true
          php -S localhost:8080 &

      - name: Checkout NcPyApi
        uses: actions/checkout@v3
        with:
          path: nc_py_api

      - name: Install NcPyApi
        working-directory: nc_py_api
        run: python3 -m pip -v install ".[dev]"

      - name: Checkout AppEcosystemV2
        uses: actions/checkout@v3
        with:
          path: apps/app_ecosystem_v2
          repository: cloud-py-api/app_ecosystem_v2

      - name: Install AppEcosystemV2
        run: |
          patch -p 1 -i apps/app_ecosystem_v2/base_php.patch
          php occ app:enable app_ecosystem_v2
          cd nc_py_api
          coverage run --data-file=.coverage.ci_install tests/_install.py &
          echo $! > /tmp/_install.pid
          python3 tests/_install_wait.py http://127.0.0.1:$APP_PORT/heartbeat "\"status\":\"ok\"" 15 0.5
          python3 tests/_app_security_checks.py http://127.0.0.1:$APP_PORT
          cd ..
          php occ app_ecosystem_v2:daemon:register manual_install "Manual Install" manual-install 0 0 0
          php occ app_ecosystem_v2:app:register $APP_ID manual_install --json-info \
            "{\"appid\":\"$APP_ID\",\"name\":\"$APP_ID\",\"daemon_config_name\":\"manual_install\",\"version\":\"$APP_VERSION\",\"secret\":\"$APP_SECRET\",\"host\":\"localhost\",\"port\":$APP_PORT,\"protocol\":\"http\",\"system_app\":1}" \
            -e --force-scopes
          kill -15 $(cat /tmp/_install.pid)
          timeout 3m tail --pid=$(cat /tmp/_install.pid) -f /dev/null

      - name: Generate coverage report
        working-directory: nc_py_api
        run: coverage run --data-file=.coverage.ci -m pytest && coverage combine && coverage xml && coverage html

      - name: HTML coverage to artifacts
        uses: actions/upload-artifact@v3
        with:
          name: coverage_maria_latest
          path: nc_py_api/htmlcov
          if-no-files-found: error

      - name: Upload report to Codecov
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          file: nc_py_api/coverage.xml
          fail_ci_if_error: true
          verbose: true

      - name: Upload NC logs
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: nc_log_maria_latest
          path: data/nextcloud.log
          if-no-files-found: warn

  tests-sqlite:
    needs: [analysis]
    runs-on: ubuntu-22.04
    name: ${{ matrix.nextcloud }} • 🐘8.1 • 🐍3.11 • SQLite
    strategy:
      fail-fast: false
      matrix:
        nextcloud: [ 'stable26', 'stable27' ]
    env:
      NEXTCLOUD_URL: "http://localhost:8080/index.php"

    steps:
      - name: Set up php
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.1
          extensions: mbstring, fileinfo, intl, sqlite, pdo_sqlite, zip, gd, curl

      - uses: actions/setup-python@v4
        with:
          python-version: 3.11

      - name: Checkout server
        uses: actions/checkout@v3
        with:
          submodules: true
          repository: nextcloud/server
          ref: ${{ matrix.nextcloud }}

      - name: Set up & run Nextcloud
        env:
          DB_PORT: 4444
        run: |
          mkdir data
          ./occ maintenance:install --verbose --database=sqlite --database-name=nextcloud --database-host=127.0.0.1 \
            --database-port=$DB_PORT --database-user=root --database-pass=rootpassword \
            --admin-user admin --admin-pass ${{ env.NC_AUTH_PASS }}
          ./occ config:system:set loglevel --value=0 --type=integer
          ./occ config:system:set debug --value=true --type=boolean
          ./occ config:system:set allow_local_remote_servers --value true
          php -S localhost:8080 &

      - name: Checkout NcPyApi
        uses: actions/checkout@v3
        with:
          path: nc_py_api

      - name: Install NcPyApi
        working-directory: nc_py_api
        run: python3 -m pip -v install ".[dev]"

      - name: Checkout AppEcosystemV2
        uses: actions/checkout@v3
        with:
          path: apps/app_ecosystem_v2
          repository: cloud-py-api/app_ecosystem_v2

      - name: Install AppEcosystemV2
        run: |
          patch -p 1 -i apps/app_ecosystem_v2/base_php.patch
          php occ app:enable app_ecosystem_v2
          cd nc_py_api
          coverage run --data-file=.coverage.ci_install tests/_install.py &
          echo $! > /tmp/_install.pid
          python3 tests/_install_wait.py http://127.0.0.1:$APP_PORT/heartbeat "\"status\":\"ok\"" 15 0.5
          python3 tests/_app_security_checks.py http://127.0.0.1:$APP_PORT
          cd ..
          php occ app_ecosystem_v2:daemon:register manual_install "Manual Install" manual-install 0 0 0
          php occ app_ecosystem_v2:app:register $APP_ID manual_install --json-info \
            "{\"appid\":\"$APP_ID\",\"name\":\"$APP_ID\",\"daemon_config_name\":\"manual_install\",\"version\":\"$APP_VERSION\",\"secret\":\"$APP_SECRET\",\"host\":\"localhost\",\"protocol\":\"http\",\"port\":$APP_PORT,\"system_app\":1}" \
            -e --force-scopes
          kill -15 $(cat /tmp/_install.pid)
          timeout 3m tail --pid=$(cat /tmp/_install.pid) -f /dev/null

      - name: Generate coverage report
        working-directory: nc_py_api
        run: coverage run --data-file=.coverage.ci -m pytest && coverage combine && coverage xml && coverage html

      - name: HTML coverage to artifacts
        uses: actions/upload-artifact@v3
        with:
          name: coverage_sqlite_${{ matrix.nextcloud }}
          path: nc_py_api/htmlcov
          if-no-files-found: error

      - name: Upload report to Codecov
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          file: nc_py_api/coverage.xml
          fail_ci_if_error: true
          verbose: true

      - name: Upload NC logs
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: nc_log_sqlite_${{ matrix.nextcloud }}
          path: data/nextcloud.log
          if-no-files-found: warn