Java: add hasProvenance predicate, remove isManuallyGenerated and isBothAutoAndManuallyGenerated

Jami Cogswell · Jami Cogswell · commit 623068c4b9b0 · 2022-12-12T11:23:46.000-05:00
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/FlowSummaryImpl.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/FlowSummaryImpl.qll
@@ -246,14 +246,10 @@ module Public {
     predicate isAutoGenerated() { none() }
 
     /**
-     * Holds if the summary is manually generated and not auto generated.
+     * Holds if the summary has the given provenance where `true` is
+     * `generated` and `false` is `manual`.
      */
-    predicate isManuallyGenerated() { none() }
-
-    /**
-     * Holds if the summary is both auto generated and manually generated.
-     */
-    predicate isBothAutoAndManuallyGenerated() { none() }
+    predicate hasProvenance(boolean generated) { summaryElement(this, _, _, _, generated) }
   }
 
   /** A callable with a flow summary stating there is no flow via the callable. */
@@ -1022,16 +1018,6 @@ module Private {
       }
 
       override predicate isAutoGenerated() { this.relevantSummaryElementGenerated(_, _, _) }
-
-      override predicate isManuallyGenerated() {
-        summaryElement(this, _, _, _, false) and
-        not summaryElement(this, _, _, _, true)
-      }
-
-      override predicate isBothAutoAndManuallyGenerated() {
-        summaryElement(this, _, _, _, true) and
-        summaryElement(this, _, _, _, false)
-      }
     }
 
     /** Holds if component `c` of specification `spec` cannot be parsed. */
diff --git a/go/ql/lib/semmle/go/dataflow/internal/FlowSummaryImpl.qll b/go/ql/lib/semmle/go/dataflow/internal/FlowSummaryImpl.qll
@@ -246,14 +246,10 @@ module Public {
     predicate isAutoGenerated() { none() }
 
     /**
-     * Holds if the summary is manually generated and not auto generated.
+     * Holds if the summary has the given provenance where `true` is
+     * `generated` and `false` is `manual`.
      */
-    predicate isManuallyGenerated() { none() }
-
-    /**
-     * Holds if the summary is both auto generated and manually generated.
-     */
-    predicate isBothAutoAndManuallyGenerated() { none() }
+    predicate hasProvenance(boolean generated) { summaryElement(this, _, _, _, generated) }
   }
 
   /** A callable with a flow summary stating there is no flow via the callable. */
@@ -1022,16 +1018,6 @@ module Private {
       }
 
       override predicate isAutoGenerated() { this.relevantSummaryElementGenerated(_, _, _) }
-
-      override predicate isManuallyGenerated() {
-        summaryElement(this, _, _, _, false) and
-        not summaryElement(this, _, _, _, true)
-      }
-
-      override predicate isBothAutoAndManuallyGenerated() {
-        summaryElement(this, _, _, _, true) and
-        summaryElement(this, _, _, _, false)
-      }
     }
 
     /** Holds if component `c` of specification `spec` cannot be parsed. */
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/FlowSummaryImpl.qll b/java/ql/lib/semmle/code/java/dataflow/internal/FlowSummaryImpl.qll
@@ -246,14 +246,10 @@ module Public {
     predicate isAutoGenerated() { none() }
 
     /**
-     * Holds if the summary is manually generated and not auto generated.
+     * Holds if the summary has the given provenance where `true` is
+     * `generated` and `false` is `manual`.
      */
-    predicate isManuallyGenerated() { none() }
-
-    /**
-     * Holds if the summary is both auto generated and manually generated.
-     */
-    predicate isBothAutoAndManuallyGenerated() { none() }
+    predicate hasProvenance(boolean generated) { summaryElement(this, _, _, _, generated) }
   }
 
   /** A callable with a flow summary stating there is no flow via the callable. */
@@ -1022,16 +1018,6 @@ module Private {
       }
 
       override predicate isAutoGenerated() { this.relevantSummaryElementGenerated(_, _, _) }
-
-      override predicate isManuallyGenerated() {
-        summaryElement(this, _, _, _, false) and
-        not summaryElement(this, _, _, _, true)
-      }
-
-      override predicate isBothAutoAndManuallyGenerated() {
-        summaryElement(this, _, _, _, true) and
-        summaryElement(this, _, _, _, false)
-      }
     }
 
     /** Holds if component `c` of specification `spec` cannot be parsed. */
