Mocha Quiet - Shell-Bash

Mocha Quiet is a command-line tool for running tests written in Shell-Bash. It is designed to provide a quiet and unobtrusive testing experience for developers. With Mocha Quiet, you can easily write and run tests for your Shell-Bash scripts, ensuring the correctness of your code and preventing regressions.

Features

• Quiet and minimal output: Mocha Quiet focuses on providing only the essential information, making it easier to understand the test results without unnecessary noise.
• Simple and expressive syntax: Write tests in a clean and concise syntax using familiar Shell-Bash scripting commands and assertions.
• Support for various test frameworks: Mocha Quiet supports popular test frameworks such as Bats and shUnit2, allowing you to choose the framework that best fits your project.
• Automatic test discovery: Mocha Quiet automatically discovers and runs all the test scripts in a given directory, saving you the hassle of manually specifying each test file.
• Detailed test reporting: Generate detailed test reports in Markdown format, allowing you to easily share and document your test results with your team.
• Integration with other testing tools: Mocha Quiet can be easily integrated into your existing CI/CD pipelines and build systems to automate the testing process.

Installation

To install Mocha Quiet, you can use the following command:

$ npm install -g mocha-quiet

Alternatively, you can install it as a development dependency in your project:

$ npm install --save-dev mocha-quiet

Usage

Once installed, you can use Mocha Quiet by running the following command in your shell:

$ mocha-quiet <directory>

Replace <directory> with the path to the directory containing your Shell-Bash test scripts. Mocha Quiet will then automatically discover and run all the tests in that directory.

Test Syntax

Mocha Quiet supports a simple and expressive syntax for writing tests. Here's an example test script using Bats as the test framework:

@test "Addition test" {
  result=$(add 2 3)
  [ "$result" -eq 5 ]
}

@test "Subtraction test" {
  result=$(subtract 5 2)
  [ "$result" -eq 3 ]
}

In this example, we have two tests: "Addition test" and "Subtraction test". Each test is written as a subshell, allowing you to define the commands and assertions to be executed. The @test annotation indicates the start of a new test.

Test Reports

After running the tests, Mocha Quiet generates a detailed test report in Markdown format. Here's an example report:

Test Results

• Passed: 2
• Failed: 0
• Skipped: 0

Addition test

• Status: Passed

Subtraction test

• Status: Passed

You can save this report to a file or use it directly in your CI/CD pipelines or documentation.

Conclusion

Mocha Quiet provides a streamlined and unobtrusive way to test your Shell-Bash scripts. With its minimal output and support for popular test frameworks, it helps you ensure the correctness of your code without adding unnecessary complexity. Give Mocha Quiet a try in your next Shell-Bash project and experience a quiet and peaceful testing experience.