EventConsumerVerticleTest.java

package org.folio.rest.api;

import static com.github.tomakehurst.wiremock.client.WireMock.ok;
import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching;
import static io.vertx.core.json.JsonObject.mapFrom;
import static java.lang.String.format;
import static java.util.concurrent.TimeUnit.SECONDS;
import static org.apache.kafka.clients.producer.ProducerConfig.ACKS_CONFIG;
import static org.apache.kafka.clients.producer.ProducerConfig.BOOTSTRAP_SERVERS_CONFIG;
import static org.awaitility.Awaitility.waitAtMost;
import static org.folio.kafka.services.KafkaEnvironmentProperties.environment;
import static org.folio.kafka.services.KafkaEnvironmentProperties.host;
import static org.folio.kafka.services.KafkaEnvironmentProperties.port;
import static org.folio.rest.RestVerticle.OKAPI_HEADER_TOKEN;
import static org.folio.rest.api.StorageTestSuite.PROXY_PORT;
import static org.folio.rest.api.StorageTestSuite.TENANT_ID;
import static org.folio.rest.api.StorageTestSuite.getVertx;
import static org.folio.rest.support.builders.RequestRequestBuilder.OPEN_NOT_YET_FILLED;
import static org.folio.rest.tools.utils.ModuleName.getModuleName;
import static org.folio.rest.tools.utils.ModuleName.getModuleVersion;
import static org.folio.rest.util.OkapiConnectionParams.OKAPI_TENANT_HEADER;
import static org.folio.rest.util.OkapiConnectionParams.OKAPI_URL_HEADER;
import static org.folio.service.event.InventoryEventType.INVENTORY_ITEM_UPDATED;
import static org.folio.service.event.InventoryEventType.INVENTORY_LOCATION_UPDATED;
import static org.folio.service.event.InventoryEventType.INVENTORY_SERVICE_POINT_DELETED;
import static org.folio.service.event.InventoryEventType.INVENTORY_SERVICE_POINT_UPDATED;
import static org.folio.service.event.handler.processor.ItemUpdateProcessorForRequest.ITEM_EFFECTIVE_LOCATION_ID;
import static org.folio.service.event.handler.processor.ItemUpdateProcessorForRequest.ITEM_EFFECTIVE_LOCATION_NAME;
import static org.folio.service.event.handler.processor.ItemUpdateProcessorForRequest.RETRIEVAL_SERVICE_POINT_ID;
import static org.folio.service.event.handler.processor.ItemUpdateProcessorForRequest.RETRIEVAL_SERVICE_POINT_NAME;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.hasItem;
import static org.hamcrest.CoreMatchers.hasItems;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.MatcherAssert.assertThat;

import java.net.URL;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Properties;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.Callable;
import java.util.stream.Collectors;

import org.folio.rest.jaxrs.model.AllowedServicePoints;
import org.folio.rest.jaxrs.model.CallNumberComponents;
import org.folio.rest.jaxrs.model.RequestType;
import org.folio.rest.jaxrs.model.SearchIndex;
import org.folio.rest.support.ApiTests;
import org.folio.rest.support.builders.ItemBuilder;
import org.folio.rest.support.builders.ItemBuilder.ItemCallNumberComponents;
import org.folio.rest.support.builders.LocationBuilder;
import org.folio.rest.support.builders.RequestItemSummary;
import org.folio.rest.support.builders.RequestPolicyBuilder;
import org.folio.rest.support.builders.RequestRequestBuilder;
import org.folio.rest.support.builders.ServicePointBuilder;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;

import com.github.tomakehurst.wiremock.client.WireMock;

import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;
import io.vertx.kafka.admin.KafkaAdminClient;
import io.vertx.kafka.client.common.TopicPartition;
import io.vertx.kafka.client.consumer.OffsetAndMetadata;
import io.vertx.kafka.client.producer.KafkaProducer;
import io.vertx.kafka.client.producer.KafkaProducerRecord;
import junitparams.JUnitParamsRunner;
import junitparams.Parameters;
import junitparams.converters.Nullable;
import lombok.SneakyThrows;

@RunWith(JUnitParamsRunner.class)
public class EventConsumerVerticleTest extends ApiTests {

  private static final String REQUEST_ID = "5d2bc53d-db13-4a51-a5a6-160a703706f1";
  private static final String REQUEST_POLICY_STORAGE_URL =
    "/request-policy-storage/request-policies";
  private static final String REQUEST_STORAGE_URL = "/request-storage/requests";
  private static final String KAFKA_SERVER_URL = format("%s:%s", host(), port());
  private final static String DEFAULT_PICKUP_SERVICE_POINT_NAME = "Circ Desk 1";
  private final static String DEFAULT_CALL_NUMBER_PREFIX = "prefix";
  private final static String DEFAULT_CALL_NUMBER = "callNumber";
  private final static String DEFAULT_CALL_NUMBER_SUFFIX = "suffix";
  private final static String DEFAULT_SHELVING_ORDER = "shelvingOrder";

  private static final String INVENTORY_ITEM_TOPIC = format(
    "%s.%s.inventory.item", environment(), TENANT_ID);
  private static final String INVENTORY_SERVICE_POINT_TOPIC = format(
    "%s.%s.inventory.service-point", environment(), TENANT_ID);
  private static final String INVENTORY_LOCATION_TOPIC = format(
          "%s.%s.inventory.location", environment(), TENANT_ID);

  private static KafkaProducer<String, JsonObject> producer;
  private static KafkaAdminClient adminClient;

  @BeforeClass
  public static void setUpClass() {
    producer = createProducer();
    adminClient = createAdminClient();
  }

  @AfterClass
  public static void tearDownClass() {
    waitFor(
      producer.close()
        .compose(v -> adminClient.close())
    );
  }

  @After
  public void afterEach() {
    truncateTable("request");
    truncateTable("request_policy");
  }

