/usr/share/obs/api/spec/README.md is in obs-api 2.7.1-10.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | # Open Build Service Test Suite
This is a test suite based on [RSpec](http://rspec.info/). We are trying to
test things based on the following rules:
* Every method that isn't private must be tested
* Every main workflow has a feature test
## Running the spec
`bundle exec rake spec`
## Directory structure
Conventionally, all tests live under the
`spec`
directory and files matching
`spec/**/*_spec.rb`
are run by default. Ruby files with custom matchers and macros, etc, belong to
`spec/support/`
and its subdirectories. Require them in the individual `*_spec.rb` or
`_helper.rb` files.
Shared examples that are shared among different test files are stored in
`spec/support/shared_example/{features,controller,model,helper}/*`
depending on the type of spec it is meant for.
## Test types
There are many different [types of specs](https://relishapp.com/rspec/rspec-rails/docs/directory-structure)
possible in RSpec. We concentrate on 4 types:
* [Model specs](https://relishapp.com/rspec/rspec-rails/docs/model-specs) reside in the `spec/models` directory and test methods in Models.
* [Controller specs](https://relishapp.com/rspec/rspec-rails/docs/controller-specs) reside in the `spec/controllers` directory and test methods in Controllers.
* [Helper specs](https://relishapp.com/rspec/rspec-rails/docs/helper-specs/helper-spec) reside in the `spec/helpers` directory and test methods in Helpers.
* [Feature specs](https://relishapp.com/rspec/rspec-rails/docs/feature-specs/feature-spec) reside in the `spec/features` directory and test workflows through the webui.
## Adding tests
We are using the standard [RSpec generators](https://relishapp.com/rspec/rspec-rails/docs/generators) like:
`rails generate rspec:model package` or
`rails generate rspec:controller webui::blah`
### Backend responses
If you require a response from the OBS backend for your new test you need to
start it with
```
vagrant exec rake db:fixtures:obs
vagrant exec RAILS_ENV=test ./script/start_test_backend
```
Once your test ran successfully for the first time [VCR](https://github.com/vcr/vcr)
will have recorded a new cassette in `spec/cassettes` and will use this for
playing back the backend response in the next run.
### VCR gotchas
VCR matches cassettes to responses you request from the backend by comparing the
`request.uri`. That means you should avoid random parts, like project/package
names, in it.
### Migrating tests
When migrating tests from the old minitest based suite to rspec, please add the
file path of the new one to every test covered.
### Untested methods
When you work on the test suite and you notice a method or part of a feature that
is not tested please add a test for it.
## Better Specs
As a set of "rules" to follow in our specs we use [BetterSpecs.org](http://betterspecs.org/).
Please read those guidelines before you start coding new specs.
|