christophwurst/nextcloud_testing

Simple and fast unit and integration testing framework for Nextcloud, based on PHPUnit

Nextcloud Testing

Simple and fast unit and integration testing framework for Nextcloud 25+, based on PHPUnit, _(*1)

Features * Minimal setUp/tearDown overhead for unit tests * Simple trait-based mechanism to reset database after integration tests * Based on PHPUnit, _(*2)

Unit Tests

Use TestCase as base class for your test case:, _(*3)

<?php

use ChristophWurst\Nextcloud\Testing\TestCase;

class ControllerTest extends TestCase {

    … your test code …

}

Integration Tests

Include the DatabaseTransaction trait in your test case and any changes to the database will be rolled back after each test:, _(*4)

<?php

use ChristophWurst\Nextcloud\Testing\DatabaseTransaction;
use ChristophWurst\Nextcloud\Testing\TestCase;

class ControllerTest extends TestCase {

    use DatabaseTransaction;

    … your test code …

}

Selenium Tests

Include the Selenium trait in your test case and access the Webdriver instance via $this->webDriver:, _(*5)

<?php

use ChristophWurst\Nextcloud\Testing\Selenium;
use ChristophWurst\Nextcloud\Testing\TestCase;

class ControllerTest extends TestCase {

    use Selenium;

    public function testWithSelenium() {
        …

        $this->webDriver->get('http://localhost:8080/index.php/login');

        …
    }

}

This framework targets Sauce Labs as testing back-end that runs the test browser instances. Hence, it is necessary to set the SAUCE_USERNAME and SAUCE_ACCESS_KEY env variables. SELENIUM_BROWSER lets you choose the browser to run your tests against., _(*6)

Test Users

Include the TestUser trait in your test case to conveniently generate new test users. The trait will create a new user with a random UID (including collision detection)., _(*7)

<?php

use ChristophWurst\Nextcloud\Testing\TestCase;
use ChristophWurst\Nextcloud\Testing\TestUser;

class ControllerTest extends TestCase {

    use TestUser;

    public function testWithSelenium() {
        …

        $user = $this->createTestUser();

        …
    }

}

The returned user is of type IUser. You can read its UID with $user->getUID(). Note that the user is not removed after the test., _(*8)