Merge pull request #1109 from OPUS4/issue1108

Solr 9.x support with PHP 8

.github/workflows/php.yml

@@ -16,18 +16,18 @@ jobs:
 
     strategy:
       matrix:
-        php-versions: ['7.1','8.1']
+        versions: [{php: '7.1', solr: '7.7.3'}, {php: '8.1', solr: '9.3.0'}]
       fail-fast: false
 
-    name: PHP ${{ matrix.php-versions }} Test
+    name: PHP ${{ matrix.versions.php }} Test
 
     steps:
       - uses: actions/checkout@v3
 
-      - name: Setup PHP ${{ matrix.php-versions }}
+      - name: Setup PHP ${{ matrix.versions.php }}
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php-versions }}
+          php-version: ${{ matrix.versions.php }}
 
       - name: Install Composer and Dependencies
         run: sudo apt-get update && curl -s http://getcomposer.org/installer | php && php composer.phar self-update && php composer.phar install
@@ -38,8 +38,8 @@ jobs:
       - name: Install additional Software
         run: sudo apt-get install libxml2-utils
 
-      - name: Solr
-        run: sudo bash bin/install_solr_docker.sh
+      - name: Install Solr ${{ matrix.versions.solr }}
+        run: sudo bash tests/bin/install_solr_docker.sh --version ${{ matrix.versions.solr }}
 
       - name: Start MySQL
         run: sudo systemctl start mysql.service
@@ -54,7 +54,7 @@ jobs:
         run: ant prepare-workspace prepare-test-workspace
 
       - name: Setup config
-        run: ant prepare-config lint -DdbUserPassword=root -DdbAdminPassword=root -DphpVersion=${{ matrix.php-versions }}
+        run: ant prepare-config lint -DdbUserPassword=root -DdbAdminPassword=root -DphpVersion=${{ matrix.versions.php }}
 
       - name: Setup testdata
         run: ant reset-testdata

Jenkinsfile

