C#: Flow summaries should also apply for overides or virtual members in abstract classes.

michaelnebel · michaelnebel · commit d699ca9aa89e · 2021-12-13T13:09:40.000+01:00
diff --git a/csharp/ql/lib/semmle/code/csharp/Member.qll b/csharp/ql/lib/semmle/code/csharp/Member.qll
@@ -362,14 +362,22 @@ class Virtualizable extends Member, @virtualizable {
   /** Holds if this member implements (transitively) an interface member. */
   predicate implements() { exists(this.getAnUltimateImplementee()) }
 
+  /**
+   * Holds if this member overrides or implements (transitively)
+   * `that` member.
+   */
+  predicate overridesOrImplements(Virtualizable that) {
+    this.getOverridee+() = that or
+    this.getAnUltimateImplementee() = that
+  }
+
   /**
    * Holds if this member overrides or implements (reflexively, transitively)
    * `that` member.
    */
   predicate overridesOrImplementsOrEquals(Virtualizable that) {
     this = that or
-    this.getOverridee+() = that or
-    this.getAnUltimateImplementee() = that
+    this.overridesOrImplements(that)
   }
 }
 
diff --git a/csharp/ql/test/library-tests/dataflow/library/FlowSummariesFiltered.ql b/csharp/ql/test/library-tests/dataflow/library/FlowSummariesFiltered.ql
@@ -13,8 +13,8 @@ class IncludeFilteredSummarizedCallable extends IncludeSummarizedCallable {
   ) {
     this.propagatesFlow(input, output, preservesValue) and
     not exists(IncludeSummarizedCallable rsc |
-      rsc.isAbstractOrInterface() and
-      this.(Virtualizable).overridesOrImplementsOrEquals(rsc) and
+      rsc.isBaseCallableOrPrototype() and
+      this.(Virtualizable).overridesOrImplements(rsc) and
       rsc.propagatesFlow(input, output, preservesValue)
     )
   }
diff --git a/csharp/ql/test/shared/FlowSummaries.qll b/csharp/ql/test/shared/FlowSummaries.qll
@@ -16,14 +16,18 @@ abstract class IncludeSummarizedCallable extends RelevantSummarizedCallable {
       )
   }
 
-  predicate isAbstractOrInterface() {
-    this.getDeclaringType() instanceof Interface or
+  /** Holds if the summary should apply for all overrides of this. */
+  predicate isBaseCallableOrPrototype() {
+    this.getDeclaringType() instanceof Interface
+    or
     this.(Modifiable).isAbstract()
+    or
+    this.getDeclaringType().(Modifiable).isAbstract() and this.(Virtualizable).isVirtual()
   }
 
-  /** Gets a string representing, whether the declaring type is an interface. */
+  /** Gets a string representing, whether the summary should apply for all overrides of this. */
   private string getCallableOverride() {
-    if this.isAbstractOrInterface() then result = "true" else result = "false"
+    if this.isBaseCallableOrPrototype() then result = "true" else result = "false"
   }
 
   /** Gets a string representing the callable in semi-colon separated format for use in flow summaries. */

Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@ class IncludeFilteredSummarizedCallable extends IncludeSummarizedCallable {`
`13`	`13`	`) {`
`14`	`14`	`this.propagatesFlow(input, output, preservesValue) and`
`15`	`15`	`not exists(IncludeSummarizedCallable rsc \|`
`16`		`- rsc.isAbstractOrInterface() and`
`17`		`- this.(Virtualizable).overridesOrImplementsOrEquals(rsc) and`
	`16`	`+ rsc.isBaseCallableOrPrototype() and`
	`17`	`+ this.(Virtualizable).overridesOrImplements(rsc) and`
`18`	`18`	`rsc.propagatesFlow(input, output, preservesValue)`
`19`	`19`	`)`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,14 +16,18 @@ abstract class IncludeSummarizedCallable extends RelevantSummarizedCallable {`
`16`	`16`	`)`
`17`	`17`	`}`
`18`	`18`
`19`		`- predicate isAbstractOrInterface() {`
`20`		`- this.getDeclaringType() instanceof Interface or`
	`19`	`+ /** Holds if the summary should apply for all overrides of this. */`
	`20`	`+ predicate isBaseCallableOrPrototype() {`
	`21`	`+ this.getDeclaringType() instanceof Interface`
	`22`	`+ or`
`21`	`23`	`this.(Modifiable).isAbstract()`
	`24`	`+ or`
	`25`	`+ this.getDeclaringType().(Modifiable).isAbstract() and this.(Virtualizable).isVirtual()`
`22`	`26`	`}`
`23`	`27`
`24`		`- /** Gets a string representing, whether the declaring type is an interface. */`
	`28`	`+ /** Gets a string representing, whether the summary should apply for all overrides of this. */`
`25`	`29`	`private string getCallableOverride() {`
`26`		`- if this.isAbstractOrInterface() then result = "true" else result = "false"`
	`30`	`+ if this.isBaseCallableOrPrototype() then result = "true" else result = "false"`
`27`	`31`	`}`
`28`	`32`
`29`	`33`	`/** Gets a string representing the callable in semi-colon separated format for use in flow summaries. */`