Updated Visualizer to use GraphViz

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "testing.openTesting": "neverOpen",
+    "jest.outputConfig": {
+        "revealOn": "run",
+        "revealWithFocus": "none",
+        "clearOnRun": "none"
+    }
+}

calm/samples/traderx/traderx.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/finos-labs/architecture-as-code/main/calm/draft/2024-03/meta/calm.json",
+  "$schema": "https://raw.githubusercontent.com/finos-labs/architecture-as-code/main/calm/draft/2024-04/meta/calm.json",
   "nodes": [
     {
       "unique-id": "traderx-system",

cli/jest.config.js

@@ -4,6 +4,6 @@ export default {
     testEnvironment: 'node',
     testMatch: ['<rootDir>/src/**/*.spec.ts'],
     moduleNameMapper: {
-        '(.+)\\.js': '$1'
-    },
+        '^(.+)\\.js$': '$1'
+    }
 };

cli/package.json

@@ -25,7 +25,9 @@
     "ajv": "^8.12.0",
     "commander": "^12.0.0",
     "fetch-mock": "^9.11.0",
+    "graphviz-cli": "^2.0.0",
     "mkdirp": "^3.0.1",
+    "ts-graphviz": "^2.1.1",
     "tsconfig-paths": "^4.2.0",
     "winston": "^3.13.0"
   },

cli/src/commands/validate/validate.spec.ts

@@ -19,6 +19,18 @@ jest.mock('@stoplight/spectral-core', () => {
     };
 });
 
+jest.mock('../helper.js', () => {
+    return {
+        initLogger: () => {
+            return {
+                info: jest.fn(),
+                debug: jest.fn(),
+                error: jest.fn()
+            };
+        }
+    };
+});
+
 const metaSchemaLocation = 'test_fixtures/calm';
 const debugDisabled = false;
 

cli/src/commands/validate/validate.ts

@@ -8,7 +8,7 @@ import { initLogger } from '../helper.js';
 
 let logger: winston.Logger; // defined later at startup
 
-export default async function validate(jsonSchemaInstantiationLocation: string, jsonSchemaLocation: string, metaSchemaPath: string, debug: boolean) {
+export default async function validate(jsonSchemaInstantiationLocation: string, jsonSchemaLocation: string, metaSchemaPath: string, debug: boolean = false) {
     logger = initLogger(debug);
     let exitCode = 0;
     try {
@@ -63,7 +63,7 @@ function loadMetaSchemas(ajv: Ajv2020, metaSchemaLocation: string) {
 
 async function runSpectralValidations(jsonSchemaInstantiation: string) {
     const spectral = new Spectral();
-    spectral.setRuleset(await getRuleset('../spectral/calm-validation-rules.yaml'));
+    spectral.setRuleset(await getRuleset('../spectral/instantiation/validation-rules.yaml'));
     const issues = await spectral.run(jsonSchemaInstantiation);
     if (issues && issues.length > 0) {
         logger.info(`Spectral issues: ${prettifyJson(issues)}`);

cli/src/commands/visualize/Types.d.ts

@@ -0,0 +1,61 @@
+export interface CALMInstantiation {
+    nodes: CALMNode[],
+    relationships: CALMRelationship[]
+}
+
+export type NodeType = 'actor' | 'system' | 'service' | 'database' | 'internal-network' | 'ldap' | 'dataclient';
+
+export interface CALMNode {
+    name: string, 
+    class?: string,
+    'unique-id': string,
+    'node-type': NodeType,
+    description: string,
+    'data-classification'?: string,
+    'run-as'?: string,
+    instance?: string
+}
+
+export type CALMRelationship = CALMInteractsRelationship | CALMConnectsRelationship | CALMDeployedInRelationship | CALMComposedOfRelationship;
+
+export interface CALMInteractsRelationship {
+    'relationship-type': {
+        'interacts': {
+            actor: string,
+            nodes: string[]
+        }
+    },
+    uniqueId: string,
+}
+
+export interface CALMConnectsRelationship {
+    'relationship-type': {
+        'connects': {
+            source: { node: string, interface?: string },
+            destination: { node: string, interface?: string }
+        }
+    },
+    uniqueId: string,
+    protocol?: string,
+    authentication?: string,
+}
+
+export interface CALMDeployedInRelationship {
+    'relationship-type': {
+        'deployed-in': {
+            container: string,
+            nodes: string[]
+        }
+    },
+    uniqueId: string,
+}
+
+export interface CALMComposedOfRelationship {
+    'relationship-type': {
+        'composed-of': {
+            container: string,
+            nodes: string[]
+        },
+    }
+    uniqueId: string,
+}

cli/src/commands/visualize/calmToDot.spec.ts

@@ -0,0 +1,93 @@
+import { CALMInstantiation } from './Types';
+import calmToDot from './calmToDot';
+
+jest.mock('../helper.js', () => {
+    return {
+        initLogger: () => {
+            return {
+                info: jest.fn(),
+                debug: jest.fn(),
+                error: jest.fn()
+            };
+        }
+    };
+});
+
+describe('calmToDot', () => {
+    let calm: CALMInstantiation;
+
+    beforeEach(() => {
+        calm = {
+            nodes: [
+                {
+                    'unique-id': 'node-1',
+                    'name': 'Node 1',
+                    'node-type': 'service',
+                    'description': 'This is node 1'
+                },
+                {
+                    'unique-id': 'node-2',
+                    'name': 'Node 2',
+                    'node-type': 'service',
+                    'description': 'This is node 2'
+                }
+            ],
+            relationships: [
+                {
+                    'uniqueId': 'relationship-1',
+                    'protocol': 'HTTPS',
+                    'relationship-type': {
+                        'connects': {
+                            source: {
+                                node: 'node-1'
+                            },
+                            destination: {
+                                node: 'node-2'
+                            }
+                        }
+                    }
+                }
+            ]
+        };
+    });
+
+    it('creates a basic node', () => {
+        const actualDot = calmToDot(calm);
+        expect(actualDot).toContain('"node-1" [');
+        expect(actualDot).toContain('label = "Service: Node 1"');
+        expect(actualDot).toContain('shape = "box"');
+    });
+
+    it('creates a basic relationship', () => {
+        const actualDot = calmToDot(calm);
+        expect(actualDot).toContain('"node-1" -> "node-2" [');
+        expect(actualDot).toContain('label = "connects HTTPS "');
+    });
+
+    it('creates an empty graph when given empty calm', () => {
+        calm = { nodes: [], relationships: []};
+        const actualDot = calmToDot(calm);
+        expect(actualDot).toEqual('digraph {   nodesep = 0.5; }');
+    });
+
+    it('creates a subgraph relationship', () => {
+        calm = {
+            ...calm,
+            relationships: [
+                {
+                    'uniqueId': 'subtest',
+                    'relationship-type': {
+                        'deployed-in': {
+                            container: 'node-1',
+                            nodes: ['node-2']
+                        }
+                    }
+                }
+            ]
+        };
+        const actualDot = calmToDot(calm);
+        expect(actualDot).toContain('subgraph "clusternode-1" {');
+        expect(actualDot).toContain('label = "node-1"');
+        expect(actualDot).toContain('"node-2" [');
+    });
+});