Use workgroup as team identifier

thomasleese · thomasleese · commit 37c882d5f145 · 2025-08-05T22:07:45.000+01:00
This updates various places where the team was being identified by the
ODS code of it's organisation to the workgroup. This is because a single
organisation can have multiple teams, and the workgroup is the way of
identifying them individually.

Jira-Issue: MAV-1280
diff --git a/app/controllers/api/testing/teams_controller.rb b/app/controllers/api/testing/teams_controller.rb
@@ -9,13 +9,7 @@ def destroy
 
     keep_itself = ActiveModel::Type::Boolean.new.cast(params[:keep_itself])
 
-    # TODO: Select the right team based on an identifier.
-    team =
-      Team.joins(:organisation).find_by!(
-        organisation: {
-          ods_code: params[:ods_code]
-        }
-      )
+    team = Team.find_by!(workgroup: params[:workgroup])
 
     @start_time = Time.zone.now
 
diff --git a/app/lib/mavis_cli/clinics/add_to_team.rb b/app/lib/mavis_cli/clinics/add_to_team.rb
@@ -5,23 +5,17 @@ module Clinics
     class AddToTeam < Dry::CLI::Command
       desc "Add an existing clinic to a team"
 
-      argument :team_ods_code, required: true, desc: "The ODS code of the team"
+      argument :workgroup, required: true, desc: "The ODS code of the team"
       argument :subteam, required: true, desc: "The subteam of the team"
-      argument :clinic_ods_codes,
+      argument :ods_codes,
                type: :array,
                required: true,
                desc: "The ODS codes of the clinics"
 
-      def call(team_ods_code:, subteam:, clinic_ods_codes:, **)
+      def call(workgroup:, subteam:, ods_codes:, **)
         MavisCLI.load_rails
 
-        # TODO: Select the right team based on an identifier.
-        team =
-          Team.joins(:organisation).find_by(
-            organisation: {
-              ods_code: team_ods_code
-            }
-          )
+        team = Team.find_by(workgroup:)
 
         if team.nil?
           warn "Could not find team."
@@ -36,7 +30,7 @@ def call(team_ods_code:, subteam:, clinic_ods_codes:, **)
         end
 
         ActiveRecord::Base.transaction do
-          clinic_ods_codes.each do |ods_code|
+          ods_codes.each do |ods_code|
             location = Location.clinic.find_by(ods_code:)
 
             if location.nil?
diff --git a/app/lib/mavis_cli/generate/consents.rb b/app/lib/mavis_cli/generate/consents.rb
@@ -6,10 +6,10 @@ module MavisCLI
   module Generate
     class Consents < Dry::CLI::Command
       desc "Generate consents"
-      option :team,
-             aliases: ["-o"],
+      option :team_workgroup,
+             aliases: ["-w"],
              default: "A9A5A",
-             desc: "ODS code of team to generate consents for"
+             desc: "Workgroup of team to generate consents for"
       option :programme_type,
              aliases: ["-p"],
              default: "hpv",
