Ability to specify type and number of officers in a company

README.md

@@ -47,6 +47,8 @@ In order to use the generator, there are different possible endpoints that can b
   - `type`: The type of the company (e.g., `ltd`, `plc`). Defaults to `ltd`.
   - `sub_type`: The subtype of the company (e.g., `community-interest-company`, `private-fund-limited-partnership`). Defaults to no subtype.
   - `has_super_secure_pscs`: Boolean value to determine if the company has super secure PSCs. Defaults to no value, field not present in the database.
+  - `number_of_appointments`: Used alongside `officer_roles` to determine the number of appointments to create. Defaults to 1.
+  - `officer_roles`: This takes a list of officer roles (`director`, `secretary`). Defaults to director when no role is passed.
 
   An usage example looks like this: `{"jurisdiction":"scotland", "company_status":"administration", "type":"plc", "sub_type":"community-interest-company", "has_super_secure_pscs":true}`
 - DELETE: Sending a DELETE request on the endpoint `{Base URL}/test-data/company/{companyNumber}` will delete the test company. There is a required parameter that is Authcode which needs to be included in the request body to be allowed to delete the test company. An usage example looks like this: `{"auth_code":"222222"}`

src/main/java/uk/gov/companieshouse/api/testdata/model/rest/CompanySpec.java

@@ -6,6 +6,8 @@
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Pattern;
 
+import java.util.List;
+
 /**
  * Requirements a new company must meet.
  */
