aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 87c1999c838c1fba9c38702a1bf4b744f593144a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# minishell\_test

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/minishell-test)](https://pypi.org/project/minishell-test/)
[![Documentation](https://readthedocs.org/projects/minishell-test/badge/?version=latest)](https://minishell-test.readthedocs.io)
[![Build Status](https://api.travis-ci.com/cacharle/minishell_test.svg?branch=master)](https://travis-ci.com/cacharle/minishell_test)

Test for 42 school's minishell project.

![preview](https://i.imgur.com/98xh2xY.gif)

## Getting Started

### Installation

``` 
$ pip3 install minishell-test
$ pip3 install --user minishell-test  # if you don't have root access
```

### Compatibility

Your executable **must** support the `-c` option which allow to pass
command as string.

``` 
$ bash -c 'echo bonjour je suis | cat -e'
bonjour je suis$
$ ./minishell -c 'echo bonjour je suis | cat -e'
bonjour je suis$
```

<div class="note">

<div class="title">

Note

</div>

With this setup `argv[2]` is what you would usually get in `line` from
`get_next_line`.

</div>

### Usage

Run all the predefined tests:

``` 
$ cd <MINISHELL>
$ minishell_test
```

<div class="warning">

<div class="title">

Warning

</div>

If you get `command not found`, do either of those things:

-   `~/.local/bin` to your `PATH` environment variable.
-   run `$ python3 -m minishell_test` instead of `$ minishell_test`

</div>

## Documentation

The full documentation for this project is available at
[minishell-test.readthedocs.io](https://minishell-test.readthedocs.io).