Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.3 KB

running_natively.md

File metadata and controls

86 lines (60 loc) · 3.3 KB
Raw

Running the app Natively

To run vets-api and its redis and postgres dependencies run the following command from within the repo you cloned in the above steps.

foreman start -m all=1,clamd=0,freshclam=0

You should then be able to navigate to http://localhost:3000/v0/status in your browser and start interacting with the API. Changes to the source in your local directory will be reflected automatically via a docker volume mount, just as they would be when running rails directly.

Running tests

Follow these steps, or alternatively use binstubs.

  • bundle exec rake spec - Run the entire test suite ( for rspec spec). Test coverage statistics are in coverage/index.html.
  • make guard - Run the guard test server that reruns your tests after files are saved. Useful for TDD!

Running tests in parallel

  • NOTE: Running specs in parallel requires that your development database exists, and is up to date. If necessary, you may need to run bundle exec rake db:create and bundle exec rake db:migrate before the following steps.
  • RAILS_ENV=test bundle exec rake parallel:setup - This prepares all of the test databases. It will create a test database for each processor on your computer.
  • RAILS_ENV=test NOCOVERAGE=true bundle exec parallel_rspec spec modules - This runs the entire test suite. Optionally, a folder path can be given as a parameter. Each file is assigned a processor, so it probably doesn't make sense to pass an individual file to run it in parallel. It is currently suggested to forgo the coverage testing by adding NOCOVERAGE=true flag (currently the coverage check will fail, even if the test suite passes). If you would like to check coverage for the test run, remove that flag.

Running pending tests

Pending or skipped tests are ignored by default, to run the test suite with pending tests in the output, simply add the PENDING=true environment variable to the test command

RAILS_ENV=test PENDING=true NOCOVERAGE=true bundle exec parallel_rspec spec modules

Running linters

  • rake lint - Run the full suite of linters on the codebase and autocorrect.
  • rake security - Run the suite of security scanners on the codebase.
  • rake ci - Run all build steps performed in CI.

Running a rails interactive console

  • rails console - runs an IRB like REPL in which all of the API's classes and environmental variables have been loaded.

Running with ClamAV

Run with ClamAV containers (recommended)

  1. In settings.local.yml turn mocking off:
clamav:
  mock: false
  host: '0.0.0.0'
  port: '33100'
  1. In another terminal window, navigate to the project directory and run
docker-compose -f docker-compose-clamav.yml up
  1. In the original terminal run the following command
foreman start -m all=1,clamd=0,freshclam=0

This overrides any configurations that utilize the daemon socket

Run with ClamAV daemon

  1. In settings.local.yml turn mocking off and make sure the host and port are removed:
clamav:
  mock: false
  1. Uncomment socket env var in config/initializers/clamav.rb
ENV['CLAMD_UNIX_SOCKET'] = '/usr/local/etc/clamav/clamd.sock'

Note you will need to comment this line out before pushing to GitHub

  1. In terminal run the following command
foreman start -m all=1