Adds support for filtered deployment views (#409).

Author: simonbrowndotje

changelog.md

@@ -3,6 +3,7 @@
 ## v5.0.0 (unreleased)
 
 - structurizr-core: Removes support for deprecated enterprise and location concepts.
+- structurizr-core: Adds support for filtered deployment views (https://github.com/structurizr/java/issues/409). 
 - structurizr-component: Fixes https://github.com/structurizr/java/issues/437 (Make ComponentFinder.run() not fail on empty Set<DiscoveredComponent>).
 - structurizr-dsl: Adds support for `iconPosition` on element styles (options are `Top`, `Bottom`, `Left`).
 - structurizr-dsl: Adds support for defining element and relationship styles for light and dark mode.

structurizr-core/src/main/java/com/structurizr/view/FilteredView.java

@@ -11,7 +11,7 @@
  */
 public final class FilteredView extends View {
 
-    private StaticView view;
+    private ModelView view;
     private String baseViewKey;
 
     private FilterMode mode = FilterMode.Exclude;
@@ -20,7 +20,7 @@ public final class FilteredView extends View {
     FilteredView() {
     }
 
-    FilteredView(StaticView view, String key, String description, FilterMode mode, String... tags) {
+    FilteredView(ModelView view, String key, String description, FilterMode mode, String... tags) {
         this.view = view;
         setKey(key);
         setDescription(description);
@@ -33,7 +33,7 @@ public View getView() {
         return view;
     }
 
-    void setView(StaticView view) {
+    void setView(ModelView view) {
         this.view = view;
     }
 

structurizr-core/src/main/java/com/structurizr/view/ViewSet.java

@@ -498,6 +498,24 @@ public FilteredView createFilteredView(StaticView view, String key, FilterMode m
      * @return              a FilteredView object
      */
     public FilteredView createFilteredView(StaticView view, String key, String description, FilterMode mode, String... tags) {
+        return newFilteredView(view, key, description, mode, tags);
+    }
+
+    /**
+     * Creates a FilteredView on top of an existing deployment view.
+     *
+     * @param view          the deployment view to base the FilteredView upon
+     * @param key           the key for the filtered view (must be unique)
+     * @param description   a description
+     * @param mode          whether to Include or Exclude elements/relationships based upon their tag
+     * @param tags          the tags to include or exclude
+     * @return              a FilteredView object
+     */
+    public FilteredView createFilteredView(DeploymentView view, String key, String description, FilterMode mode, String... tags) {
+        return newFilteredView(view, key, description, mode, tags);
+    }
+
+    private FilteredView newFilteredView(ModelView view, String key, String description, FilterMode mode, String... tags) {
         boolean keyIsAutomaticallyGenerated = false;
 
         if (StringUtils.isNullOrEmpty(key)) {
@@ -900,11 +918,11 @@ void hydrate(Model model) {
                 );
             }
 
-            if (view instanceof StaticView) {
-                filteredView.setView((StaticView)view);
+            if (view instanceof StaticView || view instanceof DeploymentView) {
+                filteredView.setView((ModelView)view);
             } else {
                 throw new WorkspaceValidationException(
-                        String.format("The filtered view with key \"%s\" is based upon a view (key=%s), but that view is not a static view.",
+                        String.format("The filtered view with key \"%s\" is based upon a view (key=%s), but that view is not a static or deployment view.",
                                 filteredView.getKey(), filteredView.getBaseViewKey())
                 );
             }

structurizr-core/src/test/java/com/structurizr/view/ViewSetTests.java

@@ -491,7 +491,7 @@ void createDeploymentViewForSoftwareSystem() {
     void createFilteredView_ThrowsAnException_WhenANullViewIsSpecified() {
         try {
             Workspace workspace = new Workspace("Name", "Description");
-            workspace.getViews().createFilteredView(null, "key", "Description", FilterMode.Include, "tag1", "tag2");
+            workspace.getViews().createFilteredView((SystemLandscapeView)null, "key", "Description", FilterMode.Include, "tag1", "tag2");
             fail();
         } catch (IllegalArgumentException iae) {
             assertEquals("A view must be specified.", iae.getMessage());
@@ -530,7 +530,7 @@ void createFilteredView_ThrowsAnException_WhenADuplicateKeyIsUsed() {
     }
 
     @Test
-    void createFilteredView() {
+    void createFilteredView_OnStaticView() {
         Workspace workspace = new Workspace("Name", "Description");
         SystemLandscapeView view = workspace.getViews().createSystemLandscapeView("systemLandscape", "Description");
         FilteredView filteredView = workspace.getViews().createFilteredView(view, "key", "Description", FilterMode.Include, "tag1", "tag2");
@@ -543,6 +543,20 @@ void createFilteredView() {
         assertTrue(filteredView.getTags().contains("tag2"));
     }
 
+    @Test
+    void createFilteredView_OnDeploymentView() {
+        Workspace workspace = new Workspace("Name", "Description");
+        DeploymentView view = workspace.getViews().createDeploymentView("deployment");
+        FilteredView filteredView = workspace.getViews().createFilteredView(view, "key", "Description", FilterMode.Include, "tag1", "tag2");
+
+        assertEquals("key", filteredView.getKey());
+        assertEquals("Description", filteredView.getDescription());
+        assertEquals(FilterMode.Include, filteredView.getMode());
+        assertEquals(2, filteredView.getTags().size());
+        assertTrue(filteredView.getTags().contains("tag1"));
+        assertTrue(filteredView.getTags().contains("tag2"));
+    }
+
     @Test
     void copyLayoutInformationFrom_WhenAViewKeyIsNotSetButTheViewTitlesMatch() {
         Workspace workspace1 = createWorkspace();

structurizr-dsl/src/main/java/com/structurizr/dsl/FilteredViewParser.java

@@ -2,9 +2,7 @@
 
 import com.structurizr.Workspace;
 import com.structurizr.util.StringUtils;
-import com.structurizr.view.FilterMode;
-import com.structurizr.view.FilteredView;
-import com.structurizr.view.StaticView;
+import com.structurizr.view.*;
 
 import java.text.DecimalFormat;
 import java.util.HashSet;
@@ -37,7 +35,7 @@ FilteredView parse(DslContext context, Tokens tokens) {
         Workspace workspace = context.getWorkspace();
         String key = "";
 
-        StaticView baseView;
+        View baseView;
         String baseKey = tokens.get(BASE_KEY_INDEX);
         String mode = tokens.get(MODE_INDEX);
         String tagsAsString = tokens.get(TAGS_INDEX);
@@ -64,21 +62,23 @@ FilteredView parse(DslContext context, Tokens tokens) {
             throw new RuntimeException("Filter mode should be include or exclude");
         }
 
-        if (workspace.getViews().getViews().stream().noneMatch(v -> v.getKey().equals(baseKey))) {
-            throw new RuntimeException("The view \"" + baseKey + "\" does not exist");
-        }
-
-        baseView = (StaticView)workspace.getViews().getViews().stream().filter(v -> v instanceof StaticView && v.getKey().equals(baseKey)).findFirst().orElse(null);
+        baseView = workspace.getViews().getViewWithKey(baseKey);
         if (baseView == null) {
-            throw new RuntimeException("The view \"" + baseKey + "\" must be a System Landscape, System Context, Container, or Component view");
+            throw new RuntimeException("The view \"" + baseKey + "\" does not exist");
         }
 
         if (tokens.includes(KEY_INDEX)) {
             key = tokens.get(KEY_INDEX);
             validateViewKey(key);
         }
 
-        return workspace.getViews().createFilteredView(baseView, key, description, filterMode, tags.toArray(new String[0]));
+        if (baseView instanceof StaticView) {
+            return workspace.getViews().createFilteredView((StaticView)baseView, key, description, filterMode, tags.toArray(new String[0]));
+        } else if (baseView instanceof DeploymentView) {
+            return workspace.getViews().createFilteredView((DeploymentView)baseView, key, description, filterMode, tags.toArray(new String[0]));
+        } else {
+            throw new RuntimeException("The view \"" + baseKey + "\" must be a System Landscape, System Context, Container, Component, or Deployment view");
+        }
     }
 
 }

structurizr-dsl/src/test/java/com/structurizr/dsl/FilteredViewParserTests.java

@@ -80,14 +80,14 @@ void test_parse_ThrowsAnException_WhenTheBaseViewDoesNotExist() {
     }
 
     @Test
-    void test_parse_ThrowsAnException_WhenTheBaseViewIsNotAStaticView() {
+    void test_parse_ThrowsAnException_WhenTheBaseViewIsNotAStaticOrDeploymentView() {
         DslContext context = context();
-        views.createDeploymentView("baseKey", "Description");
+        views.createDynamicView("baseKey", "Description");
         try {
             parser.parse(context, tokens("filtered", "baseKey", "include", "Tag 1, Tag 2", "key"));
             fail();
         } catch (RuntimeException iae) {
-            assertEquals("The view \"baseKey\" must be a System Landscape, System Context, Container, or Component view", iae.getMessage());
+            assertEquals("The view \"baseKey\" must be a System Landscape, System Context, Container, Component, or Deployment view", iae.getMessage());
         }
     }