  @Parameters({
    "OLD_PFX | NEW_PFX | OLD_CN | OLD_CN | OLD_SFX | OLD_SFX | OLD_SO | OLD_SO", // prefix changed
    "OLD_PFX | null    | OLD_CN | OLD_CN | OLD_SFX | OLD_SFX | OLD_SO | OLD_SO", // prefix removed
    "null    | NEW_PFX | OLD_CN | OLD_CN | OLD_SFX | OLD_SFX | OLD_SO | OLD_SO", // prefix added

    "OLD_PFX | OLD_PFX | OLD_CN | NEW_CN | OLD_SFX | OLD_SFX | OLD_SO | OLD_SO", // call number changed
    "OLD_PFX | OLD_PFX | OLD_CN | null   | OLD_SFX | OLD_SFX | OLD_SO | OLD_SO", // call number removed
    "OLD_PFX | OLD_PFX | null   | NEW_CN | OLD_SFX | OLD_SFX | OLD_SO | OLD_SO", // call number added

    "OLD_PFX | OLD_PFX | OLD_CN | OLD_CN | OLD_SFX | NEW_SFX | OLD_SO | OLD_SO", // suffix changed
    "OLD_PFX | OLD_PFX | OLD_CN | OLD_CN | OLD_SFX | null    | OLD_SO | OLD_SO", // suffix removed
    "OLD_PFX | OLD_PFX | OLD_CN | OLD_CN | null    | NEW_SFX | OLD_SO | OLD_SO", // suffix added

    "OLD_PFX | OLD_PFX | OLD_CN | OLD_CN | OLD_SFX | OLD_SFX | OLD_SO | NEW_SO", // shelving order changed
    "OLD_PFX | OLD_PFX | OLD_CN | OLD_CN | OLD_SFX | OLD_SFX | OLD_SO | null  ", // shelving order removed
    "OLD_PFX | OLD_PFX | OLD_CN | OLD_CN | OLD_SFX | OLD_SFX | null   | NEW_SO", // shelving order added

    "OLD_PFX | NEW_PFX | OLD_CN | NEW_CN | OLD_SFX | NEW_SFX | OLD_SO | NEW_SO", // everything changed
    "OLD_PFX | null    | OLD_CN | null   | OLD_SFX | null    | OLD_SO | null  ", // everything removed
    "null    | NEW_PFX | null   | NEW_CN | null    | NEW_SFX | null   | NEW_SO", // everything added
  })
  @Test
  public void requestSearchIndexIsUpdatedWhenItemIsUpdated(
    @Nullable String oldPrefix, @Nullable String newPrefix,
    @Nullable String oldCallNumber, @Nullable String newCallNumber,
    @Nullable String oldSuffix, @Nullable String newSuffix,
    @Nullable String oldShelvingOrder, @Nullable String newShelvingOrder) {


    JsonObject oldItem = buildItem(oldPrefix, oldCallNumber, oldSuffix, oldShelvingOrder);
    JsonObject newItem = buildItem(newPrefix, newCallNumber, newSuffix, newShelvingOrder);
    SearchIndex oldIndex = buildSearchIndex(oldPrefix, oldCallNumber, oldSuffix, oldShelvingOrder);
    SearchIndex newIndex = buildSearchIndex(newPrefix, newCallNumber, newSuffix, newShelvingOrder);

    createRequest(buildRequest(REQUEST_ID, oldItem));
    verifyRequestSearchIndex(REQUEST_ID, oldIndex);

    publishItemUpdateEvent(oldItem, newItem);
    verifyRequestSearchIndex(REQUEST_ID, newIndex);
  }

  @Test
  public void requestSearchIndexIsNotUpdatedWhenEventContainsNoRelevantChanges() {
    JsonObject oldItem = buildItem(DEFAULT_CALL_NUMBER_PREFIX, DEFAULT_CALL_NUMBER,
      DEFAULT_CALL_NUMBER_SUFFIX, DEFAULT_SHELVING_ORDER);
    JsonObject newItem = oldItem.copy().put("barcode", "new-barcode"); // irrelevant change
    SearchIndex searchIndex = buildSearchIndex(DEFAULT_CALL_NUMBER_PREFIX, DEFAULT_CALL_NUMBER,
      DEFAULT_CALL_NUMBER_SUFFIX, DEFAULT_SHELVING_ORDER);

    createRequest(buildRequest(REQUEST_ID, oldItem));
    verifyRequestSearchIndex(REQUEST_ID, searchIndex);

    int initialOffset = getOffsetForItemUpdateEvents();
    publishItemUpdateEvent(oldItem, newItem);
    waitUntilValueIsIncreased(initialOffset, EventConsumerVerticleTest::getOffsetForItemUpdateEvents);
    verifyRequestSearchIndex(REQUEST_ID, searchIndex);
  }

  @Test
  public void requestItemLocationAndSpIsSetWhenItemEffectiveLocationChange() {
    JsonObject oldItem = buildItem(DEFAULT_CALL_NUMBER_PREFIX, DEFAULT_CALL_NUMBER,
            DEFAULT_CALL_NUMBER_SUFFIX, DEFAULT_SHELVING_ORDER);
    JsonObject newItem = oldItem.copy();

    //Creating and mocking ServicePoint
    String servicePointId = UUID.randomUUID().toString();
    JsonObject servicePoint = buildServicePoint(servicePointId, "ServicePoint-1");
    createStubForServicePoints(List.of(servicePoint));

    //Creating and mocking Location
    String locationId = UUID.randomUUID().toString();
    JsonObject location = buildLocation(locationId, "Location-1", servicePointId);
    createStubForLocations(List.of(location));
    newItem.put("effectiveLocationId", locationId);

    // Expected item
    JsonObject expectedItem = new JsonObject();
    expectedItem.put(ITEM_EFFECTIVE_LOCATION_ID, locationId);
    expectedItem.put(ITEM_EFFECTIVE_LOCATION_NAME, location.getString("name"));
    expectedItem.put(RETRIEVAL_SERVICE_POINT_ID, servicePointId);
    expectedItem.put(RETRIEVAL_SERVICE_POINT_NAME, servicePoint.getString("name"));

    createRequest(buildRequest(REQUEST_ID, oldItem));

    int initialOffset = getOffsetForItemUpdateEvents();
    publishItemUpdateEvent(oldItem, newItem);
    waitUntilValueIsIncreased(initialOffset, EventConsumerVerticleTest::getOffsetForItemUpdateEvents);
    verifyRequestItem(REQUEST_ID, expectedItem);
  }

