Qase-phpunit - Qase TMS PHPUnit reporter.

Qase TMS

Last update: Nov 24, 2022

Related tags

Testing php phpunit tms reporter qase

Overview

Qase TMS PHPUnit reporter

Publish results simple and easy.

How to integrate

composer require qase/phpunit-reporter

Example of usage

The PHPUnit reporter has the ability to auto-generate test cases and suites from your test data.

But if necessary, you can independently register the ID of already existing test cases from TMS before the executing tests. For example:

/**
 * @qaseId 3
 */
public function testCanBeUsedAsString(): void
{
    $this->assertEquals(
        '[email protected]',
        Email::fromString('[email protected]')
    );
}

You should also have an active item in the project settings at

https://app.qase.io/project/QASE_PROJECT_CODE/settings/options

options in the Test Runs block:

Auto create test cases

and

Allow submitting results in bulk

To run tests and create a test run, execute the command:

$ ./vendor/bin/phpunit

A test run will be performed and available at:

https://app.qase.io/run/QASE_PROJECT_CODE

Using parameterization

PHPUnit reporter also allows you to perform parameterization of the test case. To do this, you need to specify a dataprovider. Example:

    /**
     * @dataProvider additionProvider
     */
    public function testUsingProvider($a, $b, $expected)
    {
        $this->assertSame($expected, $a + $b);
    }

    public function additionProvider()
    {
        return [
            [0, 0, 0],
            [0, 1, 1],
            [1, 0, 1],
            [1, 1, 3]
        ];
    }

Configuration

Add to your phpunit.xml extension:

<extensions>
  <extension class="Qase\PHPUnit\Reporter"/>
</extensions>

Reporter options (* - required):

QASE_REPORT - toggles sending reports to Qase.io, set 1 to enable
*QASE_API_TOKEN - access token, you can find more information here.
*QASE_PROJECT_CODE - code of your project (can be extracted from main page of your project, as example, for https://app.qase.io/project/DEMO -> DEMO is project code here.
QASE_API_BASE_URL - URL endpoint API from Qase TMS, default is https://api.qase.io/v1.
QASE_RUN_ID - allows you to use an existing test run instead of creating new.
QASE_RUN_COMPLETE - performs the "complete" function after passing the test run.

The configuration file should be called phpunit.xml, an example of such a file:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
  <extensions>
    <extension class="Qase\PHPUnit\Reporter"/>
  </extensions>
  <testsuites>
    <testsuite name="qase-phpunit">
      <directory>./tests</directory>
    </testsuite>
  </testsuites>
  <php>
    <env name="QASE_REPORT" value="1"/>
    <env name="QASE_PROJECT_CODE" value="project_code"/>
    <env name="QASE_API_BASE_URL" value="https://api.qase.io/v1"/>
    <env name="QASE_API_TOKEN" value="api_key"/>
    <env name="QASE_RUN_COMPLETE" value="1"/>
    <env name="QASE_RUN_ID"/>
  </php>
</phpunit>

Comments

Utils v2.0.0 support
This PR contains qase/php-client-utils update to v2.0.0. It resolves the following Issues:

[ ] qase-tms/qase-phpunit#32

[ ] qase-tms/qase-phpunit#33

[ ] qase-tms/qase-phpunit#34 (the above issues have been resolved in Utils)
opened by in4s 1
#28 step 1 logging/debug option added
How to test:

git clone https://github.com/in4s/qase-phpunit.git cd qase-phpunit/example git checkout logging_debug_option_support composer install --prefer-dist

Then make changes to the config file: examples/phpunit.xml And run tests: php vendor/bin/phpunit

I guess it needs to be tested only three things:

Config with <env name="QASE_LOGGING" value="1"/>

Config with <env name="QASE_LOGGING" value="0"/>

Config without <env name="QASE_LOGGING" value="1"/> line

Variants 1 and 3 should show the reporter log in console, as usual. 2nd variant should not show the reporter log. But all three variants should send data to Qase.
opened by in4s 1
Add support logging/debug option
It needs to add an option logging to hide the information about the process of passing tests. Example in readme JS reporter: https://github.com/qase-tms/qase-javascript/tree/master/qase-playwright

AC:

update readme
opened by 1ivliev 1
Add support for auto create defect
Needs adding support to auto create defects when a test fails by setting defect to true in Qase test results.

Addition information: https://developers.qase.io/reference/create-result-bulk Field defect (type boolean)

Example feature in JS -> https://github.com/qase-tms/qase-javascript/pull/248

AC:

update readme

create unit tests
opened by 1ivliev 1
Issue with arg QASE_RUN_COMPLETE

If you use a new test run and set QASE_RUN_COMPLETE=0 (or skip entering this parameter), the run will still close, but if you put it into a previously created one, then the option works correctly. We need to separate the application of this argument. If you specify type = 0, the run should not be closed.
bug

opened by 1ivliev 0
Add support for create custom run name

Must be transmitted through a variable - QASE_RUN_NAME. In case of absence, print a standard inscription. Need to update the documentation with examples, add unit tests.

opened by 1ivliev 0
Add support for custom run description

Must be transmitted through a variable - QASE_RUN_DESCRIPTION. In case of absence, print a standard inscription - PHPUnit automated run. Need to update the documentation with examples, add unit tests.

opened by 1ivliev 0

Owner

Qase TMS

Test case management software for Dev and QA teams

GitHub https://developers.qase.io

Mockery - Designed as a drop in alternative to PHPUnit's phpunit-mock-objects library

Mockery Mockery is a simple yet flexible PHP mock object framework for use in unit testing with PHPUnit, PHPSpec or any other testing framework. Its c

10.3k Jan 1, 2023

The most powerful and flexible mocking framework for PHPUnit / Codeception.

AspectMock AspectMock is not an ordinary PHP mocking framework. With the power of Aspect Oriented programming and the awesome Go-AOP library, AspectMo

777 Dec 12, 2022

Mockery is a simple yet flexible PHP mock object framework for use in unit testing with PHPUnit, PHPSpec or any other testing framework. Its core goal is to offer a test double framework with a succinct API capable of clearly defining all possible object operations and interactions using a human readable Domain Specific Language (DSL).

Mockery Mockery is a simple yet flexible PHP mock object framework for use in unit testing with PHPUnit, PHPSpec or any other testing framework. Its c

10.3k Jan 1, 2023

:computer: Parallel testing for PHPUnit

ParaTest The objective of ParaTest is to support parallel testing in PHPUnit. Provided you have well-written PHPUnit tests, you can drop paratest in y