summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-08-06 09:33:37 +0000
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-08-06 09:33:37 +0000
commita79ff4390b5a83e07f1144ecaebecf4bad7514b4 (patch)
tree1bfa562d32e7126784fda38d1fe0ce01dacf5cee
parentaa49c20e81210d8b397287eb1ec10a29bcd2f132 (diff)
parentef589219d2aecc9caeaf53e4e9d5eb49f6fb590f (diff)
downloadgitlab-ce-a79ff4390b5a83e07f1144ecaebecf4bad7514b4.tar.gz
Merge branch 'development-docs-from-gdk' into 'master'
Add 'run tests' development docs from GDK This adds some documentation that lived in https://gitlab.com/gitlab-org/gitlab-development-kit but which belongs more in here. See merge request !5684
-rw-r--r--doc/development/rake_tasks.md30
1 files changed, 26 insertions, 4 deletions
diff --git a/doc/development/rake_tasks.md b/doc/development/rake_tasks.md
index 8852dbcb19e..a7175f3f87e 100644
--- a/doc/development/rake_tasks.md
+++ b/doc/development/rake_tasks.md
@@ -14,11 +14,33 @@ Note: `db:setup` calls `db:seed` but this does nothing.
## Run tests
-This runs all test suites present in GitLab.
+In order to run the test you can use the following commands:
+- `rake spinach` to run the spinach suite
+- `rake spec` to run the rspec suite
+- `rake teaspoon` to run the teaspoon test suite
+- `rake gitlab:test` to run all the tests
-```
-bundle exec rake test
-```
+Note: Both `rake spinach` and `rake spec` takes significant time to pass.
+Instead of running full test suite locally you can save a lot of time by running
+a single test or directory related to your changes. After you submit merge request
+CI will run full test suite for you. Green CI status in the merge request means
+full test suite is passed.
+
+Note: You can't run `rspec .` since this will try to run all the `_spec.rb`
+files it can find, also the ones in `/tmp`
+
+To run a single test file you can use:
+
+- `bundle exec rspec spec/controllers/commit_controller_spec.rb` for a rspec test
+- `bundle exec spinach features/project/issues/milestones.feature` for a spinach test
+
+To run several tests inside one directory:
+
+- `bundle exec rspec spec/requests/api/` for the rspec tests if you want to test API only
+- `bundle exec spinach features/profile/` for the spinach tests if you want to test only profile pages
+
+If you want to use [Spring](https://github.com/rails/spring) set
+`ENABLE_SPRING=1` in your environment.
## Generate searchable docs for source code