  @Test
  public void requestItemSpIsSetWhenItemEffectiveLocationPrimarySpChange() {
    //Creating and mocking ServicePoint
    String servicePointId = UUID.randomUUID().toString();
    JsonObject servicePoint = buildServicePoint(servicePointId, "ServicePoint-1");
    createStubForServicePoints(List.of(servicePoint));

    //Creating and mocking Location
    String locationId = UUID.randomUUID().toString();
    JsonObject location = buildLocation(locationId, "Location-1", servicePointId);
    createStubForLocations(List.of(location));

    //Creating request with retrieval service-point in item object
    JsonObject item = buildItem();
    JsonObject request = buildRequest(REQUEST_ID, item);
    JsonObject requestItem = request.getJsonObject("item");
    requestItem.put(RETRIEVAL_SERVICE_POINT_ID, servicePointId);
    requestItem.put(RETRIEVAL_SERVICE_POINT_NAME, servicePoint.getString("name"));
    createRequest(request);

    int initialOffset = getOffsetForServicePointUpdateEvents();

    //Change ServicePoint Name in stub and publish SP update event
    JsonObject servicePointNew = servicePoint.copy();
    servicePointNew.put("name", "ServicePoint-2-Changed");
    publishServicePointUpdateEvent(servicePoint, servicePointNew);

    // Expected RETRIEVAL_SERVICE_POINT in item
    JsonObject expectedItemRetrivalServicePoint = new JsonObject();
    expectedItemRetrivalServicePoint.put(RETRIEVAL_SERVICE_POINT_ID, servicePointId);
    expectedItemRetrivalServicePoint.put(RETRIEVAL_SERVICE_POINT_NAME, servicePointNew.getString("name"));

    waitUntilValueIsIncreased(initialOffset, EventConsumerVerticleTest::getOffsetForServicePointUpdateEvents);
    verifyRequestItemRetrievalServicePoint(REQUEST_ID, expectedItemRetrivalServicePoint);
  }

  @Test
  public void requestItemLocationIsSetWhenItemEffectiveLocationNameChange() {
    //Creating and mocking ServicePoint
    String servicePointId = UUID.randomUUID().toString();
    JsonObject servicePoint = buildServicePoint(servicePointId, "ServicePoint-1");
    createStubForServicePoints(List.of(servicePoint));

    //Creating and mocking Location
    String locationId = UUID.randomUUID().toString();
    JsonObject location = buildLocation(locationId, "Location-1", servicePointId);
    createStubForLocations(List.of(location));

    //Creating request with location in item object
    JsonObject item = buildItem();
    JsonObject request = buildRequest(REQUEST_ID, item);
    JsonObject requestItem = request.getJsonObject("item");
    requestItem.put(ITEM_EFFECTIVE_LOCATION_ID, locationId);
    requestItem.put(ITEM_EFFECTIVE_LOCATION_NAME, location.getString("name"));
    createRequest(request);

    int initialOffset = getOffsetForLocationUpdateEvents();

    //Change Location Name in stub and publish location update event
    JsonObject locationNew = location.copy();
    locationNew.put("name", "Location-2-Changed");
    publishLocationUpdateEvent(location, locationNew);

    // Expected LOCATION in item
    JsonObject expectedItemLocation = new JsonObject();
    expectedItemLocation.put(ITEM_EFFECTIVE_LOCATION_ID, locationId);
    expectedItemLocation.put(ITEM_EFFECTIVE_LOCATION_NAME, locationNew.getString("name"));

    waitUntilValueIsIncreased(initialOffset, EventConsumerVerticleTest::getOffsetForLocationUpdateEvents);
    verifyRequestItemEffectiveLocation(REQUEST_ID, expectedItemLocation);
  }

  @Test
  public void requestSearchIndexIsNotUpdatedWhenRequestAndEventAreForDifferentItems() {
    JsonObject oldItem = buildItem(DEFAULT_CALL_NUMBER_PREFIX, DEFAULT_CALL_NUMBER,
      DEFAULT_CALL_NUMBER_SUFFIX, DEFAULT_SHELVING_ORDER);
    JsonObject newItem = oldItem.copy().put("effectiveShelvingOrder", "new-order"); // relevant change
    SearchIndex searchIndex = buildSearchIndex(DEFAULT_CALL_NUMBER_PREFIX, DEFAULT_CALL_NUMBER,
      DEFAULT_CALL_NUMBER_SUFFIX, DEFAULT_SHELVING_ORDER);

    JsonObject request = buildRequest(REQUEST_ID, oldItem).put("itemId", randomId());
    createRequest(request);
    verifyRequestSearchIndex(REQUEST_ID, searchIndex);

    int initialOffset = getOffsetForItemUpdateEvents();
    publishItemUpdateEvent(oldItem, newItem);
    waitUntilValueIsIncreased(initialOffset, EventConsumerVerticleTest::getOffsetForItemUpdateEvents);
    verifyRequestSearchIndex(REQUEST_ID, searchIndex);
  }

