Merge pull request #4008 from nhsuk/clinic-cli-tools

Add CLI tools for clinics

Author: thomasleese

README.md

@@ -339,7 +339,6 @@ See the [releasing documentation](docs/releasing.md) for more information.
 
 - `access_log:for_patient[id]`
 - `access_log:for_user[id]`
-- `clinics:create[name,address,town,postcode,ods_code,organisation_ods_code]`
 - `teams:create[ods_code,name,email,phone]`
 - `users:create[email,password,given_name,family_name,organisation_ods_code]`
 - `vaccines:seed[type]`

app/lib/mavis_cli.rb

@@ -18,6 +18,8 @@ def self.progress_bar(total)
   end
 end
 
+require_relative "mavis_cli/clinics/add_to_organisation"
+require_relative "mavis_cli/clinics/create"
 require_relative "mavis_cli/generate/cohort_imports"
 require_relative "mavis_cli/generate/consents"
 require_relative "mavis_cli/generate/vaccination_records"

app/lib/mavis_cli/clinics/add_to_organisation.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module MavisCLI
+  module Clinics
+    class AddToOrganisation < Dry::CLI::Command
+      desc "Add an existing clinic to an organisation"
+
+      argument :organisation_ods_code,
+               required: true,
+               desc: "The ODS code of the organisation"
+      argument :team, required: true, desc: "The team of the organisation"
+      argument :clinic_ods_codes,
+               type: :array,
+               required: true,
+               desc: "The ODS codes of the clinics"
+
+      def call(organisation_ods_code:, team:, clinic_ods_codes:, **)
+        organisation = Organisation.find_by(ods_code: organisation_ods_code)
+
+        if organisation.nil?
+          warn "Could not find organisation."
+          return
+        end
+
+        team = organisation.teams.find_by(name: team)
+
+        if team.nil?
+          warn "Could not find team."
+          return
+        end
+
+        ActiveRecord::Base.transaction do
+          clinic_ods_codes.each do |ods_code|
+            location = Location.clinic.find_by(ods_code:)
+
+            if location.nil?
+              warn "Could not find location: #{ods_code}"
+              next
+            end
+
+            if !location.team_id.nil? && location.team_id != team.id
+              warn "#{ods_code} previously belonged to #{location.team.name}"
+            end
+
+            location.update!(team:)
+          end
+        end
+      end
+    end
+  end
+
+  register "clinics" do |prefix|
+    prefix.register "add-to-organisation", Clinics::AddToOrganisation
+  end
+end

app/lib/mavis_cli/clinics/create.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module MavisCLI
+  module Clinics
+    class Create < Dry::CLI::Command
+      desc "Create a new clinic location"
+
+      argument :ods_code, required: true, desc: "The ODS code of the clinic"
+      argument :name, required: true, desc: "The name of the clinic"
+      argument :address_line_1,
+               required: true,
+               desc: "The line 1 of the address"
+      argument :address_town, required: true, desc: "The town of the address"
+      argument :address_postcode,
+               required: true,
+               desc: "The postcode of the address"
+
+      def call(
+        ods_code:,
+        name:,
+        address_line_1:,
+        address_town:,
+        address_postcode:,
+        **
+      )
+        Location.create!(
+          type: :community_clinic,
+          name:,
+          address_line_1:,
+          address_town:,
+          address_postcode:,
+          ods_code:
+        )
+      end
+    end
+  end
+
+  register "clinics" do |prefix|
+    prefix.register "create", Clinics::Create
+  end
+end

app/models/location.rb

@@ -64,16 +64,13 @@ class Location < ApplicationRecord
   validates :url, url: true, allow_nil: true
   validates :urn, uniqueness: true, allow_nil: true
 
-  with_options if: :clinic? do
-    validates :team, presence: true
-  end
-
   with_options if: :community_clinic? do
     validates :ods_code, exclusion: { in: :organisation_ods_code }
   end
 
   with_options if: :generic_clinic? do
     validates :ods_code, inclusion: { in: :organisation_ods_code }
+    validates :team, presence: true
   end
 
   with_options if: :gp_practice? do
@@ -86,7 +83,7 @@ class Location < ApplicationRecord
     validates :urn, presence: true
   end
 
-  normalizes :urn, with: -> { _1.blank? ? nil : _1.strip }
+  normalizes :urn, with: -> { it.blank? ? nil : it.strip }
 
   delegate :fhir_reference, to: :fhir_mapper
 
@@ -121,9 +118,9 @@ def create_default_programme_year_groups!(programmes)
 
   private
 
-  def organisation_ods_code
-    [team&.organisation&.ods_code]
-  end
+  def organisation_ods_code = [team&.organisation&.ods_code].compact
 
