Add data-flow tests for aliasing

smowton · smowton · commit 992b3c74fccf · 2024-09-17T17:02:43.000+01:00
diff --git a/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/embedding.go b/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/embedding.go
@@ -0,0 +1,27 @@
+package test
+
+import (
+	"test.com/basename/pkg1"
+	"test.com/basename/pkg2"
+)
+
+// pkg2.IntStruct is an alias for pkg1.IntStruct
+// Note trickery with packages is necessary so that Go will assign the fields the same name as well as the same type.
+
+type EmbedsPkg1IntStruct = struct{ pkg1.IntStruct }
+type EmbedsPkg2IntStruct = struct{ pkg2.IntStruct }
+
+func FEmbedded() {
+
+  x := source()
+  pkg1Struct := EmbedsPkg1IntStruct{pkg1.IntStruct{x}}
+
+  GEmbedded(&pkg1Struct)
+
+}
+
+func GEmbedded(pkg2Struct *EmbedsPkg2IntStruct) {
+
+  sink(pkg2Struct.Field) // $ hasValueFlow="selection of Field"
+
+}
diff --git a/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/go.mod b/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/go.mod
@@ -0,0 +1,3 @@
+module test.com/basename
+
+go 1.22.5
diff --git a/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/pkg1/struct.go b/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/pkg1/struct.go
@@ -0,0 +1,5 @@
+package pkg1
+
+type IntStruct struct {
+	Field int
+}
diff --git a/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/pkg2/struct.go b/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/pkg2/struct.go
@@ -0,0 +1,7 @@
+package pkg2
+
+import (
+	"test.com/basename/pkg1"
+)
+
+type IntStruct = pkg1.IntStruct
diff --git a/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/simple.go b/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/simple.go
@@ -0,0 +1,23 @@
+package test
+
+func source() int { return 0 }
+func sink(value int) { }
+
+type IntAlias = int
+type IntStruct = struct{ field int }
+type IntAliasStruct = struct{ field IntAlias }
+
+func F() {
+
+  x := source()
+  intStruct := IntStruct{x}
+
+  G(&intStruct)
+
+}
+
+func G(intAliasStruct *IntAliasStruct) {
+
+  sink(intAliasStruct.field) // $ hasValueFlow="selection of field"
+
+}
diff --git a/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/test.expected b/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/test.expected
diff --git a/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/test.ql b/go/ql/test/library-tests/semmle/go/aliases/DataflowFields/test.ql
@@ -0,0 +1,3 @@
+import go
+import TestUtilities.InlineFlowTest
+import DefaultFlowTest
diff --git a/go/ql/test/library-tests/semmle/go/aliases/InterfaceImpls/flow.expected b/go/ql/test/library-tests/semmle/go/aliases/InterfaceImpls/flow.expected
diff --git a/go/ql/test/library-tests/semmle/go/aliases/InterfaceImpls/flow.ql b/go/ql/test/library-tests/semmle/go/aliases/InterfaceImpls/flow.ql
@@ -0,0 +1,3 @@
+import go
+import TestUtilities.InlineFlowTest
+import DefaultFlowTest
diff --git a/go/ql/test/library-tests/semmle/go/aliases/InterfaceImpls/test.expected b/go/ql/test/library-tests/semmle/go/aliases/InterfaceImpls/test.expected
@@ -1,15 +1,22 @@
 callTargets
-| test.go:48:2:48:24 | call to ImplementMe | test.go:12:1:12:69 | function declaration | ImplementMe |
-| test.go:48:2:48:24 | call to ImplementMe | test.go:17:1:17:64 | function declaration | ImplementMe |
-| test.go:48:2:48:24 | call to ImplementMe | test.go:24:1:24:53 | function declaration | ImplementMe |
-| test.go:48:2:48:24 | call to ImplementMe | test.go:31:1:31:59 | function declaration | ImplementMe |
-| test.go:48:2:48:24 | call to ImplementMe | test.go:38:1:38:71 | function declaration | ImplementMe |
-| test.go:48:2:48:24 | call to ImplementMe | test.go:45:1:45:69 | function declaration | ImplementMe |
+| test.go:15:70:15:83 | call to sink | test.go:10:1:10:46 | function declaration | sink |
+| test.go:20:65:20:78 | call to sink | test.go:10:1:10:46 | function declaration | sink |
+| test.go:27:54:27:67 | call to sink | test.go:10:1:10:46 | function declaration | sink |
+| test.go:34:60:34:73 | call to sink | test.go:10:1:10:46 | function declaration | sink |
+| test.go:41:72:41:85 | call to sink | test.go:10:1:10:46 | function declaration | sink |
+| test.go:48:70:48:83 | call to sink | test.go:10:1:10:46 | function declaration | sink |
+| test.go:51:14:51:21 | call to source | test.go:9:1:9:55 | function declaration | source |
+| test.go:52:2:52:29 | call to ImplementMe | test.go:15:1:15:85 | function declaration | ImplementMe |
+| test.go:52:2:52:29 | call to ImplementMe | test.go:20:1:20:80 | function declaration | ImplementMe |
+| test.go:52:2:52:29 | call to ImplementMe | test.go:27:1:27:69 | function declaration | ImplementMe |
+| test.go:52:2:52:29 | call to ImplementMe | test.go:34:1:34:75 | function declaration | ImplementMe |
+| test.go:52:2:52:29 | call to ImplementMe | test.go:41:1:41:87 | function declaration | ImplementMe |
+| test.go:52:2:52:29 | call to ImplementMe | test.go:48:1:48:85 | function declaration | ImplementMe |
 #select
 | file://:0:0:0:0 | basic interface type | file://:0:0:0:0 | basic interface type |
