Merge pull request #340 from OPUS4/4.7

Release OPUS 4.7

Author: j3nsch

.github/workflows/php.yml

@@ -0,0 +1,50 @@
+name: PHP Composer
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-16.04
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Change to PHP7.0
+        run: sudo update-alternatives --set php /usr/bin/php7.0
+
+      - 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
+
+      - name: Install additional Software
+        run: sudo apt-get install libxml2-utils
+
+      - name: Solr
+        run: sudo bash bin/install_solr_docker.sh
+
+      - name: MySQL
+        run: sudo bash bin/install_mysql_docker.sh
+
+      - name: Prepare
+        run: ant prepare-workspace prepare-test-workspace prepare-javascript prepare-config lint reset-testdata -DdbUserPassword=root -DdbAdminPassword=root
+
+      - name: Mail-Server
+        run: php scripts/opus-smtp-dumpserver.php 2>&1 >> tests/workspace/log/opus-smtp-dumpserver.log &
+
+      - name: Coding-Style
+        run: php composer.phar cs-check
+      
+      - name: Test-library
+        run: php composer.phar test -- --testsuite library
+
+      - name: Test-modules
+        run: php composer.phar test -- --testsuite modules
+
+      - name: Test-admin
+        run: php composer.phar test -- --testsuite admin
+        
+      - name: Test-security
+        run: php composer.phar test -- --testsuite security
+
+      - name: Test-scripts
+        run: php composer.phar test -- --testsuite scripts

.gitignore

@@ -39,5 +39,6 @@ opus4-solr-jetty.conf
 
 # IDE files
 .idea
+out
 *.iml
 nbproject

.travis.yml

@@ -25,19 +25,28 @@ script:
   - mysql --version
   - java -version
   - ant -version
+  - travis_fold start "prepare_dependencies"
   - ant prepare-test-workspace prepare-workspace prepare-config -DdbUserName=root -DdbAdminName=root
-  - php db/createdb.php
-  - mysql opusdb -u root --password='' -e 'SELECT * FROM schema_version'
-  - ant download-solr -DsolrVersion=5.5.5
-  - cd solr-5.5.5
+  - ant download-solr -DsolrVersion=7.7.2 -DdownloadDir=$HOME/downloads
+  - cd solr-7.7.2
   - ./bin/solr start
   - ./bin/solr create -c opus4
   - cd server/solr/opus4/conf
   - rm -f managed-schema schema.xml solrconfig.xml
-  - ln -s ../../../../../vendor/opus4-repo/search/schema-5.xml schema.xml
-  - ln -s ../../../../../vendor/opus4-repo/search/solrconfig-5.xml solrconfig.xml
+  - ln -s "$TRAVIS_BUILD_DIR/vendor/opus4-repo/search/conf/schema.xml" schema.xml
+  - ln -s "$TRAVIS_BUILD_DIR/vendor/opus4-repo/search/conf/solrconfig.xml" solrconfig.xml
   - cd ../../../../
   - ./bin/solr restart
   - cd ..
+  - travis_fold end "prepare_dependencies"
+  - travis_fold start "prepare_testing"
   - ant reset-testdata
-  - ./vendor/bin/phpunit --configuration ./tests/phpunit.xml ./tests/modules
+  - travis_fold end "prepare_testing"
+  - mysql opusdb -u root --password='' -e 'SELECT * FROM schema_version'
+  - composer cs-check
+  - ./vendor/bin/phpunit --configuration ./tests/phpunit.xml --no-coverage --testsuite library
+  - ./vendor/bin/phpunit --configuration ./tests/phpunit.xml --no-coverage --testsuite modules
+  - ./vendor/bin/phpunit --configuration ./tests/phpunit.xml --no-coverage --testsuite admin
+  - ./vendor/bin/phpunit --configuration ./tests/phpunit.xml --no-coverage --testsuite security
+  - php ./scripts/opus-smtp-dumpserver.php 2>&1 >>./opus-smtp-dumpserver.log &
+  - ./vendor/bin/phpunit --configuration ./tests/phpunit.xml --no-coverage --testsuite scripts

CHANGES.md

