Default inspector adds a summary of error/warning/info/ignore counts as workspace properties.

Author: simonbrowndotje

changelog.md

@@ -14,6 +14,7 @@
 - structurizr-dsl: Adds support for removing relationships between software system instance/container instances, with a view to redefining them via infrastructure nodes.
 - structurizr-dsl: Adds support for a `jump` property on relationship styles.
 - structurizr-inspection: Adds a way to disable inspections via a workspace property named `structurizr.inspection` (`false` to disable).
+- structurizr-inspection: Default inspector adds a summary of error/warning/info/ignore counts as workspace properties.
 
 ## v4.1.0 (28th May 2025)
 

structurizr-inspection/src/main/java/com/structurizr/inspection/DefaultInspector.java

@@ -10,15 +10,28 @@
 import com.structurizr.model.*;
 import com.structurizr.view.*;
 
+import java.util.List;
+
 public class DefaultInspector extends Inspector {
 
+    private static final String INSPECTION_SUMMARY_NUMBER_OF_ERROR =    "structurizr.inspection.error";
+    private static final String INSPECTION_SUMMARY_NUMBER_OF_WARNING =  "structurizr.inspection.warning";
+    private static final String INSPECTION_SUMMARY_NUMBER_OF_INFO =     "structurizr.inspection.info";
+    private static final String INSPECTION_SUMMARY_NUMBER_OF_IGNORE =   "structurizr.inspection.ignore";
+
     public DefaultInspector(Workspace workspace) {
         super(workspace);
 
         if (!"false".equalsIgnoreCase(workspace.getProperties().get("structurizr.inspection"))) {
             runWorkspaceInspections();
             runModelInspections();
             runViewInspections();
+
+            List<Violation> violations = getViolations();
+            workspace.addProperty(INSPECTION_SUMMARY_NUMBER_OF_ERROR, "" + violations.stream().filter(r -> r.getSeverity() == Severity.ERROR).count());
+            workspace.addProperty(INSPECTION_SUMMARY_NUMBER_OF_WARNING, "" + violations.stream().filter(r -> r.getSeverity() == Severity.WARNING).count());
+            workspace.addProperty(INSPECTION_SUMMARY_NUMBER_OF_INFO, "" + violations.stream().filter(r -> r.getSeverity() == Severity.INFO).count());
+            workspace.addProperty(INSPECTION_SUMMARY_NUMBER_OF_IGNORE, "" + violations.stream().filter(r -> r.getSeverity() == Severity.IGNORE).count());
         }
     }
 

structurizr-inspection/src/test/java/com/structurizr/inspection/DefaultInspectorTests.java

@@ -9,12 +9,14 @@
 import java.util.List;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
 
 public class DefaultInspectorTests {
 
     @Test
     void test_EmptyWorkspace() {
-        DefaultInspector inspector = new DefaultInspector(new Workspace("Name", "Description"));
+        Workspace workspace = new Workspace("Name", "Description");
+        DefaultInspector inspector = new DefaultInspector(workspace);
         List<Violation> violations = inspector.getViolations();
 
         assertEquals(9, inspector.getNumberOfInspections());
@@ -34,6 +36,11 @@ void test_EmptyWorkspace() {
         assertEquals(Severity.ERROR, violation.getSeverity());
         assertEquals("views.empty", violation.getType());
         assertEquals("This workspace has no views.", violation.getMessage());
+
+        assertEquals("3", workspace.getProperties().get("structurizr.inspection.error"));
+        assertEquals("0", workspace.getProperties().get("structurizr.inspection.warning"));
+        assertEquals("0", workspace.getProperties().get("structurizr.inspection.info"));
+        assertEquals("0", workspace.getProperties().get("structurizr.inspection.ignore"));
     }
 
     @Test
@@ -46,6 +53,10 @@ void test_EmptyWorkspace_WhenInspectionsAreDisabled() {
 
         assertEquals(0, inspector.getNumberOfInspections());
         assertEquals(0, violations.size());
+        assertNull(workspace.getProperties().get("structurizr.inspection.error"));
+        assertNull(workspace.getProperties().get("structurizr.inspection.warning"));
+        assertNull(workspace.getProperties().get("structurizr.inspection.info"));
+        assertNull(workspace.getProperties().get("structurizr.inspection.ignore"));
     }
 
     @Test