Json Serialization should hide "empty".

Json serialization of java collections exposes the isEmpty function as an attribute. This issue was discussed in the design review of Interface operations.
Issue-ID: SDC-1150

Change-Id: I09e214f5631b73d60825732c4db8bbf85469c824
Signed-off-by: shrek2000 <orenkle@amdocs.com>

2 files changed, 109 insertions, 47 deletions

diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/RepresentationUtils.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/RepresentationUtils.java
index da42fe2b6f..127fb98c3c 100644
--- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/RepresentationUtils.java
+++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/RepresentationUtils.java
@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -20,24 +20,35 @@
 
 package org.openecomp.sdc.be.servlets;
 
+import com.fasterxml.jackson.annotation.JsonFilter;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter.SerializeExceptFilter;
+import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
+import com.google.common.collect.ImmutableMap;
 import com.google.gson.Gson;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
-import com.fasterxml.jackson.databind.ObjectMapper;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
 import org.openecomp.sdc.be.config.BeEcompErrorManager;
+import org.openecomp.sdc.be.datatypes.tosca.ToscaDataDefinition;
 import org.openecomp.sdc.be.model.ArtifactDefinition;
+import org.openecomp.sdc.be.model.InterfaceDefinition;
+import org.openecomp.sdc.be.model.Operation;
+import org.openecomp.sdc.be.model.Resource;
 import org.openecomp.sdc.common.api.ArtifactGroupTypeEnum;
 import org.openecomp.sdc.common.api.Constants;
