Advocate Defence Payments

a.k.a Claim for crown court defence

Staging

staging-adp.dsd.io

Demo

demo-adp.dsd.io

Dev

dev-adp.dsd.io

S3 for document storage

AWS S3 the default document storage mechanism. It is stubbed out using webmock for all tests, but active in development mode.

adp_aws_access_key    = <AWS access key>  # Required
adp_secret_access_key = <AWS secret key>  # Required
adp_bucket_name       = <AWS bucket name> # Optional

The bucket name will default to moj_cbo_documents_#{Rails.env} if adp_bucket_name is not set.

Setting up development environment

Dependencies

• Postgresql
• Redis

# for mac osx
brew bundle

Setup

Install gems, set environment files and setup database

# From the root of the project
bin/setup

NOTE: You can change the default values for the environment variables as necessary in each of the environment files (e.g. .env.development and .env.test)

Setup dummy users and data

rake db:drop db:create db:reload

Run the application server

See note below on architecture for the reason why you need to run two servers.

rails server
rails server -p 3001 -P /tmp/rails3001.pid

To import JSON claims, or import via the API, you need to run a multi-threaded server like unicorn on port 3000. This can be done with the following line, but the BetterErrors page will not work correctly if you get an exceptions.

rails server -e devunicorn

Download and install pdftk

Note: this is the version to install for OSX Sierra, and above, as of 5 Dec 2017, otherwise check the www.pdflabs.com website

curl -o ~/Downloads/pdftk_download.pkg https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/pdftk_server-2.02-mac_osx-10.11-setup.pkg

After running the package it will, by default, install to /usr/local/bin/pdftk, where the server will look for it. If you install to another location add another key to your .env files

PDFTK_PATH='/you/pdftk/location/here'

Install Libreoffice

Libreoffice is used to convert files uploaded in CCCD to PDFs for generating performant, viewable documents of any document type, accessed via a view link. You will need to install this locally.

# for mac osx
brew bundle

Architecture

This app was originally written as a single monolithic application, with the ability to import claims via a public API, or JSON uploads (AGFS claims only). A decision was later taken to split the Caseworker off into a separate application, using the API to communicate to the main app. This has only partially been done. The CaseWorker allocation pages use the API to talk to the main application, rather than access the database directly. In the dev environment, it accesses another server running on port 3001, which is why you need to start up the second server.

Testing

To execute unit tests

bundle exec rspec

To execute cucumber test scenarios

bundle exec cucumber

Testing external services

LAA fee calculator API

RSpec

Some rspec unit tests require VCR cassettes for the LAA fee calculator API external service. These specs are tagged with :fee_calc_vcr so can be targetted using rspec cmdline options.

# run specs requiring LAA fee calculator API call stubs/cassettes
$ rspec --tag fee_calc_vcr

Changes to the calling of the LAA fee calculator API will most likely require you to rerecord the VCR cassettes that stub these calls. To rerecord VCR cassettes you can delete the existing ones (in vcr/cassettes/spec). They will be recreated when the specs are run.

It is a good idea to do this when changes occur to the LAA fee calculator API too.

Cucumber

Some cucumber features require VCR cassettes to stub calls to the LAA fee calculator API. These features require and are tagged with a @fee_calc_vcr tag. To re-record the cassettes delete the existing ones and run the feature again. See Create a new VCR cassette.

For convenience the VCR recording mode for all cucumber scenarios tagged with @fee_calc_vcr can be changed by supplying an enviroment variable from the commandline.

# delete a bunch of fee calculator features
$ rm -rf vcr/cassettes/features/fee_calculator/

# run applicable features and set recording mode to 'new_episodes' if the scenario is tagged with @fee_calc_vcr
$ FEE_CALC_VCR_MODE=new_episodes cucumber features/fee_calculator/

Internal API

Some cucumber feature tests use VCR to record/store mock results the internal API calls (calling our own API) for certain endpoints (case worker claims in particular). To create a new feature/scenario that relies on such endpoints you will therefore need to record a new "cassette", as below.

Create new VCR cassette

Run this in a new console:

# Start internal API for use by test suite
$ RAILS_ENV=test rails s -p 3001 -P /tmp/rails3001.pid