-  def fhir_mapper = @fhir_mapper ||= FHIRMapper::Location.new(self)
+  def fhir_mapper
+    @fhir_mapper ||= FHIRMapper::Location.new(self)
+  end
 end

docs/rake-tasks.md

@@ -10,21 +10,6 @@ Displays the access log for a particular patient identified by their ID.
 
 Displays the access log for a particular user identified by an email address.
 
-## Clinics
-
-### `clinics:create[name,address,town,postcode,ods_code,organisation_ods_code]`
-
-- `name` - The name of the clinic.
-- `address` - The first line of the address.
-- `town` - The town of the clinic.
-- `postcode` - The postcode of the clinic.
-- `ods_code` - The ODS code of the clinic.
-- `organisation_ods_code` - The ODS code of the organisation.
-
-If none of the arguments are provided (`rake clinics:create`), the user will be prompted for responses.
-
-This creates a new clinic location and attaches it to a organisation.
-
 ## GP Practices
 
 ### `gp_practices:smoke`

spec/factories/locations.rb

@@ -65,8 +65,6 @@
       name { "#{Faker::University.name} Clinic" }
 
       sequence(:ods_code, 100) { "CL#{_1}" }
-
-      organisation
     end
 
     factory :generic_clinic do

spec/features/cli_clinics_add_to_organisation_spec.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "../../app/lib/mavis_cli"
+
+describe "mavis clinics add-to-organisation" do
+  context "when the organisation doesn't exist" do
+    it "displays an error message" do
+      when_i_run_the_command_expecting_an_error
+      then_an_organisation_not_found_error_message_is_displayed
+    end
+  end
+
+  context "when the team doesn't exist" do
+    it "displays an error message" do
+      given_the_organisation_exists
+
+      when_i_run_the_command_expecting_an_error
+      then_a_team_not_found_error_message_is_displayed
+    end
+  end
+
+  context "when the clinic doesn't exist" do
+    it "displays an error message" do
+      given_the_organisation_exists
+      and_the_team_exists
+
+      when_i_run_the_command_expecting_an_error
+      then_a_clinic_not_found_error_message_is_displayed
+    end
+  end
+
+  context "when the clinic exists" do
+    it "runs successfully" do
+      given_the_organisation_exists
+      and_the_team_exists
+      and_the_clinic_exists
+
+      when_i_run_the_command
+      then_the_clinic_is_added_to_the_organisation
+    end
+  end
+
+  private
+
+  def command
+    Dry::CLI.new(MavisCLI).call(
+      arguments: %w[clinics add-to-organisation ABC Team 123456]
+    )
+  end
+
+  def given_the_organisation_exists
+    @organisation = create(:organisation, ods_code: "ABC")
+  end
+
+  def and_the_team_exists
+    @team = create(:team, name: "Team", organisation: @organisation)
+  end
+
+  def and_the_clinic_exists
+    @clinic = create(:community_clinic, name: "Clinic", ods_code: "123456")
+  end
+
+  def when_i_run_the_command
+    @output = capture_output { command }
+  end
+
+  def when_i_run_the_command_expecting_an_error
+    @output = capture_error { command }
+  end
+
+  def then_an_organisation_not_found_error_message_is_displayed
+    expect(@output).to include("Could not find organisation.")
+  end
+
+  def then_a_team_not_found_error_message_is_displayed
+    expect(@output).to include("Could not find team.")
+  end
+
+  def then_a_clinic_not_found_error_message_is_displayed
+    expect(@output).to include("Could not find location: 123456")
+  end
+
+  def then_the_clinic_is_added_to_the_organisation
+    expect(@organisation.community_clinics).to include(@clinic)
+  end
+end

spec/features/cli_clinics_create_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "../../app/lib/mavis_cli"
+
+describe "mavis clinics create" do
+  context "when valid arguments" do
+    it "runs successfully" do
+      when_i_run_the_command
+      then_the_clinic_is_created
+    end
+  end
+
+  private
+
+  def command
+    Dry::CLI.new(MavisCLI).call(
+      arguments: %w[clinics create 123456 Clinic Line Town SW1A1AA]
+    )
+  end
+
+  def when_i_run_the_command
+    @output = capture_output { command }
+  end
+
+  def then_the_clinic_is_created
+    clinic = Location.community_clinic.find_by!(ods_code: "123456")
+
+    expect(clinic.name).to eq("Clinic")
+    expect(clinic.address_line_1).to eq("Line")
+    expect(clinic.address_town).to eq("Town")
+    expect(clinic.address_postcode).to eq("SW1A 1AA")
+  end
+end