Ensure that you have Docker and Docker Compose. Then set the environment variables (see below), copy the rails credentials (see below) and run ./bin/setup.
The following commands are available:
| Command | Description |
|---|---|
./bin/setup |
First-time project setup |
./bin/start |
Run the Rails application at localhost:3000 |
./bin/update |
Update gems, migrations and other dependencies |
./bin/migrate |
Run migrations |
./bin/test |
Run RSpec |
./bin/test -f d path/to/file |
Run RSpec with options and files/directories |
rspec --tag ~db_connection |
Run tests that aren't reliant on neo4j/postgres |
To get the server running, type docker-compose up.
To get a console running in Docker, first run docker-compose up and then in a separate terminal run docker-compose run rails_app bash.
To be able to use binding.pry, you'll need to run docker-compose run -p 3000:3000 rails_app bash and then bundle exec rails s.
When Docker starts going weird, stop the server, run docker-compose down and then start it up again. You might need to remove something in the tmp folder, but Docker will tell you about that.
Create a .env file and update it as needed using the .env.test as a template.
To run the app locally, you’ll need to have the Rails master key set in the app directory. Copy the password from the Hackney folder in Unboxed’s 1Password and save it to a master.key file in the config directory.
If you don't copy the credentials, you might run into this error:
NoMethodError: undefined method `slice' for nil:NilClass
Test are configured two ways: (1) ./bin/test will run all tests in Docker Compose, you should use this for a full test suite. (2) Some tests can be ran without Docker Compose, this is faster to run without Docker Compose, but it only covers a subset.
If you need to mock multiple web interactions, like with the Hackney API, the VCR gem is available with a custom cassete writer that will record a test's network traffic as a sequence of Webmock's stub_request calls for easy copy-pasting.
DO NOT FORGET TO FILTER SENSITIVE DATA BEFORE COMMITTING
For example:
RSpec.describe "Some stuff" do
feature "Some feature" do
scenario "Do some browsing", :js, :vcr do
...
end
end
endwill generate a .rb file under spec/vcr_cassettes containing something like:
stub_request(:get, "#{ ENV['HACKNEY_REPAIRS_API_BASE_URL'] }/v1/properties/00000666")
.to_return(status: 200, body: {
...
}.to_json)
stub_request(:get, "#{ ENV['HACKNEY_REPAIRS_API_BASE_URL'] }/v1/cautionary_contact/?reference=00000666")
.to_return(status: 200, body: {
...
}.to_json)
...App is hosted on Unboxed's Heroku: hackney-repairs pipeline
To sign in to the app you'll need a Hackney account. Someone in Hackney will create a ticket for you, you can then call up the IT services to get your name and password. General details about account information are in 1password in the Hackney vault. Information for using the VPN is also in 1password.
If setting up a review app on Heroku, you need to use the review app credentials. Those details are also in 1password.
https://github.com/alphagov/govuk-frontend
The neo4j web interface is on http://localhost:7474 . Password should be neo4j