In your .feature file add this step before any calls relying on the internal API - i.e. which will be mocked by the cassette produced:

# default recording mode has been set to `:once` so it will create a new cassette of the given name if there is not one.
And I insert the VCR cassette 'features/case_workers/claims/injection_error'

You can change the default recording mode (:once) by adding and record 'all|new_episodes|none|once' to the end of this step

# record new vcr episodes. Remember to remove this once they are recorded.
And I insert the VCR cassette 'features/case_workers/claims/injection_error' and record 'new_episodes'

Add this step at the point you want to stop recording and write the output to the cassette file:

# eject the previously inserted cassette (optional if there already is one but needs to be done if a new is being created in order to output the file
And I eject the VCR cassette

Run the feature:

# note: the 0000.feature is run first to clear the db - not sure if still/always needed
cucumber features/000.feature features/injection_errors.feature

After you have run it once you must amend the cassette inserting step as below if you added and record 'all|new_episodes' to prevent it creating new cassettes on each run:

And I insert the VCR cassette 'features/case_workers/claims/injection_error'

You are done. To test terminate/prevent the api service that the test relies on from running - in our example Crtl+c on the console running the rails server on port 3001 - and run the feature again. It should no longer require the api endpoints.

You should now commit the cassette to the repo to ensure it is not unneccessarily created by upstream test suite runs on the CI solution.

When you change a feature test such that you need to re-record its cassette you should delete the existing cassette in the vcr folder and proceed as if creating a new cassette, above.

Javascript Unit Testing

Run it using the guard command. Jasmine output available here: http://localhost:8888

Other useful rake tasks

rake db:reseed --clear, migrate, seed

rake db:reload --clear, migrate, seed, demo data

rake api:smoke_test  -- test basic API functionality

Useful aliases

To ping all environments

alias ping.adp='for i in dev-adp.dsd.io staging-adp.dsd.io demo-adp.dsd.io api-sandbox-adp.dsd.io claim-crown-court-defence.service.gov.uk ; do a="https://${i}/ping.json" ; echo $a; b=`curl --silent $a` ; echo $b; echo; done'

Sidekiq Console

To run Sidekiq

bundle exec sidekiq

To display the current state of the Sidekiq queues, as a logged in superadmin browse to /sidekiq

Mailer previewing

With your local rails server running you can browse to http://localhost:3000/rails/mailers to view a list of current email templates

Anonymised Database Dumps/restores

In order to copy the live database, anonymising all entries, execute the following command:

$ ./script/db_dump.rb <ssh-username> <environment> [<ip_address>]

The environment parameter can be gamma, staging, dev, demo, etc. The IP address is only required if there is no entry for environment in your /etc/hosts file.

This will create a file in the root directory, e.g adp_gamma_dump.psql.gz

To restore this file to one of the other environments, type:

$ ./script/db_upload.rb <ssh-name> <environment> [<ip_address>] filename

In this case, environment CANNOT be gamma.

To load the database dump on to your local database, use:

$ rake db:restore[dump-file]

Snippet for local dump and restore:

$ cd <cccd_root>
$ ./script/db_dump.rb <sshusername> gamma <IP|knownhost>
$ rake db:restore['adp_gamma_dump.psql.gz']
$ rm adp_gamma_dump.psql

VAT

The rules for when and when not to apply VAT are rather complex, so are summarised here:

AGFS

The claim's external_user attribute is an ExternalUser with a role of 'advocate' and has a vat_registered attribute which governs whether or not VAT is applied to fees and expenses.

If true, VAT at the prevailing rate is automatically added to fees and expenses; if false, not VAT is added.

LGFS

The claim's provider has an attribute 'vat_registered' which governs whether or not VAT is applied. In this case, VAT is automatically applied to fees.

For both VAT registered and unregistered LGFS providers, a VAT amount field is provided for manual input of VAT

Contributing

Bug reports and pull requests are welcome.

1. Fork the project (https://github.com/ministryofjustice/advocate-defence-payments/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit until you are happy with your contribution (git commit -am 'Add some feature')
4. Push the branch (git push origin my-new-feature)
5. Make sure your changes are covered by tests, so that we don't break it unintentionally in the future.
6. Create a new pull request.

License

Released under the MIT License. Copyright (c) 2015-2016 Ministry of Justice.