Submit social housing lettings and sales data (CORE)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Matthew J. Phelan 0527f97a4d
Merge pull request #59 from communitiesuk/CLDC-477/reason-for-leaving-because-of-the-benefit-cap
3 years ago
.github/workflows ENV vars 3 years ago
app Merge pull request #59 from communitiesuk/CLDC-477/reason-for-leaving-because-of-the-benefit-cap 3 years ago
bin Move to Gov PaaS (#24) 3 years ago
config reason_for_leaving_last_settled_home validation added 3 years ago
db CLDC/477 Code review updates 3 years ago
docs Merge pull request #59 from communitiesuk/CLDC-477/reason-for-leaving-because-of-the-benefit-cap 3 years ago
lib Add application skeleton to repo 3 years ago
log Add application skeleton to repo 3 years ago
public Add application skeleton to repo 3 years ago
spec Merge pull request #59 from communitiesuk/CLDC-477/reason-for-leaving-because-of-the-benefit-cap 3 years ago
storage Add application skeleton to repo 3 years ago
tmp Add application skeleton to repo 3 years ago
vendor Add application skeleton to repo 3 years ago
.browserslistrc Add application skeleton to repo 3 years ago
.cfignore Move to Gov PaaS (#24) 3 years ago
.dockerignore Add application skeleton to repo 3 years ago
.editorconfig Add application skeleton to repo 3 years ago
.env.example Avoid whitespace syntax mismatch between docker-compose and rails c 3 years ago
.gitignore CLDC-358 conditional page routing (#49) 3 years ago
.overcommit.yml Add application skeleton to repo 3 years ago
.rspec Add application skeleton to repo 3 years ago
.rubocop.yml Add application skeleton to repo 3 years ago
.ruby-version Update Ruby version and Gov UK frontend component gem 3 years ago
Dockerfile Update Ruby version and Gov UK frontend component gem 3 years ago
Gemfile Api update (#48) 3 years ago
Gemfile.lock Full error messages (#57) 3 years ago
LICENSE Initial commit 3 years ago
README.md CLDC-542: OpenAPI documentation (#53) 3 years ago
Rakefile Add application skeleton to repo 3 years ago
babel.config.js Add application skeleton to repo 3 years ago
config.ru Add application skeleton to repo 3 years ago
docker-compose.yml Add application skeleton to repo 3 years ago
manifest.yml Single app name 3 years ago
package.json CLDC-341: Conditional showing and hiding of question on a page (#29) 3 years ago
postcss.config.js Add application skeleton to repo 3 years ago
yarn.lock CLDC-341: Conditional showing and hiding of question on a page (#29) 3 years ago

README.md

CI/CD Pipeline

Data Collection App

This is the codebase for the Ruby on Rails app that will handle the submission of Lettings and Sales of Social Housing in England data.

API documentation

API documentation can be found here: https://communitiesuk.github.io/mhclg-data-collection-beta/. This is driven by OpenAPI docs

Required Setup

Pre-requisites:

  • Ruby
  • Rails
  • Postgres

Quick start

  1. Copy the .env.example to .env and replace the database credentials with your local postgres user credentials.

  2. Install the dependencies:
    bundle install

  3. Create the database:
    rake db:create

  4. Run the database migrations:
    rake db:migrate

  5. Install the frontend depenencies:
    yarn install

  6. Start the Rails server:
    bundle exec rails s

The Rails server will start on http://localhost:3000.

Using Docker

docker-compose build
docker-compose run --rm app rails db:create
docker-compose up

The Rails server will start on http://localhost:8080.

Note docker-compose runs the production docker image (RAILS_ENV=production) as the Dockerfile doesn’t include development gems to keep the image size down.

Infrastructure

This application is running on GOV.UK PaaS. To deploy you need to:

  1. Contact your organisation manager to get an account in dluhc-core organization and in the relevant spaces (sandbox/production).

  2. Install the Cloud Foundry CLI

  3. Login:
    cf login -a api.london.cloud.service.gov.uk -u <your_username>

  4. Set your deployment target (sandbox/production):
    cf target -o dluhc-core -s <deploy_environment>

  5. Deploy:
    cf push dluhc-core --strategy rolling. This will use the manifest file

Once the app is deployed:

  1. Get a Rails console:
    cf ssh dluhc-core -t -c "/tmp/lifecycle/launcher /home/vcap/app 'rails console' ''"

  2. Check logs:
    cf logs dluhc-core --recent

Troubleshooting deployments

A failed Github deployment action will occasionally leave a Cloud Foundry deployment in a broken state. As a result all subsequent Github deployment actions will also fail with the message Cannot update this process while a deployment is in flight.

cf cancel-deployment dluhc-core

You'd then need to check the logs and fix the issue that caused the initial deployment to fail.

CI/CD

When a commit is made to main the following GitHub action jobs are triggered:

  1. Test: RSpec runs our test suite
  2. Deploy: If the Test stage passes, this job will deploy the app to our GOV.UK PaaS account using the Cloud Foundry CLI

When a pull request is opened to main only the Test stage runs.

Single log submission

The form for this is driven by a JSON file in /config/forms/{start_year}_{end_year}.json

The JSON should follow the structure:

{
  "form_type": "lettings" / "sales",
  "start_year": Integer, // i.e. 2020
  "end_year": Integer, // i.e. 2021
  "sections": {
    "[snake_case_section_name_string]": {
      "label": String,
      "subsections": {
        "[snake_case_subsection_name_string]": {
          "label": String,
          "pages": {
            "[snake_case_page_name_string]": {
              "header": String,
              "description": String,
              "questions": {
                "[snake_case_question_name_string]": {
                  "header": String,
                  "hint_text": String,
                  "type": "text" / "numeric" / "radio" / "checkbox" / "date",
                  "min": Integer, // numeric only
                  "max": Integer, // numeric only
                  "step": Integer, // numeric only
                  "answer_options": { // checkbox and radio only
                    "0": String,
                    "1": String
                  },
                  "conditional_for": {
                    "[snake_case_question_to_enable_1_name_string]": ["condition-that-enables"],
                    "[snake_case_question_to_enable_2_name_string]": ["condition-that-enables"]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Assumptions made by the format:

  • All forms have at least 1 section
  • All sections have at least 1 subsection
  • All subsections have at least 1 page
  • All pages have at least 1 question
  • The ActiveRecord case log model has a field for each question name (must match). In the case of checkbox questions it must have one field for every answer option (again names must match).
  • Text not required by a page/question such as a header or hint text should be passed as an empty string
  • For conditionally shown questions conditions that have been implemented and can be used are:
    • Radio question answer option selected matches one of conditional e.g. ["answer-options-1-string", "answer-option-3-string"]
    • Numeric question value matches condition e.g. [">2"], ["<7"] or ["== 6"]

Useful documentation (external dependencies)

GOV.UK Design System Form Builder for Rails

GOV.UK Frontend

Hotwire (Turbo/Stimulus)