EPBR-9262 Add action plans to the scottish register

Add the schema, fixtures and test to make sure the action plans can be migrated and extracted.

Author: Christine-horrocks

Gemfile

@@ -23,7 +23,7 @@ gem "archive-zip"
 gem "aws-sdk-s3", "= 1.209.0"
 gem "csv", "~> 3.3"
 gem "epb-auth-tools", "~> 1.1.0"
-gem "epb_view_models", "~> 2.2.1"
+gem "epb_view_models", "~> 2.2.2"
 gem "geocoder", "~> 1.8.6"
 gem "json-schema", "~> 6.0"
 gem "namecase", "~> 2.0"

Gemfile.lock

@@ -64,7 +64,7 @@ GEM
     epb-auth-tools (1.1.0)
       jwt (~> 2.3)
       oauth2 (>= 1.4, < 3.0)
-    epb_view_models (2.2.1)
+    epb_view_models (2.2.2)
       nokogiri (~> 1.16)
       zeitwerk (~> 2.6)
     faraday (2.14.0)
@@ -283,7 +283,7 @@ DEPENDENCIES
   csv (~> 3.3)
   database_cleaner
   epb-auth-tools (~> 1.1.0)
-  epb_view_models (~> 2.2.1)
+  epb_view_models (~> 2.2.2)
   geocoder (~> 1.8.6)
   json-schema (~> 6.0)
   mock_redis (~> 0.52)

api/schemas/data/orchestrate.json

@@ -231,5 +231,8 @@
   },
   "CEPC-S-7.1": {
     "schema_path": "api/schemas/xml/CEPC-S-7.1/Reports/CEPC-Reports.xsd"
+  },
+  "CS63-S-7.0": {
+    "schema_path": "api/schemas/xml/CS63-S-7.0/ActionPlan.xsd"
   }
 }

api/schemas/xml/CS63-S-7.0/ActionPlan.xsd

@@ -28,7 +28,7 @@ def execute(assessment_id, is_scottish: false)
         schema_type = assessment["schema_type"]
 
         # placeholder logic until other to_certificate_summary_created
-        unless schema_type.start_with?("RdSAP", "SAP", "CEPC")
+        unless schema_type.start_with?("RdSAP", "SAP", "CEPC", "CS63")
           raise Boundary::InvalidAssessment, schema_type
         end
 

lib/use_case/certificate_summary.rb

@@ -12,6 +12,7 @@
   let(:valid_rdsap_not_scottish_xml) { Samples.xml "RdSAP-Schema-19.0" }
   let(:valid_sap_xml) { Samples.xml "SAP-Schema-S-19.0.0" }
   let(:valid_cepc_xml) { Samples.xml "CEPC-S-7.1", "cepc" }
