diff --git a/docs/en/installation/docker.md b/docs/en/installation/docker.md index 629fba556..c2c23187f 100644 --- a/docs/en/installation/docker.md +++ b/docs/en/installation/docker.md @@ -96,6 +96,28 @@ CONTAINER ID IMAGE COMMAND CREATED S d57fdd9637d6 postgres:13.16 "docker-entrypoint.s…" 50 minutes ago Up 22 seconds 5432/tcp consuldemocracy-database-1 ``` +## Running tests with RSpec + +Consul Democracy includes more than 6000 tests checking the way the application behaves. While we recommend you [configure your fork](../getting_started/configuration.md) to use a continuous integration system to run the whole test suite and verify that the latest changes don't break anything, while developing you probably want to run the tests related to the code you're working on. + +First, setup the database for the test environment: + +```bash +POSTGRES_PASSWORD=password docker-compose run app bundle exec rake db:test:prepare +``` + +Then you can run tests using RSpec. For example, to run the tests for the proposal model: + +```bash +POSTGRES_PASSWORD=password docker-compose run app bundle exec rspec spec/models/proposal_spec.rb +``` + +System tests also work out of the box, although they might fail the first time while the tool running the tests downloads the right version of Chromedriver (which is needed to run them), and only "headless" mode (with a browser running in the background) is supported, which is the mode you'd probably use more than 95% of the time anyway. For example, to run the tests for the homepage: + +```bash +POSTGRES_PASSWORD=password docker-compose run app bundle exec rspec spec/system/welcome_spec.rb +``` + ## Troubleshooting Run these commands **inside Consul Democracy's directory**, to erase all your previous Consul Democracy's Docker images and containers. Then start the Docker [installation process](#installation) once again. diff --git a/docs/es/installation/docker.md b/docs/es/installation/docker.md index 9f83e6344..4f7994e38 100644 --- a/docs/es/installation/docker.md +++ b/docs/es/installation/docker.md @@ -96,6 +96,28 @@ CONTAINER ID IMAGE COMMAND CREATED S d57fdd9637d6 postgres:13.16 "docker-entrypoint.s…" 50 minutes ago Up 22 seconds 5432/tcp consuldemocracy-database-1 ``` +## Ejecutar tests con RSpec + +Consul Democracy incluye más de 6000 tests que comprueban la manera en que se comporta la aplicación. Si bien recomendamos que [configures tu "fork"](../getting_started/configuration.md) para que use un sistema de integración continua para ejecutar todos los tests y comprobar que los últimos cambios no rompen nada, durante el desarrollo probablemente quieras ejecutar tests relacionados con el código en el que estás trabajando. + +En primer lugar, prepara la base de datos para el entorno de test: + +```bash +POSTGRES_PASSWORD=password docker-compose run app bundle exec rake db:test:prepare +``` + +Ahora puedes ejecutar tests usando RSpec. Por ejemplo, para ejecutar los tests del modelo "proposal": + +```bash +POSTGRES_PASSWORD=password docker-compose run app bundle exec rspec spec/models/proposal_spec.rb +``` + +Los tests de sistema también funcionan sin que tengas que realizar ninguna configuración adicional, si bien la primera vez que se ejecutan pueden fallar mientras la herramienta que ejecuta los tests descarga una versión adecuada de Chromedriver (que se necesita para ejecutarlos), y solamente puedes ejecutar el modo "headless" (con un navegador ejecutándose en segundo plano), que por otro lado en cualquier caso es el modo que utilizarías más del 95% del tiempo. Por ejemplo, para ejecutar los tests de la página de inicio: + +```bash +POSTGRES_PASSWORD=password docker-compose run app bundle exec rspec spec/system/welcome_spec.rb +``` + ## Resolución de problemas Ejecuta los siguientes comandos **en el directorio de Consul Democracy** para borrar todas las imágenes y contenedores anteriores del Docker de Consul Democracy. Luego, comienza de nuevo con el [proceso de instalación](#instalacion) de Docker.