From 8aa63b5e6d2ba4ad07424961416892412aafae60 Mon Sep 17 00:00:00 2001
From: withanage <dulip.withanage@gmail.com>
Date: Mon, 13 Nov 2023 04:28:59 +0100
Subject: [PATCH] Github action support

---
 .github/workflows/test.yml     | 133 +++++++++++++++++++++++++++++++++
 .github/workflows/upgrade.yml  | 116 ++++++++++++++++++++++++++++
 .github/workflows/validate.yml | 131 ++++++++++++++++++++++++++++++++
 3 files changed, 380 insertions(+)
 create mode 100644 .github/workflows/test.yml
 create mode 100644 .github/workflows/upgrade.yml
 create mode 100644 .github/workflows/validate.yml

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 00000000000..2b3024caa6d
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,133 @@
+name: test
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: '0 1 1 * *'
+env:
+  APPLICATION: '${{ github.event.repository.name }}'
+  DBUSERNAME: omp-ci
+  DBPASSWORD: omp-ci
+  DBNAME: omp-ci
+  DBHOST: 127.0.0.1
+  DATABASEDUMP: database.sql.gz
+  FILESDIR: files
+  FILESDUMP: files.tar.gz
+  CYPRESS_BASE_URL: http://127.0.0.1:8000
+  CYPRESS_DBNAME: omp-ci
+  CYPRESS_DBUSERNAME: omp-ci
+  CYPRESS_DBPASSWORD: omp-ci
+  CYPRESS_DBHOST: 127.0.0.1
+  CYPRESS_FILESDIR: files
+
+jobs:
+  install:
+    name: ${{matrix.pkp-application}}(BRANCH=${{matrix.pkp-branch}} ;PHP=${{matrix.php-versions}}; DB=${{matrix.dbs}})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: [ '8.1','8.2' ]
+        dbs: [ 'pgsql', 'mysql','mariadb']
+        pkp-application: ['${{ github.event.repository.name }}' ]
+        pkp-branch: [ '${{ github.head_ref || github.ref_name }}' ]
+    env:
+      DBTYPE: ${{matrix.dbs == 'pgsql' && 'PostgreSQL' || 'MySQLi'}}
+      CYPRESS_DBTYPE: ${{matrix.dbs=='pgsql' && 'PostgreSQL' || 'MySQLi'}}
+      TEST: ${{matrix.dbs}}
+
+    steps:
+      - name: install postgres server
+        if: ${{matrix.dbs == 'pgsql'}}
+        run: |
+          sudo apt install postgresql postgresql-contrib
+          sudo dpkg-reconfigure locales
+          sudo sed -i -E 's\peer|scram-sha-256\trust\g' /etc/postgresql/14/main/pg_hba.conf
+
+      - name: Install server
+        if: ${{matrix.dbs == 'mysql'}}
+        run: |
+          sudo apt install -q -y mysql-server mysql-client
+          sudo service mysql start
+          sudo mysqladmin -u root -p'root' password ''
+
+      - name: Install mariadb  server
+        if: ${{matrix.dbs == 'mariadb'}}
+        uses: ankane/setup-mariadb@v1
+        with:
+          mariadb-version: "10.11"
+
+      - name: Install ${{matrix.pkp-application}}
+        run: |
+          git clone -b ${{matrix.pkp-branch}} https://github.com/${{github.repository}} ~/${{matrix.pkp-application}}
+          cd ~/${{matrix.pkp-application}}
+          git submodule update --init --recursive
+      - name: Setup PHP, extensions and composer
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{matrix.php-versions}}
+          extensions: bcmath, bz2, common, cli, curl, fpm, gd, intl, mbstring, mysql,mysqlnd, mysqli, opcache, pdo_mysql, pgsql, json,soap, xml, zip
+          coverage: xdebug
+        env:
+          update: true
+
+      - name: Install composer dependencies
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          lib/pkp/tools/travis/install-composer-dependencies.sh
+          npm i g -npm && npm i @vue/cli-service && npm i cypress && npm install && npm run build
+
+      - name: Create additional directories
+        run: |
+          mkdir -p $HOME/bin
+
+      - name: Prepare tests
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          ./lib/pkp/tools/travis/prepare-webserver.sh
+          ./lib/pkp/tools/travis/prepare-tests.sh
+
+      - name: Run PHP web server
+        run: |
+          php -S 127.0.0.1:8000 -t . >& access.log &
+
+      - name: Run cypress data tests
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          npx cypress run --headless --browser chrome --config '{"specPattern":["cypress/tests/data/**/*.cy.js"]}'
+
+      - name: Run cypress pkp-lib integration tests
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          npx cypress run --headless --browser chrome --config '{"specPattern":["lib/pkp/cypress/tests/integration/**/*.cy.js"]}'
+
+      - name: Run cypress ${{matrix.pkp-application}} integration tests
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          if [ -d "cypress/tests/integration" ]; then
+            npx cypress run --headless --browser chrome --config '{"specPattern":["cypress/tests/integration/**/*.cy.js"]}'
+          fi
+
+      - name: Run ${{matrix.pkp-application}} unit tests
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          ./lib/pkp/tools/travis/dump-database.sh
+          ./lib/pkp/tools/runAllTests.sh -CcPpdR
+
+      - uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: Create cypess screenshots as artifacts
+          path: $HOME/${{ matrix.pkp-application}}/cypress/screenshots
+          if-no-files-found: ignore
+
+      - name: Show web access log
+        if: ${{ failure() }}
+        run: |
+          cd ~/${{ matrix.pkp-application }}
+          cat access.log
+
diff --git a/.github/workflows/upgrade.yml b/.github/workflows/upgrade.yml
new file mode 100644
index 00000000000..8920af64976
--- /dev/null
+++ b/.github/workflows/upgrade.yml
@@ -0,0 +1,116 @@
+name: upgrade
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: '0 1 1 * *'
+
+
+jobs:
+  install:
+    name: ${{matrix.pkp-application}}(VERSION=${{matrix.test-upgrade}}(DB=${{matrix.dbs}};)
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: [ '8.1','8.2' ]
+        dbs: [ 'pgsql', 'mysql' ]
+        pkp-application: [ '${{ github.event.repository.name }}' ]
+        test-upgrade: [ 'stable-3_4_0','stable-3_3_0','stable-3_2_1','stable-3_2_0' ]
+        pkp-branch: [ '${{ github.head_ref || github.ref_name }}' ]
+    env:
+      APPLICATION: '${{ github.event.repository.name }}'
+      DBTYPE: ${{matrix.dbs  == 'pgsql' && 'PostgreSQL' || 'MySQLi'}}
+      DBUSERNAME: omp-ci
+      DBPASSWORD: omp-ci
+      DBNAME: omp-ci
+      DBHOST: 127.0.0.1
+      FILESDIR: files
+      TEST: ${{matrix.dbs}}
+
+    steps:
+      - name: Install   ${{matrix.dbs}} server
+        if: ${{matrix.dbs == 'pgsql'}}
+        run: |
+          sudo apt install postgresql postgresql-contrib
+          sudo dpkg-reconfigure locales
+          sudo sed -i 's\peer\trust\g' /etc/postgresql/14/main/pg_hba.conf
+          sudo sed -i 's\scram-sha-256\trust\g' /etc/postgresql/14/main/pg_hba.conf
+
+      - name: Install   ${{matrix.dbs}} server
+        if: ${{matrix.dbs == 'mysql'}}
+        run: |
+          sudo apt install -q -y mysql-server mysql-client
+          sudo service mysql start
+          sudo mysqladmin -u root -p'root' password ''
+
+      - name: Install PKP Application
+        run: |
+          git clone -b ${{matrix.pkp-branch}} https://github.com/${{github.repository}} ~/${{matrix.pkp-application}}
+          cd ~/${{matrix.pkp-application}}
+          git submodule update --init --recursive
+
+      - name: Setup PHP, extensions and composer
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{matrix.php-versions}}
+          extensions: bcmath, bz2, common, cli, curl, fpm, gd, intl, mbstring, mysql,mysqlnd, mysqli, opcache, pdo_mysql,  pgsql, json,soap, xml, zip
+          coverage: xdebug
+        env:
+          update: true
+
+      - name: Install Composer Dependencies
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          lib/pkp/tools/travis/install-composer-dependencies.sh
+          npm i g -npm && npm i @vue/cli-service && npm i cypress && npm install && npm run build
+
+      - name: Start  ${{matrix.dbs}} server
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          ./lib/pkp/tools/travis/prepare-webserver.sh
+          ./lib/pkp/tools/travis/prepare-tests.sh
+
+
+      - name: Create folders
+        run: |
+          mkdir --parents ${FILESDIR}
+          mkdir --parents public
+
+      - name: upgrade from ${{matrix.test-upgrade}}  for  ${{matrix.dbs}}
+        if: ${{(matrix.php-versions == '8.2')  && (matrix.test-upgrade =='stable-3_4-0')}}
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          echo
+          git clone https://github.com/pkp/datasets
+          cp -r datasets/${APPLICATION}/${DATASET_BRANCH}/${TEST}/files/* files/
+          cp -r datasets/${APPLICATION}/${DATASET_BRANCH}/${TEST}/public/* public/
+          cp  datasets/${APPLICATION}/${DATASET_BRANCH}/${TEST}/config.inc.php .
+          ./datasets/tools/dbclient.sh < datasets/${APPLICATION}/${DATASET_BRANCH}/${TEST}/database.sql
+          php tools/upgrade.php check
+          php tools/upgrade.php upgrade
+        env:
+          DATASET_BRANCH: ${{matrix.test-upgrade}}
+          TEST: ${{matrix.dbs}}
+
+
+      - name: upgrade from ${{matrix.test-upgrade}}  for  ${{matrix.dbs}}
+        if: matrix.php-versions == '8.1'  && contains('["stable-3_2_0","stable-3_2_1","stable-3_3_0"]', matrix.test-upgrade)
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          git clone https://github.com/pkp/datasets
+          cp -r datasets/${APPLICATION}/${DATASET_BRANCH}/${TEST}/files/* files/
+          cp -r datasets/${APPLICATION}/${DATASET_BRANCH}/${TEST}/public/* public/
+          cp datasets/${APPLICATION}/${DATASET_BRANCH}/${TEST}/config.inc.php .
+          patch -p1 < datasets/upgrade/3_4_0-add-email-config.diff
+          patch -p1 < datasets/upgrade/3_4_0-update-locale.diff
+          ./datasets/tools/dbclient.sh < datasets/${APPLICATION}/${DATASET_BRANCH}/${TEST}/database.sql
+          php tools/upgrade.php check
+          php tools/upgrade.php upgrade
+        env:
+          DATASET_BRANCH: ${{matrix.test-upgrade}}
+          TEST: ${{matrix.dbs}}
diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
new file mode 100644
index 00000000000..6fea3020d88
--- /dev/null
+++ b/.github/workflows/validate.yml
@@ -0,0 +1,131 @@
+name: validate
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: '0 1 1 * *'
+env:
+  APPLICATION: '${{ github.event.repository.name }}'
+  DBUSERNAME: omp-ci
+  DBPASSWORD: omp-ci
+  DBNAME: omp-ci
+  DBHOST: 127.0.0.1
+  DATABASEDUMP: database.sql.gz
+  FILESDIR: files
+  FILESDUMP: files.tar.gz
+  CYPRESS_BASE_URL: http://127.0.0.1:8000
+  CYPRESS_DBNAME: omp-ci
+  CYPRESS_DBUSERNAME: omp-ci
+  CYPRESS_DBPASSWORD: omp-ci
+  CYPRESS_DBHOST: 127.0.0.1
+  CYPRESS_FILESDIR: files
+
+jobs:
+  install:
+    name: ${{matrix.pkp-application}}(BRANCH=${{matrix.pkp-branch}} ;PHP=${{matrix.php-versions}}; DB=${{matrix.dbs}})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: [ '8.1','8.2' ]
+        dbs: [ 'pgsql']
+        pkp-application: ['${{ github.event.repository.name }}' ]
+        pkp-branch: [ '${{ github.head_ref || github.ref_name }}' ]
+    env:
+      DBTYPE: ${{matrix.dbs == 'pgsql' && 'PostgreSQL' || 'MySQLi'}}
+      CYPRESS_DBTYPE: ${{matrix.dbs=='pgsql' && 'PostgreSQL' || 'MySQLi'}}
+      TEST: ${{matrix.dbs}}
+
+    steps:
+      - name: install postgres server
+        if: ${{matrix.dbs == 'pgsql'}}
+        run: |
+          sudo apt install postgresql postgresql-contrib
+          sudo dpkg-reconfigure locales
+          sudo sed -i -E 's\peer|scram-sha-256\trust\g' /etc/postgresql/14/main/pg_hba.conf
+
+      - name: Install server
+        if: ${{matrix.dbs == 'mysql'}}
+        run: |
+          sudo apt install -q -y mysql-server mysql-client
+          sudo service mysql start
+          sudo mysqladmin -u root -p'root' password ''
+
+      - name: Install mariadb  server
+        if: ${{matrix.dbs == 'mariadb'}}
+        uses: ankane/setup-mariadb@v1
+        with:
+          mariadb-version: "10.11"
+
+      - name: Install ${{matrix.pkp-application}}
+        run: |
+          git clone -b ${{matrix.pkp-branch}} https://github.com/${{github.repository}} ~/${{matrix.pkp-application}}
+          cd ~/${{matrix.pkp-application}}
+          git submodule update --init --recursive
+      - name: Setup PHP, extensions and composer
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{matrix.php-versions}}
+          extensions: bcmath, bz2, common, cli, curl, fpm, gd, intl, mbstring, mysql,mysqlnd, mysqli, opcache, pdo_mysql, pgsql, json,soap, xml, zip
+          coverage: xdebug
+        env:
+          update: true
+
+      - name: Install composer dependencies
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          lib/pkp/tools/travis/install-composer-dependencies.sh
+          npm i g -npm && npm i @vue/cli-service && npm i cypress && npm install && npm run build
+
+      - name: Create additional directories
+        run: |
+          mkdir -p $HOME/bin
+
+      - name: Install validation tools
+        run: |
+          set -e
+          sudo pip install six
+          sudo pip install https://github.com/google/closure-linter/zipball/master
+          wget "https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/jslint4java/jslint4java-2.0.2-dist.zip"
+          unzip jslint4java-2.0.2-dist.zip
+          mv jslint4java-2.0.2/jslint4java-2.0.2.jar ~/bin/jslint4java.jar
+
+      - name: Run XML validation
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          ./lib/pkp/tools/travis/validate-xml.sh
+
+      - name: Run Javascript/JSON validation
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          ./lib/pkp/tools/buildjs.sh -n
+          ./lib/pkp/tools/travis/validate-json.sh
+
+      - name: Run linting
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          npm run lint
+
+      - name: Run Documentation validation
+        run: |
+          cd ~/${{matrix.pkp-application}}
+          # Look for help filenames referred to in templates and check that they all exist (in English)
+          ERRORS=0
+          for filename in `find . -name \*.tpl -exec sed -n -e "s/.*{help[^}]file=\"\([^\"#]\+\)[#\"].*/\1/p" "{}" ";"`; do
+           if [ ! -f docs/manual/en/$filename.md ]; then
+             echo "Help file \"$filename.md\" referred to in template does not exist!"
+             ERRORS=1
+            fi
+          done
+          if [ $ERRORS -ne 0 ]; then
+            exit -1
+          fi
+          # Generate a quick report of the differences between the files listed in templates and the available files.
+          find . -name \*.tpl -exec sed -n -e "s/.*{help[^}]file=\"\([^\"]\+\)\".*/\1/p" "{}" ";" | sort | uniq > /tmp/template-help-references.txt
+          cat docs/manual/en/SUMMARY.md | sed -n -e "s/.*(\([^)]\+\))/\1/p" | sort | uniq > /tmp/help-files.txt
+          echo "Unreferenced help files:"
+          diff /tmp/template-help-references.txt /tmp/help-files.txt | grep -e "^>"