@@ -0,0 +1,37 @@
+FROM ubuntu:16.04
+
+# Add opus4 user, because in the Jenkinsfile we are root. Some tests dont work with root, so we need to start them with opus4-user
+RUN useradd opus4
+
+# The parts of the script are combined by &&. If something changes, always the update of the system is done, to find new packages or versions.
+# Update Ubuntu
+RUN apt-get update\
+
+# Install system-packages
+&& apt-get install -y debconf-utils\
+    composer\
+    curl\
+    openjdk-8-jdk\
+    wget\
+    unzip\
+    ant\
+    apache2\
+    libxml2-utils\
+    libapache2-mod-php7.0\
+    sudo \
+
+# Install PHP
+&& apt-get install -y php\
+    php-cli\
+    php-dev\
+    php-mbstring\
+    php-mysql\
+    php-curl\
+    php-gd\
+    php-common\
+    php-intl\
+    php-zip\
+    php-uuid\
+    php-xsl\
+    php-log\
+    php-mcrypt

Dockerfile

@@ -1,26 +1,134 @@
-#!groovy
+// Jenkinsfile for the application
 
+// Define the project name and the build type. A short build dispenses with coverage, since coverage is very time-consuming
+def jobNameParts = JOB_NAME.tokenize('/') as String[]
+def projectName = jobNameParts[0]
+def buildType = "short"
+
+// If the project has "night" in its name and the master branch or the development branch is present, the build is defined as a long build
+if (projectName.contains('night') && (env.BRANCH_NAME == '4.7' || env.BRANCH_NAME == 'master')) {
+    buildType = "long"
+}
 pipeline {
-    agent any
+    /*
+    Agent (location where the pipeline is executed) is the docker file.
+    This must have root privileges, because MySQL and Solr must be installed.
+    Also, creating a docker on the server requires root privileges.
+    Furthermore, the docker socket of the server must be connected to the docker socket of the docker.
+    */
+    agent { dockerfile {args "-u root -v /var/run/docker.sock:/var/run/docker.sock"}}
+    environment {XML_CATALOG_FILES = "${WORKSPACE}/tests/resources/opus4-catalog.xml"}
+
+    /*
+    A long build will not be built on every commit because of the long duration, but will be time-triggered.
+    Coverage takes so long that it is only built once a week for the development branch and the master branch
+    */
+    triggers {
+        cron( buildType.equals('long') ? 'H 21 * * 5' : '')
+    }
 
     stages {
-        stage('prepare') {
+        stage('Composer') {
+            steps {
+                // Update Operating system
+                sh 'sudo apt-get update'
+
+                // Install and update Composer. Additionally install dependencies of OPUS4-Application
+                sh 'curl -s http://getcomposer.org/installer | php && php composer.phar self-update && php composer.phar install'
+            }
+        }
+
+        stage('Install Solr') {
+            steps {
+                sh 'sudo bash bin/install_solr_docker.sh'
+            }
+        }
+
+        stage('Install MySQL') {
+            steps {
+                sh 'sudo bash bin/install_mysql_docker.sh'
+            }
+        }
+
+        stage('Prepare Opus4') {
             steps {
-                echo 'TODO - Configure database'
-                echo 'TODO - Configure Solr core'
+                // Prepare OPUS4 with ant using standard passwords (only test-system)
+                sh 'ant prepare-workspace prepare-test-workspace prepare-javascript prepare-config lint -DdbUserPassword=root -DdbAdminPassword=root'
+
+                // Install XDebug with Pecl -> Using apt-get would install a old version
+                sh 'pecl install xdebug-2.8.0 && echo "zend_extension=/usr/lib/php/20151012/xdebug.so" >> /etc/php/7.0/cli/php.ini'
+
+                // Install Mail-Server for mailing-tests
+                sh 'php ${WORKSPACE}/scripts/opus-smtp-dumpserver.php 2>&1 >> ${WORKSPACE}/tests/workspace/log/opus-smtp-dumpserver.log &'
+                sh 'chown -R opus4:opus4 .'
             }
         }
 
-        stage('build') {
+        stage('Analyse') {
             steps {
-                echo 'TODO - Run unit tests'
+                script{
+                   sh 'php composer.phar analysis'
+                }
             }
         }
 
-        stage('publish') {
+        stage('Test') {
             steps {
-                echo 'TODO - Publish results'
+                script{
+                    sh 'ant reset-testdata'
+                    if (buildType == 'long'){
+                        sh 'php composer.phar test-coverage'
+                    } else {
+                        sh 'php composer.phar test'
+                    }
+                }
             }
         }
     }
+
+    post {
+        always {
+            /*
+            For the cleanup the entire workspace is deleted.
+            This reduces the server load, since Jenkins does not track the workspaces unnecessarily.
+            It may be possible to turn off tracking, but I couldn't find an option.
+            Jenkins must have permissions to delete the workspaces.
+            */
+            sh "chmod -R 777 ."
+
+            // Publishing test-results (unit-tests)
+            step([
+                $class: 'JUnitResultArchiver',
+                testResults: 'build/phpunit.xml'
+            ])
+
+            // Publishing checkstyle-results (coding-style)
+            step([
+                $class: 'hudson.plugins.checkstyle.CheckStylePublisher',
+                pattern: 'build/checkstyle.xml'
+            ])
+
+            // Publishing CPD-results (find duplicated code-fragments)
+            step([
+                $class: 'hudson.plugins.dry.DryPublisher',
+                pattern: 'build/pmd-cpd.xml'
+            ])
+
+            // Publishing PMD-results (static codeanalysis)
+            step([
+                $class: 'hudson.plugins.pmd.PmdPublisher',
+                pattern: 'build/pmd.xml'
+            ])
+
+            // Publishing coverage-report if exists
+            step([
+                $class: 'CloverPublisher',
+                cloverReportDir: 'build',
+                cloverReportFileName: 'clover.xml"'
+            ])
+
+            // Cleanup
+            step([$class: 'WsCleanup', externalDelete: 'rm -rf *'])
+        }
+    }
 }

Jenkinsfile

@@ -7,26 +7,46 @@ redevelopment that was created as part of a DFG ([Deutsche Forschungsgemeinschaf
 Since then the development has been continued at KOBV ([Kooperativer Bibliotheksverbund Berlin-Brandenburg][KOBV])
 mostly.
 
-## OPUS 4 at GitHub
+## OPUS 4.7-RC (Release Candidate)
 
-In 2015 the development was moved to GitHub in order to better support collaboration in the continued development
-efforts. The first OPUS 4 version developed at GitHub is 4.5. Starting with this version OPUS 4 should be installed
-using Git, since this will make updates for bug fixes and new features easier. More information can be found online.
+The release candidate should be used to test updating OPUS 4 instances and giving feedback to the developers 
+[here][ISSUES] or using the OPUS 4 [tester mailing list][OPUSTESTER]. Thank you very much!
+
+The release candidate is available on the [4.7-RC][BRANCH47RC] branch.
+
+Depending on the level of customization of your instance the update might require some work. A lot of files were 
+changed and the list of new features and modifications is long.   
+
+We are still working on a number of issues before we can release the final version of OPUS 4.7. Here some of the 
+most important points.
+
+- Configuration of search facettes for enrichments 
+- Translation management in Setup area of administration
+- Update issues (?)
+- Documentation is outdated and needs to be updated (especially customizing translations)
 
-The current version of OPUS is 4.5. It is available using the 4.5 tag and on the master branch. The master branch 
-will be updated for releases or if urgent bugs have been fixed.
+## Current Version - OPUS 4.6.3
+
+The current version of OPUS 4 is 4.6.3. It is available on the [master][MASTER] branch. 
 
 [Documentation][DOC]
 : Information on setting up a repository, for users and administrators.
 
 [Developers][DEVDOC]
 : Information for developers.
 
+## OPUS 4 at GitHub
+
+In 2015 the development was moved to GitHub in order to better support collaboration in the continued development
+efforts. The first OPUS 4 version developed at GitHub is 4.5. Starting with this version OPUS 4 should be installed
+using Git, since this will make updates for bug fixes and new features easier. More information can be found online.
+
 ## Previous (non-GitHub) Version:
 
 The last non-Git release of OPUS 4 is Version 4.4.5 and can be [downloaded][OPUS445] from the
 [OPUS 4 Homepage][OPUS4] as a tarball. The [documentation][OPUS445DOC] for this version can
-be found there as well.
+be found there as well. This version is no longer supported. 
+
 Version 4.4.5 can be installed without Git. It is recommended to use the GitHub version of
 OPUS 4 for setting up new repositories. However if you are looking at migrating an existing OPUS 3
 repository to OPUS 4 using this version would currently be a necessary step since there is at the moment
@@ -39,3 +59,7 @@ no working migration script for the Git version.
 [DFG]: http://www.dfg.de
 [OPUS445]: https://www.kobv.de/entwicklung/software/opus-4/download/
 [OPUS445DOC]: https://www.kobv.de/entwicklung/software/opus-4/dokumentation/
+[OPUSTESTER]: http://listserv.zib.de/mailman/listinfo/kobv-opus-tester/
+[ISSUES]: http://github.com/OPUS4/application/issues
+[BRANCH47RC]: https://github.com/OPUS4/application/tree/4.7-RC
+[MASTER]: https://github.com/OPUS4/application/tree/master