@@ -33,7 +33,7 @@ class Consents < Dry::CLI::Command
              desc: "Number of refused consents to create"
 
       def call(
-        team:,
+        team_workgroup:,
         programme_type:,
         given:,
         needing_triage:,
@@ -46,9 +46,7 @@ def call(
         session = Session.find(session_id) if session_id
 
         ::Generate::Consents.call(
-          # TODO: Select the right team based on an identifier.
-          team:
-            Team.joins(:organisation).find_by(organisation: { ods_code: team }),
+          team: Team.find_by(workgroup: team_workgroup),
           programme: Programme.find_by(type: programme_type),
           session:,
           given: given.to_i,
diff --git a/app/lib/mavis_cli/generate/vaccination_records.rb b/app/lib/mavis_cli/generate/vaccination_records.rb
@@ -4,10 +4,10 @@ module MavisCLI
   module Generate
     class VaccinationRecords < Dry::CLI::Command
       desc "Generate vaccination records (and attendances if required)"
-      option :team,
-             aliases: ["-o"],
+      option :team_workgroup,
+             aliases: ["-w"],
              default: "A9A5A",
-             desc: "ODS code of team to generate consents for"
+             desc: "Workgroup of team to generate consents for"
       option :programme_type,
              aliases: ["-p"],
              default: "hpv",
@@ -23,15 +23,19 @@ class VaccinationRecords < Dry::CLI::Command
              aliases: ["-A"],
              desc: "Number of administered vaccination records to create"
 
-      def call(team:, programme_type:, administered:, session_id: nil, **)
+      def call(
+        team_workgroup:,
+        programme_type:,
+        administered:,
+        session_id: nil,
+        **
+      )
         MavisCLI.load_rails
 
         session = Session.find(session_id) if session_id
 
         ::Generate::VaccinationRecords.call(
-          # TODO: Select the right team based on an identifier.
-          team:
-            Team.joins(:organisation).find_by(organisation: { ods_code: team }),
+          team: Team.find_by(workgroup: team_workgroup),
           programme: Programme.includes(:teams).find_by(type: programme_type),
           session:,
           administered: administered.to_i
diff --git a/app/lib/mavis_cli/schools/add_to_team.rb b/app/lib/mavis_cli/schools/add_to_team.rb
@@ -5,7 +5,7 @@ module Schools
     class AddToTeam < Dry::CLI::Command
       desc "Add an existing school to a team"
 
-      argument :ods_code, required: true, desc: "The ODS code of the team"
+      argument :workgroup, required: true, desc: "The ODS code of the team"
       argument :subteam, required: true, desc: "The subteam of the team"
       argument :urns,
                type: :array,
@@ -16,11 +16,10 @@ class AddToTeam < Dry::CLI::Command
              type: :array,
              desc: "The programmes administered at the school"
 
-      def call(ods_code:, subteam:, urns:, programmes: [], **)
+      def call(workgroup:, subteam:, urns:, programmes: [], **)
         MavisCLI.load_rails
 
-        # TODO: Select the right team based on an identifier.
-        team = Team.joins(:organisation).find_by(organisation: { ods_code: })
+        team = Team.find_by(workgroup:)
 
         if team.nil?
           warn "Could not find team."
diff --git a/app/lib/mavis_cli/teams/add_programme.rb b/app/lib/mavis_cli/teams/add_programme.rb
@@ -5,25 +5,14 @@ module Teams
     class AddProgramme < Dry::CLI::Command
       desc "Adds a programme to a team"
 
-      argument :ods_code,
-               required: true,
-               desc: "The ODS code of the organisation"
-
-      argument :name, required: true, desc: "The name of the team"
+      argument :workgroup, required: true, desc: "The workgroup of the team"
 
       argument :type, required: true, desc: "The type of programme to add"
 
-      def call(ods_code:, name:, type:)
+      def call(workgroup:, type:)
         MavisCLI.load_rails
 
-        organisation = Organisation.find_by(ods_code:)
-
-        if organisation.nil?
-          warn "Could not find organisation."
-          return
-        end
-
-        team = organisation.teams.find_by(name:)
+        team = Team.find_by(workgroup:)
 
         if team.nil?
           warn "Could not find team."
diff --git a/app/lib/mavis_cli/teams/create_sessions.rb b/app/lib/mavis_cli/teams/create_sessions.rb
@@ -5,27 +5,16 @@ module Teams
     class CreateSessions < Dry::CLI::Command
       desc "Create sessions for all locations"
 
-      argument :ods_code,
-               required: true,
-               desc: "The ODS code of the organisation"
-
-      argument :name, required: true, desc: "The name of the team"
+      argument :workgroup, required: true, desc: "The workgroup of the team"
 
       option :academic_year,
              type: :integer,
              desc: "The academic year to create the sessions for"
 
-      def call(ods_code:, name:, academic_year: nil)
+      def call(workgroup:, academic_year: nil)
         MavisCLI.load_rails
 
-        organisation = Organisation.find_by(ods_code:)
-
-        if organisation.nil?
-          warn "Could not find organisation."
-          return
-        end
-
-        team = organisation.teams.find_by(name:)
+        team = Team.find_by(workgroup:)
 
         if team.nil?
           warn "Could not find team."
diff --git a/config/routes.rb b/config/routes.rb
@@ -90,7 +90,7 @@
     unless Rails.env.production?
       namespace :testing do
         resources :locations, only: :index
-        resources :teams, only: :destroy, param: :ods_code
+        resources :teams, only: :destroy, param: :workgroup
         post "/onboard", to: "onboard#create"
       end
     end
diff --git a/db/seeds.rb b/db/seeds.rb
@@ -20,13 +20,15 @@ def create_gp_practices
 end
 
 def create_team(ods_code:)
-  # TODO: Select the right team based on an identifier.
-  Team.joins(:organisation).find_by(organisation: { ods_code: }) ||
+  workgroup = ods_code.downcase
+
+  Team.find_by(workgroup:) ||
     FactoryBot.create(
       :team,
       :with_generic_clinic,
       ods_code:,
-      programmes: Programme.all
+      programmes: Programme.all,
+      workgroup:
     )
 end
 
diff --git a/lib/generate/cohort_imports.rb b/lib/generate/cohort_imports.rb
@@ -41,15 +41,14 @@ class CohortImports
                 :progress_bar
 
     def initialize(
-      ods_code: "A9A5A",
+      team_workgroup: "A9A5A",
       programme: "hpv",
       urns: nil,
       school_year_groups: nil,
       patient_count: 10,
       progress_bar: nil
     )
-      # TODO: Select the right team based on an identifier.
-      @team = Team.joins(:organisation).find_by(organisation: { ods_code: })
+      @team = Team.find_by(workgroup: team_workgroup)
       @programme = Programme.find_by(type: programme)
       @urns =
         urns || @team.locations.select { it.urn.present? }.sample(3).pluck(:urn)
diff --git a/lib/tasks/subteams.rake b/lib/tasks/subteams.rake
@@ -8,18 +8,18 @@ namespace :subteams do
 
     Usage:
       rake subteams:create # Complete the prompts
-      rake subteams:create[ods_code,name,email,phone]
+      rake subteams:create[workgroup,name,email,phone]
   DESC
-  task :create, %i[ods_code name email phone] => :environment do |_task, args|
+  task :create, %i[workgroup name email phone] => :environment do |_task, args|
     include TaskHelpers
 
     if args.to_a.empty? && $stdin.isatty && $stdout.isatty
-      ods_code = prompt_user_for "Enter team ODS code:", required: true
+      workgroup = prompt_user_for "Enter team workgroup:", required: true
       name = prompt_user_for "Enter subteam name:", required: true
       email = prompt_user_for "Enter subteam email:", required: true
       phone = prompt_user_for "Enter subteam phone:", required: true
     elsif args.to_a.size == 4
-      ods_code = args[:ods_code]
+      workgroup = args[:workgroup]
       name = args[:name]
       email = args[:email]
       phone = args[:phone]
@@ -28,8 +28,7 @@ namespace :subteams do
     end
 
     ActiveRecord::Base.transaction do
-      # TODO: Select the right team based on an identifier.
-      team = Team.joins(:organisation).find_by!(organisation: { ods_code: })
+      team = Team.find_by!(workgroup:)
 
       subteam = team.subteams.create!(name:, email:, phone:)
 
diff --git a/lib/tasks/teams.rake b/lib/tasks/teams.rake
diff --git a/lib/tasks/users.rake b/lib/tasks/users.rake
@@ -5,7 +5,7 @@ require_relative "../task_helpers"
 namespace :users do
   desc "Create a new user and add them to a team."
   task :create,
-       %i[email password given_name family_name team_ods_code fallback_role] =>
+       %i[email password given_name family_name workgroup fallback_role] =>
          :environment do |_task, args|
     include TaskHelpers
 
@@ -14,7 +14,7 @@ namespace :users do
       password = prompt_user_for "Enter password:", required: true
       given_name = prompt_user_for "Enter given name:", required: true
       family_name = prompt_user_for "Enter family name:", required: true
-      team_ods_code = prompt_user_for "Enter team ODS code:", required: true
+      workgroup = prompt_user_for "Enter team workgroup:", required: true
       fallback_role =
         prompt_user_for "Enter fallback role (nurse/admin):",
                         default: "nurse",
@@ -26,19 +26,13 @@ namespace :users do
       password = args[:password]
       given_name = args[:given_name]
       family_name = args[:family_name]
-      team_ods_code = args[:team_ods_code]
+      workgroup = args[:workgroup]
       fallback_role = args[:fallback_role] || "nurse"
     else
       raise "Expected 5-6 arguments, got #{args.to_a.size}"
     end
 
-    # TODO: Select the right team based on an identifier.
-    team =
-      Team.joins(:organisation).find_by!(
-        organisation: {
-          ods_code: team_ods_code
-        }
-      )
+    team = Team.find_by(workgroup:)
 
     user =
       User.create!(email:, password:, family_name:, given_name:, fallback_role:)
diff --git a/spec/controllers/api/testing/teams_controller_spec.rb b/spec/controllers/api/testing/teams_controller_spec.rb
@@ -10,7 +10,13 @@
     let(:programmes) { [create(:programme, :hpv_all_vaccines)] }
 
     let(:team) do
-      create(:team, :with_generic_clinic, ods_code: "R1L", programmes:)
+      create(
+        :team,
+        :with_generic_clinic,
+        ods_code: "R1L",
+        workgroup: "r1l",
+        programmes:
+      )
     end
 
     let(:cohort_import) do
@@ -69,7 +75,7 @@
     end
 
     it "deletes associated data" do
-      expect { delete :destroy, params: { ods_code: "r1l" } }.to(
+      expect { delete :destroy, params: { workgroup: "r1l" } }.to(
         change(Team, :count)
           .by(-1)
           .and(change(Subteam, :count).by(-1))
@@ -87,7 +93,7 @@
 
     context "when keeping itself" do
       subject(:call) do
-        delete :destroy, params: { ods_code: "r1l", keep_itself: "true" }
+        delete :destroy, params: { workgroup: "r1l", keep_itself: "true" }
       end
 
       it "deletes associated data" do
diff --git a/spec/features/cli_clinics_add_to_team_spec.rb b/spec/features/cli_clinics_add_to_team_spec.rb
@@ -44,12 +44,12 @@
 
   def command
     Dry::CLI.new(MavisCLI).call(
-      arguments: %w[clinics add-to-team ABC Team 123456]
+      arguments: %w[clinics add-to-team abc Team 123456]
     )
   end
 
   def given_the_team_exists
-    @team = create(:team, ods_code: "ABC")
+    @team = create(:team, workgroup: "abc")
   end
 
   def and_the_subteam_exists
diff --git a/spec/features/cli_generate_consents_spec.rb b/spec/features/cli_generate_consents_spec.rb
diff --git a/spec/features/cli_generate_vaccination_records_spec.rb b/spec/features/cli_generate_vaccination_records_spec.rb
diff --git a/spec/features/cli_schools_add_to_team_spec.rb b/spec/features/cli_schools_add_to_team_spec.rb
diff --git a/spec/features/cli_teams_add_programme_spec.rb b/spec/features/cli_teams_add_programme_spec.rb
diff --git a/spec/features/cli_teams_create_sessions_spec.rb b/spec/features/cli_teams_create_sessions_spec.rb
diff --git a/spec/lib/generate/cohort_imports_spec.rb b/spec/lib/generate/cohort_imports_spec.rb
