#41 Implement Modelcheck Queries to be executed from a checks-config.… (#42)

* #41 Implement Modelcheck Queries to be executed from a checks-config.json

* #41 added runChecksLocal.ps1 to enable localtesting

* #41 Specify custom rules

* #41 Remove optional fields and add Journal check to checks-config.json

Author: danielsiegl

.github/workflows/ReviewModelCheck.yml

@@ -47,10 +47,10 @@ jobs:
         run: |
           Write-Output "starting validation"
           if ('${{runner.os}}' -eq 'Linux') {         
-              &./LemonTree.Pipeline.Tools.ModelCheck  --model "${{env.ModelName}}" --out "./output.md" 
+              &./LemonTree.Pipeline.Tools.ModelCheck  --model "${{env.ModelName}}" --out "./output.md" --ChecksConfig "./checks-config.json" --NoCompact
           }
           elseif ('${{runner.os}}' -eq 'Windows') {
-              &./LemonTree.Pipeline.Tools.ModelCheck.exe  --model "${{env.ModelName}}" --out "./output.md" 
+              &./LemonTree.Pipeline.Tools.ModelCheck.exe  --model "${{env.ModelName}}" --out "./output.md" --ChecksConfig "./checks-config.json" --NoCompact
           }
           else {
               Write-Output "${{runner.os}} is not supported"

.gitignore

@@ -1 +1,3 @@
 /LieberLieber.Pipeline.Tools.PCS.Toggle.exe
+/output.md
+/LemonTree.Pipeline.Tools.ModelCheck.exe

checks-config.json

@@ -0,0 +1,33 @@
+{
+  "checks": [
+    {
+      "id": "Unsatisfied Requirements",
+      "query": "select count (*) from t_object where object_id not in  ( select o.object_id from t_object o inner join t_connector c on o.object_id = c.end_object_id where o.object_type = 'requirement' and c.stereotype = 'satisfy' ) and object_type = 'requirement'",
+      "passedTitle": "There are no unsatisfied requirements",
+      "failedTitle": "Model has {count} unsatisfied requirements",
+      "failedDetail": "Each requirement should be linked to at least one design element using a 'satisfy' relationship."
+    },
+    {
+      "id": "Ports without Interface Defintion",
+      "query": "select count(*) from t_object where object_type = 'Port' and t_object.PDATA1 is NULL",
+      "passedTitle": "There are no ports without interface definition",
+      "failedTitle": "Model has {count} ports without interface definition",
+      "failedDetail": "All ports should have an interface definition assigned.",
+      "failedLevel": "Warning"
+    },
+    {
+      "id": "Orphaned InterfaceBlocks",
+      "query": "select count(*) from t_object where stereotype = 'InterfaceBlock' and ea_guid not in (select pdata1 from t_object where object_type = 'Port')",
+      "passedTitle": "There are no orphaned InterfaceBlocks",
+      "failedTitle": "Model has {count} orphaned InterfaceBlocks",
+      "failedDetail": "There shouldn't be orphaned InterfaceBlocks."
+    },
+    {
+      "id": "Journal",
+      "query": "Select Count(*) from t_document where t_document.DocType = \"JEntry\"",
+      "passedTitle": "No Journal entries in the model",
+      "failedTitle": "Model has {count} Journal Entries",
+      "failedDetail": "Journal entries are not merged by LemonTree."
+    }
+  ]
+}

runChecksLocal.ps1

@@ -0,0 +1,5 @@
+#rough script for testing - no checks no nothing
+if (-not (Test-Path .\LemonTree.Pipeline.Tools.ModelCheck.exe)) {
+    Invoke-WebRequest -URI "https://nexus.lieberlieber.com/repository/lemontree-pipeline-tools/LemonTree.Pipeline.Tools.ModelCheck.exe" -OutFile ./LemonTree.Pipeline.Tools.ModelCheck.exe
+}
+& .\LemonTree.Pipeline.Tools.ModelCheck.exe --model "./LemonTree.DevOps.Demo.qeax" --out ".\output.md" --ChecksConfig ".\checks-config.json" --NoCompact