Merge pull request #6171 from NHSDigital/fix-flaky-test

Avoid creating vaccines in tests

Author: thomasleese

spec/factories/vaccines.rb

@@ -189,5 +189,13 @@
         snomed_product_term { data["snomed_product_term"] }
       end
     end
+
+    before(:create) do |_vaccine, _evaluator|
+      unless Vaccine.enable_factorybot_factories
+        raise "Do not create vaccines in tests. " \
+                "This introduces dependencies between tests as they get cached " \
+                "on the programme and then deleted from the database."
+      end
+    end
   end
 end

spec/helpers/consents_helper_spec.rb

@@ -4,15 +4,6 @@
   subject(:reasons) { helper.consent_refusal_reasons(consent) }
 
   shared_examples "refusal reason label" do |expected_label|
-    before do
-      create(
-        :vaccine,
-        :contains_gelatine,
-        programme_type: programme.type,
-        disease_types: programme.disease_types
-      )
-    end
-
     it "uses the programme-specific refusal reason label" do
       reason = reasons.find { |reason| reason.value == "contains_gelatine" }
       expect(reason.label).to eq(expected_label) if reason

spec/lib/fhir_mapper/vaccine_spec.rb

@@ -4,7 +4,7 @@
   subject(:fhir_mapper) { described_class.new(vaccine) }
 
   let(:vaccine) do
-    create(
+    build(
       :vaccine,
       :injection,
       snomed_product_code: "183817183",
@@ -58,7 +58,7 @@
     end
 
     context "with flu injection vaccine, dose 1" do
-      let(:vaccine) { create(:vaccine, :flu, :injection) }
+      let(:vaccine) { build(:vaccine, :flu, :injection) }
 
       it "pairs the correct code with the correct term" do
         coding =
@@ -72,7 +72,7 @@
     end
 
     context "with flu nasal vaccine, dose 2" do
-      let(:vaccine) { create(:vaccine, :flu, :nasal) }
+      let(:vaccine) { build(:vaccine, :flu, :nasal) }
 
       it "pairs the correct code with the correct term" do
         coding =

spec/models/batch_spec.rb

@@ -24,11 +24,13 @@
 #  fk_rails_...  (vaccine_id => vaccines.id)
 #
 describe Batch do
-  subject(:batch) { build(:batch) }
+  subject(:batch) { build(:batch, vaccine:) }
+
+  let(:vaccine) { Vaccine.all.sample }
 
   describe "scopes" do
-    let(:archived_batch) { create(:batch, :archived) }
-    let(:not_archived_batch) { create(:batch) }
+    let(:archived_batch) { create(:batch, :archived, vaccine:) }
+    let(:not_archived_batch) { create(:batch, vaccine:) }
 
     describe "#archived" do
       subject(:scope) { described_class.archived }
@@ -79,7 +81,7 @@
     end
 
     context "when already archived" do
-      let(:batch) { create(:batch, :archived) }
+      let(:batch) { create(:batch, :archived, vaccine:) }
 
       it "doesn't change archived_at" do
         expect { archive! }.not_to change(batch, :archived_at)

spec/models/health_question_spec.rb

@@ -33,6 +33,13 @@
   let(:vaccine) { create(:vaccine) }
   let!(:hqs) { create_list(:health_question, 3, vaccine:) }
 
+  around(:all) do |example|
+    # This is safe because we don't reference a programme at any point.
+    Vaccine.enable_factorybot_factories = true
+    example.run
+    Vaccine.enable_factorybot_factories = false
+  end
+
   describe "#first_health_question" do
     it "returns the first health question" do
       hqs.first.update! next_question: hqs.second

spec/policies/batch_policy_spec.rb

@@ -7,9 +7,11 @@
     let(:team) { create(:team) }
     let(:user) { create(:user, team:) }
 
-    let(:batch) { create(:batch, team:) }
-    let(:archived_batch) { create(:batch, :archived, team:) }
-    let(:non_team_batch) { create(:batch) }
+    let(:vaccine) { Vaccine.all.sample }
+
+    let(:batch) { create(:batch, team:, vaccine:) }
+    let(:archived_batch) { create(:batch, :archived, team:, vaccine:) }
+    let(:non_team_batch) { create(:batch, vaccine:) }
 
     it { should include(batch) }
     it { should include(archived_batch) }

spec/spec_helper.rb

@@ -220,7 +220,7 @@
 
   config.before(:suite) do
     DatabaseCleaner.clean_with(:truncation)
-    ProgrammeHelper.create_vaccines!
+    Vaccine.factorybot_create_all!
     DatabaseCleaner.strategy = :transaction
   end
 

spec/support/programme_helper.rb spec/support/vaccine.rbspec/support/programme_helper.rb renamed to spec/support/vaccine.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
-class ProgrammeHelper
-  def self.create_vaccines!
+class Vaccine
+  cattr_accessor :enable_factorybot_factories
+
+  def self.factorybot_create_all!
+    Vaccine.enable_factorybot_factories = true
+
     FactoryBot.create(:vaccine, :cervarix, programme: Programme.hpv)
     FactoryBot.create(:vaccine, :gardasil, programme: Programme.hpv)
     FactoryBot.create(:vaccine, :gardasil_9, programme: Programme.hpv)
@@ -22,5 +26,7 @@ def self.create_vaccines!
     FactoryBot.create(:vaccine, :priorix_tetra, programme: Programme.mmr)
 
     FactoryBot.create(:vaccine, :revaxis, programme: Programme.td_ipv)
+
+    Vaccine.enable_factorybot_factories = false
   end
 end