references/openproject
1
0
Fork 0
mirror of https://github.com/opf/openproject.git synced 2026-06-13 19:20:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow skipping capybara logs and document test running for feature specs

Browse Source
This commit is contained in:
Klaus Zanders
2026-02-13 11:17:27 +01:00
parent 8cfa698f04
commit 20f78b1cb0
2 changed files with 19 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/development/testing/running-tests-locally/README.md
+18 -9
View File
@@ -73,7 +73,11 @@ RAILS_ENV=test bundle exec rspec spec/models/work_package_spec.rb spec/models/pr
## System tests
System tests are also called *rspec feature specs* and use [Capybara](https://rubydoc.info/github/teamcapybara/capybara/master) and [Selenium](https://www.selenium.dev/documentation/webdriver/) to run. They are automatically executed with an actual browser when `js: true` is set.
System tests are also called _rspec feature specs_ and use [Capybara](https://rubydoc.info/github/teamcapybara/capybara/master) and [Selenium](https://www.selenium.dev/documentation/webdriver/) to run. They are automatically executed with an actual browser when `js: true` is set.
To run feature specs, it is important that the frontend assets are being served. This is done by running `npm run serve`
in a separate terminal tab. This will start the Angular CLI and serve the frontend assets on `http://localhost:4200`.
Otherwise, the tests will fail because JavaScript and CSS assets are not available.
System tests are located in `spec/features`. Use the following command to run individual test:
@@ -81,6 +85,10 @@ System tests are located in `spec/features`. Use the following command to run in
RAILS_ENV=test bundle exec rspec spec/features/auth/login_spec.rb
```
When feature specs are run and a failure occurs, the browser logs are printed to the console. This can be helpful for
debugging, but it can also be overwhelming when there are many logs. To disable this behavior, set the environment
variable `SKIP_CAPYBARA_BROWSER_LOGS` to `true` in your `.env` file or export it in your terminal session:
### Dependencies
For the javascript dependent integration tests, you have to install Chrome and Firefox, to run them locally.
@@ -91,7 +99,7 @@ Capybara uses Selenium to drive the browser and perform the actions we describe
Almost all system tests depend on the browser for testing, you will need to have the Angular CLI running to serve frontend assets.
So with `npm run serve` running and completed in one tab, run the test using `rspec` as for the unit tests:
So with `npm run serve` running and completed in one tab, run the test using `rspec` as for the unit tests:
```shell
RAILS_ENV=test bundle exec rspec ./modules/documents/spec/features/attachment_upload_spec.rb[1:1:1:1]
@@ -99,7 +107,7 @@ RAILS_ENV=test bundle exec rspec ./modules/documents/spec/features/attachment_up
The tests will generally run a lot slower due to the whole application being run end-to-end, but these system tests will provide the most elaborate tests possible.
You can also run *all* feature specs locally with this command. This is not recommended due to the required execution time. Instead, prefer to select individual tests that you would like to test and let GitHub Actions CI test the entire suite.
You can also run _all_ feature specs locally with this command. This is not recommended due to the required execution time. Instead, prefer to select individual tests that you would like to test and let GitHub Actions CI test the entire suite.
```shell
RAILS_ENV=test bundle exec rake parallel:features -- --group-number 1 --only-group 1
@@ -119,7 +127,7 @@ Either save the driver under `C:\Windows\system32` to make it available or add i
**3) Find out your WSL ethernet adapter IP**
You can do this by opening a powershell and running ```wsl cat /etc/resolv.conf `| grep nameserver `| cut -d ' ' -f 2```. Alternatively looking for the adapter's IP in the output of `ipconfig` works too.
You can do this by opening a powershell and running ``wsl cat /etc/resolv.conf `| grep nameserver `| cut -d ' ' -f 2``. Alternatively looking for the adapter's IP in the output of `ipconfig` works too.
It will be called something like "Ethernet adapter vEthernet (WSL)".
**4) Download Selenium hub**
@@ -185,9 +193,9 @@ You can fix this either by accessing a page locally (if the rails server is runn
You can run the specs with the following commands:
* `bundle exec rake spec` Run all core specs and feature tests. Again ensure that the Angular CLI is running for these to work. This will take a long time locally, and it is not recommend to run the entire suite locally. Instead, wait for the test suite run to be performed on GitHub Actions CI as part of your pull request.
- `bundle exec rake spec` Run all core specs and feature tests. Again ensure that the Angular CLI is running for these to work. This will take a long time locally, and it is not recommend to run the entire suite locally. Instead, wait for the test suite run to be performed on GitHub Actions CI as part of your pull request.
* `SPEC_OPTS="--seed 12935" bundle exec rake spec` Run the core specs with the seed 12935. Use this to control in what order the tests are run to identify order-dependent failures. You will find the seed that GitHub Actions CI used in their log output.
- `SPEC_OPTS="--seed 12935" bundle exec rake spec` Run the core specs with the seed 12935. Use this to control in what order the tests are run to identify order-dependent failures. You will find the seed that GitHub Actions CI used in their log output.
## Parallel testing
@@ -255,7 +263,7 @@ To easily change the RSpec examples being run without relaunching `watchexec` ev
## Manual acceptance tests
* Sometimes you want to test things manually. Always remember: If you test something more than once, write an automated test for it.
- Sometimes you want to test things manually. Always remember: If you test something more than once, write an automated test for it.
### Accessing a local OpenProject instance from a VM or mobile phone
@@ -287,6 +295,7 @@ you can access both from inside a VM with nat/bridged networking as follows:
# Start ng serve middleware binding to the interface given by FE_HOST or on localhost if not defined
FE_HOST=<your local IP address> PROXY_HOSTNAME=<your local IP address> npm run serve
```
On npm run serve, you want to ensure it logs the correct hostname:
```log
@@ -312,9 +321,9 @@ OPENPROJECT_CLI_PROXY="http://$LOCAL_IP_ADDR:4200"
### Legacy LDAP tests
OpenProject supports using LDAP for user authentications. To test LDAP
OpenProject supports using LDAP for user authentications. To test LDAP
with OpenProject, load the LDAP export from `test/fixtures/ldap/test-ldap.ldif`
into a testing LDAP server. Test that the ldap server can be accessed
into a testing LDAP server. Test that the ldap server can be accessed
at 127.0.0.1 on port 389.
Setting up the test ldap server is beyond the scope of this documentation.
spec/support/capybara_browser_logs.rb
+1
View File
@@ -9,6 +9,7 @@ module Capybara::BrowserLogs
class << self
def after_failed_example(example)
return if ENV["SKIP_CAPYBARA_BROWSER_LOGS"] == "true"
return unless failed?(example)
return unless example.example_group.include?(Capybara::DSL)
return if Capybara.page.current_url.blank?