@@ -34,6 +36,13 @@ public class CompanySpec {
     @JsonProperty("has_super_secure_pscs")
     private Boolean hasSuperSecurePscs;
 
+    @JsonProperty("number_of_appointments")
+    private int numberOfAppointments = 1;
+
+    @JsonProperty("officer_roles")
+    private List<@Pattern(regexp = "director|secretary",
+            message = "Invalid officer role") String> officerRoles;
+
     public CompanySpec() {
         jurisdiction = Jurisdiction.ENGLAND_WALES;
     }
@@ -85,4 +94,20 @@ public Boolean getHasSuperSecurePscs() {
     public void setHasSuperSecurePscs(Boolean hasSuperSecurePscs) {
         this.hasSuperSecurePscs = hasSuperSecurePscs;
     }
+
+    public int getNumberOfAppointments() {
+        return numberOfAppointments;
+    }
+
+    public void setNumberOfAppointments(int numberOfAppointments) {
+        this.numberOfAppointments = numberOfAppointments;
+    }
+
+    public List<String> getOfficerRoles() {
+        return officerRoles;
+    }
+
+    public void setOfficerRoles(List<String> officerRoles) {
+        this.officerRoles = officerRoles;
+    }
 }

src/main/java/uk/gov/companieshouse/api/testdata/repository/AppointmentsRepository.java

@@ -1,6 +1,6 @@
 package uk.gov.companieshouse.api.testdata.repository;
 
-import java.util.Optional;
+import java.util.List;
 
 import org.springframework.data.mongodb.repository.MongoRepository;
 import org.springframework.data.repository.NoRepositoryBean;
@@ -9,5 +9,5 @@
 
 @NoRepositoryBean
 public interface AppointmentsRepository extends MongoRepository<Appointment, String> {
-    Optional<Appointment> findByCompanyNumber(String companyNumber);
+    List<Appointment> findAllByCompanyNumber(String companyNumber);
 }

src/main/java/uk/gov/companieshouse/api/testdata/service/impl/AppointmentsServiceImpl.java

@@ -5,12 +5,14 @@
 import java.time.ZoneId;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Optional;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
-import uk.gov.companieshouse.api.testdata.model.entity.*;
+import uk.gov.companieshouse.api.testdata.model.entity.Appointment;
+import uk.gov.companieshouse.api.testdata.model.entity.Links;
+import uk.gov.companieshouse.api.testdata.model.entity.OfficerAppointment;
+import uk.gov.companieshouse.api.testdata.model.entity.OfficerAppointmentItem;
 import uk.gov.companieshouse.api.testdata.model.rest.CompanySpec;
 import uk.gov.companieshouse.api.testdata.model.rest.Jurisdiction;
 import uk.gov.companieshouse.api.testdata.repository.AppointmentsRepository;
@@ -20,7 +22,7 @@
 import uk.gov.companieshouse.api.testdata.service.RandomService;
 
 @Service
-public class AppointmentsServiceImpl implements DataService<Appointment,CompanySpec> {
+public class AppointmentsServiceImpl implements DataService<List<Appointment>,CompanySpec> {
 
     private static final int SALT_LENGTH = 8;
     private static final int ID_LENGTH = 10;
@@ -40,77 +42,99 @@ public class AppointmentsServiceImpl implements DataService<Appointment,CompanyS
     private OfficerRepository officerRepository;
 
     @Override
-    public Appointment create(CompanySpec spec) {
+    public List<Appointment> create(CompanySpec spec) {
         final String companyNumber = spec.getCompanyNumber();
+        final String countryOfResidence =
+                addressService.getCountryOfResidence(spec.getJurisdiction());
+        int numberOfAppointments = spec.getNumberOfAppointments();
+        if (numberOfAppointments <= 0) {
+            numberOfAppointments = 1;
+        }
 
-        final String countryOfResidence = addressService.getCountryOfResidence(spec.getJurisdiction());
-
-        Appointment appointment = new Appointment();
-
-        String appointmentId = randomService.getEncodedIdWithSalt(ID_LENGTH, SALT_LENGTH);
-
-        LocalDate officerDob = LocalDate.of(1990, 3, 6);
-
-        Instant dateTimeNow = Instant.now();
-        Instant dateNow = LocalDate.now().atStartOfDay(ZoneId.of("UTC")).toInstant();
-        Instant dob = officerDob.atStartOfDay(ZoneId.of("UTC")).toInstant();
-
-        appointment.setId(appointmentId);
-        appointment.setCreated(dateTimeNow);
-
-        String internalId = INTERNAL_ID_PREFIX + this.randomService.getNumber(INTERNAL_ID_LENGTH);
-        String officerId = randomService.addSaltAndEncode(internalId, SALT_LENGTH);
-        appointment.setInternalId(internalId);
-        appointment.setAppointmentId(appointmentId);
-
-        appointment.setNationality("British");
-        appointment.setOccupation(OCCUPATION);
-        appointment.setServiceAddressIsSameAsRegisteredOfficeAddress(true);
-        appointment.setCountryOfResidence(countryOfResidence);
-        appointment.setUpdatedAt(dateTimeNow);
-        appointment.setForename("Test");
-        appointment.setAppointedOn(dateNow);
-        appointment.setOfficerRole("director");
-        appointment.setEtag(randomService.getEtag());
-
-        appointment.setServiceAddress(addressService.getAddress(spec.getJurisdiction()));
-        appointment.setDataCompanyNumber(companyNumber);
-
-        Links links = new Links();
-        links.setSelf(COMPANY_LINK + companyNumber + "/appointments/" + officerId);
-        links.setOfficerSelf(OFFICERS_LINK + officerId);
-        links.setOfficerAppointments(OFFICERS_LINK + officerId + "/appointments");
-        appointment.setLinks(links);
-
-        appointment.setSurname("DIRECTOR");
-        appointment.setDateOfBirth(dob);
+        List<String> officerRoles = spec.getOfficerRoles();
+        if (officerRoles == null) {
+            officerRoles = new ArrayList<>();
+        }
 
-        appointment.setCompanyName("Company " + companyNumber);
-        appointment.setCompanyStatus("active");
-        appointment.setOfficerId(officerId);
-        appointment.setCompanyNumber(companyNumber);
-        appointment.setUpdated(dateTimeNow);
+        while (officerRoles.size() < numberOfAppointments) {
+            officerRoles.add("director");
+        }
 
-        this.createOfficerAppointment(spec, officerId, appointmentId);
+        List<Appointment> createdAppointments = new ArrayList<>();
+
+        for (int i = 0; i < numberOfAppointments; i++) {
+            String currentRole = officerRoles.get(i);
+
+            Appointment appointment = new Appointment();
+
+            String appointmentId = randomService.getEncodedIdWithSalt(ID_LENGTH, SALT_LENGTH);
+            String internalId =
+                    INTERNAL_ID_PREFIX + this.randomService.getNumber(INTERNAL_ID_LENGTH);
+            String officerId =
+                    randomService.addSaltAndEncode(internalId, SALT_LENGTH);
+
+            LocalDate officerDob = LocalDate.of(1990, 3, 6);
+            Instant dateTimeNow = Instant.now();
+            Instant dateNow = LocalDate.now().atStartOfDay(ZoneId.of("UTC")).toInstant();
+            Instant dob = officerDob.atStartOfDay(ZoneId.of("UTC")).toInstant();
+
+            appointment.setId(appointmentId);
+            appointment.setCreated(dateTimeNow);
+            appointment.setInternalId(internalId);
+            appointment.setAppointmentId(appointmentId);
+            appointment.setNationality("British");
+            appointment.setOccupation(OCCUPATION);
+            appointment.setServiceAddressIsSameAsRegisteredOfficeAddress(true);
+            appointment.setCountryOfResidence(countryOfResidence);
+            appointment.setUpdatedAt(dateTimeNow);
+            appointment.setForename("Test " + (i + 1));
+            appointment.setAppointedOn(dateNow);
+            appointment.setOfficerRole(currentRole);
+            appointment.setEtag(randomService.getEtag());
+            appointment.setServiceAddress(addressService.getAddress(spec.getJurisdiction()));
+            appointment.setDataCompanyNumber(companyNumber);
+
+            Links links = new Links();
+            links.setSelf(COMPANY_LINK + companyNumber + "/appointments/" + officerId);
+            links.setOfficerSelf(OFFICERS_LINK + officerId);
+            links.setOfficerAppointments(OFFICERS_LINK + officerId + "/appointments");
+            appointment.setLinks(links);
+
+            appointment.setSurname("DIRECTOR");
+            appointment.setDateOfBirth(dob);
+            appointment.setCompanyName("Company " + companyNumber);
+            appointment.setCompanyStatus("active");
+            appointment.setOfficerId(officerId);
+            appointment.setCompanyNumber(companyNumber);
+            appointment.setUpdated(dateTimeNow);
+
+            this.createOfficerAppointment(spec, officerId, appointmentId, currentRole);
+
+            Appointment savedAppointment = appointmentsRepository.save(appointment);
+            createdAppointments.add(savedAppointment);
+        }
 
-        return appointmentsRepository.save(appointment);
+        return createdAppointments;
     }
 
     @Override
     public boolean delete(String companyNumber) {
-        Optional<Appointment> existingAppointment = appointmentsRepository.findByCompanyNumber(companyNumber);
-
-        if (existingAppointment.isPresent()) {
-            String officerId = existingAppointment.get().getOfficerId();
-            officerRepository.findById(officerId).ifPresent(officerRepository::delete);
-            appointmentsRepository.delete(existingAppointment.get());
+        List<Appointment> foundAppointments =
+                appointmentsRepository.findAllByCompanyNumber(companyNumber);
+
+        if (!foundAppointments.isEmpty()) {
+            for (Appointment ap : foundAppointments) {
+                String officerId = ap.getOfficerId();
+                officerRepository.findById(officerId).ifPresent(officerRepository::delete);
+            }
+            appointmentsRepository.deleteAll(foundAppointments);
             return true;
         }
         return false;
     }
 
-    private void createOfficerAppointment(CompanySpec spec, String officerId, String appointmentId) {
-
+    private void createOfficerAppointment(CompanySpec spec,
+                                          String officerId, String appointmentId, String role) {
         OfficerAppointment officerAppointment = new OfficerAppointment();
 
         Instant dayTimeNow = Instant.now();
@@ -119,7 +143,6 @@ private void createOfficerAppointment(CompanySpec spec, String officerId, String
         officerAppointment.setId(officerId);
         officerAppointment.setCreatedAt(dayTimeNow);
         officerAppointment.setUpdatedAt(dayTimeNow);
-
         officerAppointment.setTotalResults(1);
         officerAppointment.setActiveCount(1);
         officerAppointment.setInactiveCount(0);
@@ -131,17 +154,25 @@ private void createOfficerAppointment(CompanySpec spec, String officerId, String
         links.setSelf(OFFICERS_LINK + officerId + "/appointments");
         officerAppointment.setLinks(links);
 
-        officerAppointment.setEtag(this.randomService.getEtag());
+        officerAppointment.setEtag(randomService.getEtag());
         officerAppointment.setDateOfBirthYear(1990);
         officerAppointment.setDateOfBirthMonth(3);
+
         officerAppointment.setOfficerAppointmentItems(
-                createOfficerAppointmentItems(spec, appointmentId, dayNow, dayTimeNow));
+                createOfficerAppointmentItems(spec, appointmentId, dayNow, dayTimeNow, role)
+        );
 
         officerRepository.save(officerAppointment);
     }
 
-    private List<OfficerAppointmentItem> createOfficerAppointmentItems(CompanySpec companySpec, String appointmentId,
-                                                                       Instant dayNow, Instant dayTimeNow) {
+
+    private List<OfficerAppointmentItem> createOfficerAppointmentItems(
+            CompanySpec companySpec,
+            String appointmentId,
+            Instant dayNow,
+            Instant dayTimeNow,
+            String role
+    ) {
         List<OfficerAppointmentItem> officerAppointmentItemList = new ArrayList<>();
 
         String companyNumber = companySpec.getCompanyNumber();
@@ -152,9 +183,11 @@ private List<OfficerAppointmentItem> createOfficerAppointmentItems(CompanySpec c
         officerAppointmentItem.setAddress(addressService.getAddress(jurisdiction));
         officerAppointmentItem.setForename("Test");
         officerAppointmentItem.setSurname(OCCUPATION);
-        officerAppointmentItem.setOfficerRole("director");
-        officerAppointmentItem.setLinks(createOfficerAppointmentItemLinks(companyNumber, appointmentId));
-        officerAppointmentItem.setCountryOfResidence(addressService.getCountryOfResidence(jurisdiction));
+        officerAppointmentItem.setOfficerRole(role);
+        officerAppointmentItem.setLinks(
+                createOfficerAppointmentItemLinks(companyNumber, appointmentId));
+        officerAppointmentItem.setCountryOfResidence(
+                addressService.getCountryOfResidence(jurisdiction));
         officerAppointmentItem.setAppointedOn(dayNow);
         officerAppointmentItem.setNationality("British");
         officerAppointmentItem.setUpdatedAt(dayTimeNow);

src/main/java/uk/gov/companieshouse/api/testdata/service/impl/TestDataServiceImpl.java

@@ -56,7 +56,7 @@ public class TestDataServiceImpl implements TestDataService {
     @Autowired
     private CompanyAuthCodeService companyAuthCodeService;
     @Autowired
-    private DataService<Appointment, CompanySpec> appointmentService;
+    private DataService<List<Appointment>, CompanySpec> appointmentService;
     @Autowired
     private DataService<CompanyMetrics, CompanySpec> companyMetricsService;
     @Autowired