From af1c4e0896095fa28dddc05bcc4a14d64e00124d Mon Sep 17 00:00:00 2001
From: Michael Nebel <michaelnebel@github.com>
Date: Tue, 1 Jul 2025 09:42:20 +0200
Subject: [PATCH] Ql4Ql: Share the definition of TestFile between multiple
 tests.

---
 ql/ql/src/codeql/files/FileSystem.qll              | 5 +++++
 ql/ql/src/queries/style/MissingQualityMetadata.ql  | 6 +-----
 ql/ql/src/queries/style/MissingSecurityMetadata.ql | 6 +-----
 3 files changed, 7 insertions(+), 10 deletions(-)

diff --git a/ql/ql/src/codeql/files/FileSystem.qll b/ql/ql/src/codeql/files/FileSystem.qll
index 5a219f3b7f0..7f64ed00b03 100644
--- a/ql/ql/src/codeql/files/FileSystem.qll
+++ b/ql/ql/src/codeql/files/FileSystem.qll
@@ -61,3 +61,8 @@ class File extends Container, Impl::File {
   /** Holds if this file was extracted from ordinary source code. */
   predicate fromSource() { any() }
 }
+
+/** A test file. */
+class TestFile extends File {
+  TestFile() { this.getRelativePath().matches("%/" + ["experimental", "examples", "test"] + "/%") }
+}
diff --git a/ql/ql/src/queries/style/MissingQualityMetadata.ql b/ql/ql/src/queries/style/MissingQualityMetadata.ql
index a01b2028e57..ceed39cf717 100644
--- a/ql/ql/src/queries/style/MissingQualityMetadata.ql
+++ b/ql/ql/src/queries/style/MissingQualityMetadata.ql
@@ -10,10 +10,6 @@
 
 import ql
 
-private predicate unInterestingLocation(File f) {
-  f.getRelativePath().matches("%/" + ["experimental", "examples", "test"] + "/%")
-}
-
 private predicate hasQualityTag(QueryDoc doc) { doc.getQueryTags() = "quality" }
 
 private predicate incorrectTopLevelCategorisation(QueryDoc doc) {
@@ -31,7 +27,7 @@ private predicate maintainabilitySubCategory(QueryDoc doc) {
 from TopLevel t, QueryDoc doc, string msg
 where
   doc = t.getQLDoc() and
-  not unInterestingLocation(t.getLocation().getFile()) and
+  not t.getLocation().getFile() instanceof TestFile and
   hasQualityTag(doc) and
   (
     incorrectTopLevelCategorisation(doc) and
diff --git a/ql/ql/src/queries/style/MissingSecurityMetadata.ql b/ql/ql/src/queries/style/MissingSecurityMetadata.ql
index fea75d36302..1618bed02ea 100644
--- a/ql/ql/src/queries/style/MissingSecurityMetadata.ql
+++ b/ql/ql/src/queries/style/MissingSecurityMetadata.ql
@@ -10,10 +10,6 @@
 
 import ql
 
-private predicate unInterestingLocation(File f) {
-  f.getRelativePath().matches("%/" + ["experimental", "examples", "test"] + "/%")
-}
-
 predicate missingSecuritySeverity(QueryDoc doc) {
   doc.getQueryTags() = "security" and
   exists(doc.getQueryPrecision()) and
@@ -29,7 +25,7 @@ predicate missingSecurityTag(QueryDoc doc) {
 from TopLevel t, QueryDoc doc, string msg
 where
   doc = t.getQLDoc() and
-  not unInterestingLocation(t.getLocation().getFile()) and
+  not t.getLocation().getFile() instanceof TestFile and
   (
     missingSecuritySeverity(doc) and
     msg = "This query file is missing a `@security-severity` tag."