Merge pull request #3590 from nhsuk/mavis-cli

Add "mavis" CLI runner and "generate" commands

Author: misaka

Gemfile

@@ -31,6 +31,7 @@ gem "config"
 gem "csv"
 gem "devise"
 gem "discard"
+gem "dry-cli"
 gem "factory_bot_rails"
 gem "faker"
 gem "faraday"

Gemfile.lock

@@ -207,6 +207,7 @@ GEM
     docile (1.4.0)
     domain_name (0.6.20240107)
     drb (2.2.3)
+    dry-cli (1.2.0)
     email_validator (2.2.4)
       activemodel
     erb (5.0.1)
@@ -736,6 +737,7 @@ DEPENDENCIES
   debug
   devise
   discard
+  dry-cli
   factory_bot_instruments
   factory_bot_rails
   faker

app/lib/mavis_cli.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module MavisCLI
+  extend Dry::CLI::Registry
+
+  def self.load_rails
+    require_relative "../../config/environment"
+  end
+end
+
+require_relative "mavis_cli/generate/cohort_imports"
+require_relative "mavis_cli/generate/consents"
+require_relative "mavis_cli/generate/vaccination_records"

app/lib/mavis_cli/generate/cohort_imports.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "../../mavis_cli"
+
+module MavisCLI
+  module Generate
+    class CohortImports < Dry::CLI::Command
+      desc "Generate cohort imports"
+      option :patients,
+             type: :integer,
+             required: true,
+             default: 10,
+             desc: "Number of patients to create"
+
+      def call(patients:)
+        MavisCLI.load_rails
+
+        ::Generate::CohortImports.call(patient_count: patients.to_i)
+      end
+    end
+  end
+
+  register "generate", aliases: ["g"] do |prefix|
+    prefix.register "cohort-imports", Generate::CohortImports
+  end
+end

app/lib/mavis_cli/generate/consents.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "../../mavis_cli"
+
+module MavisCLI
+  module Generate
+    class Consents < Dry::CLI::Command
+      desc "Generate consents"
+      option :organisation,
+             aliases: ["-o"],
+             default: "A9A5A",
+             desc: "ODS code of organisation to generate consents for"
+      option :programme_type,
+             aliases: ["-p"],
+             default: "hpv",
+             desc:
+               "Programme type to generate consents for (hpv, menacwy, td_ipv, etc)"
+      option :session_id,
+             aliases: ["-s"],
+             desc:
+               "Generate consents for patients in a session, instead of across the entire organisation"
+      option :given,
+             default: 0,
+             aliases: ["-g"],
+             desc: "Number of given consents to create"
+      option :needing_triage,
+             default: 0,
+             aliases: ["-N"],
+             desc: "Number of given consents that need triage to create"
+      option :refused,
+             default: 0,
+             aliases: ["-r"],
+             desc: "Number of refused consents to create"
+
+      def call(
+        organisation:,
+        programme_type:,
+        given:,
+        needing_triage:,
+        refused:,
+        session_id: nil,
+        **
+      )
+        MavisCLI.load_rails
+
+        session = Session.find(session_id) if session_id
+
+        ::Generate::Consents.call(
+          organisation: Organisation.find_by(ods_code: organisation),
+          programme: Programme.find_by(type: programme_type),
+          session:,
+          given: given.to_i,
+          given_needs_triage: needing_triage.to_i,
+          refused: refused.to_i
+        )
+      end
+    end
+  end
+
+  register "generate", aliases: ["g"] do |prefix|
+    prefix.register "consents", Generate::Consents
+  end
+end

app/lib/mavis_cli/generate/vaccination_records.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MavisCLI
+  module Generate
+    class VaccinationRecords < Dry::CLI::Command
+      desc "Generate vaccination records (and attendances if required)"
+      option :organisation,
+             aliases: ["-o"],
+             default: "A9A5A",
+             desc: "ODS code of organisation to generate consents for"
+      option :programme_type,
+             aliases: ["-p"],
+             default: "hpv",
+             desc:
+               "Programme type to generate consents for (hpv, menacwy, td_ipv, etc)"
+      option :session_id,
+             aliases: ["-s"],
+             desc:
+               "Generate consents for patients in a session, instead of" \
+                 " across the entire organisation"
+      option :administered,
+             default: 0,
+             aliases: ["-A"],
+             desc: "Number of administered vaccination records to create"
+
+      def call(
+        organisation:,
+        programme_type:,
+        administered:,
+        session_id: nil,
+        **
+      )
+        MavisCLI.load_rails
+
+        session = Session.find(session_id) if session_id
+
+        ::Generate::VaccinationRecords.call(
+          organisation: Organisation.find_by(ods_code: organisation),
+          programme:
+            Programme.includes(:organisations).find_by(type: programme_type),
+          session:,
+          administered: administered.to_i
+        )
+      end
+    end
+  end
+
+  register "generate", aliases: ["g"] do |prefix|
+    prefix.register "vaccination-records", Generate::VaccinationRecords
+  end
+end

config/initializers/inflections.rb

@@ -15,6 +15,7 @@
 ActiveSupport::Inflector.inflections(:en) do |inflect|
   inflect.acronym "API"
   inflect.acronym "CIS2"
+  inflect.acronym "CLI"
   inflect.acronym "CSRF"
   inflect.acronym "CSV"
   inflect.acronym "DPS"

lib/generate/consents.rb

@@ -60,9 +60,9 @@ def patients
     end
 
     def random_patients(count)
-      patients
-        .shuffle
-        .take(count)
+      @patients_randomised ||= patients.shuffle
+      @patients_randomised
+        .shift(count)
         .tap do
           if it.size < count
             raise "Only #{it.size} patients without consent in #{programme.type} programme"

script/mavis

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dry/cli"
+
+require_relative "../app/lib/mavis_cli"
+
+Dry::CLI.new(MavisCLI).call

spec/features/cli_generate_consents_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "../../app/lib/mavis_cli"
+
+describe "mavis generate consents" do
+  it "generates consents" do
+    given_an_organisation_exists
+    and_there_are_three_patients_in_a_session
+    when_i_run_the_generate_consents_command
+    then_consents_are_created_with_the_given_statuses
+  end
+
+  def given_an_organisation_exists
+    @organisation = create(:organisation)
+    @programme = create(:programme, type: "hpv")
+  end
+
+  def and_there_are_three_patients_in_a_session
+    @session =
+      create(:session, organisation: @organisation, programmes: [@programme])
+    parent = create(:parent)
+    create_list(
+      :patient,
+      3,
+      organisation: @organisation,
+      session: @session,
+      programmes: [@programme],
+      parents: [parent]
+    )
+  end
+
+  def when_i_run_the_generate_consents_command
+    @consent_count_before = @organisation.consents.count
+
+    Dry::CLI.new(MavisCLI).call(
+      arguments: [
+        "generate",
+        "consents",
+        "-o",
+        @organisation.ods_code.to_s,
+        "-p",
+        @programme.type,
+        "-s",
+        @session.id.to_s,
+        "-g",
+        "1",
+        "-N",
+        "1",
+        "-r",
+        "1"
+      ]
+    )
+  end
+
+  def then_consents_are_created_with_the_given_statuses
+    expect(@organisation.consents.count).to eq @consent_count_before + 3
+
+    expect(
+      @organisation
+        .patient_sessions
+        .has_consent_status(:given, programme: @programme)
+        .has_triage_status(:not_required, programme: @programme)
+        .count
+    ).to eq 1
+  end
+end