npm install grunt-phpunit-runner> A phpunit runner that works
~0.4.5If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
``shell`
npm install grunt-phpunit-runner --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-phpunit-runner');
to the data object passed into grunt.initConfig().`js
grunt.initConfig({
'phpunit-runner': {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
}
}
});
`Phpunit currently doesn't support individual files to deal with.
bridges that gap... sort of.$3
#### Specifying a test folder
`js
grunt.initConfig({
'phpunit-runner': {
all: {
options: {
phpunit: 'vendor/bin/phpunit'
},
testFolder: 'tests/'
}
}
});
`##### Specifying multiple folders
You can specify multiple folders. That will result in running phpunit as many times
as number of folders you have.
js
grunt.initConfig({
'phpunit-runner': {
all: {
options: {
phpunit: 'vendor/bin/phpunit'
},
testFolder1: 'tests1/',
testFolder2: 'tests2/'
}
}
});
`#### Specifying unittests
js
grunt.initConfig({
'phpunit-runner': {
all: {
options: {
phpunit: 'vendor/bin/phpunit'
},
testName: 'tests/testName.php'
}
}
});
`
Again, you can specify as many as you'd like$3
The options more or less mimic
's configuration parameters.> There are 2 special cases however, the
options.extraParameters and the
options.phpIni#### options.extraParameters
Type:
If you want to pass through something that
doesn't support
Whatever you'd add in the command line, like:
`js
extraParameters: [
'--a-new-option',
'--another-option'
]
`#### options.phpIni
Type:
For
's -d flag.`js
phpIni: {
'parameter':'value',
'flag': ''
}
`
will translate to #### options.coverageClover
Type:
The equivalent of
's --coverage-clover option#### options.coverageCrap4j
Type:
stringThe equivalent of
's --coverage-crap4j option#### options.coverageHtml
Type:
stringThe equivalent of
's --coverage-html option#### options.coveragePhp
Type:
stringThe equivalent of
's --coverage-php option#### options.coverageText
Type:
stringThe equivalent of
's --coverage-text option#### options.coverageXml
Type:
stringThe equivalent of
's --coverage-xml option#### options.logJunit
Type:
stringThe equivalent of
's --log-junit option#### options.logTap
Type:
stringThe equivalent of
's --log-tap option#### options.logJson
Type:
stringThe equivalent of
's --log-json option#### options.testdoxHtml
Type:
stringThe equivalent of
's --testdox-html option#### options.testdoxText
Type:
stringThe equivalent of
's --testdox-text option#### options.configuration
Type:
stringThe equivalent of
's --configuration option#### options.bootstrap
Type:
stringThe equivalent of
's --bootstrap option#### options.filter
Type:
stringThe equivalent of
's --filter option#### options.testsuite
Type:
stringThe equivalent of
's --testsuite option#### options.group
Type:
stringThe equivalent of
's --group option#### options.excludeGroup
Type:
stringThe equivalent of
's --exclude-group option#### options.listGroups
Type:
booleanThe equivalent of
's --list-groups option#### options.testSuffix
Type:
stringThe equivalent of
's --test-suffix option#### options.reportUselessTests
Type:
booleanThe equivalent of
's --report-useless-tests option#### options.strictCoverage
Type:
booleanThe equivalent of
's --strict-coverage option#### options.strictGlobalState
Type:
booleanThe equivalent of
's --strict-global-state option#### options.disallowTestOutput
Type:
booleanThe equivalent of
's --disallow-test-output option#### options.enforecTimeLimit
Type:
booleanThe equivalent of
's --enforce-time-limit option#### options.disallowTodoTests
Type:
booleanThe equivalent of
's --disallow-todo-tests option#### options.processIsolation
Type:
booleanThe equivalent of
's --process-isolation option#### options.noGlobalsBackup
Type:
booleanThe equivalent of
's --no-globals-backup option#### options.staticBackup
Type:
booleanThe equivalent of
's --static-backup option#### options.columns
Type:
stringThe equivalent of
's --columns option#### options.stderr
Type:
booleanThe equivalent of
's --stderr option#### options.stopOnError
Type:
booleanThe equivalent of
's --stop-on-error option#### options.stopOnFailure
Type:
booleanThe equivalent of
's --stop-on-failure option#### options.stopOnRisky
Type:
booleanThe equivalent of
's --stop-on-risky option#### options.stopOnSkipped
Type:
booleanThe equivalent of
's --stop-on-skipped option#### options.stopOnIncomplete
Type:
booleanThe equivalent of
's --stop-on-incomplete option#### options.verbose
Type:
booleanThe equivalent of
's --verbose option#### options.debug
Type:
booleanThe equivalent of
's --debug option#### options.loader
Type:
stringThe equivalent of
's --loader option#### options.repeat
Type:
stringThe equivalent of
's --repeat option#### options.tap
Type:
booleanThe equivalent of
's --tap option#### options.testdox
Type:
booleanThe equivalent of
's --testdox option#### options.printer
Type:
stringThe equivalent of
's --printer option#### options.noConfiguration
Type:
booleanThe equivalent of
's --no-configuration option#### options.includePath
Type:
stringThe equivalent of
's --include-path option#### options.version
Type:
booleanThe equivalent of
's --version option
$3
#### Good Options
An example how to generate test and coverage reports
`js
grunt.initConfig({
'phpunit-runner': {
complete: {
options: {
phpunit: 'vendor/bin/phpunit',
logJunit: 'reports/unit.xml',
coverageClover: 'reports/coverage.xml',
colors: true
},
files: {
testFiles: 'tests/'
}
}
}
}
});
`#### Fast Options
This is a config that runs very fast, and could be used in a
config for example`js
grunt.initConfig({
'phpunit-runner': {
fast: {
options: {
phpunit: 'vendor/bin/phpunit',
colors: true
},
files: {
testFiles: 'tests/'
}
}
}
}
});
``