Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guillaumefalourd/assert-command-line-output
Github Action to assert / check a command line output 🕵️⚙️🖥
https://github.com/guillaumefalourd/assert-command-line-output
all-os-supported assert cli command-line github-actions hacktoberfest utilities
Last synced: 2 months ago
JSON representation
Github Action to assert / check a command line output 🕵️⚙️🖥
- Host: GitHub
- URL: https://github.com/guillaumefalourd/assert-command-line-output
- Owner: GuillaumeFalourd
- License: apache-2.0
- Created: 2021-06-18T13:41:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T11:40:53.000Z (3 months ago)
- Last Synced: 2024-10-12T14:38:33.292Z (3 months ago)
- Topics: all-os-supported, assert, cli, command-line, github-actions, hacktoberfest, utilities
- Homepage: https://github.com/marketplace/actions/assert-command-line-output
- Size: 104 KB
- Stars: 18
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Assert Command Line Output
[](https://github.com/search?o=desc&q=GuillaumeFalourd+assert-command-line-output+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code) [](https://github.com/GuillaumeFalourd/check-command-line-output/actions/workflows/ubuntu_test_command_output.yml) [](https://github.com/GuillaumeFalourd/assert-command-line-output/actions/workflows/macos_test_command_output.yml) [](https://github.com/GuillaumeFalourd/assert-command-line-output/actions/workflows/windows_test_command_output.yml)
Github Action to assert / check a command line output 🕵️⚙️🖥
This action allows to compare a _command line output_ (success or error) with a _file content_ located on the repository, or to check if it contains a specific _expression_.
---
## 📚 Usage
### How does the action work?
### Requirements
⚠️ The [`actions/checkout`](https://github.com/marketplace/actions/checkout) is mandatory to use this action, as it will be necessary to access the repository files, or to access the command line output file after the action execution.
☞ _Note: This action gathers the logic from the [command-output-file-action](https://github.com/GuillaumeFalourd/command-output-file-action) and the [diff-action](https://github.com/GuillaumeFalourd/diff-action)_.
---
## ♻️ Scenarios
### `1️⃣ Assert file content`
#### Expecting command output to be EQUAL to `assert.txt` file content
```yaml
steps:
- uses: actions/checkout@v4
- uses: GuillaumeFalourd/[email protected]
with:
command_line: ls -lha
assert_file_path: path/to/assert.txt
expected_result: PASSED
```
#### Expecting command output to be DIFFERENT than the `assert.txt` file content
```yaml
steps:
- uses: actions/checkout@v4
- uses: GuillaumeFalourd/[email protected]
with:
command_line: ls -lha
assert_file_path: path/to/assert.txt
expected_result: FAILED
```
### `2️⃣ Assert specific file line`
#### Expecting command output line 3 to be EQUAL than the `assert.txt` file content in line 3
```yaml
steps:
- uses: actions/checkout@v4
- uses: GuillaumeFalourd/[email protected]
with:
command_line: ls -lha
assert_file_path: path/to/assert.txt
expected_result: PASSED
specific_line: 3
```
#### Expecting command output line 3 to be DIFFERENT than the `assert.txt` file content in line 3
```yaml
steps:
- uses: actions/checkout@v4
- uses: GuillaumeFalourd/[email protected]
with:
command_line: ls -lha
assert_file_path: path/to/assert.txt
expected_result: FAILED
specific_line: 3
```
### `3️⃣ Assert specific expression`
#### Expecting command output to contain specific expression
```yaml
steps:
- uses: actions/checkout@v4
- uses: GuillaumeFalourd/[email protected]
with:
command_line: ls -lha
contains: runner
expected_result: PASSED
```
#### Expecting command output NOT to contain specific expression
```yaml
steps:
- uses: actions/checkout@v4
- uses: GuillaumeFalourd/[email protected]
with:
command_line: ls -lha
contains: error
expected_result: FAILED
```
### `4️⃣ Multiple-line commands`
The assert may fail while using multiple-line commands. When this is necessary, use single quotes `'`.
```yaml
steps:
- uses: actions/checkout@v4
- uses: GuillaumeFalourd/[email protected]
with:
command_line: |
'a_very_long_command --that --need
--multiple --lines --to --write'
assert_file_path: path/to/assert.txt
expected_result: PASSED
```
---
## ▶️ Action Inputs
| Field | Mandatory | Observation |
| -------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **command_line** | YES | Command Line to assert / check.
_e.g: `ls -lha`_ |
| **assert_file_path** | NO | Path to assert file that will be compared to command line output.
_e.g: `path/to/assert.txt`_ |
| **specific_line** | NO | Specific line to check from output file with assert file.
**NEEDS** `assert_file_path` configured.
_e.g: `1` (*integer value only*)_ |
| **contains** | NO | String expression to check on the command line output.
_e.g: `string expression`_ |
| **expected_result** | NO | Expected assert output.
_e.g: `PASSED` (*default*) or `FAILED`_ |
| **work_dir** | NO | Use the input as working directory to run the action. |
### 🔎 Good to know
- At least **one type of assert** between `contains`, `specific_line` and `assert_file_path` has to be configured.
- If **more than one type of assert** is set, the priority between them is:
- 1️⃣ `contains`
- 2️⃣ `specific_line`
- 3️⃣ `assert_file_path`
- You can access the **output.txt file** in the repository directory **after running the action**.
---
## 🤝 Contributing
☞ [Guidelines](https://github.com/GuillaumeFalourd/test-cli-commands-action/blob/main/CONTRIBUTING.md)
## 🏅 Licensed
☞ This repository uses the [Apache License 2.0](https://github.com/GuillaumeFalourd/assert-command-line-output/blob/main/LICENSE)