Swift: Rewrite inline expectation tests to use the parameterized module

jketema · jketema · commit 3a3d9bc50578 · 2023-05-24T11:38:22.000+02:00
diff --git a/swift/ql/test/library-tests/dataflow/dataflow/DataFlowInline.expected b/swift/ql/test/library-tests/dataflow/dataflow/DataFlowInline.expected
@@ -0,0 +1,2 @@
+failures
+testFailures
diff --git a/swift/ql/test/library-tests/dataflow/dataflow/DataFlowInline.ql b/swift/ql/test/library-tests/dataflow/dataflow/DataFlowInline.ql
@@ -2,12 +2,10 @@ import swift
 import FlowConfig
 import TestUtilities.InlineExpectationsTest
 
-class TaintTest extends InlineExpectationsTest {
-  TaintTest() { this = "DataFlowTest" }
+module TaintTest implements TestSig {
+  string getARelevantTag() { result = "flow" }
 
-  override string getARelevantTag() { result = "flow" }
-
-  override predicate hasActualResult(Location location, string element, string tag, string value) {
+  predicate hasActualResult(Location location, string element, string tag, string value) {
     exists(DataFlow::Node source, DataFlow::Node sink, Expr sinkExpr |
       TestFlow::flow(source, sink) and
       sinkExpr = sink.asExpr() and
@@ -18,3 +16,5 @@ class TaintTest extends InlineExpectationsTest {
     )
   }
 }
+
+import MakeTest<TaintTest>
diff --git a/swift/ql/test/library-tests/dataflow/flowsources/FlowSourcesInline.expected b/swift/ql/test/library-tests/dataflow/flowsources/FlowSourcesInline.expected
@@ -0,0 +1,2 @@
+failures
+testFailures
diff --git a/swift/ql/test/library-tests/dataflow/flowsources/FlowSourcesInline.ql b/swift/ql/test/library-tests/dataflow/flowsources/FlowSourcesInline.ql
@@ -8,12 +8,10 @@ string describe(FlowSource source) {
   source instanceof LocalFlowSource and result = "local"
 }
 
-class FlowSourcesTest extends InlineExpectationsTest {
-  FlowSourcesTest() { this = "FlowSourcesTest" }
+module FlowSourcesTest implements TestSig {
+  string getARelevantTag() { result = "source" }
 
-  override string getARelevantTag() { result = "source" }
-
-  override predicate hasActualResult(Location location, string element, string tag, string value) {
+  predicate hasActualResult(Location location, string element, string tag, string value) {
     exists(FlowSource source |
       location = source.getLocation() and
       location.getFile().getBaseName() != "" and
@@ -23,3 +21,5 @@ class FlowSourcesTest extends InlineExpectationsTest {
     )
   }
 }
+
+import MakeTest<FlowSourcesTest>
diff --git a/swift/ql/test/library-tests/dataflow/taint/core/TaintInline.expected b/swift/ql/test/library-tests/dataflow/taint/core/TaintInline.expected
@@ -0,0 +1,2 @@
+failures
+testFailures
diff --git a/swift/ql/test/library-tests/dataflow/taint/core/TaintInline.ql b/swift/ql/test/library-tests/dataflow/taint/core/TaintInline.ql
@@ -2,12 +2,10 @@ import swift
 import Taint
 import TestUtilities.InlineExpectationsTest
 
-class TaintTest extends InlineExpectationsTest {
-  TaintTest() { this = "TaintTest" }
+module TaintTest implements TestSig {
+  string getARelevantTag() { result = "tainted" }
 
-  override string getARelevantTag() { result = "tainted" }
-
-  override predicate hasActualResult(Location location, string element, string tag, string value) {
+  predicate hasActualResult(Location location, string element, string tag, string value) {
     exists(DataFlow::Node source, DataFlow::Node sink, Expr sinkExpr |
       TestFlow::flow(source, sink) and
       sinkExpr = sink.asExpr() and
@@ -18,3 +16,5 @@ class TaintTest extends InlineExpectationsTest {
     )
   }
 }
+
+import MakeTest<TaintTest>
diff --git a/swift/ql/test/library-tests/dataflow/taint/libraries/TaintInline.expected b/swift/ql/test/library-tests/dataflow/taint/libraries/TaintInline.expected
@@ -0,0 +1,2 @@
+failures
+testFailures
diff --git a/swift/ql/test/library-tests/dataflow/taint/libraries/TaintInline.ql b/swift/ql/test/library-tests/dataflow/taint/libraries/TaintInline.ql
@@ -2,12 +2,10 @@ import swift
 import Taint
 import TestUtilities.InlineExpectationsTest
 
-class TaintTest extends InlineExpectationsTest {
-  TaintTest() { this = "TaintTest" }
+module TaintTest implements TestSig {
+  string getARelevantTag() { result = "tainted" }
 
-  override string getARelevantTag() { result = "tainted" }
-
-  override predicate hasActualResult(Location location, string element, string tag, string value) {
+  predicate hasActualResult(Location location, string element, string tag, string value) {
     exists(DataFlow::Node source, DataFlow::Node sink, Expr sinkExpr |
       TestFlow::flow(source, sink) and
       sinkExpr = sink.asExpr() and
@@ -18,3 +16,5 @@ class TaintTest extends InlineExpectationsTest {
     )
   }
 }
+
+import MakeTest<TaintTest>
diff --git a/swift/ql/test/query-tests/Security/CWE-022/PathInjectionTest.expected b/swift/ql/test/query-tests/Security/CWE-022/PathInjectionTest.expected
@@ -0,0 +1,2 @@
+failures
+testFailures
diff --git a/swift/ql/test/query-tests/Security/CWE-022/PathInjectionTest.ql b/swift/ql/test/query-tests/Security/CWE-022/PathInjectionTest.ql
@@ -4,12 +4,10 @@ import codeql.swift.dataflow.FlowSources
 import codeql.swift.security.PathInjectionQuery
 import TestUtilities.InlineExpectationsTest
 
-class PathInjectionTest extends InlineExpectationsTest {
-  PathInjectionTest() { this = "PathInjectionTest" }
+module PathInjectionTest implements TestSig {
+  string getARelevantTag() { result = "hasPathInjection" }
 
-  override string getARelevantTag() { result = "hasPathInjection" }
-
-  override predicate hasActualResult(Location location, string element, string tag, string value) {
+  predicate hasActualResult(Location location, string element, string tag, string value) {
     exists(DataFlow::Node source, DataFlow::Node sink |
       PathInjectionFlow::flow(source, sink) and
       location = sink.getLocation() and
@@ -20,3 +18,5 @@ class PathInjectionTest extends InlineExpectationsTest {
     )
   }
 }
+
+import MakeTest<PathInjectionTest>
diff --git a/swift/ql/test/query-tests/Security/CWE-312/CleartextLoggingTest.expected b/swift/ql/test/query-tests/Security/CWE-312/CleartextLoggingTest.expected
@@ -0,0 +1,2 @@
+failures
+testFailures
diff --git a/swift/ql/test/query-tests/Security/CWE-312/CleartextLoggingTest.ql b/swift/ql/test/query-tests/Security/CWE-312/CleartextLoggingTest.ql
@@ -3,12 +3,10 @@ import codeql.swift.dataflow.DataFlow
 import codeql.swift.security.CleartextLoggingQuery
 import TestUtilities.InlineExpectationsTest
 
-class CleartextLogging extends InlineExpectationsTest {
-  CleartextLogging() { this = "CleartextLogging" }
+module CleartextLogging implements TestSig {
+  string getARelevantTag() { result = "hasCleartextLogging" }
 
-  override string getARelevantTag() { result = "hasCleartextLogging" }
-
-  override predicate hasActualResult(Location location, string element, string tag, string value) {
+  predicate hasActualResult(Location location, string element, string tag, string value) {
     exists(DataFlow::Node source, DataFlow::Node sink, Expr sinkExpr |
       CleartextLoggingFlow::flow(source, sink) and
       sinkExpr = sink.asExpr() and
@@ -19,3 +17,5 @@ class CleartextLogging extends InlineExpectationsTest {
     )
   }
 }
+
+import MakeTest<CleartextLogging>
diff --git a/swift/ql/test/query-tests/Security/CWE-611/XXETest.expected b/swift/ql/test/query-tests/Security/CWE-611/XXETest.expected
@@ -0,0 +1,2 @@
+failures
+testFailures
diff --git a/swift/ql/test/query-tests/Security/CWE-611/XXETest.ql b/swift/ql/test/query-tests/Security/CWE-611/XXETest.ql
@@ -9,12 +9,10 @@ class TestRemoteSource extends RemoteFlowSource {
   override string getSourceType() { result = "Test source" }
 }
 
-class XxeTest extends InlineExpectationsTest {
-  XxeTest() { this = "XxeTest" }
+module XxeTest implements TestSig {
+  string getARelevantTag() { result = "hasXXE" }
 
-  override string getARelevantTag() { result = "hasXXE" }
-
-  override predicate hasActualResult(Location location, string element, string tag, string value) {
+  predicate hasActualResult(Location location, string element, string tag, string value) {
     exists(DataFlow::Node source, DataFlow::Node sink, Expr sinkExpr |
       XxeFlow::flow(source, sink) and
       sinkExpr = sink.asExpr() and
@@ -25,3 +23,5 @@ class XxeTest extends InlineExpectationsTest {
     )
   }
 }
+
+import MakeTest<XxeTest>
diff --git a/swift/ql/test/query-tests/Security/CWE-946/PredicateInjectionTest.expected b/swift/ql/test/query-tests/Security/CWE-946/PredicateInjectionTest.expected
@@ -0,0 +1,2 @@
+failures
+testFailures
diff --git a/swift/ql/test/query-tests/Security/CWE-946/PredicateInjectionTest.ql b/swift/ql/test/query-tests/Security/CWE-946/PredicateInjectionTest.ql
@@ -3,12 +3,10 @@ import codeql.swift.dataflow.DataFlow
 import codeql.swift.security.PredicateInjectionQuery
 import TestUtilities.InlineExpectationsTest
 
-class PredicateInjectionTest extends InlineExpectationsTest {
-  PredicateInjectionTest() { this = "PredicateInjectionTest" }
+module PredicateInjectionTest implements TestSig {
+  string getARelevantTag() { result = "hasPredicateInjection" }
 
-  override string getARelevantTag() { result = "hasPredicateInjection" }
-
-  override predicate hasActualResult(Location location, string element, string tag, string value) {
+  predicate hasActualResult(Location location, string element, string tag, string value) {
     exists(DataFlow::Node source, DataFlow::Node sink, Expr sinkExpr |
       PredicateInjectionFlow::flow(source, sink) and
       sinkExpr = sink.asExpr() and
@@ -19,3 +17,5 @@ class PredicateInjectionTest extends InlineExpectationsTest {
     )
   }
 }
+
+import MakeTest<PredicateInjectionTest>

Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,10 @@ import swift`
`2`	`2`	`import FlowConfig`
`3`	`3`	`import TestUtilities.InlineExpectationsTest`
`4`	`4`
`5`		`-class TaintTest extends InlineExpectationsTest {`
`6`		`- TaintTest() { this = "DataFlowTest" }`
	`5`	`+module TaintTest implements TestSig {`
	`6`	`+ string getARelevantTag() { result = "flow" }`
`7`	`7`
`8`		`- override string getARelevantTag() { result = "flow" }`
`9`		`-`
`10`		`- override predicate hasActualResult(Location location, string element, string tag, string value) {`
	`8`	`+ predicate hasActualResult(Location location, string element, string tag, string value) {`
`11`	`9`	`exists(DataFlow::Node source, DataFlow::Node sink, Expr sinkExpr \|`
`12`	`10`	`TestFlow::flow(source, sink) and`
`13`	`11`	`sinkExpr = sink.asExpr() and`
`@@ -18,3 +16,5 @@ class TaintTest extends InlineExpectationsTest {`
`18`	`16`	`)`
`19`	`17`	`}`
`20`	`18`	`}`
	`19`	`+`
	`20`	`+import MakeTest<TaintTest>`
Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,10 @@ string describe(FlowSource source) {`
`8`	`8`	`source instanceof LocalFlowSource and result = "local"`
`9`	`9`	`}`
`10`	`10`
`11`		`-class FlowSourcesTest extends InlineExpectationsTest {`
`12`		`- FlowSourcesTest() { this = "FlowSourcesTest" }`
	`11`	`+module FlowSourcesTest implements TestSig {`
	`12`	`+ string getARelevantTag() { result = "source" }`
`13`	`13`
`14`		`- override string getARelevantTag() { result = "source" }`
`15`		`-`
`16`		`- override predicate hasActualResult(Location location, string element, string tag, string value) {`
	`14`	`+ predicate hasActualResult(Location location, string element, string tag, string value) {`
`17`	`15`	`exists(FlowSource source \|`
`18`	`16`	`location = source.getLocation() and`
`19`	`17`	`location.getFile().getBaseName() != "" and`
`@@ -23,3 +21,5 @@ class FlowSourcesTest extends InlineExpectationsTest {`
`23`	`21`	`)`
`24`	`22`	`}`
`25`	`23`	`}`
	`24`	`+`
	`25`	`+import MakeTest<FlowSourcesTest>`
Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,10 @@ import swift`
`2`	`2`	`import Taint`
`3`	`3`	`import TestUtilities.InlineExpectationsTest`
`4`	`4`
`5`		`-class TaintTest extends InlineExpectationsTest {`
`6`		`- TaintTest() { this = "TaintTest" }`
	`5`	`+module TaintTest implements TestSig {`
	`6`	`+ string getARelevantTag() { result = "tainted" }`
`7`	`7`
`8`		`- override string getARelevantTag() { result = "tainted" }`
`9`		`-`
`10`		`- override predicate hasActualResult(Location location, string element, string tag, string value) {`
	`8`	`+ predicate hasActualResult(Location location, string element, string tag, string value) {`
`11`	`9`	`exists(DataFlow::Node source, DataFlow::Node sink, Expr sinkExpr \|`
`12`	`10`	`TestFlow::flow(source, sink) and`
`13`	`11`	`sinkExpr = sink.asExpr() and`
`@@ -18,3 +16,5 @@ class TaintTest extends InlineExpectationsTest {`
`18`	`16`	`)`
`19`	`17`	`}`
`20`	`18`	`}`
	`19`	`+`
	`20`	`+import MakeTest<TaintTest>`
Original file line number	Diff line number	Diff line change
`@@ -4,12 +4,10 @@ import codeql.swift.dataflow.FlowSources`
`4`	`4`	`import codeql.swift.security.PathInjectionQuery`
`5`	`5`	`import TestUtilities.InlineExpectationsTest`
`6`	`6`
`7`		`-class PathInjectionTest extends InlineExpectationsTest {`
`8`		`- PathInjectionTest() { this = "PathInjectionTest" }`
	`7`	`+module PathInjectionTest implements TestSig {`
	`8`	`+ string getARelevantTag() { result = "hasPathInjection" }`
`9`	`9`
`10`		`- override string getARelevantTag() { result = "hasPathInjection" }`
`11`		`-`
`12`		`- override predicate hasActualResult(Location location, string element, string tag, string value) {`
	`10`	`+ predicate hasActualResult(Location location, string element, string tag, string value) {`
`13`	`11`	`exists(DataFlow::Node source, DataFlow::Node sink \|`
`14`	`12`	`PathInjectionFlow::flow(source, sink) and`
`15`	`13`	`location = sink.getLocation() and`
`@@ -20,3 +18,5 @@ class PathInjectionTest extends InlineExpectationsTest {`
`20`	`18`	`)`
`21`	`19`	`}`
`22`	`20`	`}`
	`21`	`+`
	`22`	`+import MakeTest<PathInjectionTest>`