Bsh/README.md

45 lines
1.2 KiB
Markdown

# Bsh
## Testsuite
First, you need to install the dependencies using pip:
```sh
➜ bsh ✗ pip install -r tests/requirements.txt
```
Make sure to have the bsh binary, and then execute the tests/moulinette.py file using python3
```sh
➜ bsh ✗ python3 tests/moulinette.py --binary bsh --tests tests/echo.yml
```
- ```--binary``` is the relative path of the bsh binary
- ```--tests``` is a list of all yaml files containing tests
A test is formatted like this in a yaml file:
```yml
- name: a name
input: an input in a single line (for example -> echo "Foo!")
file: a path to a file, relative from the root of the git
```
You can choose either input or file for a test. In the case you set a value for each of them, only input will be taken into account.
## Options
In order to debug the program, there are 2 options.
- ```--petty-print``` print the AST before each execution
- ```--verbose``` print some functions output during execution. For now, there is only the lexer output.
:warning: **The order is important**: ```--petty-print``` has to be before ```--verbose```
## Environment
```sh
➜ b-sh-bitarrays git:(main) env -i ./bsh
```
You need to execute the shell with this command, in order to start with an empty environment