Shared: move shared file to 'shared' folder and add parameterized module for 'getInvalidModelKind'

Author: Jami Cogswell

config/identical-files.json

@@ -598,14 +598,5 @@
   "EncryptionKeySizes Python/Java": [
     "python/ql/lib/semmle/python/security/internal/EncryptionKeySizes.qll",
     "java/ql/lib/semmle/code/java/security/internal/EncryptionKeySizes.qll"
-  ],
-  "SharedModelValidation Java/C#/Go/JS/Python/Ruby/Swift": [
-    "java/ql/lib/semmle/code/java/dataflow/internal/SharedModelValidation.qll",
-    "csharp/ql/lib/semmle/code/csharp/dataflow/internal/SharedModelValidation.qll",
-    "go/ql/lib/semmle/go/dataflow/internal/SharedModelValidation.qll",
-    "swift/ql/lib/codeql/swift/dataflow/internal/SharedModelValidation.qll",
-    "javascript/ql/lib/semmle/javascript/frameworks/data/internal/SharedModelValidation.qll",
-    "python/ql/lib/semmle/python/frameworks/data/internal/SharedModelValidation.qll",
-    "ruby/ql/lib/codeql/ruby/frameworks/data/internal/SharedModelValidation.qll"
   ]
 }

csharp/ql/lib/qlpack.yml

@@ -6,6 +6,7 @@ extractor: csharp
 library: true
 upgrades: upgrades
 dependencies:
+  codeql/mad: ${workspace}
   codeql/ssa: ${workspace}
   codeql/tutorial: ${workspace}
   codeql/util: ${workspace}

csharp/ql/lib/semmle/code/csharp/dataflow/ExternalFlow.qll

@@ -95,7 +95,7 @@ private import internal.DataFlowPublic
 private import internal.FlowSummaryImpl::Public
 private import internal.FlowSummaryImpl::Private::External
 private import internal.FlowSummaryImplSpecific
-private import internal.SharedModelValidation
+private import codeql.mad.ModelValidation as SharedModelVal
 
 /** Holds if a source model exists for the given parameters. */
 predicate sourceModel = Extensions::sourceModel/9;
@@ -205,32 +205,20 @@ module ModelValidation {
     )
   }
 
-  /** Gets an error message relating to an invalid kind in a model. */
-  private string getInvalidModelKind() {
-    exists(string kind | summaryModel(_, _, _, _, _, _, _, _, kind, _) |
-      not kind instanceof ValidSummaryKind and
-      result = "Invalid kind \"" + kind + "\" in summary model."
-    )
-    or
-    exists(string kind, string msg | sinkModel(_, _, _, _, _, _, _, kind, _) |
-      not kind instanceof ValidSinkKind and
-      msg = "Invalid kind \"" + kind + "\" in sink model." and
-      // The part of this message that refers to outdated sink kinds can be deleted after June 1st, 2024.
-      if kind instanceof OutdatedSinkKind
-      then result = msg + " " + kind.(OutdatedSinkKind).outdatedMessage()
-      else result = msg
-    )
-    or
-    exists(string kind | sourceModel(_, _, _, _, _, _, _, kind, _) |
-      not kind instanceof ValidSourceKind and
-      result = "Invalid kind \"" + kind + "\" in source model."
-    )
-    or
-    exists(string kind | neutralModel(_, _, _, _, kind, _) |
-      not kind instanceof ValidNeutralKind and
-      result = "Invalid kind \"" + kind + "\" in neutral model."
-    )
-  }
+  /** Holds if a summary model exists for the given `kind`. */
+  private predicate summaryKind(string kind) { summaryModel(_, _, _, _, _, _, _, _, kind, _) }
+
+  /** Holds if a sink model exists for the given `kind`. */
+  private predicate sinkKind(string kind) { sinkModel(_, _, _, _, _, _, _, kind, _) }
+
+  /** Holds if a source model exists for the given `kind`. */
+  private predicate sourceKind(string kind) { sourceModel(_, _, _, _, _, _, _, kind, _) }
+
+  /** Holds if a neutral model exists for the given `kind`. */
+  private predicate neutralKind(string kind) { neutralModel(_, _, _, _, kind, _) }
+
+  private module KindVal =
+    SharedModelVal::KindValidation<summaryKind/1, sinkKind/1, sourceKind/1, neutralKind/1>;
 
   private string getInvalidModelSignature() {
     exists(
@@ -273,7 +261,7 @@ module ModelValidation {
     msg =
       [
         getInvalidModelSignature(), getInvalidModelInput(), getInvalidModelOutput(),
-        getInvalidModelKind()
+        KindVal::getInvalidModelKind()
       ]
   }
 }

csharp/ql/lib/semmle/code/csharp/dataflow/internal/SharedModelValidation.qll

@@ -6,6 +6,7 @@ extractor: go
 library: true
 upgrades: upgrades
 dependencies:
+  codeql/mad: ${workspace}
   codeql/tutorial: ${workspace}
   codeql/util: ${workspace}
 dataExtensions:

go/ql/lib/qlpack.yml

@@ -68,7 +68,7 @@ private import internal.FlowSummaryImpl::Private::External
 private import internal.FlowSummaryImplSpecific
 private import internal.AccessPathSyntax
 private import FlowSummary
-private import internal.SharedModelValidation
+private import codeql.mad.ModelValidation as SharedModelVal
 
 /**
  * A module importing the frameworks that provide external flow data,
@@ -189,27 +189,20 @@ module ModelValidation {
     )
   }
 
-  /** Gets an error message relating to an invalid kind in a model. */
-  private string getInvalidModelKind() {
-    exists(string kind | summaryModel(_, _, _, _, _, _, _, _, kind, _) |
-      not kind instanceof ValidSummaryKind and
-      result = "Invalid kind \"" + kind + "\" in summary model."
-    )
-    or
-    exists(string kind, string msg | sinkModel(_, _, _, _, _, _, _, kind, _) |
-      not kind instanceof ValidSinkKind and
-      msg = "Invalid kind \"" + kind + "\" in sink model." and
-      // The part of this message that refers to outdated sink kinds can be deleted after June 1st, 2024.
-      if kind instanceof OutdatedSinkKind
-      then result = msg + " " + kind.(OutdatedSinkKind).outdatedMessage()
-      else result = msg
-    )
-    or
-    exists(string kind | sourceModel(_, _, _, _, _, _, _, kind, _) |
-      not kind instanceof ValidSourceKind and
-      result = "Invalid kind \"" + kind + "\" in source model."
-    )
-  }
+  /** Holds if a summary model exists for the given `kind`. */
+  private predicate summaryKind(string kind) { summaryModel(_, _, _, _, _, _, _, _, kind, _) }
+
+  /** Holds if a sink model exists for the given `kind`. */
+  private predicate sinkKind(string kind) { sinkModel(_, _, _, _, _, _, _, kind, _) }
+
+  /** Holds if a source model exists for the given `kind`. */
+  private predicate sourceKind(string kind) { sourceModel(_, _, _, _, _, _, _, kind, _) }
+
+  /** Holds if a neutral model exists for the given `kind`. */
+  private predicate neutralKind(string kind) { none() }
+
+  private module KindVal =
+    SharedModelVal::KindValidation<summaryKind/1, sinkKind/1, sourceKind/1, neutralKind/1>;
 
   private string getInvalidModelSignature() {
     exists(
@@ -247,7 +240,7 @@ module ModelValidation {
     msg =
       [
         getInvalidModelSignature(), getInvalidModelInput(), getInvalidModelOutput(),
-        getInvalidModelKind()
+        KindVal::getInvalidModelKind()
       ]
   }
 }