diff --git a/java/ql/src/Metrics/Summaries/GeneratedVsManualCoverage.ql b/java/ql/src/Metrics/Summaries/GeneratedVsManualCoverage.ql
@@ -25,10 +25,10 @@ private float getNumMadModeledApis(string package, string provenance) {
         sc.isAutoGenerated() and // "auto-only"
         provenance = "generated"
         or
-        sc.isManuallyGenerated() and // "manual-only"
+        (sc.hasProvenance(false) and not sc.hasProvenance(true)) and // "manual-only"
         provenance = "manual"
         or
-        sc.isBothAutoAndManuallyGenerated() and // "both"
+        (sc.hasProvenance(false) and sc.hasProvenance(true)) and // "both"
         provenance = "both"
       )
     )
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/FlowSummaryImpl.qll b/python/ql/lib/semmle/python/dataflow/new/internal/FlowSummaryImpl.qll
@@ -246,14 +246,10 @@ module Public {
     predicate isAutoGenerated() { none() }
 
     /**
-     * Holds if the summary is manually generated and not auto generated.
+     * Holds if the summary has the given provenance where `true` is
+     * `generated` and `false` is `manual`.
      */
-    predicate isManuallyGenerated() { none() }
-
-    /**
-     * Holds if the summary is both auto generated and manually generated.
-     */
-    predicate isBothAutoAndManuallyGenerated() { none() }
+    predicate hasProvenance(boolean generated) { summaryElement(this, _, _, _, generated) }
   }
 
   /** A callable with a flow summary stating there is no flow via the callable. */
@@ -1022,16 +1018,6 @@ module Private {
       }
 
       override predicate isAutoGenerated() { this.relevantSummaryElementGenerated(_, _, _) }
-
-      override predicate isManuallyGenerated() {
-        summaryElement(this, _, _, _, false) and
-        not summaryElement(this, _, _, _, true)
-      }
-
-      override predicate isBothAutoAndManuallyGenerated() {
-        summaryElement(this, _, _, _, true) and
-        summaryElement(this, _, _, _, false)
-      }
     }
 
     /** Holds if component `c` of specification `spec` cannot be parsed. */
diff --git a/ruby/ql/lib/codeql/ruby/dataflow/internal/FlowSummaryImpl.qll b/ruby/ql/lib/codeql/ruby/dataflow/internal/FlowSummaryImpl.qll
@@ -246,14 +246,10 @@ module Public {
     predicate isAutoGenerated() { none() }
 
     /**
-     * Holds if the summary is manually generated and not auto generated.
+     * Holds if the summary has the given provenance where `true` is
+     * `generated` and `false` is `manual`.
      */
-    predicate isManuallyGenerated() { none() }
-
-    /**
-     * Holds if the summary is both auto generated and manually generated.
-     */
-    predicate isBothAutoAndManuallyGenerated() { none() }
+    predicate hasProvenance(boolean generated) { summaryElement(this, _, _, _, generated) }
   }
 
   /** A callable with a flow summary stating there is no flow via the callable. */
@@ -1022,16 +1018,6 @@ module Private {
       }
 
       override predicate isAutoGenerated() { this.relevantSummaryElementGenerated(_, _, _) }
-
-      override predicate isManuallyGenerated() {
-        summaryElement(this, _, _, _, false) and
-        not summaryElement(this, _, _, _, true)
-      }
-
-      override predicate isBothAutoAndManuallyGenerated() {
-        summaryElement(this, _, _, _, true) and
-        summaryElement(this, _, _, _, false)
-      }
     }
 
     /** Holds if component `c` of specification `spec` cannot be parsed. */
diff --git a/swift/ql/lib/codeql/swift/dataflow/internal/FlowSummaryImpl.qll b/swift/ql/lib/codeql/swift/dataflow/internal/FlowSummaryImpl.qll
@@ -246,14 +246,10 @@ module Public {
     predicate isAutoGenerated() { none() }
 
     /**
-     * Holds if the summary is manually generated and not auto generated.
+     * Holds if the summary has the given provenance where `true` is
+     * `generated` and `false` is `manual`.
      */
-    predicate isManuallyGenerated() { none() }
-
-    /**
-     * Holds if the summary is both auto generated and manually generated.
-     */
-    predicate isBothAutoAndManuallyGenerated() { none() }
+    predicate hasProvenance(boolean generated) { summaryElement(this, _, _, _, generated) }
   }
 
   /** A callable with a flow summary stating there is no flow via the callable. */
@@ -1022,16 +1018,6 @@ module Private {
       }
 
       override predicate isAutoGenerated() { this.relevantSummaryElementGenerated(_, _, _) }
-
-      override predicate isManuallyGenerated() {
-        summaryElement(this, _, _, _, false) and
-        not summaryElement(this, _, _, _, true)
-      }
-
-      override predicate isBothAutoAndManuallyGenerated() {
-        summaryElement(this, _, _, _, true) and
-        summaryElement(this, _, _, _, false)
-      }
     }
 
     /** Holds if component `c` of specification `spec` cannot be parsed. */

Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,10 @@ private float getNumMadModeledApis(string package, string provenance) {`
`25`	`25`	`sc.isAutoGenerated() and // "auto-only"`
`26`	`26`	`provenance = "generated"`
`27`	`27`	`or`
`28`		`- sc.isManuallyGenerated() and // "manual-only"`
	`28`	`+ (sc.hasProvenance(false) and not sc.hasProvenance(true)) and // "manual-only"`
`29`	`29`	`provenance = "manual"`
`30`	`30`	`or`
`31`		`- sc.isBothAutoAndManuallyGenerated() and // "both"`
	`31`	`+ (sc.hasProvenance(false) and sc.hasProvenance(true)) and // "both"`
`32`	`32`	`provenance = "both"`
`33`	`33`	`)`
`34`	`34`	`)`