Skip to content

Shared: Adjust semantics of optional inline expectation tags #21772

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

Open
hvitved wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −5
Open

Shared: Adjust semantics of optional inline expectation tags #21772

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 14 additions & 5 deletions shared/util/codeql/util/test/InlineExpectationsTest.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,19 @@ module Make<InlineExpectationsTestSig Impl> {
bindingset[expectedTag, actualTag]
default predicate tagMatches(string expectedTag, string actualTag) { expectedTag = actualTag }

/** Holds if expectations marked with `expectedTag` are optional. */
/**
* Holds if expectations marked with `expectedTag` are optional.
*
* Results with an optional tag will not cause a failure if there is no matching expectation,
* but any expectation with an optional tag must have a matching result.
*/
bindingset[expectedTag]
default predicate tagIsOptional(string expectedTag) { none() }

/** Holds if expectations marked with `expectedTag` should be ignored. */
bindingset[expectedTag]
default predicate ignoreTag(string expectedTag) { none() }

/**
* Holds if expected value `expectedValue` matches actual value `actualValue`.
*
Expand Down Expand Up @@ -223,8 +232,7 @@ module Make<InlineExpectationsTestSig Impl> {
exists(ValidTestExpectation expectation |
not exists(ActualTestResult actualResult | expectation.matchesActualResult(actualResult)) and
expectation.getTag() = TestImpl::getARelevantTag() and
element = expectation and
not expectation.isOptional()
element = expectation
|
expectation instanceof GoodTestExpectation and
message = "Missing result: " + expectation.getExpectationText()
Expand Down Expand Up @@ -253,7 +261,8 @@ module Make<InlineExpectationsTestSig Impl> {
exists(TColumn column, string tags |
getAnExpectation(comment, column, _, tags, value) and
tag = tags.splitAt(",") and
knownFailure = getColumnString(column)
knownFailure = getColumnString(column) and
not TestImpl::ignoreTag(tag)
)
} or
TInvalidExpectation(Impl::ExpectationComment comment, string expectation) {
Expand Down Expand Up @@ -870,7 +879,7 @@ module TestPostProcessing {
}

bindingset[expectedTag]
predicate tagIsOptional(string expectedTag) {
predicate ignoreTag(string expectedTag) {
exists(getQueryKind()) and
(
// ignore irrelevant tags
Expand Down
Loading