Merge pull request #1268 from lugaru1234/issue977

Fixes #977: Tags have been filtered

Author: webron

modules/swagger-core/src/main/java/io/swagger/core/filter/SpecFilter.java

@@ -5,27 +5,33 @@
 import io.swagger.models.Operation;
 import io.swagger.models.Path;
 import io.swagger.models.Swagger;
+import io.swagger.models.Tag;
 import io.swagger.models.parameters.Parameter;
 import io.swagger.models.properties.Property;
 
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 public class SpecFilter {
     public Swagger filter(Swagger swagger, SwaggerSpecFilter filter, Map<String, List<String>> params, Map<String, String> cookies, Map<String, List<String>> headers) {
         Swagger clone = new Swagger();
         clone.info(swagger.getInfo())
-                .tags(swagger.getTags())
+                .tags(swagger.getTags() == null ? null : new ArrayList<Tag>(swagger.getTags()))
                 .host(swagger.getHost())
                 .basePath(swagger.getBasePath())
                 .schemes(swagger.getSchemes())
                 .consumes(swagger.getConsumes())
                 .produces(swagger.getProduces())
                 .externalDocs(swagger.getExternalDocs());
 
+        final Set<String> filteredTags = new HashSet<String>();
+        final Set<String> allowedTags = new HashSet<String>();
         for (String resourcePath : swagger.getPaths().keySet()) {
             Path path = swagger.getPaths().get(resourcePath);
             Map<String, Operation> ops = new HashMap<String, Operation>();
@@ -41,15 +47,34 @@ public Swagger filter(Swagger swagger, SwaggerSpecFilter filter, Map<String, Lis
                 Operation op = ops.get(key);
                 if (op != null) {
                     ApiDescription desc = new ApiDescription(resourcePath, key);
+                    final Set<String> tags;
                     if (filter.isOperationAllowed(op, desc, params, cookies, headers)) {
                         clonedPath.set(key, filterOperation(filter, op, desc, params, cookies, headers));
+                        tags = allowedTags;
+                    } else {
+                        tags = filteredTags;
+                    }
+                    if (op.getTags() != null) {
+                        tags.addAll(op.getTags());
                     }
                 }
             }
             if (!clonedPath.isEmpty()) {
                 clone.path(resourcePath, clonedPath);
             }
         }
+        final List<Tag> tags = clone.getTags();
+        filteredTags.removeAll(allowedTags);
+        if (tags != null && !filteredTags.isEmpty()) {
+            for (Iterator<Tag> it = tags.iterator(); it.hasNext(); ) {
+                if (filteredTags.contains(it.next().getName())) {
+                    it.remove();
+                }
+            }
+            if (clone.getTags().isEmpty()) {
+                clone.setTags(null);
+            }
+        }
 
         Map<String, Model> definitions = filterDefinitions(filter, swagger.getDefinitions(), params, cookies, headers);
         clone.setSecurityDefinitions(swagger.getSecurityDefinitions());

modules/swagger-core/src/test/scala/filter/SpecFilterTest.scala

@@ -107,4 +107,24 @@ class SpecFilterTest extends FlatSpec with Matchers {
     if (filtered.size() != 1)
       fail("ModelImpl with no properties failed to filter")
   }
+
+  it should "contain all tags in the top level Swagger object" in {
+    val json = Source.fromFile("src/test/scala/specFiles/petstore.json").mkString
+    val swagger = Json.mapper().readValue(json, classOf[Swagger])
+    val filter = new NoOpOperationsFilter()
+    val filtered = new SpecFilter().filter(swagger, filter, null, null, null)
+    getTagNames(filtered) should be(Set("pet", "user", "store"))
+  }
+
+  it should "not contain user tags in the top level Swagger object" in {
+    val json = Source.fromFile("src/test/scala/specFiles/petstore.json").mkString
+    val swagger = Json.mapper().readValue(json, classOf[Swagger])
+    val filter = new NoUserOperationsFilter
+    val filtered = new SpecFilter().filter(swagger, filter, null, null, null)
+    getTagNames(filtered) should be(Set("pet", "store"))
+  }
+
+  def getTagNames(swagger: Swagger) = {
+    (for (item <- swagger.getTags.asScala) yield item.getName).toSet
+  }
 }