Skip to content

QL4QL: Exclude PrintAst like tests from being reported as having missing InlineExpectations. #19104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 25, 2025
Merged

QL4QL: Exclude PrintAst like tests from being reported as having missing InlineExpectations. #19104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a8a822
Ql4Ql: Add PrintAst test case for QlRefInlineExpectations.
michaelnebel Mar 24, 2025
7dda951
Ql4Ql: Exclude files named PrintAst.qlref and qlref files that uses a…
michaelnebel Mar 24, 2025
be4c9d8
Ql4Ql: Update test expected file.
michaelnebel Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions ql/ql/src/codeql_ql/ast/Yaml.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,15 @@ class QlRefDocument extends YamlDocument {
value = n.lookup("postprocess").(YamlSequence).getElement(_)
)
}

predicate isPrintAst() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A more ambitious solution would be to resolve the the query pointed to by the .qlref file, and then only flag cases where the query has kind problem or path-problem, but we can leave that for a future improvement.

this.getFile().getStem() = "PrintAst"
or
exists(YamlMapping n, YamlScalar value |
n.getDocument() = this and
value.getValue().matches("%PrintAst%")
|
value = n.lookup("query")
)
Comment on lines +71 to +76
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a comment that this is for .qlref files.
And maybe check that the file-extension is .qlref?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review! That is included in the char pred and description of the class QlRefDocument. Is that acceptable?
However, I do need to add a comment for the predicate.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I didn't notice that context.

LGTM 👍

}
}
4 changes: 3 additions & 1 deletion ql/ql/src/queries/style/QlRefInlineExpectations.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
1 change: 1 addition & 0 deletions ql/ql/test/queries/style/QlRefInlineExpectations/PrintAst.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
| |
1 change: 1 addition & 0 deletions ql/ql/test/queries/style/QlRefInlineExpectations/PrintAst.qlref
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dummy/PrintAst.ql
1 change: 1 addition & 0 deletions ql/ql/test/queries/style/QlRefInlineExpectations/Test4.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
| |
1 change: 1 addition & 0 deletions ql/ql/test/queries/style/QlRefInlineExpectations/Test4.qlref
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
query: dummy/PrintAst.ql
1 change: 1 addition & 0 deletions ql/ql/test/queries/style/QlRefInlineExpectations/dummy/PrintAst.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
| |
1 change: 1 addition & 0 deletions ql/ql/test/queries/style/QlRefInlineExpectations/dummy/PrintAst.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
select ""
Loading