C#: Convert neutral capture test to inline expectation.

michaelnebel · michaelnebel · commit adeff8c60259 · 2024-05-17T09:44:58.000+02:00
diff --git a/csharp/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.expected b/csharp/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.expected
@@ -1,24 +1,2 @@
-| NoSummaries;BaseClass;M1;(System.String);summary;df-generated |
-| NoSummaries;BaseClass;M2;(System.String);summary;df-generated |
-| NoSummaries;CollectionFlow;ReturnSimpleTypeArray;(System.Int32[]);summary;df-generated |
-| NoSummaries;CollectionFlow;ReturnSimpleTypeDictionary;(System.Collections.Generic.Dictionary<System.Int32,System.Int32>);summary;df-generated |
-| NoSummaries;CollectionFlow;ReturnSimpleTypeList;(System.Collections.Generic.List<System.Int32>);summary;df-generated |
-| NoSummaries;EquatableBound;Equals;(System.Object);summary;df-generated |
-| NoSummaries;EquatableUnBound<T>;Equals;(T);summary;df-generated |
-| NoSummaries;SimpleTypes;M1;(System.Boolean);summary;df-generated |
-| NoSummaries;SimpleTypes;M2;(System.Boolean);summary;df-generated |
-| NoSummaries;SimpleTypes;M3;(System.Int32);summary;df-generated |
-| NoSummaries;SimpleTypes;M4;(System.Int32);summary;df-generated |
-| Sinks;NewSinks;WrapFieldResponseWriteFile;();summary;df-generated |
-| Sinks;NewSinks;WrapPrivateFieldResponseWriteFile;();summary;df-generated |
-| Sinks;NewSinks;WrapPrivatePropResponseWriteFile;();summary;df-generated |
-| Sinks;NewSinks;WrapPropPrivateSetResponseWriteFile;();summary;df-generated |
-| Sinks;NewSinks;WrapPropResponseWriteFile;();summary;df-generated |
-| Sinks;NewSinks;WrapResponseWrite;(System.Object);summary;df-generated |
-| Sinks;NewSinks;WrapResponseWriteFile;(System.String);summary;df-generated |
-| Sources;NewSources;WrapConsoleReadKey;();summary;df-generated |
-| Sources;NewSources;WrapConsoleReadLine;();summary;df-generated |
-| Sources;NewSources;WrapConsoleReadLineAndProcees;(System.String);summary;df-generated |
-| Summaries;EqualsGetHashCodeNoFlow;Equals;(System.Object);summary;df-generated |
-| Summaries;EqualsGetHashCodeNoFlow;GetHashCode;();summary;df-generated |
-| Summaries;OperatorFlow;op_Increment;(Summaries.OperatorFlow);summary;df-generated |
+unexpectedModel
+expectedModel
diff --git a/csharp/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.ql b/csharp/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.ql
@@ -0,0 +1,11 @@
+import csharp
+import utils.modelgenerator.internal.CaptureSummaryFlowQuery
+import TestUtilities.InlineMadTest
+
+module InlineMadTestConfig implements InlineMadTestConfigSig {
+  string getCapturedModel(Callable c) { result = captureNoFlow(c) }
+
+  string getKind() { result = "neutral" }
+}
+
+import InlineMadTest<InlineMadTestConfig>
diff --git a/csharp/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.qlref b/csharp/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.qlref
diff --git a/csharp/ql/test/utils/modelgenerator/dataflow/NoSummaries.cs b/csharp/ql/test/utils/modelgenerator/dataflow/NoSummaries.cs
@@ -49,6 +49,8 @@ public object ReturnParam(object input)
 public class EquatableBound : IEquatable<object>
 {
     public readonly bool tainted;
+
+    // neutral=NoSummaries;EquatableBound;Equals;(System.Object);summary;df-generated
     public bool Equals(object other)
     {
         return tainted;
@@ -58,6 +60,8 @@ public bool Equals(object other)
 public class EquatableUnBound<T> : IEquatable<T>
 {
     public readonly bool tainted;
+
+    // neutral=NoSummaries;EquatableUnBound<T>;Equals;(T);summary;df-generated
     public bool Equals(T? other)
     {
         return tainted;
@@ -68,21 +72,25 @@ public bool Equals(T? other)
 // simple types are used.
 public class SimpleTypes
 {
+    // neutral=NoSummaries;SimpleTypes;M1;(System.Boolean);summary;df-generated
     public bool M1(bool b)
     {
         return b;
     }
 
+    // neutral=NoSummaries;SimpleTypes;M2;(System.Boolean);summary;df-generated
     public Boolean M2(Boolean b)
     {
         return b;
     }
 
+    // neutral=NoSummaries;SimpleTypes;M3;(System.Int32);summary;df-generated
     public int M3(int i)
     {
         return i;
     }
 
+    // neutral=NoSummaries;SimpleTypes;M4;(System.Int32);summary;df-generated
     public Int32 M4(Int32 i)
     {
         return i;
@@ -104,30 +112,33 @@ public object M2(Func<object, object> map, object o)
 
 public abstract class BaseClass
 {
-    // Negative summary.
+    // neutral=NoSummaries;BaseClass;M1;(System.String);summary;df-generated
     public virtual string M1(string s)
     {
         return "";
     }
 
-    // Negative summary.
+    // neutral=NoSummaries;BaseClass;M2;(System.String);summary;df-generated
     public abstract string M2(string s);
 }
 
 // No methods in this class will have generated flow as
 // the simple types used in the collection are not bulk data types.
 public class CollectionFlow
 {
+    // neutral=NoSummaries;CollectionFlow;ReturnSimpleTypeArray;(System.Int32[]);summary;df-generated
     public int[] ReturnSimpleTypeArray(int[] a)
     {
         return a;
     }
 
+    // neutral=NoSummaries;CollectionFlow;ReturnSimpleTypeList;(System.Collections.Generic.List<System.Int32>);summary;df-generated
     public List<int> ReturnSimpleTypeList(List<int> a)
     {
         return a;
     }
 
+    // neutral=NoSummaries;CollectionFlow;ReturnSimpleTypeDictionary;(System.Collections.Generic.Dictionary<System.Int32,System.Int32>);summary;df-generated
     public Dictionary<int, int> ReturnSimpleTypeDictionary(Dictionary<int, int> a)
     {
         return a;
diff --git a/csharp/ql/test/utils/modelgenerator/dataflow/Sinks.cs b/csharp/ql/test/utils/modelgenerator/dataflow/Sinks.cs
@@ -14,6 +14,7 @@ public class NewSinks
 
     // New sink
     // sink=Sinks;NewSinks;false;WrapResponseWrite;(System.Object);;Argument[0];html-injection;df-generated
+    // neutral=Sinks;NewSinks;WrapResponseWrite;(System.Object);summary;df-generated
     public void WrapResponseWrite(object o)
     {
         var response = new HttpResponse();
@@ -29,6 +30,7 @@ private void PrivateWrapResponseWrite(object o)
 
     // New sink
     // sink=Sinks;NewSinks;false;WrapResponseWriteFile;(System.String);;Argument[0];html-injection;df-generated
+    // neutral=Sinks;NewSinks;WrapResponseWriteFile;(System.String);summary;df-generated
     public void WrapResponseWriteFile(string s)
     {
         var response = new HttpResponse();
@@ -37,13 +39,15 @@ public void WrapResponseWriteFile(string s)
 
     // New sink
     // sink=Sinks;NewSinks;false;WrapFieldResponseWriteFile;();;Argument[this];html-injection;df-generated
+    // neutral=Sinks;NewSinks;WrapFieldResponseWriteFile;();summary;df-generated
     public void WrapFieldResponseWriteFile()
     {
         var response = new HttpResponse();
         response.WriteFile(tainted);
     }
 
     // NOT new sink as field is private
+    // neutral=Sinks;NewSinks;WrapPrivateFieldResponseWriteFile;();summary;df-generated
     public void WrapPrivateFieldResponseWriteFile()
     {
         var response = new HttpResponse();
@@ -52,20 +56,23 @@ public void WrapPrivateFieldResponseWriteFile()
 
     // New sink
     // sink=Sinks;NewSinks;false;WrapPropResponseWriteFile;();;Argument[this];html-injection;df-generated
+    // neutral=Sinks;NewSinks;WrapPropResponseWriteFile;();summary;df-generated
     public void WrapPropResponseWriteFile()
     {
         var response = new HttpResponse();
         response.WriteFile(TaintedProp);
     }
 
     // NOT new sink as property is private
+    // neutral=Sinks;NewSinks;WrapPrivatePropResponseWriteFile;();summary;df-generated
     public void WrapPrivatePropResponseWriteFile()
     {
         var response = new HttpResponse();
         response.WriteFile(PrivateTaintedProp);
     }
 
     // NOT new sink as property setter is private
+    // neutral=Sinks;NewSinks;WrapPropPrivateSetResponseWriteFile;();summary;df-generated
     public void WrapPropPrivateSetResponseWriteFile()
     {
         var response = new HttpResponse();
diff --git a/csharp/ql/test/utils/modelgenerator/dataflow/Sources.cs b/csharp/ql/test/utils/modelgenerator/dataflow/Sources.cs
@@ -6,13 +6,15 @@ public class NewSources
 {
     // New source
     // source=Sources;NewSources;false;WrapConsoleReadLine;();;ReturnValue;local;df-generated
+    // neutral=Sources;NewSources;WrapConsoleReadLine;();summary;df-generated
     public string? WrapConsoleReadLine()
     {
         return Console.ReadLine();
     }
 
     // New source
     // source=Sources;NewSources;false;WrapConsoleReadLineAndProcees;(System.String);;ReturnValue;local;df-generated
+    // neutral=Sources;NewSources;WrapConsoleReadLineAndProcees;(System.String);summary;df-generated
     public string WrapConsoleReadLineAndProcees(string prompt)
     {
         var s = Console.ReadLine();
@@ -27,6 +29,7 @@ public string WrapConsoleReadLineAndProcees(string prompt)
 
     // New source
     // source=Sources;NewSources;false;WrapConsoleReadKey;();;ReturnValue;local;df-generated
+    // neutral=Sources;NewSources;WrapConsoleReadKey;();summary;df-generated
     public ConsoleKeyInfo WrapConsoleReadKey()
     {
         return Console.ReadKey();
diff --git a/csharp/ql/test/utils/modelgenerator/dataflow/Summaries.cs b/csharp/ql/test/utils/modelgenerator/dataflow/Summaries.cs
@@ -254,6 +254,7 @@ public OperatorFlow(object o)
     }
 
     // No flow summary.
+    // neutral=Summaries;OperatorFlow;op_Increment;(Summaries.OperatorFlow);summary;df-generated
     public static OperatorFlow operator ++(OperatorFlow a)
     {
         return new OperatorFlow(new object());
@@ -279,6 +280,7 @@ public class EqualsGetHashCodeNoFlow
     public readonly int intTainted;
 
     // No flow summary as this is an override of the Equals method.
+    // neutral=Summaries;EqualsGetHashCodeNoFlow;Equals;(System.Object);summary;df-generated
     public override bool Equals(object obj)
     {
         return boolTainted;
@@ -292,6 +294,7 @@ public string Equals(string s)
     }
 
     // No flow summary as this is an override of the GetHashCode method.
+    // neutral=Summaries;EqualsGetHashCodeNoFlow;GetHashCode;();summary;df-generated
     public override int GetHashCode()
     {
         return intTainted;

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@ public object ReturnParam(object input)`
`49`	`49`	`public class EquatableBound : IEquatable<object>`
`50`	`50`	`{`
`51`	`51`	`public readonly bool tainted;`
	`52`	`+`
	`53`	`+ // neutral=NoSummaries;EquatableBound;Equals;(System.Object);summary;df-generated`
`52`	`54`	`public bool Equals(object other)`
`53`	`55`	`{`
`54`	`56`	`return tainted;`
`@@ -58,6 +60,8 @@ public bool Equals(object other)`
`58`	`60`	`public class EquatableUnBound<T> : IEquatable<T>`
`59`	`61`	`{`
`60`	`62`	`public readonly bool tainted;`
	`63`	`+`
	`64`	`+ // neutral=NoSummaries;EquatableUnBound<T>;Equals;(T);summary;df-generated`
`61`	`65`	`public bool Equals(T? other)`
`62`	`66`	`{`
`63`	`67`	`return tainted;`
`@@ -68,21 +72,25 @@ public bool Equals(T? other)`
`68`	`72`	`// simple types are used.`
`69`	`73`	`public class SimpleTypes`
`70`	`74`	`{`
	`75`	`+ // neutral=NoSummaries;SimpleTypes;M1;(System.Boolean);summary;df-generated`
`71`	`76`	`public bool M1(bool b)`
`72`	`77`	`{`
`73`	`78`	`return b;`
`74`	`79`	`}`
`75`	`80`
	`81`	`+ // neutral=NoSummaries;SimpleTypes;M2;(System.Boolean);summary;df-generated`
`76`	`82`	`public Boolean M2(Boolean b)`
`77`	`83`	`{`
`78`	`84`	`return b;`
`79`	`85`	`}`
`80`	`86`
	`87`	`+ // neutral=NoSummaries;SimpleTypes;M3;(System.Int32);summary;df-generated`
`81`	`88`	`public int M3(int i)`
`82`	`89`	`{`
`83`	`90`	`return i;`
`84`	`91`	`}`
`85`	`92`
	`93`	`+ // neutral=NoSummaries;SimpleTypes;M4;(System.Int32);summary;df-generated`
`86`	`94`	`public Int32 M4(Int32 i)`
`87`	`95`	`{`
`88`	`96`	`return i;`
`@@ -104,30 +112,33 @@ public object M2(Func<object, object> map, object o)`
`104`	`112`
`105`	`113`	`public abstract class BaseClass`
`106`	`114`	`{`
`107`		`- // Negative summary.`
	`115`	`+ // neutral=NoSummaries;BaseClass;M1;(System.String);summary;df-generated`
`108`	`116`	`public virtual string M1(string s)`
`109`	`117`	`{`
`110`	`118`	`return "";`
`111`	`119`	`}`
`112`	`120`
`113`		`- // Negative summary.`
	`121`	`+ // neutral=NoSummaries;BaseClass;M2;(System.String);summary;df-generated`
`114`	`122`	`public abstract string M2(string s);`
`115`	`123`	`}`
`116`	`124`
`117`	`125`	`// No methods in this class will have generated flow as`
`118`	`126`	`// the simple types used in the collection are not bulk data types.`
`119`	`127`	`public class CollectionFlow`
`120`	`128`	`{`
	`129`	`+ // neutral=NoSummaries;CollectionFlow;ReturnSimpleTypeArray;(System.Int32[]);summary;df-generated`
`121`	`130`	`public int[] ReturnSimpleTypeArray(int[] a)`
`122`	`131`	`{`
`123`	`132`	`return a;`
`124`	`133`	`}`
`125`	`134`
	`135`	`+ // neutral=NoSummaries;CollectionFlow;ReturnSimpleTypeList;(System.Collections.Generic.List<System.Int32>);summary;df-generated`
`126`	`136`	`public List<int> ReturnSimpleTypeList(List<int> a)`
`127`	`137`	`{`
`128`	`138`	`return a;`
`129`	`139`	`}`
`130`	`140`
	`141`	`+ // neutral=NoSummaries;CollectionFlow;ReturnSimpleTypeDictionary;(System.Collections.Generic.Dictionary<System.Int32,System.Int32>);summary;df-generated`
`131`	`142`	`public Dictionary<int, int> ReturnSimpleTypeDictionary(Dictionary<int, int> a)`
`132`	`143`	`{`
`133`	`144`	`return a;`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ public class NewSinks`
`14`	`14`
`15`	`15`	`// New sink`
`16`	`16`	`// sink=Sinks;NewSinks;false;WrapResponseWrite;(System.Object);;Argument[0];html-injection;df-generated`
	`17`	`+ // neutral=Sinks;NewSinks;WrapResponseWrite;(System.Object);summary;df-generated`
`17`	`18`	`public void WrapResponseWrite(object o)`
`18`	`19`	`{`
`19`	`20`	`var response = new HttpResponse();`
`@@ -29,6 +30,7 @@ private void PrivateWrapResponseWrite(object o)`
`29`	`30`
`30`	`31`	`// New sink`
`31`	`32`	`// sink=Sinks;NewSinks;false;WrapResponseWriteFile;(System.String);;Argument[0];html-injection;df-generated`
	`33`	`+ // neutral=Sinks;NewSinks;WrapResponseWriteFile;(System.String);summary;df-generated`
`32`	`34`	`public void WrapResponseWriteFile(string s)`
`33`	`35`	`{`
`34`	`36`	`var response = new HttpResponse();`
`@@ -37,13 +39,15 @@ public void WrapResponseWriteFile(string s)`
`37`	`39`
`38`	`40`	`// New sink`
`39`	`41`	`// sink=Sinks;NewSinks;false;WrapFieldResponseWriteFile;();;Argument[this];html-injection;df-generated`
	`42`	`+ // neutral=Sinks;NewSinks;WrapFieldResponseWriteFile;();summary;df-generated`
`40`	`43`	`public void WrapFieldResponseWriteFile()`
`41`	`44`	`{`
`42`	`45`	`var response = new HttpResponse();`
`43`	`46`	`response.WriteFile(tainted);`
`44`	`47`	`}`
`45`	`48`
`46`	`49`	`// NOT new sink as field is private`
	`50`	`+ // neutral=Sinks;NewSinks;WrapPrivateFieldResponseWriteFile;();summary;df-generated`
`47`	`51`	`public void WrapPrivateFieldResponseWriteFile()`
`48`	`52`	`{`
`49`	`53`	`var response = new HttpResponse();`
`@@ -52,20 +56,23 @@ public void WrapPrivateFieldResponseWriteFile()`
`52`	`56`
`53`	`57`	`// New sink`
`54`	`58`	`// sink=Sinks;NewSinks;false;WrapPropResponseWriteFile;();;Argument[this];html-injection;df-generated`
	`59`	`+ // neutral=Sinks;NewSinks;WrapPropResponseWriteFile;();summary;df-generated`
`55`	`60`	`public void WrapPropResponseWriteFile()`
`56`	`61`	`{`
`57`	`62`	`var response = new HttpResponse();`
`58`	`63`	`response.WriteFile(TaintedProp);`
`59`	`64`	`}`
`60`	`65`
`61`	`66`	`// NOT new sink as property is private`
	`67`	`+ // neutral=Sinks;NewSinks;WrapPrivatePropResponseWriteFile;();summary;df-generated`
`62`	`68`	`public void WrapPrivatePropResponseWriteFile()`
`63`	`69`	`{`
`64`	`70`	`var response = new HttpResponse();`
`65`	`71`	`response.WriteFile(PrivateTaintedProp);`
`66`	`72`	`}`
`67`	`73`
`68`	`74`	`// NOT new sink as property setter is private`
	`75`	`+ // neutral=Sinks;NewSinks;WrapPropPrivateSetResponseWriteFile;();summary;df-generated`
`69`	`76`	`public void WrapPropPrivateSetResponseWriteFile()`
`70`	`77`	`{`
`71`	`78`	`var response = new HttpResponse();`
Original file line number	Diff line number	Diff line change
`@@ -6,13 +6,15 @@ public class NewSources`
`6`	`6`	`{`
`7`	`7`	`// New source`
`8`	`8`	`// source=Sources;NewSources;false;WrapConsoleReadLine;();;ReturnValue;local;df-generated`
	`9`	`+ // neutral=Sources;NewSources;WrapConsoleReadLine;();summary;df-generated`
`9`	`10`	`public string? WrapConsoleReadLine()`
`10`	`11`	`{`
`11`	`12`	`return Console.ReadLine();`
`12`	`13`	`}`
`13`	`14`
`14`	`15`	`// New source`
`15`	`16`	`// source=Sources;NewSources;false;WrapConsoleReadLineAndProcees;(System.String);;ReturnValue;local;df-generated`
	`17`	`+ // neutral=Sources;NewSources;WrapConsoleReadLineAndProcees;(System.String);summary;df-generated`
`16`	`18`	`public string WrapConsoleReadLineAndProcees(string prompt)`
`17`	`19`	`{`
`18`	`20`	`var s = Console.ReadLine();`
`@@ -27,6 +29,7 @@ public string WrapConsoleReadLineAndProcees(string prompt)`
`27`	`29`
`28`	`30`	`// New source`
`29`	`31`	`// source=Sources;NewSources;false;WrapConsoleReadKey;();;ReturnValue;local;df-generated`
	`32`	`+ // neutral=Sources;NewSources;WrapConsoleReadKey;();summary;df-generated`
`30`	`33`	`public ConsoleKeyInfo WrapConsoleReadKey()`
`31`	`34`	`{`
`32`	`35`	`return Console.ReadKey();`
Original file line number	Diff line number	Diff line change
`@@ -254,6 +254,7 @@ public OperatorFlow(object o)`
`254`	`254`	`}`
`255`	`255`
`256`	`256`	`// No flow summary.`
	`257`	`+ // neutral=Summaries;OperatorFlow;op_Increment;(Summaries.OperatorFlow);summary;df-generated`
`257`	`258`	`public static OperatorFlow operator ++(OperatorFlow a)`
`258`	`259`	`{`
`259`	`260`	`return new OperatorFlow(new object());`
`@@ -279,6 +280,7 @@ public class EqualsGetHashCodeNoFlow`
`279`	`280`	`public readonly int intTainted;`
`280`	`281`
`281`	`282`	`// No flow summary as this is an override of the Equals method.`
	`283`	`+ // neutral=Summaries;EqualsGetHashCodeNoFlow;Equals;(System.Object);summary;df-generated`
`282`	`284`	`public override bool Equals(object obj)`
`283`	`285`	`{`
`284`	`286`	`return boolTainted;`
`@@ -292,6 +294,7 @@ public string Equals(string s)`
`292`	`294`	`}`
`293`	`295`
`294`	`296`	`// No flow summary as this is an override of the GetHashCode method.`
	`297`	`+ // neutral=Summaries;EqualsGetHashCodeNoFlow;GetHashCode;();summary;df-generated`
`295`	`298`	`public override int GetHashCode()`
`296`	`299`	`{`
`297`	`300`	`return intTainted;`