[#68] Integrate Model Orphans Reporting

Added Model Orphan Support

Author: danielsiegl

.github/workflows/release.yml

@@ -4,6 +4,13 @@ on:
     release:
       types: [created]
 
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+    deployments: write
+
 jobs:
     prepareVersion:
         runs-on: windows-latest

src/LemonTree.Pipeline.Tools.ModelCheck/Checks/Checks.cs

@@ -453,6 +453,47 @@ internal static Issue CheckTableSize(string model)
             result.Detail = ToMD(resultTable.DefaultView.ToTable(), header: true);
 
 
+            #endregion
+
+            return result;
+        }
+
+        internal static Issue CheckModelOrphans(string model)
+        {
+            #region get result table
+
+            const string statisticSql = @"SELECT ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE, t_object.* FROM t_object WHERE t_object.Object_Type <> 'Package'  AND t_object.Object_ID NOT IN (SELECT t_diagramobjects.Object_ID FROM t_diagramobjects)  AND t_object.Object_ID NOT IN (SELECT t_object.Classifier FROM t_object WHERE t_object.Classifier <> 0) AND t_object.Object_ID NOT IN (SELECT a.Object_ID FROM t_object AS a JOIN t_object AS b ON b.PDATA1 = a.ea_guid) AND t_object.Object_ID NOT IN (SELECT CAST(t_attribute.Classifier AS INTEGER) FROM t_attribute WHERE t_attribute.Classifier <> '0' AND t_attribute.Classifier <> '') AND t_object.Object_ID NOT IN (SELECT CAST(t_operation.Classifier AS INTEGER) FROM t_operation WHERE t_operation.Classifier <> '0' AND t_operation.Classifier <> '') AND t_object.Object_ID NOT IN (SELECT CAST(t_operationparams.Classifier AS INTEGER) FROM t_operationparams WHERE t_operationparams.Classifier <> '0' AND t_operationparams.Classifier <> '') AND t_object.Object_ID NOT IN (SELECT t_connector.Start_Object_ID FROM t_connector) AND t_object.Object_ID NOT IN (SELECT t_connector.End_Object_ID FROM t_connector) AND t_object.Object_ID NOT IN (SELECT t_object.ParentID FROM t_object) AND t_object.Object_ID NOT IN ( SELECT t_object.Object_ID  FROM t_xref  JOIN t_object ON t_xref.Description LIKE '%' || t_object.ea_guid || '%' WHERE t_xref.Name = 'MOFProps' ) AND t_object.ea_guid NOT IN ( SELECT t_operation.Behaviour FROM t_operation WHERE t_operation.Behaviour <> '' ) AND t_object.Object_ID NOT IN ( SELECT CAST(t_connector.PDATA1 AS INTEGER)  FROM t_connector  WHERE t_connector.Connector_Type = 'Association' AND t_connector.SubType = 'Class' );";
+
+            var resultTable = ModelAccess.RunSql(statisticSql);
+
+            Console.WriteLine(ToMD(resultTable, header: true));
+
+            #endregion
+
+
+            #region process result table and calculate Issue number
+
+
+            #endregion
+
+            #region set Issue Level
+
+            Issue result = new Issue();
+
+            result.Level = IssueLevel.Information;
+            result.Title = "Model Orphans Statistics (all >32)";
+
+
+            if (resultTable.Rows.Count > 0)
+            {
+                result.Detail = ToMD(resultTable.DefaultView.ToTable(), header: true);
+            }
+            else
+            {
+                result.Detail = "No Orphans found in Model!";
+            }
+
+
             #endregion
 
             return result;

src/LemonTree.Pipeline.Tools.ModelCheck/CommandLineOptions/ModelCheckOptions.cs

@@ -19,5 +19,8 @@ internal class ModelCheckOptions:BaseOptions
 
         [Option("TableSize", Required = false, HelpText = "If set the size of the tables in the database will be reported!")]
         public bool TableSize { get; set; }
+
+        [Option("Orphans", Required = false, HelpText = "If Model Orphans will be reported!")]
+        public bool Orphans { get; set; }
     }
 }

src/LemonTree.Pipeline.Tools.ModelCheck/Program.cs

@@ -70,7 +70,7 @@ private static int RunModelCheck(ModelCheckOptions opts)
                 }
 
 
-               // issues.WriteOutPut(Checks.Checks.CheckProjectStatitics(opts.Model));
+                // issues.WriteOutPut(Checks.Checks.CheckProjectStatitics(opts.Model));
 
 
                 Console.WriteLine(issues.ToString());
@@ -84,23 +84,39 @@ private static int RunModelCheck(ModelCheckOptions opts)
                 {
                     if (ModelAccess.IsSqlLite())
                     {
-                        sb.AppendLine(Checks.Checks.CheckTableSize(opts.Model).Detail);
+                        var result = Checks.Checks.CheckTableSize(opts.Model);
+                        sb.AppendLine(result.Detail);
+                        issues.AddIfNotNull(result);
                     }
                     else
                     {
                         Console.WriteLine("Talbesize reporting only supported for SqlLite!");
                     }
                 }
 
-               
+                if (opts.Orphans == true)
+                {
+                    if (ModelAccess.IsSqlLite())
+                    {
+                        var result = Checks.Checks.CheckModelOrphans(opts.Model);
+                        sb.AppendLine(result.Detail);
+                        issues.AddIfNotNull(result);
+                    }
+                    else
+                    {
+                        Console.WriteLine("Orphans reporting only supported for SqlLite!");
+                    }
+                }
+
+
 
 
                 if (opts.Out != null)
                 {
-                     File.WriteAllText(opts.Out, sb.ToString());
+                    File.WriteAllText(opts.Out, sb.ToString());
                 }
 
-            
+
 
                 if (opts.FailOnErrors == true)
                 {

src/LemonTree.Pipeline.Tools.ModelCheck/Properties/launchSettings.json

@@ -2,7 +2,11 @@
   "profiles": {
     "LemonTree.Pipeline.Tools.ModelCheck": {
       "commandName": "Project",
-      "commandLineArgs": "--model models\\model.qeax --tablesize"
+      "commandLineArgs": "--model models\\model.qeax --tablesize --orphans"
+    },
+    "ExampleModel": {
+      "commandName": "Project",
+      "commandLineArgs": "--model \"C:\\repos\\SixthForth\\lemontree_demo\\EAExample.qeax\" --tablesize --orphans"
     }
   }
 }