Search

Cli

Installation

If you use Codeception installed using composer, install this module with the following command:

composer require --dev codeception/module-cli

Alternatively, you can enable Cli module in suite configuration file and run

codecept init upgrade4

This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
Some modules are bundled with PHAR files.
Warning. Using PHAR file and composer in the same project can cause unexpected errors.

Description

Wrapper for basic shell commands and shell output

Responsibility

Please review the code of non-stable modules and provide patches if you have issues.

Actions

dontSeeInShellOutput

Checks that output from latest command doesn’t contain text

  • param $text

runShellCommand

Executes a shell command. Fails if exit code is > 0. You can disable this by passing false as second argument

<?php
$I->runShellCommand('phpunit');

// do not fail test when command fails
$I->runShellCommand('phpunit', false);
  • param $command
  • param bool $failNonZero

seeInShellOutput

Checks that output from last executed command contains text

  • param $text

seeResultCodeIs

Checks result code. To verify a result code > 0, you need to pass false as second argument to runShellCommand()

<?php
$I->seeResultCodeIs(0);
  • param $code

seeResultCodeIsNot

Checks result code

<?php
$I->seeResultCodeIsNot(0);
  • param $code

seeShellOutputMatches

  • param $regex

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference
Don't know how to write tests on your own? We will build or improve them for you. Request a quote for official enterprise support or trainings