X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README.md;h=c71e0f654968fb185a72e30b94b59832492142fe;hb=81718c9d09a3be92fe37fa0ed0f2254d5e65eeb2;hp=63cece5688bbbbdb80613c5b2402ea9ab8eb6e38;hpb=8da25b8f417af37d783289c118c798f034c9f9fb;p=plcapi.git diff --git a/README.md b/README.md index 63cece5..c71e0f6 100644 --- a/README.md +++ b/README.md @@ -33,19 +33,36 @@ If you are upgrading from version 3 or earlier you have two options: In any case, read carefully the docs in [doc/api_changes_v4.md](doc/api_changes_v4.md) and report back any undocumented issue using GitHub. +Running tests +------------- + +The recommended way to run the library test suite is via the provided Docker containers. +A handy shell script is available that simplifies usage of Docker. + +The full sequence of operations is: + + ./tests/ci/vm.sh build + ./tests/ci/vm.sh start + ./tests/ci/vm.sh runtests + ./tests/ci/vm.sh stop + + # and, once you have finished all testing related work: + ./tests/ci/vm.sh cleanup + +By default tests are run using php 7.0 in a Container based on Ubuntu 16 Xenial. +You can change the version of PHP and Ubuntu in use by setting the environment variables PHP_VERSION and UBUNTU_VERSION +before building the Container. + +To generate the code-coverage report, run `./tests/ci/vm.sh runcoverage` + License ------- Use of this software is subject to the terms in the [license.txt](license.txt) file -SSL-certificate ---------------- -The passphrase for the rsakey.pem certificate is 'test'. - [![License](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/license)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) [![Latest Stable Version](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/v/stable)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) [![Total Downloads](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/downloads)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) -[![Build Status](https://travis-ci.com/gggeek/phpxmlrpc.svg)](https://travis-ci.org/gggeek/phpxmlrpc) -[![Test Coverage](https://codeclimate.com/github/gggeek/phpxmlrpc/badges/coverage.svg)](https://codeclimate.com/github/gggeek/phpxmlrpc) -[![Code Coverage](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/badges/coverage.png?b=php53)](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/?branch=php53) +[![Build Status](https://travis-ci.com/gggeek/phpxmlrpc.svg)](https://travis-ci.com/gggeek/phpxmlrpc) +[![Code Coverage](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/badges/coverage.png)](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc)