https://github.com/atoum/sfatoumplugin

atoum plugin for symfony 1.4
https://github.com/atoum/sfatoumplugin

atoum-extension php symfony1 symphony

Last synced: about 2 months ago
JSON representation

atoum plugin for symfony 1.4

• Host: GitHub
• URL: https://github.com/atoum/sfatoumplugin
• Owner: atoum
• Created: 2011-09-17T20:25:13.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2012-12-01T11:44:19.000Z (about 12 years ago)
• Last Synced: 2024-03-25T21:15:13.895Z (9 months ago)
• Topics: atoum-extension, php, symfony1, symphony
• Language: PHP
• Homepage:
• Size: 132 KB
• Stars: 7
• Watchers: 10
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
# *sfAtoumPlugin*

##Install

### Using composer

Add this to you dependencies in your composer.json ([example](https://gist.github.com/3006430)) : 

```

  "require"     : {

    "atoum/sfAtoumPlugin": "*"

  },

```

After a 

`php composer.phar update`

The plugin should be in the plugin folder and atoum in the vendor folder.

Then in your ProjectConfiguration file you have to activate the plugin and define the atoum path.

``` php

  sfConfig::set('sf_atoum_path', dirname(__FILE__) . '/../vendor/atoum/atoum');

  if (sfConfig::get('sf_environment') != 'prod')

  {

    $this->enablePlugins('sfAtoumPlugin');

  }

```

### Using a git submodule

Install atoum as a submodule

`git submodule add git://github.com/atoum/atoum.git lib/vendor/atoum`

Install sfAtoumPlugin as a git submodule

`git submodule add git://github.com/agallou/sfAtoumPlugin.git plugins/sfAtoumPlugin`

Add the plugin in your ProjectConfiguration file

``` php

  if (sfConfig::get('sf_environment') != 'prod')

  {

    $this->enablePlugins('sfAtoumPlugin');

  }

```

##Launch tests

`php symfony atoum:test`

You can pass a configuration file (see here for how to write the configuration file : https://github.com/atoum/atoum/wiki/atoum-et-Jenkins-(ou-Hudson) )

via the -c option :

`php symfony atoum:test -c config/atoum/hudson.php`

All atoum options are available :

```

 ./symfony help atoum:test

Usage:

 symfony atoum:test [-p|--php[="..."]] [--default-report-title[="..."]] [-c|--configurations[="..."]] [--score-file[="..."]] [--max-children-number[="..."]] [--no-code-coverage] [--no-code-coverage-in-directories[="..."]] [--no-code-coverage-for-namespaces[="..."]] [--no-code-coverage-for-classes[="..."]] [-f|--files[="..."]] [-d|--directories[="..."]] [--test-file-extensions[="..."]] [-g|--glob[="..."]] [--tags[="..."]] [-m|--methods[="..."]] [--namespaces[="..."]] [-l|--loop] [--test-it[="..."]] [--test-all[="..."]] [--force-terminal[="..."]] [--bootstrap-file[="..."]] [--use-light-report[="..."]] [--debug[="..."]]

Arguments:

 test-file-or-dir        path to test files or folders

Options:

 --php                              (-p) Path to PHP binary which must be used to run tests (default: Array(    [0] => /usr/bin/php5)) (multiple values allowed)

 --default-report-title             Define default report title with  (multiple values allowed)

 --configurations                   (-c) Use all configuration files  (multiple values allowed)

 --score-file                       Save score in file  (multiple values allowed)

 --max-children-number              Maximum number of sub-processus which will be run simultaneously (multiple values allowed)

 --no-code-coverage                 Disable code coverage

 --no-code-coverage-in-directories  Disable code coverage in directories  (multiple values allowed)

 --no-code-coverage-for-namespaces  Disable code coverage for namespaces  (multiple values allowed)

 --no-code-coverage-for-classes     Disable code coverage for classes  (multiple values allowed)

 --files                            (-f) Execute all unit test files  (multiple values allowed)

 --directories                      (-d) Execute unit test files in all  (default: Array(    [0] => /var/www/ereservation/test/unit/)) (multiple values allowed)

 --test-file-extensions             Execute unit test files with one of extensions  (multiple values allowed)

 --glob                             (-g) Execute unit test files which match  (multiple values allowed)

 --tags                             Execute only unit test with tags  (multiple values allowed)

 --methods                          (-m) Execute all , * may be used as wildcard for class name or method name (multiple values allowed)

 --namespaces                       Execute all classes in all namespaces  (multiple values allowed)

 --loop                             (-l) Execute tests in an infinite loop

 --test-it                          Execute atoum unit tests (multiple values allowed)

 --test-all                         Execute unit tests in directories defined via $script->addTestAllDirectory('path/to/directory') in a configuration file (multiple values allowed)

 --force-terminal                   Force output as in terminal (multiple values allowed)

 --bootstrap-file                   Include  before executing each test method (multiple values allowed)

 --use-light-report                 Use "light" CLI report (multiple values allowed)

 --debug                            Enable debug mode (multiple values allowed)

```

##Write tests

tests must include the bootstrap

``` php

require_once __DIR__ . '/../../../../plugins/sfAtoumPlugin/bootstrap/unit.php';

```

##Atoum

Atoum repository and documentation are available here : 

https://github.com/atoum/atoum