Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rbaltrusch/batest
Lightweight batchfile unit testing framework
https://github.com/rbaltrusch/batest
batch batch-file batchfile framework lightweight test-automation testing tests unit-testing windows
Last synced: 2 days ago
JSON representation
Lightweight batchfile unit testing framework
- Host: GitHub
- URL: https://github.com/rbaltrusch/batest
- Owner: rbaltrusch
- License: mit
- Created: 2021-02-10T16:34:22.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-08T11:42:47.000Z (about 1 year ago)
- Last Synced: 2023-10-08T13:36:53.358Z (about 1 year ago)
- Topics: batch, batch-file, batchfile, framework, lightweight, test-automation, testing, tests, unit-testing, windows
- Language: Batchfile
- Homepage:
- Size: 86.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/rbaltrusch/batest/actions/workflows/run_tests.yml)
[](https://opensource.org/licenses/MIT)
# Batest
Batest is a lightweight batchfile unit testing framework, shipping with an [assert](https://github.com/rbaltrusch/batest/tree/master/README.md/#assertions) statement to make testing batchfiles easy. It generates a simple HTML test report containing the results after every run.
## Getting started
To get a copy of this repository, simply open up git bash in an empty folder and use the command:
$ git clone https://github.com/rbaltrusch/batest
To call batest from anywhere in the command line, add it to the Windows PATH. Alternatively, navigate to the folder containing the *batest.bat* file to run batest without modifying your Windows PATH.
## How to use
Batest ships with an [assert](https://github.com/rbaltrusch/batest/tree/master/README.md/#assertions) statement (located in the same folder as *batest.bat*), which should be used in the test files you define. Information on the functionality provided with the *assert* statement can be found [here](https://github.com/rbaltrusch/batest/wiki/assert).
To test the current folder with batest, simply run one of the following from the command line:
```batch
batest
batest .
```
To test a specific folder, run one of the following from the command line, either specifying relative or absolute paths:
```batch
batest "../script_folder"
batest "D:/some_folder/script_folder"
```
For more help directly on the command line, run:
```
batest help
```
### Folder structure
The folder containing the scripts to be tested should contain a subfolder called *tests* (as in the example folder structure below).
The *tests* folder must contain all test files that test the scripts under test.
```
+---scripts1
| \---tests
\---scripts2
\---tests
```
### Test file naming
All test files must end with the suffix *_test* to be recognized and run by batest.
For example, *some_test.bat* would be recognized and run by batest, but *test_something.bat* would not be.
To list all test files recognized by batest under a path without actually running them, use the *--list [-l]* option, as in the example below:
```batch
batest --list "path/to/folder"
```
### Assertions
The *assert.bat* script shipping with batest supports much of the functionality of the Batch IF statement.
The general syntax for the assert call is:
```batch
call assert operand1 operator operand2 errormessage
```
Some examples of various assert statements and whether they are expected to fail or to pass:
```batch
:: should pass, 1 equals 1
call assert 1 EQU 1 "my message"
```
```batch
::should pass if file.txt exists
call assert exist file.txt "file is missing"
```
```batch
::should pass 1 is not greater than 2
call assert NOT 1 GEQ 2 "error message"
```
Passing assert statements set ERRORLEVEL to 0, failing ones to 1.
More help is available in the [wiki](https://github.com/rbaltrusch/batest/wiki/assert) or directly in the command line:
assert help
### CI/CD
Batest can also be used to test code automatically using services such as Github Actions. A local example of this can be found in the batest [test workflow](https://github.com/rbaltrusch/batest/tree/master/.github/workflows/run_tests.yaml), and an example of a third-party repository testing with batest can be found [here](https://github.com/rbaltrusch/objectbatch/tree/master/.github/workflows/run_tests.yaml).
### More information
For more information on the use of batest, assert, and the folder structure, please have a look at the [examples](https://github.com/rbaltrusch/batest/tree/master/examples) and the [wiki](https://github.com/rbaltrusch/batest/wiki).
## Contributions
Any contributions, such as additional features, bugfixes, or documentation are much appreciated. Contribution guidelines are specified in [CONTRIBUTING.md](https://github.com/rbaltrusch/batest/blob/master/CONTRIBUTING.md).
## License
This repository is open-source software available under the [MIT license](https://github.com/rbaltrusch/batest/blob/master/LICENSE).
## Contact
Please raise an issue for code changes. To reach out, please send an email to [email protected].