Skip to content
This repository was archived by the owner on May 8, 2023. It is now read-only.

Latest commit

 

History

History
112 lines (60 loc) · 2.68 KB

File metadata and controls

112 lines (60 loc) · 2.68 KB
layout doc
title Cli - Codeception - Documentation

Cli

Installation

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

{% highlight yaml %} composer require --dev codeception/module-cli

{% endhighlight %}

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

{% highlight yaml %} codecept init upgrade4

{% endhighlight %}

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 setting second parameter to false

{% highlight php %}

runShellCommand('phpunit'); // do not fail test when command fails $I->runShellCommand('phpunit', false); {% endhighlight %} * `param` $command * `param bool` $failNonZero #### seeInShellOutput Checks that output from last executed command contains text * `param` $text #### seeResultCodeIs Checks result code {% highlight php %} seeResultCodeIs(0); {% endhighlight %} * `param` $code #### seeResultCodeIsNot Checks result code {% highlight php %} seeResultCodeIsNot(0); {% endhighlight %} * `param` $code #### seeShellOutputMatches * `param` $regex

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference