backend-tests.yml

name: "Backend tests"

# any branch is useful for testing before a PR is submitted
on: [push, pull_request]

jobs:
  withplugins:
    # run on pushes to any branch
    # run on PRs from external forks
    if: |
      (github.event_name != 'pull_request')
      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
    name: with Plugins
    runs-on: ubuntu-latest

    steps:
      -
        name: Install libreoffice
        run: |
          sudo add-apt-repository -y ppa:libreoffice/ppa
          sudo apt update
          sudo apt install -y --no-install-recommends libreoffice libreoffice-pdfimport
      -
        name: Install etherpad core
        uses: actions/checkout@v4
        with:
          repository: ether/etherpad-lite
      -
        name: Checkout plugin repository
        uses: actions/checkout@v4
        with:
          path: ./node_modules/__tmp
      -
        name: Determine plugin name
        id: plugin_name
        run: |
          cd ./node_modules/__tmp
          npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
      -
        name: Rename plugin directory
        run: |
          mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
        env:
          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
      -
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: 'npm'
          cache-dependency-path: |
            src/package-lock.json
            src/bin/doc/package-lock.json
            node_modules/${{ steps.plugin_name.outputs.plugin_name }}/package-lock.json
      - run: npm install npm@6.14.18 -g
        name: Install legacy npm for correct dependency resolution
      -
        name: Install plugin dependencies
        run: |
          cd ./node_modules/"${PLUGIN_NAME}"
          npm ci
        env:
          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
      # Etherpad core dependencies must be installed after installing the
      # plugin's dependencies, otherwise npm will try to hoist common
      # dependencies by removing them from src/node_modules and installing them
      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
      # to be buggy, because it sometimes removes dependencies from
      # src/node_modules but fails to add them to the top-level node_modules.
      # Even if npm correctly hoists the dependencies, the hoisting seems to
      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
      # rules.
      -
        name: Install Etherpad core dependencies
        run: src/bin/installDeps.sh
      -
        name: Run the backend tests
        run: cd src && npm test