Remove spaces in runtime to avoid qualifier mismatches and add tests.

dmdashenkov · dmdashenkov · commit 5134b27c7674 · 2017-01-31T16:30:52.000+02:00
diff --git a/server/src/main/java/org/spine3/server/event/enrich/EventEnrichmentsMap.java b/server/src/main/java/org/spine3/server/event/enrich/EventEnrichmentsMap.java
@@ -164,10 +164,11 @@ private static Collection<String> parseFieldNames(String qualifiers) {
             final Collection<String> result = new LinkedList<>();
             final String[] fieldNames = PIPE_SEPARATOR_PATTERN.split(qualifiers);
             for (String singleFieldName : fieldNames) {
-                if (singleFieldName.isEmpty()) {
+                final String normalizedFieldName = singleFieldName.trim();
+                if (normalizedFieldName.isEmpty()) {
                     continue;
                 }
-                final String fieldName = getSimpleFieldName(singleFieldName);
+                final String fieldName = getSimpleFieldName(normalizedFieldName);
                 result.add(fieldName);
             }
             return result;
diff --git a/server/src/main/java/org/spine3/server/event/enrich/ReferenceValidator.java b/server/src/main/java/org/spine3/server/event/enrich/ReferenceValidator.java
@@ -65,6 +65,11 @@ class ReferenceValidator {
     private static final String PIPE_SEPARATOR = "|";
     private static final Pattern PATTERN_PIPE_SEPARATOR = Pattern.compile("\\|");
 
+    private static final String SPACE = " ";
+    private static final String EMPTY_STRING = "";
+    private static final Pattern SPACE_PATTERN = Pattern.compile(SPACE, Pattern.LITERAL);
+
+
     /** The reference to the event context used in the `by` field option. */
     private static final String CONTEXT_REFERENCE = "context";
 
@@ -118,11 +123,12 @@ private Collection<FieldDescriptor> findSourceFields(FieldDescriptor enrichmentF
         final String byOptionArgument = enrichmentField.getOptions()
                                                        .getExtension(EventAnnotationsProto.by);
         checkNotNull(byOptionArgument);
-        final int pipeSeparatorIndex = byOptionArgument.indexOf(PIPE_SEPARATOR);
+        final String targetFields = removeSpaces(byOptionArgument);
+        final int pipeSeparatorIndex = targetFields.indexOf(PIPE_SEPARATOR);
         if (pipeSeparatorIndex < 0) {
-            return Collections.singleton(findSourceFieldByName(byOptionArgument, enrichmentField, true));
+            return Collections.singleton(findSourceFieldByName(targetFields, enrichmentField, true));
         } else {
-            final String[] targetFieldNames = PATTERN_PIPE_SEPARATOR.split(byOptionArgument);
+            final String[] targetFieldNames = PATTERN_PIPE_SEPARATOR.split(targetFields);
             return findSourceFieldsByNames(targetFieldNames, enrichmentField);
         }
     }
@@ -147,6 +153,13 @@ private FieldDescriptor findSourceFieldByName(String name, FieldDescriptor enric
         return field;
     }
 
+    private static String removeSpaces(String source) {
+        checkNotNull(source);
+        final String result = SPACE_PATTERN.matcher(source)
+                                           .replaceAll(EMPTY_STRING);
+        return result;
+    }
+
     private Collection<FieldDescriptor> findSourceFieldsByNames(String[] names, FieldDescriptor enrichmentField) {
         checkArgument(names.length > 0, "Names may not be empty");
         checkArgument(names.length > 1,
diff --git a/server/src/test/java/org/spine3/server/event/enrich/EventEnrichmentsMapShould.java b/server/src/test/java/org/spine3/server/event/enrich/EventEnrichmentsMapShould.java
@@ -32,6 +32,7 @@
 import org.spine3.test.event.ProjectStarted;
 import org.spine3.test.event.TaskAdded;
 import org.spine3.test.event.enrichment.EnrichmentBoundThoughFieldFqnWithFieldsWithDifferentNames;
+import org.spine3.test.event.enrichment.EnrichmentBoundWithFieldsSeparatedWithSpaces;
 import org.spine3.test.event.enrichment.EnrichmentBoundWithFieldsWithDifferentNames;
 import org.spine3.test.event.enrichment.EnrichmentBoundWithFieldsWithDifferentNamesOfWildcardTypes;
 import org.spine3.test.event.enrichment.EnrichmentBoundWithMultipleFieldsWithDifferentNames;
@@ -189,6 +190,13 @@ public void contain_enrichments_defined_with_by_with_multiple_arguments_using_wi
                                             PermissionRevokedEvent.class);
     }
 
+    @Test
+    public void contain_enrichments_defined_with_by_containing_separating_spaces() {
+        assertOnlyEventTypeByEnrichmentType(EnrichmentBoundWithFieldsSeparatedWithSpaces.class,
+                                            TaskAdded.class,
+                                            PermissionGrantedEvent.class);
+    }
+
     @SafeVarargs
     private static void assertEventTypeByEnrichmentType(
             Class<? extends Message> enrichmentClass,
diff --git a/server/src/test/java/org/spine3/server/event/enrich/ReferenceValidatorShould.java b/server/src/test/java/org/spine3/server/event/enrich/ReferenceValidatorShould.java
@@ -27,6 +27,8 @@
 import org.spine3.server.event.Given;
 import org.spine3.server.event.enrich.ReferenceValidator.ValidationResult;
 import org.spine3.test.event.ProjectCreated;
+import org.spine3.test.event.TaskAdded;
+import org.spine3.test.event.enrichment.EnrichmentBoundWithFieldsSeparatedWithSpaces;
 import org.spine3.test.event.enrichment.EnrichmentBoundWithMultipleFieldsWithDifferentNames;
 import org.spine3.test.event.enrichment.GranterEventsEnrichment;
 import org.spine3.test.event.enrichment.ProjectCreatedEnrichmentAnotherPackage;
@@ -52,6 +54,7 @@
  */
 public class ReferenceValidatorShould {
 
+    private static final String USER_GOOGLE_UID_FIELD = "user_google_uid";
     private final EventEnricher eventEnricher = Given.Enrichment.newEventEnricher();
 
     @Test
@@ -97,7 +100,7 @@ public void store_valid_map_of_enrichment_fields_after_validation() {
 
         final FieldDescriptor enrichmentField = enrichmentFieldIterator.next();
         final String enrichmentFieldName = enrichmentField.getName();
-        assertEquals("user_google_uid", enrichmentFieldName);
+        assertEquals(USER_GOOGLE_UID_FIELD, enrichmentFieldName);
     }
 
     @Test(expected = IllegalStateException.class)
@@ -123,4 +126,34 @@ public void skip_mapping_if_no_mapping_function_is_defined() {
         final Multimap<FieldDescriptor, FieldDescriptor> fields = result.getFieldMap();
         assertEmpty(fields);
     }
+
+    @Test
+    public void handle_separator_spaces_in_by_argument() {
+        final ReferenceValidator validator
+                = new ReferenceValidator(eventEnricher,
+                                         TaskAdded.class,
+                                         EnrichmentBoundWithFieldsSeparatedWithSpaces.class);
+        final ValidationResult result = validator.validate();
+        final Multimap<FieldDescriptor, FieldDescriptor> fieldMap = result.getFieldMap();
+        assertFalse(fieldMap.isEmpty());
+        assertSize(1, fieldMap);
+
+        final Iterator<Map.Entry<FieldDescriptor, Collection<FieldDescriptor>>> mapIterator = fieldMap.asMap()
+                                                                                                      .entrySet()
+                                                                                                      .iterator();
+        assertTrue(mapIterator.hasNext());
+        final Map.Entry<FieldDescriptor, Collection<FieldDescriptor>> singleEntry = mapIterator.next();
+        final FieldDescriptor boundField = singleEntry.getKey();
+
+        final String boundFieldName = boundField.getName();
+        assertEquals("project_id", boundFieldName);
+
+        final Collection<FieldDescriptor> targets = singleEntry.getValue();
+        assertSize(1, targets);
+
+        final FieldDescriptor targetField = targets.iterator()
+                                                   .next();
+        final String targetFieldName = targetField.getName();
+        assertEquals(USER_GOOGLE_UID_FIELD, targetFieldName);
+    }
 }
diff --git a/server/src/test/proto/spine/test/event/enrichment/enrichment.proto b/server/src/test/proto/spine/test/event/enrichment/enrichment.proto
@@ -110,3 +110,7 @@ message EnrichmentBoundWithMultipleFieldsWithDifferentNames {
 
     int32 user_google_uid = 1 [(by) = "SharingRequestApproved.second_user_uid|PermissionGrantedEvent.user_uid|UserDeletedEvent.deleted_uid"];
 }
+
+message EnrichmentBoundWithFieldsSeparatedWithSpaces {
+    string user_google_uid = 1 [(by) = "  spine.test.event.TaskAdded.project_id   | spine.test.event.user.permission.PermissionGrantedEvent.user_uid "];
+}

Original file line number	Diff line number	Diff line change
`@@ -164,10 +164,11 @@ private static Collection<String> parseFieldNames(String qualifiers) {`
`164`	`164`	`final Collection<String> result = new LinkedList<>();`
`165`	`165`	`final String[] fieldNames = PIPE_SEPARATOR_PATTERN.split(qualifiers);`
`166`	`166`	`for (String singleFieldName : fieldNames) {`
`167`		`- if (singleFieldName.isEmpty()) {`
	`167`	`+ final String normalizedFieldName = singleFieldName.trim();`
	`168`	`+ if (normalizedFieldName.isEmpty()) {`
`168`	`169`	`continue;`
`169`	`170`	`}`
`170`		`- final String fieldName = getSimpleFieldName(singleFieldName);`
	`171`	`+ final String fieldName = getSimpleFieldName(normalizedFieldName);`
`171`	`172`	`result.add(fieldName);`
`172`	`173`	`}`
`173`	`174`	`return result;`
Original file line number	Diff line number	Diff line change
`@@ -110,3 +110,7 @@ message EnrichmentBoundWithMultipleFieldsWithDifferentNames {`
`110`	`110`
`111`	`111`	`int32 user_google_uid = 1 [(by) = "SharingRequestApproved.second_user_uid\|PermissionGrantedEvent.user_uid\|UserDeletedEvent.deleted_uid"];`
`112`	`112`	`}`
	`113`	`+`
	`114`	`+message EnrichmentBoundWithFieldsSeparatedWithSpaces {`
	`115`	`+ string user_google_uid = 1 [(by) = " spine.test.event.TaskAdded.project_id \| spine.test.event.user.permission.PermissionGrantedEvent.user_uid "];`
	`116`	`+}`