-import org.openecomp.sdc.common.config.EcompErrorName;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.io.IOException;
-import com.fasterxml.jackson.databind.SerializationFeature;
-
 public class RepresentationUtils {
 
     private static final Logger log = LoggerFactory.getLogger(RepresentationUtils.class);
@@ -89,13 +100,15 @@ public class RepresentationUtils {
      * @throws IOException
      */
     public static <T> Object toRepresentation(T elementToRepresent) throws IOException {
-
         ObjectMapper mapper = new ObjectMapper();
         mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
         mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
         return mapper.writeValueAsString(elementToRepresent);
     }
 
+
+
+
     public static <T> T fromRepresentation(String json, Class<T> clazz) {
         ObjectMapper mapper = new ObjectMapper();
         T object = null;
@@ -111,6 +124,7 @@ public class RepresentationUtils {
         return object;
     }
 
+
     public static ArtifactDefinition convertJsonToArtifactDefinition(String content, Class<ArtifactDefinition> clazz) {
 
         JsonObject jsonElement = new JsonObject();
@@ -157,4 +171,31 @@ public class RepresentationUtils {
         return resourceInfo;
     }
 
+    public static <T> Object toFilteredRepresentation(T elementToRepresent) throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
+        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+        mapper.setMixIns(IS_EMPTY_FILTER_MIXIN);
+        return mapper.writer(new SimpleFilterProvider().addFilter(REMOVE_IS_EMPTY_FROM_COLLECTIONS_FILTER,
+            SerializeExceptFilter.serializeAllExcept(EMPTY))).writeValueAsString(elementToRepresent);
+    }
+
+    @JsonFilter(REMOVE_IS_EMPTY_FROM_COLLECTIONS_FILTER)
+    private static class IsEmptyFilterMixIn {}
+
+    private static final String EMPTY = "empty";
+    private static final String REMOVE_IS_EMPTY_FROM_COLLECTIONS_FILTER = "removeIsEmptyFromCollections";
+    private static final ImmutableMap<Class<?>,Class<?>> IS_EMPTY_FILTER_MIXIN =
+        ImmutableMap.<Class<?>,Class<?>>builder()
+            .put(Collection.class,IsEmptyFilterMixIn.class)
+            .put(List.class,IsEmptyFilterMixIn.class)
+            .put(Set.class,IsEmptyFilterMixIn.class)
+            .put(HashMap.class,IsEmptyFilterMixIn.class)
+            .put(ArrayList.class,IsEmptyFilterMixIn.class)
+            .put(HashSet.class,IsEmptyFilterMixIn.class)
+            .put(InterfaceDefinition.class,IsEmptyFilterMixIn.class)
+            .put(Operation.class,IsEmptyFilterMixIn.class)
+            .put(Resource.class,IsEmptyFilterMixIn.class)
+            .put(ToscaDataDefinition.class,IsEmptyFilterMixIn.class).build();
+
 }
diff --git a/catalog-be/src/test/java/org/openecomp/sdc/be/servlets/RepresentationUtilsTest.java b/catalog-be/src/test/java/org/openecomp/sdc/be/servlets/RepresentationUtilsTest.java
index f82fdfc1ef..63e76700df 100644
--- a/catalog-be/src/test/java/org/openecomp/sdc/be/servlets/RepresentationUtilsTest.java
+++ b/catalog-be/src/test/java/org/openecomp/sdc/be/servlets/RepresentationUtilsTest.java
@@ -1,46 +1,67 @@
 package org.openecomp.sdc.be.servlets;
 
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+import java.util.HashMap;
 import org.apache.tinkerpop.gremlin.structure.T;
 import org.junit.Test;
 import org.openecomp.sdc.be.model.ArtifactDefinition;
+import org.openecomp.sdc.be.model.Operation;
+
+public class RepresentationUtilsTest  {
+
+    private RepresentationUtils createTestSubject() {
+        return new RepresentationUtils();
+    }
+
+
+    @Test
+    public void testConvertJsonToArtifactDefinitionForUpdate() throws Exception {
+        String content = "";
+        Class<ArtifactDefinition> clazz = null;
+        ArtifactDefinition result;
+
+        // default test
+        result = RepresentationUtils.convertJsonToArtifactDefinitionForUpdate(content, clazz);
+    }
+
+
+    @Test
+    public void testToRepresentation() throws Exception {
+        T elementToRepresent = null;
+        Object result;
+
+        // default test
+        result = RepresentationUtils.toRepresentation(elementToRepresent);
+    }
+
+
+
+
+    @Test
+    public void testConvertJsonToArtifactDefinition() throws Exception {
+        String content = "";
+        Class<ArtifactDefinition> clazz = null;
+        ArtifactDefinition result;
+
+        // default test
+        result = RepresentationUtils.convertJsonToArtifactDefinition(content, clazz);
+    }
 
-public class RepresentationUtilsTest {
-
-	private RepresentationUtils createTestSubject() {
-		return new RepresentationUtils();
-	}
-
-	
-	@Test
-	public void testConvertJsonToArtifactDefinitionForUpdate() throws Exception {
-		String content = "";
-		Class<ArtifactDefinition> clazz = null;
-		ArtifactDefinition result;
-
-		// default test
-		result = RepresentationUtils.convertJsonToArtifactDefinitionForUpdate(content, clazz);
-	}
-
-	
-	@Test
-	public void testToRepresentation() throws Exception {
-		T elementToRepresent = null;
-		Object result;
-
-		// default test
-		result = RepresentationUtils.toRepresentation(elementToRepresent);
-	}
-
-	
-
-	
-	@Test
-	public void testConvertJsonToArtifactDefinition() throws Exception {
-		String content = "";
-		Class<ArtifactDefinition> clazz = null;
-		ArtifactDefinition result;
-
-		// default test
-		result = RepresentationUtils.convertJsonToArtifactDefinition(content, clazz);
-	}
+    @Test
+    public void checkIsEmptyFiltering() throws Exception {
+        HashMap<String, Operation> op = new HashMap<>();
+        Operation opValue = new Operation();
+        opValue.setName("eee");
+        opValue.setDescription("ccc");
+        op.put("Bla", opValue);
+        Object result = RepresentationUtils.toRepresentation(op);
+        assertNotNull(result);
+        assertTrue(result.toString(), result.toString().contains("empty"));
+        result = RepresentationUtils.toFilteredRepresentation(op);
+        assertNotNull(result);
+        assertFalse(result.toString(), result.toString().contains("empty"));
+    }
 }
\ No newline at end of file