Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.84 KB

developer.md

File metadata and controls

49 lines (31 loc) · 1.84 KB

Developer information

This document contains information about ARC2 internals which are relevant for maintaining and extending ARC2.

Run test environment

To run test environment execute:

make test

Tests are split into different groups, currently:

  • unit
  • db_adapter_depended

You can run the unit group directly, but you need to set some environment variables for db_adapter_depended. For more information please have a look into our Makefile.

config.php

Currently, we use the following standard db credentials to connect with the database:

$dbConfig = array(
    'db_name' => 'testdb',
    'db_user' => 'root',
    'db_pwd'  => '',
    'db_host' => '127.0.0.1',
);

The is used in the travis environment. If you have different credentials, copy the tests/config.php.dist to tests/config.php and set your credentials.

Editor

Please make sure your editor uses our .editorconfig file.

Docker setup

For ARC2 developers we recommend this following Docker setup. It provides a pre-configured set of software (for PHP, DBS etc.) and allows quick switches between different software versions.

No matter if one needs a MariaDB 10.3 with PHP 7.2 or a PHP 5.6 with MySQL 5.7.0. If there is a docker container, it runs.

Docker and Travis

We use a very wide range of software-combinations to test ARC2 (Travis). Currently, all combinations of major versions of PHP and database systems (currently MySQL and MariaDB only) are checked.

Using a Docker setup for local development allows to switch the backend very easily. So, if a test with a certain DBS/PHP version combination fails on travis, its very likely that you can reproduce it locally. Dont forget to run composer update after a switch to make sure appropriate software is used.