Merge pull request github#19104 from michaelnebel/ql4ql/excludeprintastinlineexpect

erik-krogh · web-flow · commit 9d3d3deffa86 · 2025-03-25T09:42:22.000+01:00
QL4QL: Exclude PrintAst like tests from being reported as having missing InlineExpectations.
diff --git a/ql/ql/src/codeql_ql/ast/Yaml.qll b/ql/ql/src/codeql_ql/ast/Yaml.qll
@@ -64,4 +64,15 @@ class QlRefDocument extends YamlDocument {
       value = n.lookup("postprocess").(YamlSequence).getElement(_)
     )
   }
+
+  predicate isPrintAst() {
+    this.getFile().getStem() = "PrintAst"
+    or
+    exists(YamlMapping n, YamlScalar value |
+      n.getDocument() = this and
+      value.getValue().matches("%PrintAst%")
+    |
+      value = n.lookup("query")
+    )
+  }
 }
diff --git a/ql/ql/src/queries/style/QlRefInlineExpectations.ql b/ql/ql/src/queries/style/QlRefInlineExpectations.ql
@@ -11,5 +11,7 @@ import ql
 import codeql_ql.ast.Yaml
 
 from QlRefDocument f
-where not f.usesInlineExpectations()
+where
+  not f.usesInlineExpectations() and
+  not f.isPrintAst()
 select f, "Query test does not use inline test expectations."
diff --git a/ql/ql/test/queries/style/QlRefInlineExpectations/PrintAst.expected b/ql/ql/test/queries/style/QlRefInlineExpectations/PrintAst.expected
@@ -0,0 +1 @@
+|  |
diff --git a/ql/ql/test/queries/style/QlRefInlineExpectations/PrintAst.qlref b/ql/ql/test/queries/style/QlRefInlineExpectations/PrintAst.qlref
@@ -0,0 +1 @@
+dummy/PrintAst.ql
diff --git a/ql/ql/test/queries/style/QlRefInlineExpectations/Test4.expected b/ql/ql/test/queries/style/QlRefInlineExpectations/Test4.expected
@@ -0,0 +1 @@
+|  |
diff --git a/ql/ql/test/queries/style/QlRefInlineExpectations/Test4.qlref b/ql/ql/test/queries/style/QlRefInlineExpectations/Test4.qlref
@@ -0,0 +1 @@
+query: dummy/PrintAst.ql
diff --git a/ql/ql/test/queries/style/QlRefInlineExpectations/dummy/PrintAst.expected b/ql/ql/test/queries/style/QlRefInlineExpectations/dummy/PrintAst.expected
@@ -0,0 +1 @@
+|  |
diff --git a/ql/ql/test/queries/style/QlRefInlineExpectations/dummy/PrintAst.ql b/ql/ql/test/queries/style/QlRefInlineExpectations/dummy/PrintAst.ql
@@ -0,0 +1 @@
+select ""

Original file line number	Diff line number	Diff line change
`@@ -64,4 +64,15 @@ class QlRefDocument extends YamlDocument {`
`64`	`64`	`value = n.lookup("postprocess").(YamlSequence).getElement(_)`
`65`	`65`	`)`
`66`	`66`	`}`
	`67`	`+`
	`68`	`+ predicate isPrintAst() {`
	`69`	`+ this.getFile().getStem() = "PrintAst"`
	`70`	`+ or`
	`71`	`+ exists(YamlMapping n, YamlScalar value \|`
	`72`	`+ n.getDocument() = this and`
	`73`	`+ value.getValue().matches("%PrintAst%")`
	`74`	`+ \|`
	`75`	`+ value = n.lookup("query")`
	`76`	`+ )`
	`77`	`+ }`
`67`	`78`	`}`