Merge pull request #51 from devsecopsmaturitymodel/feat/51-generate-dependency-tree

Generate dependency tree as markdown

Author: wurstbrot

yaml-generation/functions.php

@@ -319,6 +319,16 @@ function getReferences($references) {
 
 }
 
+/**
+ * Push item to array at key, creating array if needed.
+ */
+function array_push_item_to(array &$array, $key, $value) {
+    if (!isset($array[$key])) {
+        $array[$key] = [];
+    }
+    array_push($array[$key], $value);
+}
+
 
 // TODO create testcases
 

yaml-generation/generateDimensions.php

@@ -51,6 +51,8 @@
     $dimensionsAggregated = $dimensions;
 }
 
+$dependencies = array();
+$activityIndex = array();
 foreach ($dimensionsAggregated as $dimension => $subdimensions) {
     ksort($subdimensions);
     foreach ($subdimensions as $subdimension => $elements) {
@@ -68,7 +70,7 @@
                 array_push($errorMsg,"Missing 'level' attribute in activity: $activityName");
 	        }
 
-            echo "$subdimension | $activityName\n";
+            // echo "$subdimension | $activityName\n";
             if (!array_key_exists("uuid", $activity)) {
                 array_push($errorMsg, "$activityName is missing an uuid in $dimension");
             } else {
@@ -147,6 +149,16 @@
                             array_push($errorMsg,"DependsOn non-existing activity: '$dependsOn' (in activity: $activityName)");
                         }
                     }
+
+                    // Build dependency graph
+                    if (!array_key_exists($activityName, $activityIndex)) {
+                        $activityIndex[$activityName] = count($activityIndex);
+                    }
+                    if (!array_key_exists($dependsOn, $activityIndex)) {
+                        $activityIndex[$dependsOn] = count($activityIndex);
+                    }
+                    array_push_item_to($dependencies, $activityIndex[$dependsOn], $activityIndex[$activityName]);
+
                 }
             }
         }
@@ -188,6 +200,48 @@
 file_put_contents($targetGeneratedFile, $dimensionsString);
 
 
+// Store dependency graph
+$graphFilename = getcwd() . "/src/assets/YAML/generated/dependency-tree.md";
+$graphFile = fopen($graphFilename, "w");
+fwrite($graphFile, "```mermaid\n\n");
+fwrite($graphFile, "graph LR\n\n");
+// List all nodes
+foreach ($activityIndex as $activityName => $key) {
+    $level = getActivityByActivityName($activityName,  $dimensionsAggregated)["level"];
+    $activityName = "L$level $activityName";
+    $activityName = str_replace('(', '', $activityName);
+    $activityName = str_replace(')', '', $activityName);
+    fwrite($graphFile, "$key($activityName)\n");
+}
+// Add links between nodes
+fwrite($graphFile, "\n\n");
+foreach ($dependencies as $dad => $children) {
+    foreach ($children as $child) {
+        fwrite($graphFile, "$dad --> $child\n");
+    }
+}
+// Tie all orphans to a common start node
+fwrite($graphFile, "\n");
+foreach ($activityIndex as $activityName => $key) {
+    $isOrphan = true;
+    foreach ($dependencies as $dad => $children) {
+        if ($dad == $key) continue;
+        if (in_array($key, $children)) {
+            $isOrphan = false;
+            break;
+        }
+    }
+    if ($isOrphan) {
+        fwrite($graphFile, "O --> $key\n");
+    }
+}
+
+// Close the file
+fwrite($graphFile, "```\n");
+fclose($graphFile);
+echo "\nSaved dependency graph '$graphFilename'\n\n";
+
+
 
 function assertUniqueRefs($all_references, &$errorMsg) {
     foreach ($all_references as $references) {