@@ -40,13 +40,13 @@ pipeline {
 
         stage('Install Solr') {
             steps {
-                sh 'sudo bash bin/install_solr_docker.sh'
+                sh 'sudo bash tests/bin/install_solr_docker.sh'
             }
         }
 
         stage('Install MySQL') {
             steps {
-                sh 'sudo bash bin/install_mysql_docker.sh'
+                sh 'sudo bash tests/bin/install_mysql_docker.sh'
             }
         }
 

Vagrantfile

@@ -61,12 +61,14 @@ $solr = <<SCRIPT
 cd /home/vagrant
 mkdir -p "downloads"
 cd downloads
-SOLR_TAR="solr-7.7.2.tgz"
+SOLR_TAR="solr-$SOLR_VERSION.tgz"
 if test ! -f "$SOLR_TAR"; then
-  wget "https://archive.apache.org/dist/lucene/solr/7.7.2/$SOLR_TAR"
+  SOLR_URL="https://archive.apache.org/dist/solr/solr/$SOLR_VERSION/$SOLR_TAR"
+  echo "Getting: $SOLR_URL"
+  wget -q --show-progress --progress=bar:force $SOLR_URL
 fi
 tar xfz "$SOLR_TAR" -C /home/vagrant
-cd /home/vagrant/solr-7.7.2
+cd /home/vagrant/solr-$SOLR_VERSION
 mkdir -p server/solr/opus4/conf
 echo name=opus4 > server/solr/opus4/core.properties
 cd server/solr/opus4/conf/
@@ -122,6 +124,7 @@ fi
 if ! grep "PATH=/vagrant/bin" /home/vagrant/.bashrc > /dev/null; then
   echo "export PATH=/vagrant/bin:$PATH" >> /home/vagrant/.bashrc
 fi
+# Increase limits for Apache Solr
 if ! grep "vagrant hard" /etc/security/limits.conf > /dev/null; then
   echo "vagrant hard nofile 65535" >> /etc/security/limits.conf
   echo "vagrant soft nofile 65535" >> /etc/security/limits.conf
@@ -132,7 +135,7 @@ SCRIPT
 
 $start = <<SCRIPT
 sudo service apache2 reload
-cd /home/vagrant/solr-7.7.2
+cd /home/vagrant/solr-$SOLR_VERSION
 ./bin/solr start
 SCRIPT
 
@@ -152,17 +155,19 @@ Vagrant.configure("2") do |config|
   config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1"
   config.vm.network "forwarded_port", guest: 8983, host: 9983, host_ip: "127.0.0.1"
 
+  ENV['SOLR_VERSION']="9.3.0"
+
   config.vm.provision "Install required software...", type: "shell", inline: $software
   config.vm.provision "Install pandoc...", type: "shell", inline: $pandoc
   config.vm.provision "Install fonts...", type: "shell", inline: $fonts
   config.vm.provision "Install Composer dependencies...", type: "shell", privileged: false, inline: $composer
-  config.vm.provision "Install Apache Solr...", type: "shell", privileged: false, inline: $solr
+  config.vm.provision "Install Apache Solr...", type: "shell", privileged: false, inline: $solr, env: {"SOLR_VERSION" => ENV['SOLR_VERSION']}
   config.vm.provision "Create database...", type: "shell", inline: $database
   config.vm.provision "Configure OPUS 4...", type: "shell", privileged: false, inline: $opus
   config.vm.provision "Setup site in Apache2...", type: "shell", inline: $apache
   config.vm.provision "Fix permissions...", type: "shell", inline: $fix
   config.vm.provision "Setup environment...", type: "shell", inline: $environment
-  config.vm.provision "Start services...", type: "shell", privileged: false, run: "always", inline: $start
+  config.vm.provision "Start services...", type: "shell", privileged: false, run: "always", inline: $start, env: {"SOLR_VERSION" => ENV['SOLR_VERSION']}
   config.vm.provision "Initialize test data...", type: "shell", privileged: false, inline: $testdata
   config.vm.provision "Information", type: "shell", privileged: false, run: "always", inline: $help
 end

composer.json

@@ -24,7 +24,7 @@
     "jpgraph/jpgraph": "dev-master",
     "opus4-repo/opus4-common": "dev-master as 4.8.1",
     "opus4-repo/framework": "dev-master as 4.8.1",
-    "opus4-repo/search": ">4.7.2",
+    "opus4-repo/search": "4.7.3.x-dev || 4.8.1.x-dev",
     "opus4-repo/opus4-bibtex": "^4.8",
     "opus4-repo/opus4-import": "^4.8",
     "opus4-repo/opus4-pdf": "^4.8",

tests/bin/install_solr_docker.sh

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+
+#
+# Script to install Solr. By default, version 9.3.0 will be installed.
+# Another Solr version can be specified using the `--version` option.
+
+script_name="$(basename "$0")"
+
+# Define variables and their default values
+version="9.3.0"
+
+# Parse command line options
+while [ $# -gt 0 ]; do
+    if [[ $1 == "--"* ]]; then # only deal with long options
+        if [[ -n "$2" && $2 != "-"* ]]; then # ignore options without a value
+            # Create variable name from option name
+            v="${1/--/}" # uses parameter expansion removing '--'
+
+            # Read option value into variable
+            declare "$v"="$2"
+
+            # Process next option
+            shift
+        fi
+    fi
+    shift
+done
+
+# Download Solr version
+if [[ "$version" =~ ^[1-8]\.[0-9]+\.[0-9]+$ ]]; then
+  SOLR_VERSION="$version"
+  ant download-solr -DsolrVersion=$SOLR_VERSION -DdownloadDir=./downloads
+elif [[ "$version" =~ ^(9|[1-9][0-9]+)\.[0-9]+\.[0-9]+$ ]]; then # new archive URL for versions >9.0.0
+  SOLR_VERSION="$version"
+  SOLR_URL="https://archive.apache.org/dist/solr/solr/$SOLR_VERSION/solr-$SOLR_VERSION.tgz"
+  echo "Getting: $SOLR_URL"
+  wget -q $SOLR_URL -O - | tar -xz
+else
+  echo "Unrecognized version number"
+  echo -e "The --version option requires a 3-digit version number, e.g.: 9.3.0"
+  exit 1
+fi
+
+# Configure & start Solr
+cd solr-$SOLR_VERSION
+./bin/solr start -force
+./bin/solr create -c opus4 -force
+cd server/solr/opus4/conf/
+rm -f managed-schema schema.xml solrconfig.xml
+ln -s ../../../../../vendor/opus4-repo/search/conf/schema.xml schema.xml
+ln -s ../../../../../vendor/opus4-repo/search/conf/solrconfig.xml solrconfig.xml
+cd ../../../../
+./bin/solr restart -force
+cd ..