From 5c12603df9bf1669a689f0dc8820cf062d7a0cc0 Mon Sep 17 00:00:00 2001 From: Alvaro Faundez Date: Thu, 23 Dec 2021 10:42:47 -0500 Subject: [PATCH] Improve testing doc --- TESTING.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/TESTING.md b/TESTING.md index 39b0b69..c3fb28f 100644 --- a/TESTING.md +++ b/TESTING.md @@ -1,25 +1,32 @@ # Testing -Tested using chef-workstation from Homebrew +## Unit testing and liting -# Lint and Style +Tested using chef-workstation devcontainer. + +In the case you are not using the devcontainer you will probably need to install the dependencies before running the tests: ```sh -CHEF_LICENSE=accept-no-persist delivery local lint +berks install --except integration ``` -# Unit specs +### Lint and Style +```sh +CHEF_LICENSE=accept-no-persist delivery local lint ``` -berks install --except integration + +### Unit specs + +```sh CHEF_LICENSE=accept-no-persist delivery local unit ``` -# Integration tests +## Integration tests Check [Test Kitchen](https://kitchen.ci/docs/getting-started/running-test). Consider using the `--concurrency` flag when possible. -## kitchen-vagrant +### kitchen-vagrant Tested locally with macOS Monterrey 12.1, VirtualBox 6.1.30, and Vagrant 2.2.19. @@ -27,7 +34,7 @@ Tested locally with macOS Monterrey 12.1, VirtualBox 6.1.30, and Vagrant 2.2.19. kitchen test ``` -## kitchen-dokken +### kitchen-dokken Tested locally with macOS Monterrey 12.1, and Docker Desktop 4.3.1. Tested remotely with Github Actions.