typisttech/codeception-composer-project-module

Create throw away composer projects for Codeception tests

0.1.2 2020-12-06 21:54 UTC

Requires

• php: ^7.3 || ^8.0
• spatie/temporary-directory: ^1.3

Requires (Dev)

• codeception/codeception: ^4.1
• codeception/module-asserts: ^1.3
• codeception/module-cli: ^1.1
• codeception/module-filesystem: ^1.0
• squizlabs/php_codesniffer: ^3.5

MIT

• Typist Tech
• Tang Rufus

• testing
• BDD
• composer
• TDD
• codeception-module

README

Codeception Composer Project Module

Create throw away composer projects for Codeception tests.

Built with ♥ by Typist Tech

Codeception Composer Project Module is an open source project and completely free to use.

However, the amount of effort needed to maintain and develop new features is not sustainable without proper financial backing. If you have the capability, please consider donating using the links below:

Create throw away composer projects for Codeception tests.

Why?

Because it's good to test your composer plugins in a more realistic environment.

The Goals, or What This Module Does?

Create throw away composer projects for Codeception tests.

Before each test:

• Copy dummy composer project files to a temporary directory
• Config local packages paths
• Install package via composer
• Change directory into the temporary directory

After each test:

• Delete the temporary directory

Install

composer require --dev typisttech/codeception-composer-project-module

Config

In your Codeception config file (e.g: acceptance.suite.yml or acceptance.yml):

This is the minimal config:

modules:
    enabled:
        - ComposerProject:
            projectRoot: 'path/to/composer/project'
            depends:
                - Cli
                - Filesystem

This is the full config:

modules:
    enabled:
        - ComposerProject:
            projectRoot: 'path/to/composer/project'
            composerInstallFlags: '--no-interaction --quiet'
            symlink: 'true'
            repositoryPaths:
                - 'tests/_data/dummy'
                - 'tests/_data/another-dummy'
            depends:
                - Cli
                - Filesystem

projectRoot

Required String

Example: tests/_data/project

Path to the composer project directory, relative to the root directory (where codeception.yml is located). This directory must contain a composer.json file.

composerInstallFlags

Optional String

Example: --no-interaction --verbose --no-ansi

Default: --no-interaction --quiet

Extra flags to pass in during composer install.

See: $ composer help install

symlink

Optional Boolean in single quotes

Example: 'false'

Default: 'true'

Should the local packages be symlink-ed or not.

See: Composer document

repositoryPaths

Optional Array of strings

Example:

- 'tests/_data/dummy'
- 'tests/_data/another-dummy'

Default: The root directory (where codeception.yml is located).

Paths to local packages, relative to the root directory (where codeception.yml is located).

See: Composer document

Typist Tech is ready to build your next awesome WordPress site. Hire us!

API

amInTmpProjectDir

Change directory to the temporary project directory

• @return void

Example:

$I->amInTmpProjectDir();

runComposerCommand

Run a composer command

• @param string $command
• @param bool $failNonZero Optional. Default: true Fails If exit code is > 0.
• @return void

Example:

// This is equivalent to running `$ composer update --verbose` in the console.
$I->runComposerCommand('update --verbose');

runComposerInstall

Run composer install with composerInstallFlags

• @return void

Example:

$I->runComposerInstall();

getTmpProjectDir()

Get the path to the temporary project directory

Note: Return value maybe a symbolic link.

• @return string

Example:

$I->getTmpProjectDir();

// To ensure real path:
$tmpProjectDir = $I->getTmpProjectDir();
$tmpProjectDir = realpath($tmpProjectDir);

Frequently Asked Questions

Which composer versions are supported?

Both v1 and v2.

I want to see what Codeception Composer Project Module have done for me?

Run the tests with the --debug flag.

Codeception Composer Project Module will log debug message to the console.

What to do when composer install fail or not install the latest version?

Your requirements could not be resolved to an installable set of packages.

Make sure you have package version constraints and minimum stability set up correctly.

{
    "require": {
        "dummy/dummy": "*"
    },
    "minimum-stability": "dev"
}

What to do when the tests are too slow?

• Enable symlink
• Add --prefer-dist to composerInstallFlags
• Add "prefer-stable": true to composer.json

Note: These methods are not suitable for every use case.

Do you have real life examples that use this composer plugin?

Here you go:

• Imposter Plugin

Add your own here

Will you add support for older PHP versions?

Never! This plugin will only work on actively supported PHP versions.

Don't use it on end of life or security fixes only PHP versions.

It looks awesome. Where can I find some more goodies like this

• Articles on Typist Tech's blog
• Tang Rufus' WordPress plugins on wp.org
• More projects on Typist Tech's GitHub profile
• Stay tuned on Typist Tech's newsletter
• Follow Tang Rufus' Twitter account
• Hire Tang Rufus to build your next awesome site

Where can I give 5-star reviews?

Thanks! Glad you like it. It's important to let me knows somebody is using this project. Please consider:

• tweet something good with mentioning @TangRufus
• ★ star the Github repo
• 👀 watch the Github repo
• write tutorials and blog posts
• hire Typist Tech

Testing

composer test
composer style:check

Feedback

Please provide feedback! We want to make this project as useful as possible. Please submit an issue and point out what you do and don't like, or fork the project and send pull requests. No issue is too small.

Security Vulnerabilities

If you discover a security vulnerability within this project, please email us at [e-mail]. All security vulnerabilities will be promptly addressed.

Credits

Codeception Composer Project Module is a Typist Tech project and maintained by Tang Rufus, freelance developer for hire.

Full list of contributors can be found here.

License

Codeception Composer Project Module is released under the MIT License.