opus4-repo/framework

Framework for Opus 4

OPUS 4 Framework Implementation

The project is using Composer for handling dependencies. The OPUS 4 Framework itself is a Composer package that is used by the OPUS 4 Application., _(*1)

The OPUS 4 Framework is written in PHP. It also uses Ant for scripting common development actions. The Ant script (build.xml) is used for automation by a continous integration system., _(*2)

Requirements

The system must meet the following basic requirements in order to run the unit tests:, _(*3)

• PHP < 7.2 (because of Zend Framework 1)
• MySQL > 5.1

Dependencies

The dependencies are declared in composer.json and can be downloaded automatically using, _(*4)

composer install

or, _(*5)

php composer.phar install

Now the necessary packages are automatically downloaded and installed in the vendor directory., _(*6)

For more information about Composer: https://getcomposer.org, _(*7)

The script bin/install-composer.sh can be used to automatically download composer.phar, so the most recent version can be used. Composer is also available in most Linux distributions., _(*8)

Running the Unit Tests

In order to run the unit tests you need to create database and a configuration for the framework., _(*9)

Creating the database

The database can be setup by executing the setup.sh script. It will create the configuration file and the database with the chosen database name., _(*10)

cd framework
./bin/setup.sh

The database schema can be created using the createdb.php script., _(*11)

ant create-database

The database access parameters are stored in tests/config.ini and needs to be configured with the correct user and database name., _(*12)

Configuring the Framework

This step is optional and needs to be executed only if the previous steps didn't work., _(*13)

The configuration file (tests/config.ini) can be created using the following command., _(*14)

cd tests
./configure.sh

The script will ask you for values for the placeholders in the configuration template file, tests/config.ini.template., _(*15)

Creating the workspace folders

The workspace directory for testing can be created using, _(*16)

ant prepare

Testing

Tests can be run using the Composer, _(*17)

composer test

or executing phpunit directly, _(*18)

vendor/bin/phpunit -c tests    

Coding Style

The basic formatting of the code can be checked automatically using, _(*19)

composer cs-check

Most basic styling errors can be fixed automatically using, _(*20)

composer cs-fix