Skip to content
This repository has been archived by the owner on May 25, 2022. It is now read-only.

Latest commit

 

History

History
87 lines (56 loc) · 3.51 KB

run.md

File metadata and controls

87 lines (56 loc) · 3.51 KB
Raw

The run command

The run command is the main command of JoliCi. It create and prepare the differents environments (jobs) and execute the command on every one.

Workflow

Creating environments

An environment is created when a build strategy is detected on your project, this can be as simple as parsing a .travis.yml file or more complex by reading a `.jolici directory

Each environment will be prepared in a temporary directory so this will never modify your project (no need to add a line in your .gitignore file)

Building environment

An environment is simply a docker image build with a Dockerfile, which can be generated for you when using TravisCi strategy or using your own with JoliCi strategy

Starting services

Before running test, JoliCi will try to launch services determined by your configuration file (only on TravisCi for the moment), in order to have mysql, memcached, elasticsearch... services available for your tests.

Each service will start from a clean state, data is not keeped.

For the moment, services are not host in the test container but run in a separate container. To use them you need to set the correct host name for the service on your different configuration files.

The hostname for each service is the same as the service name, so i.e. connecting to mysql can be done like that in your test container :

mysql -u travis -h mysql

Also be aware that services are only available during the script execution, any action using a service before the script will fail (like creating the schema in the install part).

Elimination of this two downsides are currently the focus for the next releases.

Running test

Once the environment is ready, JoliCi will run your test command on it and display the output directly on your console.

Exit code

If all test on each environment is successful (return 0 for exit code), jolici will return as well 0 for exit code. Otherwise it will return the number of failing tests.

Cleaning

JoliCi try to do his best to keep disk space as low as possible without decreasing speed. In order to do this it will delete all files related to an environment at the exception of the last run so we can use his cache.

Default command:

php jolici.phar run

The default command will run test for each environments created, this will only output the result of the test command. If you want to see the output of the build process (like TravisCi) you can run this command with a verbose option:

php jolici.phar run -v

## Options

Here is a list of options you can pass to the clean command:

  • --project-path DIRECTORY / -p DIRECTORY: Set the root path (DIRECTORY) of your project, use current directory as a default
  • --keep NUMBER / -k NUMBER: How many versions (NUMBER) of images, containers and / or build directories should be clean after running test (default to 1)
  • --no-cache: Use this option if you don't want to use the cache from the last build
  • --timeout TIMEOUT / -t TIMEOUT: This is the timeout, in seconds, for the run command, it allows to aborting test if a command hangs up forever (default to 5 minutes)
  • --notify: Use this option to display desktop notifications for each job

Overriding test command

If one more argument is present there will be considered as the command line for running test, for example to see the php version of an environment created by JoliCi you can do the following command:

php jolici.phar run php -v