+  let(:valid_action_plan_xml) { Samples.xml "CS63-S-7.0", "cs63" }
   let(:valid_assessor_request_body) do
     AssessorStub.new.fetch_request_body(
       domestic_rd_sap: "ACTIVE",
@@ -239,6 +240,49 @@
       end
     end
 
+    context "when migrating a valid Scottish Action Plan assessment" do
+      expected_action_plan_assessment_data = {
+        "assessment_id" => "0000-0000-0000-0000-0000",
+        "date_of_assessment" => "2025-06-04",
+        "date_registered" => "2025-06-11",
+        "type_of_assessment" => "CS63",
+        "current_energy_efficiency_rating" => 0,
+        "postcode" => "FK1 1XE",
+        "date_of_expiry" => "2028-12-11",
+        "address_line1" => "Non-dom Property",
+        "address_line2" => "",
+        "address_line3" => "",
+        "address_line4" => "",
+        "town" => "Town",
+        "scheme_assessor_id" => "SPEC000000",
+        "opt_out" => false,
+        "address_id" => "0000000001",
+        "migrated" => true,
+        "cancelled_at" => nil,
+        "not_for_issue_at" => nil,
+        "created_at" => "2021-06-21",
+        "hashed_assessment_id" => "4af9d2c31cf53e72ef6f59d3f59a1bfc500ebc2b1027bc5ca47361435d988e1a",
+      }
+
+      it "successfully migrates the assessment" do
+        response = lodge_assessment assessment_body: valid_action_plan_xml,
+                                    accepted_responses: [201],
+                                    scopes: %w[migrate:scotland],
+                                    auth_data: {
+                                      scheme_ids: [scheme_id],
+                                    },
+                                    schema_name: "CS63-S-7.0",
+                                    migrated: "true"
+
+        action_plan_data = ActiveRecord::Base.connection.exec_query(
+          "SELECT * FROM scotland.assessments WHERE assessment_id = '0000-0000-0000-0000-0000'",
+        ).entries.first
+
+        expect(JSON.parse(response.body, symbolize_names: true)[:data][:assessments].first).to eq "0000-0000-0000-0000-0000"
+        expect(action_plan_data).to eq expected_action_plan_assessment_data
+      end
+    end
+
     context "when migrating a non-Scottish domestic assessment" do
       it "rejects a migration" do
         expect(lodge_assessment(

spec/acceptance/scotland-schema/lodge_spec.rb

@@ -460,5 +460,78 @@
         expect(response[:data]).to eq(expected_response)
       end
     end
+
+    context "when requesting an Action Plan assessment" do
+      before do
+        action_plan_xml = Nokogiri.XML Samples.xml("CS63-S-7.0", "cs63")
+        action_plan_xml
+          .xpath("//*[local-name() = 'RRN']")
+          .each do |node|
+          node.content = "0000-0000-0000-0003-0000"
+        end
+        lodge_assessment(
+          assessment_body: action_plan_xml.to_xml,
+          accepted_responses: [201],
+          auth_data: {
+            scheme_ids: [scheme_id],
+          },
+          schema_name: "CS63-S-7.0",
+          migrated: true,
+        )
+      end
+
+      it "returns the expected Action Plan" do
+        response =
+          JSON.parse(
+            fetch_scottish_certificate_summary(id: "0000-0000-0000-0003-0000").body,
+            symbolize_names: true,
+          )
+
+        expected_response = { typeOfAssessment: "CS63",
+                              assessmentId: "0000-0000-0000-0003-0000",
+                              epcAssessmentId: "0000-0000-0000-0000-0001",
+                              saleLeaseDate: "2025-06-13",
+                              reportType: "9",
+                              dateOfAssessment: "2025-06-04",
+                              planReportDate: "2025-06-11",
+                              address: { addressLine1: "Non-dom Property", addressLine2: "", addressLine3: "", addressLine4: "", town: "Town", postcode: "FK1 1XE" },
+                              assessor:
+                               { schemeAssessorId: "SPEC000000",
+                                 contactDetails: { email: "sessor@email.co.uk", tradingAddress: "6 Unit Business Park Town", telephoneNumber: "00000000073" },
+                                 companyName: "EPC R Us Ltd",
+                                 status: "Registered",
+                                 firstName: "Someone",
+                                 lastName: "Person",
+                                 registeredBy: { name: "test scheme", schemeId: scheme_id } },
+                              ownerCommissionReport: "Y",
+                              delegatedPersonCommissionReport: "N",
+                              propertyTypeShortDescription: "General Industrial",
+                              propertyTypeLongDescription: "B2 to B7 General Industrial and Special Industrial Groups",
+                              buildingImprovements: "N",
+                              operationalRatings: "Y",
+                              dec: "N",
+                              plannedCompletionDate: "2028-12-12",
+                              actualCompletionDate: nil,
+                              targetEmissionSavings: "1.61",
+                              targetEnergySavings: "10.11",
+                              acceptPrescriptiveImprovements: "Y",
+                              prescriptiveImprovements:
+                               [{ measureDescriptionShort: "Central time heating control", measureDescriptionLong: nil, measureValid: "N", measureType: nil },
+                                { measureDescriptionShort: "Lighting controls", measureDescriptionLong: nil, measureValid: "Y", measureType: nil },
+                                { measureDescriptionShort: "Draught-stripping windows and doors", measureDescriptionLong: nil, measureValid: "Y", measureType: nil },
+                                { measureDescriptionShort: "Hot water storage insulation", measureDescriptionLong: nil, measureValid: "N", measureType: nil },
+                                { measureDescriptionShort: "Lamp replacement", measureDescriptionLong: nil, measureValid: "N", measureType: nil },
+                                { measureDescriptionShort: "Boiler replacement", measureDescriptionLong: nil, measureValid: "N", measureType: nil },
+                                { measureDescriptionShort: "Roof insulation", measureDescriptionLong: nil, measureValid: "N", measureType: nil }],
+                              alternativeImprovements: [],
+                              addressId: "RRN-0000-0000-0000-0003-0000",
+                              optOut: false,
+                              relatedAssessments: [],
+                              supersededBy: nil,
+                              countryName: "Unknown" }
+
+        expect(response[:data]).to eq(expected_response)
+      end
+    end
   end
 end