  @Parameters({
    "OLD_SP_NAME | NEW_SP_NAME", // service point name changed
    "OLD_SP_NAME | null       ", // service point name removed
    "null        | NEW_SP_NAME", // service point name added
  })
  @Test
  public void requestPickupServicePointNameIsUpdatedWhenServicePointIsUpdated(
    @Nullable String oldServicePointName, @Nullable String newServicePointName) {

    JsonObject item = buildItem();
    String servicePointId = randomId();

    JsonObject oldServicePoint = buildServicePoint(servicePointId, oldServicePointName);
    JsonObject newServicePoint = buildServicePoint(servicePointId, newServicePointName);
    SearchIndex oldIndex = buildSearchIndex(oldServicePointName);
    SearchIndex newIndex = buildSearchIndex(newServicePointName);

    JsonObject request = buildRequest(REQUEST_ID, item, servicePointId, oldServicePointName);
    createRequest(request);
    verifyRequestSearchIndex(REQUEST_ID, oldIndex);

    int initialOffset = getOffsetForServicePointUpdateEvents();
    publishServicePointUpdateEvent(oldServicePoint, newServicePoint);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointUpdateEvents);
    verifyRequestSearchIndex(REQUEST_ID, newIndex);
  }

  @Test
  public void requestPickupServicePointNameIsNotUpdatedWhenEventContainsNoRelevantChanges() {
    JsonObject item = buildItem();
    String servicePointId = randomId();

    JsonObject oldServicePoint = buildServicePoint(servicePointId,
      DEFAULT_PICKUP_SERVICE_POINT_NAME, "code1");
    JsonObject newServicePoint = buildServicePoint(servicePointId,
      DEFAULT_PICKUP_SERVICE_POINT_NAME, "code2");
    SearchIndex searchIndex = buildSearchIndex(DEFAULT_PICKUP_SERVICE_POINT_NAME);

    JsonObject request = buildRequest(REQUEST_ID, item, servicePointId,
      DEFAULT_PICKUP_SERVICE_POINT_NAME);
    createRequest(request);
    verifyRequestSearchIndex(REQUEST_ID, searchIndex);

    int initialOffset = getOffsetForServicePointUpdateEvents();
    publishServicePointUpdateEvent(oldServicePoint, newServicePoint);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointUpdateEvents);
    verifyRequestSearchIndex(REQUEST_ID, searchIndex);
  }

  @Test
  public void
  requestPickupServicePointNameIsNotUpdatedWhenRequestAndEventAreForDifferentServicePoints() {
    JsonObject item = buildItem();
    String servicePointId = randomId();
    String oldServicePointName = "oldName";
    String newServicePointName = "newName";

    JsonObject oldServicePoint = buildServicePoint(servicePointId, oldServicePointName);
    JsonObject newServicePoint = buildServicePoint(servicePointId, newServicePointName);
    SearchIndex searchIndex = buildSearchIndex(oldServicePointName);

    JsonObject request = buildRequest(REQUEST_ID, item, randomId(), oldServicePointName);
    createRequest(request);
    verifyRequestSearchIndex(REQUEST_ID, searchIndex);

    int initialOffset = getOffsetForServicePointUpdateEvents();
    publishServicePointUpdateEvent(oldServicePoint, newServicePoint);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointUpdateEvents);
    verifyRequestSearchIndex(REQUEST_ID, searchIndex);
  }

  @Test
  public void requestPolicyIsUpdatedWhenServicePointIsDeleted() {
    String requestPolicyId = randomId();

    String servicePoint1Id = randomId();
    String servicePoint2Id = randomId();
    String servicePoint3Id = randomId();
    JsonObject servicePoint1 = buildServicePoint(servicePoint1Id, "sp-1");
    JsonObject servicePoint2 = buildServicePoint(servicePoint2Id, "sp-2");
    JsonObject servicePoint3 = buildServicePoint(servicePoint3Id, "sp-3");
    createStubForServicePoints(List.of(servicePoint1, servicePoint2, servicePoint3));

    var requestTypes = List.of(RequestType.HOLD, RequestType.PAGE, RequestType.RECALL);
    var allowedServicePoints = new AllowedServicePoints()
      .withHold(Set.of(servicePoint1Id, servicePoint2Id))
      .withPage(Set.of(servicePoint3Id));
    JsonObject requestPolicy = buildRequestPolicy(requestPolicyId, requestTypes,
      allowedServicePoints);
    createRequestPolicy(requestPolicy);

    int initialOffset = getOffsetForServicePointDeleteEvents();

    // Delete service point 2 and check that allowed service points for Hold type changed from
    // (sp-1, sp-2) to (sp-1)
    publishServicePointDeleteEvent(servicePoint2);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointDeleteEvents);
    verifyRequestPolicyAllowedServicePoints(requestPolicyId, RequestType.HOLD,
      List.of(servicePoint1Id));
    verifyRequestPolicyAllowedServicePoints(requestPolicyId, RequestType.PAGE,
      List.of(servicePoint3Id));

    // Delete service point 3 and check that Page is not allowed
    publishServicePointDeleteEvent(servicePoint3);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointDeleteEvents);
    verifyRequestPolicyAllowedServicePoints(requestPolicyId, RequestType.HOLD,
      List.of(servicePoint1Id));
    verifyRequestTypeIsNotAllowedByRequestPolicy(requestPolicyId, RequestType.PAGE);

    // Delete service point 1 and check that Hold is not allowed
    publishServicePointDeleteEvent(servicePoint1);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointDeleteEvents);
    verifyRequestTypeIsNotAllowedByRequestPolicy(requestPolicyId, RequestType.PAGE);
    verifyRequestTypeIsNotAllowedByRequestPolicy(requestPolicyId, RequestType.HOLD);
  }

  @Test
  public void requestPolicyIsNotUpdatedWhenServicePointIsDeletedWithInvalidKafkaMessagePayload() {
    String requestPolicyId = randomId();

    String servicePoint1Id = randomId();
    String servicePoint2Id = randomId();
    String servicePoint3Id = randomId();
    JsonObject servicePoint1 = buildServicePoint(servicePoint1Id, "sp-1");
    JsonObject servicePoint2 = buildServicePoint(servicePoint2Id, "sp-2");
    JsonObject servicePoint3 = buildServicePoint(servicePoint3Id, "sp-3");
    createStubForServicePoints(List.of(servicePoint1, servicePoint2, servicePoint3));

    var requestTypes = List.of(RequestType.HOLD, RequestType.PAGE, RequestType.RECALL);
    var allowedServicePoints = new AllowedServicePoints()
      .withHold(Set.of(servicePoint1Id, servicePoint2Id))
      .withPage(Set.of(servicePoint3Id));
    JsonObject requestPolicy = buildRequestPolicy(requestPolicyId, requestTypes,
      allowedServicePoints);
    createRequestPolicy(requestPolicy);

    int initialOffset = getOffsetForServicePointDeleteEvents();

    // Invalid delete event, nothing should change
    publishInvalidServicePointDeleteEvent(servicePoint2);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointDeleteEvents);
    verifyRequestPolicyAllowedServicePoints(requestPolicyId, RequestType.HOLD,
      List.of(servicePoint1Id, servicePoint2Id));
    verifyRequestPolicyAllowedServicePoints(requestPolicyId, RequestType.PAGE,
      List.of(servicePoint3Id));
  }

  @Parameters({ "false", "null"})
  @Test
  public void shouldUpdateRequestPolicyWhenServicePointIsNoLongerPickupLocation(
    Boolean isPickupLocation) {

    String updatedServicePointId = randomId();
    String anotherServicePointId = randomId();
    JsonObject anotherServicePoint = buildServicePoint(anotherServicePointId, "anotherSp", true);
    JsonObject oldServicePoint = buildServicePoint(updatedServicePointId, "oldSp", true);
    JsonObject newServicePoint = buildServicePoint(updatedServicePointId, "newSp", isPickupLocation);
    createStubForServicePoints(List.of(anotherServicePoint, oldServicePoint));

    JsonObject requestPolicy = buildRequestPolicy(List.of(
      updatedServicePointId, anotherServicePointId), RequestType.HOLD, RequestType.PAGE);
    createRequestPolicy(requestPolicy);

    int initialOffset = getOffsetForServicePointUpdateEvents();
    publishServicePointUpdateEvent(oldServicePoint, newServicePoint);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointUpdateEvents);

    JsonObject requestPolicyById = getRequestPolicy(requestPolicy.getString("id"));
    JsonObject allowedServicePoints = requestPolicyById.getJsonObject("allowedServicePoints");
    JsonArray holdAllowedServicePoints = allowedServicePoints.getJsonArray("Hold");
    JsonArray pageAllowedServicePoints = allowedServicePoints.getJsonArray("Page");

    assertThat(holdAllowedServicePoints.size(), is(1));
    assertThat(holdAllowedServicePoints, hasItem(anotherServicePointId));
    assertThat(pageAllowedServicePoints.size(), is(1));
    assertThat(holdAllowedServicePoints, hasItem(anotherServicePointId));
  }

  @Test
  public void shouldNotUpdateRequestPolicyWhenServicePointPickupLocationWasNotChanged() {
    String updatedServicePointId = randomId();
    String anotherServicePointId = randomId();
    JsonObject oldServicePoint = buildServicePoint(updatedServicePointId, "oldSp", true);
    JsonObject anotherServicePoint = buildServicePoint(anotherServicePointId, "anotherSp", true);
    JsonObject newServicePoint = buildServicePoint(updatedServicePointId, "newSp", true);
    createStubForServicePoints(List.of(anotherServicePoint, oldServicePoint));

    JsonObject requestPolicy = buildRequestPolicy(List.of(
      updatedServicePointId, anotherServicePointId), RequestType.PAGE, RequestType.RECALL);
    createRequestPolicy(requestPolicy);

    int initialOffset = getOffsetForServicePointUpdateEvents();
    publishServicePointUpdateEvent(oldServicePoint, newServicePoint);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointUpdateEvents);

    JsonObject requestPolicyById = getRequestPolicy(requestPolicy.getString("id"));
    JsonObject allowedServicePoints = requestPolicyById.getJsonObject("allowedServicePoints");
    JsonArray pageAllowedServicePoints = allowedServicePoints.getJsonArray("Page");
    JsonArray recallAllowedServicePoints = allowedServicePoints.getJsonArray("Recall");

    assertThat(pageAllowedServicePoints.size(), is(2));
    assertThat(pageAllowedServicePoints, hasItems(updatedServicePointId, anotherServicePointId));
    assertThat(recallAllowedServicePoints.size(), is(2));
    assertThat(recallAllowedServicePoints, hasItems(updatedServicePointId, anotherServicePointId));
  }

  @Parameters({ "false", "null"})
  @Test
  public void shouldRemoveAllowedServicePointsWhenSingleServicePointBecomesNotPickupLocation(
    Boolean isPickupLocation) {

    String updatedServicePointId = randomId();
    JsonObject oldServicePoint = buildServicePoint(updatedServicePointId, "oldSp", true);
    JsonObject newServicePoint = buildServicePoint(updatedServicePointId, "newSp", isPickupLocation);
    createStubForServicePoints(List.of(oldServicePoint));

    JsonObject requestPolicy = buildRequestPolicy(List.of(updatedServicePointId),
      RequestType.HOLD, RequestType.PAGE);
    createRequestPolicy(requestPolicy);

    int initialOffset = getOffsetForServicePointUpdateEvents();
    publishServicePointUpdateEvent(oldServicePoint, newServicePoint);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointUpdateEvents);

    JsonObject requestPolicyById = getRequestPolicy(requestPolicy.getString("id"));
    assertThat(requestPolicyById.getJsonObject("allowedServicePoints"), is(nullValue()));
  }

  @Parameters({ "false", "null"})
  @Test
  public void requestPolicyShouldNotContainPageWhenSingleServicePointBecomesNotPickupLocation(
    Boolean isPickupLocation) {

    String requestPolicyId = randomId();
    String servicePoint1Id = randomId();
    String servicePoint2Id = randomId();
    String servicePoint3Id = randomId();
    String servicePoint3Name = "sp-3";
    JsonObject servicePoint1 = buildServicePoint(servicePoint1Id, "sp-1", true);
    JsonObject servicePoint2 = buildServicePoint(servicePoint2Id, "sp-2", true);
    JsonObject servicePoint3 = buildServicePoint(servicePoint3Id, servicePoint3Name, true);
    createStubForServicePoints(List.of(servicePoint1, servicePoint2, servicePoint3));

    var requestTypes = List.of(RequestType.HOLD, RequestType.PAGE);
    var allowedServicePoints = new AllowedServicePoints()
      .withHold(Set.of(servicePoint1Id, servicePoint2Id))
      .withPage(Set.of(servicePoint3Id));
    createRequestPolicy(buildRequestPolicy(requestPolicyId, requestTypes, allowedServicePoints));

    int initialOffset = getOffsetForServicePointUpdateEvents();
    var updatedServicePoint3 = buildServicePoint(servicePoint3Id, servicePoint3Name, isPickupLocation);
    publishServicePointUpdateEvent(servicePoint3, updatedServicePoint3);
    waitUntilValueIsIncreased(initialOffset,
      EventConsumerVerticleTest::getOffsetForServicePointUpdateEvents);

    verifyRequestPolicyAllowedServicePoints(requestPolicyId, RequestType.HOLD,
      List.of(servicePoint1Id, servicePoint2Id));
    verifyRequestTypeIsNotAllowedByRequestPolicy(requestPolicyId, RequestType.PAGE);
  }


  private static JsonObject buildItem() {
    return new ItemBuilder()
      .withId(randomId())
      .withHoldingsRecordId(randomId())
      .withStatus("Paged")
      .withEffectiveShelvingOrder(DEFAULT_SHELVING_ORDER)
      .withCallNumberComponents(new ItemCallNumberComponents()
        .withPrefix(DEFAULT_CALL_NUMBER_PREFIX)
        .withCallNumber(DEFAULT_CALL_NUMBER)
        .withSuffix(DEFAULT_CALL_NUMBER_SUFFIX))
      .create();
  }

  private static JsonObject buildItem(String prefix, String callNumber, String suffix,
    String shelvingOrder) {

    return new ItemBuilder()
      .withId(randomId())
      .withHoldingsRecordId(randomId())
      .withStatus("Paged")
      .withEffectiveShelvingOrder(shelvingOrder)
      .withCallNumberComponents(new ItemCallNumberComponents()
        .withPrefix(prefix)
        .withCallNumber(callNumber)
        .withSuffix(suffix))
      .create();
  }

  private static JsonObject buildLocation(String id, String name, String primaryServicePoint) {
    return buildLocation(id, name, "code", primaryServicePoint);
  }

  private static JsonObject buildLocation(String id, String name, String code, String primaryServicePoint) {
    return new LocationBuilder(name)
      .withId(id)
      .withCode(code)
      .withPrimaryServicePoint(primaryServicePoint)
      .create();
  }

  private static JsonObject buildServicePoint(String id, String name) {
    return buildServicePoint(id, name, "code");
  }

  private static JsonObject buildServicePoint(String id, String name, String code) {
    return new ServicePointBuilder(name)
      .withId(id)
      .withCode(code)
      .withPickupLocation(true)
      .create();
  }

  private static JsonObject buildServicePoint(String id, String name, Boolean isPickupLocation) {
    return new ServicePointBuilder(name)
      .withId(id)
      .withCode("code")
      .withPickupLocation(isPickupLocation)
      .create();
  }

  private static SearchIndex buildSearchIndex(String callNumberPrefix, String callNumber,
    String callNumberSuffix, String shelvingOrder) {

    return new SearchIndex()
      .withPickupServicePointName(DEFAULT_PICKUP_SERVICE_POINT_NAME)
      .withShelvingOrder(shelvingOrder)
      .withCallNumberComponents(new CallNumberComponents()
        .withPrefix(callNumberPrefix)
        .withCallNumber(callNumber)
        .withSuffix(callNumberSuffix));
  }

  private static SearchIndex buildSearchIndex(String pickupServicePointName) {
    return new SearchIndex()
      .withPickupServicePointName(pickupServicePointName)
      .withShelvingOrder(DEFAULT_SHELVING_ORDER)
      .withCallNumberComponents(new CallNumberComponents()
        .withPrefix(DEFAULT_CALL_NUMBER_PREFIX)
        .withCallNumber(DEFAULT_CALL_NUMBER)
        .withSuffix(DEFAULT_CALL_NUMBER_SUFFIX));
  }

  @SneakyThrows
  private static URL requestPolicyStorageUrl(String path) {
    return StorageTestSuite.storageUrl(REQUEST_POLICY_STORAGE_URL + path);
  }

  @SneakyThrows
  private JsonObject createRequest(JsonObject request) {
    return createEntity(request, requestStorageUrl()).getJson();
  }

  @SneakyThrows
  private JsonObject createRequestPolicy(JsonObject requestPolicy) {
    return createEntity(requestPolicy, requestPolicyStorageUrl()).getJson();
  }

  private static URL requestStorageUrl() {
    return requestStorageUrl("");
  }

  private static URL requestPolicyStorageUrl() {
    return requestPolicyStorageUrl("");
  }

  @SneakyThrows
  private static URL requestStorageUrl(String subPath) {
    return StorageTestSuite.storageUrl(REQUEST_STORAGE_URL + subPath);
  }

  private JsonObject getRequest(String requestId) {
    return getById(requestStorageUrl("/" + requestId));
  }

  private JsonObject getRequestPolicy(String requestPolicyId) {
    return getById(requestPolicyStorageUrl("/" + requestPolicyId));
  }

  private static KafkaProducer<String, JsonObject> createProducer() {
    Properties config = new Properties();
    config.put(BOOTSTRAP_SERVERS_CONFIG, KAFKA_SERVER_URL);
    config.put(ACKS_CONFIG, "1");

    return KafkaProducer.create(getVertx(), config, String.class, JsonObject.class);
  }

  private void publishItemUpdateEvent(JsonObject oldItem, JsonObject newItem) {
    publishEvent(INVENTORY_ITEM_TOPIC, buildUpdateEvent(oldItem, newItem));
  }

  private void publishServicePointUpdateEvent(JsonObject oldServicePoint,
    JsonObject newServicePoint) {

    publishEvent(INVENTORY_SERVICE_POINT_TOPIC, buildUpdateEvent(oldServicePoint, newServicePoint));
  }

  private void publishLocationUpdateEvent(JsonObject oldLocation, JsonObject newLocation) {
    publishEvent(INVENTORY_LOCATION_TOPIC, buildUpdateEvent(oldLocation, newLocation));
  }

  private void publishServicePointDeleteEvent(JsonObject servicePoint) {
    publishEvent(INVENTORY_SERVICE_POINT_TOPIC, buildDeleteEvent(servicePoint));
  }

  private void publishInvalidServicePointDeleteEvent(JsonObject servicePoint) {
    publishEvent(INVENTORY_SERVICE_POINT_TOPIC, buildInvalidDeleteEvent(servicePoint));
  }

  private void publishEvent(String topic, JsonObject eventPayload) {
    var record = KafkaProducerRecord.create(topic, "test-key", eventPayload);
    record.addHeader(OKAPI_TENANT_HEADER, TENANT_ID);
    record.addHeader(OKAPI_URL_HEADER, "http://localhost:" + PROXY_PORT);
    record.addHeader(OKAPI_HEADER_TOKEN, "RANDOM_TOKEN");
    waitFor(producer.write(record));
  }

  private static JsonObject buildUpdateEvent(JsonObject oldVersion, JsonObject newVersion) {
    return new JsonObject()
      .put("tenant", TENANT_ID)
      .put("type", "UPDATE")
      .put("old", oldVersion)
      .put("new", newVersion);
  }

  private static JsonObject buildDeleteEvent(JsonObject object) {
    return new JsonObject()
      .put("tenant", TENANT_ID)
      .put("type", "DELETE")
      .put("old", object);
  }

  private static JsonObject buildInvalidDeleteEvent(JsonObject object) {
    return new JsonObject()
      .put("tenant", TENANT_ID)
      .put("type", "DELETE");
  }

  private List<String> verifyRequestPolicyAllowedServicePoints(String requestPolicyId,
    RequestType requestType, List<String> allowedServicePoints) {

    return waitAtMost(60, SECONDS)
      .until(() -> getRequestPolicyAllowedServicePoints(requestPolicyId, requestType),
        equalTo(allowedServicePoints.stream().sorted().toList()));
  }

  private boolean verifyRequestTypeIsNotAllowedByRequestPolicy(String requestPolicyId,
    RequestType requestType) {

    return waitAtMost(60, SECONDS)
      .until(() -> isRequestTypeNotAllowedByRequestPolicy(requestPolicyId, requestType),
        is(true));
  }

  private JsonObject verifyRequestSearchIndex(String requestId, SearchIndex searchIndex) {
    return waitAtMost(60, SECONDS)
      .until(() -> getRequestSearchIndex(requestId), equalTo(mapFrom(searchIndex)));
  }

  private JsonObject verifyRequestItem(String requestId, JsonObject itemObject) {
    return waitAtMost(60, SECONDS)
      .until(() -> {
        JsonObject requestItem = getRequestItem(requestId);
        JsonObject actualItem = new JsonObject();
        actualItem.put(ITEM_EFFECTIVE_LOCATION_ID, requestItem.getString(ITEM_EFFECTIVE_LOCATION_ID));
        actualItem.put(ITEM_EFFECTIVE_LOCATION_NAME, requestItem.getString(ITEM_EFFECTIVE_LOCATION_NAME));
        actualItem.put(RETRIEVAL_SERVICE_POINT_ID, requestItem.getString(RETRIEVAL_SERVICE_POINT_ID));
        actualItem.put(RETRIEVAL_SERVICE_POINT_NAME, requestItem.getString(RETRIEVAL_SERVICE_POINT_NAME));
        return actualItem;
      }, equalTo(itemObject));
  }

  private JsonObject verifyRequestItemRetrievalServicePoint(String requestId, JsonObject itemObject) {
    return waitAtMost(60, SECONDS)
            .until(() -> {
              JsonObject requestItem = getRequestItem(requestId);
              JsonObject actualItem = new JsonObject();
              actualItem.put(RETRIEVAL_SERVICE_POINT_ID, requestItem.getString(RETRIEVAL_SERVICE_POINT_ID));
              actualItem.put(RETRIEVAL_SERVICE_POINT_NAME, requestItem.getString(RETRIEVAL_SERVICE_POINT_NAME));
              return actualItem;
            }, equalTo(itemObject));
  }

  private JsonObject verifyRequestItemEffectiveLocation(String requestId, JsonObject itemObject) {
    return waitAtMost(60, SECONDS)
            .until(() -> {
              JsonObject requestItem = getRequestItem(requestId);
              JsonObject actualItem = new JsonObject();
              actualItem.put(ITEM_EFFECTIVE_LOCATION_ID, requestItem.getString(ITEM_EFFECTIVE_LOCATION_ID));
              actualItem.put(ITEM_EFFECTIVE_LOCATION_NAME, requestItem.getString(ITEM_EFFECTIVE_LOCATION_NAME));
              return actualItem;
            }, equalTo(itemObject));
  }

  private JsonObject verifyPickupServicePointName(String requestId, SearchIndex searchIndex) {
    return waitAtMost(60, SECONDS)
      .until(() -> getRequestSearchIndex(requestId), equalTo(mapFrom(searchIndex)));
  }

  private List<String> getRequestPolicyAllowedServicePoints(String requestPolicyId,
    RequestType requestType) {

    return getRequestPolicy(requestPolicyId)
      .getJsonObject("allowedServicePoints")
      .getJsonArray(requestType.toString())
      .stream()
      .map(Object::toString)
      .sorted()
      .collect(Collectors.toList());
  }

  private boolean isRequestTypeNotAllowedByRequestPolicy(String requestPolicyId,
    RequestType requestType) {

    return getRequestPolicy(requestPolicyId)
      .getJsonArray("requestTypes")
      .stream()
      .noneMatch(requestType.toString()::equals);
  }

  private JsonObject getRequestSearchIndex(String requestId) {
    return getRequest(requestId).getJsonObject("searchIndex");
  }

  private JsonObject getRequestItem(String requestId) {
    return getRequest(requestId).getJsonObject("item");
  }

  private static JsonObject buildRequestPolicy(String requestPolicyId,
    List<RequestType> requestTypes, AllowedServicePoints allowedServicePoints) {

    return new RequestPolicyBuilder()
      .withId(requestPolicyId)
      .withName(format("request-policy-%s", requestPolicyId))
      .withDescription("test description")
      .withRequestTypes(requestTypes)
      .withAllowedServicePoints(allowedServicePoints)
      .create();
  }

  private static JsonObject buildRequest(String requestId, JsonObject item) {
    return buildRequest(requestId, item, randomId(), DEFAULT_PICKUP_SERVICE_POINT_NAME);
  }

  private static JsonObject buildRequest(String requestId, JsonObject item,
    String pickupServicePointId, String pickupServicePointName) {

    SearchIndex searchIndex = new SearchIndex()
      .withPickupServicePointName(pickupServicePointName)
      .withShelvingOrder(item.getString("effectiveShelvingOrder"));

    JsonObject callNumberComponents = item.getJsonObject("effectiveCallNumberComponents");
    if (callNumberComponents != null) {
      searchIndex = searchIndex.withCallNumberComponents(new CallNumberComponents()
        .withCallNumber(callNumberComponents.getString(DEFAULT_CALL_NUMBER))
        .withPrefix(callNumberComponents.getString(DEFAULT_CALL_NUMBER_PREFIX))
        .withSuffix(callNumberComponents.getString(DEFAULT_CALL_NUMBER_SUFFIX)));
    }

    return new RequestRequestBuilder()
      .withId(UUID.fromString(requestId))
      .page()
      .toHoldShelf()
      .withRequestDate(new DateTime(2017, 7, 22, 10, 22, 54, DateTimeZone.UTC))
      .withItemId(UUID.fromString(item.getString("id")))
      .withRequesterId(UUID.randomUUID())
      .withRequestLevel("Item")
      .withItem(new RequestItemSummary("Nod", "565578437802"))
      .withHoldingsRecordId(UUID.fromString(item.getString("holdingsRecordId")))
      .withInstanceId(UUID.randomUUID())
      .withRequester("Jones", "Stuart", "Anthony", "6837502674015")
      .withStatus(OPEN_NOT_YET_FILLED)
      .withPosition(1)
      .withPickupServicePointId(UUID.fromString(pickupServicePointId))
      .withSearchIndex(searchIndex)
      .create();
  }

  private static Integer getOffsetForItemUpdateEvents() {
    return getOffset(INVENTORY_ITEM_TOPIC, buildConsumerGroupId(INVENTORY_ITEM_UPDATED.name()));
  }

  private static Integer getOffsetForServicePointUpdateEvents() {
    return getOffset(INVENTORY_SERVICE_POINT_TOPIC,
      buildConsumerGroupId(INVENTORY_SERVICE_POINT_UPDATED.name()));
  }

  private static Integer getOffsetForLocationUpdateEvents() {
    return getOffset(INVENTORY_LOCATION_TOPIC,
            buildConsumerGroupId(INVENTORY_LOCATION_UPDATED.name()));
  }

  private static Integer getOffsetForServicePointDeleteEvents() {
    return getOffset(INVENTORY_SERVICE_POINT_TOPIC,
      buildConsumerGroupId(INVENTORY_SERVICE_POINT_DELETED.name()));
  }

  private static String buildConsumerGroupId(String eventType) {
    return format("%s.%s-%s", eventType, getModuleName().replace("_", "-"), getModuleVersion());
  }

  private static KafkaAdminClient createAdminClient() {
    Map<String, String> config = Map.of(BOOTSTRAP_SERVERS_CONFIG, KAFKA_SERVER_URL);
    return KafkaAdminClient.create(getVertx(), config);
  }

  private static int waitUntilValueIsIncreased(int previousValue, Callable<Integer> valueSupplier) {
    return waitAtMost(60, SECONDS)
      .until(valueSupplier, newValue -> newValue > previousValue);
  }

  private static int getOffset(String topic, String consumerGroupId) {
    return waitFor(
      adminClient.listConsumerGroupOffsets(consumerGroupId)
        .map(partitions -> Optional.ofNullable(partitions.get(new TopicPartition(topic, 0)))
          .map(OffsetAndMetadata::getOffset)
          .map(Long::intValue)
          .orElse(0)) // if topic does not exist yet
    );
  }

  private void createStubForServicePoints(List<JsonObject> servicePoints) {
    StorageTestSuite.getWireMockServer()
      .stubFor(WireMock.get(urlPathMatching("/service-points.*"))
        .willReturn(ok().withBody(new JsonObject().put("servicepoints", new JsonArray(servicePoints))
          .encodePrettily())));
  }

  private void createStubForLocations(List<JsonObject> locations) {
    StorageTestSuite.getWireMockServer()
      .stubFor(WireMock.get(urlPathMatching("/locations.*"))
        .willReturn(ok().withBody(new JsonObject().put("locations", new JsonArray(locations))
          .encodePrettily())));
  }

  private JsonObject buildRequestPolicy(List<String> allowedServicePointIds,
    RequestType... requestTypes) {

    JsonArray requestTypesArray = new JsonArray();
    JsonObject allowedServicePoints = new JsonObject();
    for (RequestType requestType : requestTypes) {
      requestTypesArray.add(requestType);
      allowedServicePoints.put(requestType.value(), new JsonArray(allowedServicePointIds));
    }

    return new JsonObject()
      .put("id", randomId())
      .put("name", "Request policy")
      .put("requestTypes", requestTypesArray)
      .put("allowedServicePoints", allowedServicePoints);
  }
}