From c6363b3bb50f79d25f7505b1414228ec9bd5c808 Mon Sep 17 00:00:00 2001 From: PatricioIribarneCatella Date: Thu, 4 Apr 2024 22:29:56 -0300 Subject: [PATCH] chore: update README with test target --- shell/README.md | 40 +++++++++++++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 7 deletions(-) diff --git a/shell/README.md b/shell/README.md index 5254629..cbc1bd6 100644 --- a/shell/README.md +++ b/shell/README.md @@ -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`.