soundasleep/component-tests

There is no license information available for the latest version (0.2.1) of this package.

Common Composer and PHP component lint and validation tests

Maintainers

Details

github.com/soundasleep/component-tests

Source

Issues

Installs: 8 444

Dependents: 32

Suggesters: 0

Security: 0

Stars: 0

Watchers: 4

Forks: 2

Open Issues: 0

0.2.1 2022-01-15 23:47 UTC

Requires

Unknown License b696dde14d8ebf98d1f0f2034e61daea60fd70da

This package is auto-updated.

Last update: 2024-11-16 06:28:27 UTC

README

Common Composer and PHP component lint and validation tests.

Tests

  1. Check that all .json files are valid JSON (using json_decode)
  2. Check that all .php files are valid PHP (using php -l)
  3. Check that all composer.json files are valid according to the Composer JSON-schema
  4. Check that all PHP files that use require() etc. use __DIR__ in the path
  5. Check that all PHP files that use require() etc. refer to files that actually exist

Using

First include component-tests as a requirement in your project composer.json, and run composer update to install it into your project:

{
  "require": {
    "soundasleep/component-tests": "~0.2"
  }
}

Now create an instance of \ComponentTests\ComponentTest to define which paths to search (and optionally exclude):

class MyComponentTest extends \ComponentTests\ComponentTest {

  function getRoots() {
    return array(__DIR__ . "/..");
  }

  /**
   * Optional: exclude certain paths
   */
  function getExcludes() {
    return array("/resources/", "/vendor/");
  }
}

You can now run this test through your normal phpunit.

Tests

This component is tested itself; install the composer requirements with composer install and run vendor/bin/phpunit.