Skip to content

Commit

Permalink
chore: update README with test target
Browse files Browse the repository at this point in the history
  • Loading branch information
PatricioIribarneCatella committed Apr 5, 2024
1 parent 163a084 commit c6363b3
Showing 1 changed file with 33 additions and 7 deletions.
40 changes: 33 additions & 7 deletions shell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,51 @@ Utilizar el archivo `shell.md` provisto en el repositorio
## Compilar

```bash
$ make
make
```

## Ejecutar
## Pruebas

- Ejecutar todas las pruebas

```bash
make test
```

- Ejecutar una **única** prueba

```bash
make test-TEST_NAME
```

Por ejemplo:

```bash
$ make run
make test-env_empty_variable
```

Cada identificador de una prueba se muestra entre paréntesis `(TEST_NAME)` al lado de cada _test_ cuando se ejecutan todas las pruebas.

```
=== Temporary files will be stored in: /tmp/tmp0l10br1k-shell-test ===
PASS 1/26: cd . and cd .. work correctly by checking pwd (no prompt) (cd_back)
PASS 2/26: cd works correctly by checking pwd (no prompt) (cd_basic)
PASS 3/26: cd with no arguments takes you home (/proc/sys :D) (cd_home)
PASS 4/26: empty variables are not substituted (env_empty_variable)
...
```

O si se quire utilizar `valgrind`:
## Ejecutar

```bash
$ make valgrind
./sh
```

## Linter

```bash
$ make format
make format
```

Para efectivamente subir los cambios producidos por el `format`, hay que `git add .` y `git commit`.
Para efectivamente subir los cambios producidos por `make format`, hay que hacer `git add .` y `git commit`.

0 comments on commit c6363b3

Please sign in to comment.