https://github.com/kiwitcms/phpunit-plugin
PHPUnit plugin for Kiwi TCMS
https://github.com/kiwitcms/phpunit-plugin
Last synced: over 1 year ago
JSON representation
PHPUnit plugin for Kiwi TCMS
- Host: GitHub
- URL: https://github.com/kiwitcms/phpunit-plugin
- Owner: kiwitcms
- License: gpl-3.0
- Created: 2018-12-05T15:58:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T21:26:04.000Z (over 1 year ago)
- Last Synced: 2024-10-30T05:42:04.288Z (over 1 year ago)
- Language: PHP
- Homepage: https://kiwitcms.org
- Size: 118 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PHPUnit plugin for Kiwi TCMS
[](https://travis-ci.org/kiwitcms/phpunit-plugin)
[](https://tidelift.com/subscription/pkg/packagist-kiwitcms-phpunit-plugin?utm_source=packagist-kiwitcms-phpunit-plugin&utm_medium=github&utm_campaign=readme)
[](https://opencollective.com/kiwitcms#contributors)
[](https://twitter.com/KiwiTCMS)
## Configuration and environment
#### 1. Install package
The preferred method of installation is via [`Composer`](https://getcomposer.org/). Run the following
command to install the package and add it as a requirement to your project's
`composer.json`:
```
composer require kiwitcms/phpunit-plugin
```
#### 2. Create `~/.tcms.conf` with the following contents:
```
[tcms]
url =
username =
password =
product =
product_version =
build =
```
The filename `~/.tcms.conf` is expanded to something like `/home/tcms-bot/.tcms.conf` on Linux
and `C:\Users\tcms-bot\.tcms.conf` on Windows, where tcms-bot is the username on the local computer.
It’s also possible to provide system-wide config in `/etc/tcms.conf`, which is valid only on Linux!
On Windows it would be `C:\tcms.conf`.
Execute the following command to find the exact location on your system:
```
php configFilePath.php
```
Set the appropriate values.
You can set all of them as environment variables (config file values have precedence):
```
TCMS_API_URL =
TCMS_USERNAME =
TCMS_PASSWORD =
TCMS_PRODUCT =
TCMS_PRODUCT_VERSION =
TCMS_BUILD =
TCMS_RUN_ID =
```
#### 3. Add listener configuration to phpunit.xml
```
```
### Other
If the product, product version or build do no exist, they will be created.
A new test run and test plan will be created on each run. You can set `run_id` in the config file or `TCMS_RUN_ID` env var, if you want to update a single run.
### License
Distributed under the terms of the [`GNU GPL v3.0`](http://www.gnu.org/licenses/gpl-3.0.txt) license, "kiwitcms/phpunit-plugin" is free and open source software
### Issues
If you encounter any problems, please [file an issue](https://github.com/kiwitcms/phpunit-plugin/issues) along with a detailed description.