-| file://:0:0:0:0 | basic interface type | test.go:10:6:10:10 | Impl1 |
-| file://:0:0:0:0 | basic interface type | test.go:15:6:15:10 | Impl2 |
-| file://:0:0:0:0 | basic interface type | test.go:20:6:20:10 | Impl3 |
-| file://:0:0:0:0 | basic interface type | test.go:27:6:27:10 | Impl4 |
-| file://:0:0:0:0 | basic interface type | test.go:34:6:34:10 | Impl5 |
-| file://:0:0:0:0 | basic interface type | test.go:41:6:41:10 | Impl6 |
+| file://:0:0:0:0 | basic interface type | test.go:13:6:13:10 | Impl1 |
+| file://:0:0:0:0 | basic interface type | test.go:18:6:18:10 | Impl2 |
+| file://:0:0:0:0 | basic interface type | test.go:23:6:23:10 | Impl3 |
+| file://:0:0:0:0 | basic interface type | test.go:30:6:30:10 | Impl4 |
+| file://:0:0:0:0 | basic interface type | test.go:37:6:37:10 | Impl5 |
+| file://:0:0:0:0 | basic interface type | test.go:44:6:44:10 | Impl6 |
diff --git a/go/ql/test/library-tests/semmle/go/aliases/InterfaceImpls/test.go b/go/ql/test/library-tests/semmle/go/aliases/InterfaceImpls/test.go
@@ -6,44 +6,48 @@ type Target = interface {
 	ImplementMe(callable func(struct{ x IntAlias }))
 }
 
+func source() func(struct{ x IntAlias }) { return nil }
+func sink(fptr func(struct{ x IntAlias })) { }
+
 // Simple direct implementation
 type Impl1 struct{}
 
-func (recv Impl1) ImplementMe(callable func(struct{ x IntAlias })) {}
+func (recv Impl1) ImplementMe(callable func(struct{ x IntAlias })) { sink(callable) } // $ hasValueFlow="callable"
 
 // Implementation via unaliasing
 type Impl2 struct{}
 
-func (recv Impl2) ImplementMe(callable func(struct{ x int })) {}
+func (recv Impl2) ImplementMe(callable func(struct{ x int })) { sink(callable) } // $ hasValueFlow="callable"
 
 // Implementation via top-level aliasing
 type Impl3 struct{}
 
 type Impl3Alias = func(struct{ x IntAlias })
 
-func (recv Impl3) ImplementMe(callable Impl3Alias) {}
+func (recv Impl3) ImplementMe(callable Impl3Alias) { sink(callable) } // $ hasValueFlow="callable"
 
 // Implementation via aliasing the struct
 type Impl4 struct{}
 
 type Impl4Alias = struct{ x IntAlias }
 
-func (recv Impl4) ImplementMe(callable func(Impl4Alias)) {}
+func (recv Impl4) ImplementMe(callable func(Impl4Alias)) { sink(callable) } // $ hasValueFlow="callable"
 
 // Implementation via aliasing the struct member
 type Impl5 struct{}
 
 type Impl5Alias = IntAlias
 
-func (recv Impl5) ImplementMe(callable func(struct{ x Impl5Alias })) {}
+func (recv Impl5) ImplementMe(callable func(struct{ x Impl5Alias })) { sink(callable) } // $ hasValueFlow="callable"
 
 // Implementation via defining the method on an alias
 type Impl6 struct{}
 
 type Impl6Alias = Impl6
 
-func (recv Impl6Alias) ImplementMe(callable func(struct{ x int })) {}
+func (recv Impl6Alias) ImplementMe(callable func(struct{ x int })) { sink(callable) } // $ hasValueFlow="callable"
 
 func Caller(target Target) {
-	target.ImplementMe(nil)
+	callable := source()
+	target.ImplementMe(callable)
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module test.com/basename`
	`2`	`+`
	`3`	`+go 1.22.5`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import go`
	`2`	`+import TestUtilities.InlineFlowTest`
	`3`	`+import DefaultFlowTest`