README

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.

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 continuous integration system.

Dependencies

The dependencies are declared in composer.json and can be downloaded automatically using

composer install

or

php composer.phar install

Now the necessary packages are automatically downloaded and installed in the vendor directory.

For more information about Composer: https://getcomposer.org

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.

Running the Unit Tests

In order to run the unit tests you need to create database and a configuration for the framework.

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.

cd framework
./bin/setup.sh

The database schema can be created using the createdb.php script.

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.

Configuring the Framework

This step is optional and needs to be executed only if the previous steps didn't work.

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

cd tests
./configure.sh

The script will ask you for values for the placeholders in the configuration template file, tests/config.ini.template.

Creating the workspace folders

The workspace directory for testing can be created using

ant prepare

Testing

Tests can be run using the Composer

composer test

or executing phpunit directly

vendor/bin/phpunit -c tests    

Coding Style

The basic formatting of the code can be checked automatically using

composer cs-check

Most basic styling errors can be fixed automatically using

composer cs-fix