Merge pull request #767 from CJSCommonPlatform/add-ordering-to-subscriptions

mapingo · web-flow · commit bbd59674a4d6 · 2019-08-30T10:56:30.000+01:00
Add ordering to subscriptions descriptor
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,9 @@ on [Keep a CHANGELOG](http://keepachangelog.com/). This project adheres to
 ## [Unreleased]
 
 ## [6.0.11] - 2018-08-30
+### Added
+- ordering to subscriptions descriptor yamls
+
 ### Fixed
 - JdbcDataSourceProvider can now handle multiple DataSources
 
diff --git a/event-subscription-test-utils/src/main/java/uk/gov/justice/subscription/domain/builders/SubscriptionBuilder.java b/event-subscription-test-utils/src/main/java/uk/gov/justice/subscription/domain/builders/SubscriptionBuilder.java
@@ -11,7 +11,7 @@ public final class SubscriptionBuilder {
     private String name;
     private final List<Event> events = new ArrayList<>();
     private String eventSourceName;
-    private String prioritisation;
+    private int prioritisation;
 
     private SubscriptionBuilder() {
     }
@@ -40,7 +40,7 @@ public SubscriptionBuilder withEventSourceName(final String eventSourceName) {
         return this;
     }
 
-    public SubscriptionBuilder withPrioritisation(final String prioritisation) {
+    public SubscriptionBuilder withPrioritisation(final int prioritisation) {
         this.prioritisation = prioritisation;
         return this;
     }
diff --git a/event-subscription-test-utils/src/main/java/uk/gov/justice/subscription/domain/builders/SubscriptionsDescriptorBuilder.java b/event-subscription-test-utils/src/main/java/uk/gov/justice/subscription/domain/builders/SubscriptionsDescriptorBuilder.java
@@ -11,6 +11,7 @@ public final class SubscriptionsDescriptorBuilder {
     private String specVersion;
     private String service;
     private String serviceComponent;
+    private int prioritisation = 0;
     private final List<Subscription> subscriptions = new ArrayList<>();
 
     private SubscriptionsDescriptorBuilder() {
@@ -45,7 +46,12 @@ public SubscriptionsDescriptorBuilder withSubscriptions(final List<Subscription>
         return this;
     }
 
+    public SubscriptionsDescriptorBuilder withPrioritisation(final int prioritisation) {
+        this.prioritisation = prioritisation;
+        return this;
+    }
+
     public SubscriptionsDescriptor build() {
-        return new SubscriptionsDescriptor(specVersion, service, serviceComponent, subscriptions);
+        return new SubscriptionsDescriptor(specVersion, service, serviceComponent, prioritisation, subscriptions);
     }
 }
diff --git a/event-subscription-test-utils/src/test/java/uk/gov/justice/subscription/domain/builders/SubscriptionBuilderTest.java b/event-subscription-test-utils/src/test/java/uk/gov/justice/subscription/domain/builders/SubscriptionBuilderTest.java
@@ -22,7 +22,7 @@ public void shouldBuildASubscription() throws Exception {
         final Event event_1 = mock(Event.class);
         final Event event_2 = mock(Event.class);
         final String eventSourceName = "eventSoureName";
-        final String prioritisation = "1";
+        final int prioritisation = 1;
 
         final Subscription subscription = subscription()
                 .withName(name)
@@ -45,7 +45,7 @@ public void shouldBeAbleToAddEventsOneAtATime() throws Exception {
         final Event event_1 = mock(Event.class);
         final Event event_2 = mock(Event.class);
         final String eventSourceName = "eventSourceName";
-        final String prioritisation = "1";
+        final int prioritisation = 1;
 
         final Subscription subscription = subscription()
                 .withName(name)
diff --git a/event-subscription-test-utils/src/test/java/uk/gov/justice/subscription/domain/builders/SubscriptionsDescriptorBuilderTest.java b/event-subscription-test-utils/src/test/java/uk/gov/justice/subscription/domain/builders/SubscriptionsDescriptorBuilderTest.java
@@ -20,19 +20,22 @@ public void shouldBuildASubscription() {
         final String specVersion = "specVersion";
         final String service = "service";
         final String serviceComponent = "serviceComponent";
+        final int prioritisation = 1;
         final Subscription subscription_1 = mock(Subscription.class);
         final Subscription subscription_2 = mock(Subscription.class);
 
         final SubscriptionsDescriptor subscriptionsDescriptor = subscriptionsDescriptor()
                 .withSpecVersion(specVersion)
                 .withService(service)
                 .withServiceComponent(serviceComponent)
+                .withPrioritisation(prioritisation)
                 .withSubscriptions(asList(subscription_1, subscription_2))
                 .build();
 
         assertThat(subscriptionsDescriptor.getSpecVersion(), is(specVersion));
         assertThat(subscriptionsDescriptor.getService(), is(service));
         assertThat(subscriptionsDescriptor.getServiceComponent(), is(serviceComponent));
+        assertThat(subscriptionsDescriptor.getPrioritisation(), is(prioritisation));
         assertThat(subscriptionsDescriptor.getSubscriptions(), hasItem(subscription_1));
         assertThat(subscriptionsDescriptor.getSubscriptions(), hasItem(subscription_2));
     }
@@ -43,20 +46,23 @@ public void shouldBeAbleToAddSubscriptionsOneAtATime() {
         final String specVersion = "specVersion";
         final String service = "service";
         final String serviceComponent = "serviceComponent";
+        final int prioritisation = 1;
         final Subscription subscription_1 = mock(Subscription.class);
         final Subscription subscription_2 = mock(Subscription.class);
 
         final SubscriptionsDescriptor subscriptionsDescriptor = subscriptionsDescriptor()
                 .withSpecVersion(specVersion)
                 .withService(service)
                 .withServiceComponent(serviceComponent)
+                .withPrioritisation(prioritisation)
                 .withSubscription(subscription_1)
                 .withSubscription(subscription_2)
                 .build();
 
         assertThat(subscriptionsDescriptor.getSpecVersion(), is(specVersion));
         assertThat(subscriptionsDescriptor.getService(), is(service));
         assertThat(subscriptionsDescriptor.getServiceComponent(), is(serviceComponent));
+        assertThat(subscriptionsDescriptor.getPrioritisation(), is(prioritisation));
         assertThat(subscriptionsDescriptor.getSubscriptions(), hasItem(subscription_1));
         assertThat(subscriptionsDescriptor.getSubscriptions(), hasItem(subscription_2));
     }
diff --git a/event-subscription/src/main/java/uk/gov/justice/subscription/SubscriptionSorter.java b/event-subscription/src/main/java/uk/gov/justice/subscription/SubscriptionSorter.java
@@ -1,31 +1,16 @@
 package uk.gov.justice.subscription;
 
-import static java.lang.Integer.parseInt;
-import static java.lang.String.format;
 import static java.util.Comparator.comparing;
 import static java.util.Comparator.naturalOrder;
 
-import uk.gov.justice.services.yaml.YamlParserException;
+import uk.gov.justice.subscription.domain.subscriptiondescriptor.Subscription;
 import uk.gov.justice.subscription.domain.subscriptiondescriptor.SubscriptionsDescriptor;
 
 public class SubscriptionSorter {
 
-    private final static int HIGHEST_PRIORITY = 0;
-
     public void sortSubscriptionsByPrioritisation(final SubscriptionsDescriptor subscriptionsDescriptor) {
         if (!subscriptionsDescriptor.getSubscriptions().isEmpty()) {
-            subscriptionsDescriptor.getSubscriptions().sort(comparing(subscription -> getPrioritisationNumber(subscription.getPrioritisation()), naturalOrder()));
-        }
-    }
-
-    private Integer getPrioritisationNumber(final String prioritisation) {
-        try {
-            if (null != prioritisation) {
-                return parseInt(prioritisation);
-            }
-            return HIGHEST_PRIORITY;
-        } catch (final NumberFormatException nfe) {
-            throw new YamlParserException(format("Incorrect prioritisation number: %s in subscription-descriptor.yaml", prioritisation), nfe);
+            subscriptionsDescriptor.getSubscriptions().sort(comparing(Subscription::getPrioritisation, naturalOrder()));
         }
     }
 }
diff --git a/event-subscription/src/main/java/uk/gov/justice/subscription/SubscriptionsDescriptorParser.java b/event-subscription/src/main/java/uk/gov/justice/subscription/SubscriptionsDescriptorParser.java
@@ -1,5 +1,7 @@
 package uk.gov.justice.subscription;
 
+import static java.util.Comparator.comparingInt;
+
 import uk.gov.justice.services.yaml.YamlFileValidator;
 import uk.gov.justice.services.yaml.YamlParser;
 import uk.gov.justice.subscription.domain.subscriptiondescriptor.SubscriptionsDescriptor;
@@ -41,7 +43,9 @@ public SubscriptionsDescriptorParser(final YamlParser yamlParser,
      * @return Stream of {@link SubscriptionsDescriptor}
      */
     public Stream<SubscriptionsDescriptor> getSubscriptionDescriptorsFrom(final Collection<URL> urls) {
-        return urls.stream().map(this::parseSubscriptionDescriptorFromYaml);
+        return urls.stream()
+                .map(this::parseSubscriptionDescriptorFromYaml)
+                .sorted(comparingInt(SubscriptionsDescriptor::getPrioritisation));
     }
 
     private SubscriptionsDescriptor parseSubscriptionDescriptorFromYaml(final URL url) {
diff --git a/event-subscription/src/main/java/uk/gov/justice/subscription/domain/subscriptiondescriptor/Subscription.java b/event-subscription/src/main/java/uk/gov/justice/subscription/domain/subscriptiondescriptor/Subscription.java
@@ -8,12 +8,12 @@ public class Subscription {
     private final String name;
     private final List<Event> events;
     private final String eventSourceName;
-    private final String prioritisation;
+    private final int prioritisation;
 
     public Subscription(final String name,
                         final List<Event> events,
                         final String eventSourceName,
-                        final String prioritisation) {
+                        final int prioritisation) {
         this.name = name;
         this.events = events;
         this.eventSourceName = eventSourceName;
@@ -32,7 +32,7 @@ public String getEventSourceName() {
         return eventSourceName;
     }
 
-    public String getPrioritisation() {
+    public int getPrioritisation() {
         return prioritisation;
     }
 
@@ -51,4 +51,14 @@ public boolean equals(final Object o) {
     public int hashCode() {
         return Objects.hash(name, events,prioritisation, eventSourceName);
     }
+
+    @Override
+    public String toString() {
+        return "Subscription{" +
+                "name='" + name + '\'' +
+                ", events=" + events +
+                ", eventSourceName='" + eventSourceName + '\'' +
+                ", prioritisation=" + prioritisation +
+                '}';
+    }
 }
diff --git a/event-subscription/src/main/java/uk/gov/justice/subscription/domain/subscriptiondescriptor/SubscriptionsDescriptor.java b/event-subscription/src/main/java/uk/gov/justice/subscription/domain/subscriptiondescriptor/SubscriptionsDescriptor.java
@@ -8,15 +8,18 @@ public class SubscriptionsDescriptor {
     private final String specVersion;
     private final String service;
     private final String serviceComponent;
+    private final int prioritisation;
     private final List<Subscription> subscriptions;
 
     public SubscriptionsDescriptor(final String specVersion,
                                    final String service,
                                    final String serviceComponent,
+                                   final int prioritisation,
                                    final List<Subscription> subscriptions) {
         this.specVersion = specVersion;
         this.service = service;
         this.serviceComponent = serviceComponent;
+        this.prioritisation = prioritisation;
         this.subscriptions = subscriptions;
     }
 
@@ -32,23 +35,39 @@ public String getServiceComponent() {
         return serviceComponent;
     }
 
+    public int getPrioritisation() {
+        return prioritisation;
+    }
+
+    public List<Subscription> getSubscriptions() {
+        return subscriptions;
+    }
+
     @Override
-    public boolean equals(Object object) {
-        if (this == object) return true;
-        if (object == null || getClass() != object.getClass()) return false;
-        SubscriptionsDescriptor that = (SubscriptionsDescriptor) object;
+    public boolean equals(final Object o) {
+        if (this == o) return true;
+        if (!(o instanceof SubscriptionsDescriptor)) return false;
+        final SubscriptionsDescriptor that = (SubscriptionsDescriptor) o;
         return Objects.equals(specVersion, that.specVersion) &&
                 Objects.equals(service, that.service) &&
-                Objects.equals(serviceComponent, that.serviceComponent);
+                Objects.equals(serviceComponent, that.serviceComponent) &&
+                Objects.equals(prioritisation, that.prioritisation) &&
+                Objects.equals(subscriptions, that.subscriptions);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(specVersion, service, serviceComponent);
+        return Objects.hash(specVersion, service, serviceComponent, prioritisation, subscriptions);
     }
 
-    public List<Subscription> getSubscriptions() {
-        return subscriptions;
+    @Override
+    public String toString() {
+        return "SubscriptionsDescriptor{" +
+                "specVersion='" + specVersion + '\'' +
+                ", service='" + service + '\'' +
+                ", serviceComponent='" + serviceComponent + '\'' +
+                ", prioritisation='" + prioritisation + '\'' +
+                ", subscriptions=" + subscriptions +
+                '}';
     }
-
 }
diff --git a/event-subscription/src/main/resources/json/schema/subscription-schema.json b/event-subscription/src/main/resources/json/schema/subscription-schema.json
@@ -32,6 +32,14 @@
             "EVENT_LISTENER"
           ]
         },
+        "prioritisation": {
+          "$id": "/properties/subscriptions_descriptor/properties/prioritisation",
+          "type": "integer",
+          "title": "Subscription descriptor prioritisation",
+          "examples": [
+            "1"
+          ]
+        },
         "subscriptions": {
           "$id": "/properties/subscriptions_descriptor/properties/subscriptions",
           "type": "array",
diff --git a/event-subscription/src/test/java/uk/gov/justice/subscription/SubscriptionSorterTest.java b/event-subscription/src/test/java/uk/gov/justice/subscription/SubscriptionSorterTest.java
@@ -26,12 +26,12 @@ public void shouldSortBySubscriptionPrioritisation() {
 
         final List<Event> eventList = asList(mock(Event.class), mock(Event.class));
 
-        final Subscription subscription1 = new Subscription("name1", eventList, "eventSourceName1", "1");
-        final Subscription subscription2 = new Subscription("name2", eventList, "eventSourceName3", "2");
-        final Subscription subscription3 = new Subscription("name3", eventList, "eventSourceName1", "3");
+        final Subscription subscription1 = new Subscription("name1", eventList, "eventSourceName1", 1);
+        final Subscription subscription2 = new Subscription("name2", eventList, "eventSourceName3", 2);
+        final Subscription subscription3 = new Subscription("name3", eventList, "eventSourceName1", 3);
 
         final List<Subscription> subscriptions = asList(subscription2, subscription3, subscription1);
-        final SubscriptionsDescriptor subscriptionsDescriptor = new SubscriptionsDescriptor("specVersion", "service", "serviceComponent", subscriptions);
+        final SubscriptionsDescriptor subscriptionsDescriptor = new SubscriptionsDescriptor("specVersion", "service", "serviceComponent", 1, subscriptions);
 
         final SubscriptionSorter subscriptionSorter = new SubscriptionSorter();
 
@@ -48,13 +48,13 @@ public void shouldSortBySubscriptionPrioritisationNullsFirst() {
 
         final List<Event> eventList = asList(mock(Event.class), mock(Event.class));
 
-        final Subscription subscription1 = new Subscription("name1", eventList, "eventSourceName1", "1");
-        final Subscription subscription2 = new Subscription("name2", eventList, "eventSourceName3", null);
-        final Subscription subscription3 = new Subscription("name3", eventList, "eventSourceName1", "3");
+        final Subscription subscription1 = new Subscription("name1", eventList, "eventSourceName1", 1);
+        final Subscription subscription2 = new Subscription("name2", eventList, "eventSourceName3", 0);
+        final Subscription subscription3 = new Subscription("name3", eventList, "eventSourceName1", 3);
 
         final List<Subscription> subscriptions = asList(subscription2, subscription3, subscription1);
 
-        final SubscriptionsDescriptor subscriptionsDescriptor = new SubscriptionsDescriptor("specVersion", "service", "serviceComponent", subscriptions);
+        final SubscriptionsDescriptor subscriptionsDescriptor = new SubscriptionsDescriptor("specVersion", "service", "serviceComponent", 1, subscriptions);
 
         final SubscriptionSorter subscriptionSorter = new SubscriptionSorter();
 
@@ -65,27 +65,4 @@ public void shouldSortBySubscriptionPrioritisationNullsFirst() {
         assertThat(subscriptionsDescriptor.getSubscriptions().get(2), is(subscription3));
 
     }
-
-    @Test
-    public void shouldThrowExceptionIfPrioritisationNotNumber() {
-
-        final List<Event> eventList = asList(mock(Event.class), mock(Event.class));
-
-        final Subscription subscription1 = new Subscription("name1", eventList, "eventSourceName1", "1");
-        final Subscription subscription2 = new Subscription("name2", eventList, "eventSourceName3", "wrongPrioritisation");
-        final Subscription subscription3 = new Subscription("name3", eventList, "eventSourceName1", "3");
-
-        final List<Subscription> subscriptions = asList(subscription2, subscription3, subscription1);
-
-        final SubscriptionsDescriptor subscriptionsDescriptor = new SubscriptionsDescriptor("specVersion", "service", "serviceComponent", subscriptions);
-
-        final SubscriptionSorter subscriptionSorter = new SubscriptionSorter();
-
-        try {
-            subscriptionSorter.sortSubscriptionsByPrioritisation(subscriptionsDescriptor);
-            fail();
-        } catch (final YamlParserException expected) {
-            assertThat(expected.getMessage(), is("Incorrect prioritisation number: wrongPrioritisation in subscription-descriptor.yaml"));
-        }
-    }
 }
diff --git a/event-subscription/src/test/java/uk/gov/justice/subscription/SubscriptionsDescriptorParserTest.java b/event-subscription/src/test/java/uk/gov/justice/subscription/SubscriptionsDescriptorParserTest.java
diff --git a/event-subscription/src/test/java/uk/gov/justice/subscription/domain/subscriptiondescriptor/SubscriptionsDescriptorTest.java b/event-subscription/src/test/java/uk/gov/justice/subscription/domain/subscriptiondescriptor/SubscriptionsDescriptorTest.java
diff --git a/event-subscription/src/test/resources/yaml/no-priority-subscriptions-descriptor.yaml b/event-subscription/src/test/resources/yaml/no-priority-subscriptions-descriptor.yaml
diff --git a/event-subscription/src/test/resources/yaml/priority-one-subscriptions-descriptor.yaml b/event-subscription/src/test/resources/yaml/priority-one-subscriptions-descriptor.yaml
diff --git a/event-subscription/src/test/resources/yaml/subscriptions-descriptor.yaml b/event-subscription/src/test/resources/yaml/subscriptions-descriptor.yaml

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public final class SubscriptionBuilder {`
`11`	`11`	`private String name;`
`12`	`12`	`private final List<Event> events = new ArrayList<>();`
`13`	`13`	`private String eventSourceName;`
`14`		`- private String prioritisation;`
	`14`	`+ private int prioritisation;`
`15`	`15`
`16`	`16`	`private SubscriptionBuilder() {`
`17`	`17`	`}`
`@@ -40,7 +40,7 @@ public SubscriptionBuilder withEventSourceName(final String eventSourceName) {`
`40`	`40`	`return this;`
`41`	`41`	`}`
`42`	`42`
`43`		`- public SubscriptionBuilder withPrioritisation(final String prioritisation) {`
	`43`	`+ public SubscriptionBuilder withPrioritisation(final int prioritisation) {`
`44`	`44`	`this.prioritisation = prioritisation;`
`45`	`45`	`return this;`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ public final class SubscriptionsDescriptorBuilder {`
`11`	`11`	`private String specVersion;`
`12`	`12`	`private String service;`
`13`	`13`	`private String serviceComponent;`
	`14`	`+ private int prioritisation = 0;`
`14`	`15`	`private final List<Subscription> subscriptions = new ArrayList<>();`
`15`	`16`
`16`	`17`	`private SubscriptionsDescriptorBuilder() {`
`@@ -45,7 +46,12 @@ public SubscriptionsDescriptorBuilder withSubscriptions(final List<Subscription>`
`45`	`46`	`return this;`
`46`	`47`	`}`
`47`	`48`
	`49`	`+ public SubscriptionsDescriptorBuilder withPrioritisation(final int prioritisation) {`
	`50`	`+ this.prioritisation = prioritisation;`
	`51`	`+ return this;`
	`52`	`+ }`
	`53`	`+`
`48`	`54`	`public SubscriptionsDescriptor build() {`
`49`		`- return new SubscriptionsDescriptor(specVersion, service, serviceComponent, subscriptions);`
	`55`	`+ return new SubscriptionsDescriptor(specVersion, service, serviceComponent, prioritisation, subscriptions);`
`50`	`56`	`}`
`51`	`57`	`}`