Merge pull request #18 from github/query-pattern

Pass a query pattern

Author: Sam Lanning

README.md

@@ -28,17 +28,17 @@ including links to the lines of source code on GitHub when possible:
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**
 
-- [Creating your own course](#creating-your-own-course)
-  - [Creating the Query Checking Action](#creating-the-query-checking-action)
-    - [Testing the action](#testing-the-action)
-    - [Adding new queries & calculating the contents for the CSV files](#adding-new-queries--calculating-the-contents-for-the-csv-files)
-    - [Publishing your action](#publishing-your-action)
-  - [Contributing your GitHub Action to this repository](#contributing-your-github-action-to-this-repository)
-  - [Creating the Learning Lab Course](#creating-the-learning-lab-course)
-- [Example Courses](#example-courses)
-- [Contributing](#contributing)
-  - [Releasing new versions or updating dependencies](#releasing-new-versions-or-updating-dependencies)
-- [License](#license)
+  - [Creating your own course](#creating-your-own-course)
+    - [Creating the Query Checking Action](#creating-the-query-checking-action)
+      - [Testing the action](#testing-the-action)
+      - [Adding new queries & calculating the contents for the CSV files](#adding-new-queries--calculating-the-contents-for-the-csv-files)
+      - [Publishing your action](#publishing-your-action)
+    - [Contributing your GitHub Action to this repository](#contributing-your-github-action-to-this-repository)
+    - [Creating the Learning Lab Course](#creating-the-learning-lab-course)
+  - [Example Courses](#example-courses)
+  - [Contributing](#contributing)
+    - [Releasing new versions or updating dependencies](#releasing-new-versions-or-updating-dependencies)
+  - [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -207,6 +207,11 @@ run either of these scripts:
   affect this specific course,
   without publishing any new images.
 
+Both scripts take as argument an **optional** regexp string.
+If this string is passed, only the queries 
+with names matching the regexp will be run.
+Otherwise all queries are run.
+
 **In GitHub Actions:**
 
 If adding a course to this repository,
@@ -329,4 +334,3 @@ as per the [terms & conditions](https://securitylab.github.com/tools/codeql/lice
 > **To generate CodeQL databases for or during automated analysis,
 > continuous integration or continuous delivery,
 > whether as part of normal software engineering processes or otherwise.**
-

codeql-learninglab-check/package/src/index.ts

@@ -18,9 +18,11 @@ const readFile = promisify(fs.readFile);
 const writeFile = promisify(fs.writeFile);
 
 /**
- * Must be "true" if all queries should be run (and not just changed queries)
+ * RUN_ALL must be "true" if all queries should be run (and not just changed queries)
+ * If specific queries should be run, RUN_ALL cannot be true
  */
 const RUN_ALL = process.env.RUN_ALL === 'true';
+const QUERY_PATTERN: RegExp | null = process.env.QUERY_PATTERN ? RegExp(process.env.QUERY_PATTERN) : null;
 
 /**
  * Set to true to avoid using the GitHub API to post a comment
@@ -115,15 +117,15 @@ function isConfig(config: any): config is Config {
   }
 
   /**
-   * File paths changed by the user (if we're not just running all queries)
+   * File paths changed by the user (if we're not just running all queries or a specific ones)
    *
    * This is used to reduce the number of queries we need to run to only those
    * that currently interest the user.
    */
   const queriesChanged = new Set<string>();
   let unableToGetChangedQueries = false;
 
-  if (!RUN_ALL) {
+  if (!RUN_ALL && !QUERY_PATTERN) {
 
    /*
     * There are a few different ways in which we may determine which queries
@@ -274,7 +276,7 @@ function isConfig(config: any): config is Config {
   for (const query of Object.keys(config.expectedResults)) {
     const exists = await access(query, fs.constants.R_OK).then(() => true, () => false);
     // Run the query if either it's changed, or runAll is true
-    if (exists && (RUN_ALL || unableToGetChangedQueries || queriesChanged.has(query))) {
+    if (exists && (RUN_ALL || unableToGetChangedQueries || queriesChanged.has(query)) || (QUERY_PATTERN && QUERY_PATTERN.test(query))) {
       queriesToRun.push(query);
     }
   }
@@ -362,4 +364,4 @@ function isConfig(config: any): config is Config {
 })().catch(err => {
   console.error(err);
   process.exit(1);
-});
+});

codeql-learninglab-check/publish.sh

@@ -5,8 +5,8 @@ set -x
 
 docker login docker.pkg.github.com -u github-actions -p ${GITHUB_TOKEN}
 
-PREV_IMAGE_VERSION=v0.0.7
-IMAGE_VERSION=v0.0.8
+PREV_IMAGE_VERSION=v0.0.8
+IMAGE_VERSION=v0.0.9
 IMAGE_PATH=docker.pkg.github.com/github/codeql-learninglab-actions/codeql-learninglab-check
 IMAGE_TAG=${IMAGE_PATH}:${IMAGE_VERSION}
 
@@ -22,4 +22,4 @@ else
   docker build -t $IMAGE_TAG .
 
   docker push $IMAGE_TAG
-fi
+fi

scripts/test-course-actual.sh

@@ -16,4 +16,4 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 docker pull $PARENT_TAG
 
 # Run ./test-course-shared.sh
-$DIR/test-course-shared.sh
+$DIR/test-course-shared.sh $@

scripts/test-course-latest.sh

@@ -16,4 +16,4 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 docker build -t $PARENT_TAG $DIR/../codeql-learninglab-check
 
 # Run ./test-course-shared.sh
-$DIR/test-course-shared.sh
+$DIR/test-course-shared.sh $@

scripts/test-course-shared.sh

@@ -1,6 +1,6 @@
 #! /bin/bash
 
-# Build the course image, and run all queries in
+# Build the course image, and run all or specific queries in
 # the course to ensure the expected result
 #
 # Should be run with the cwd being the course folder
@@ -19,12 +19,24 @@ mkdir -p $TMP
 cp -R answers $TMP/answers
 echo "{}" > $TMP/event.json
 
+# Get query argument
+RUN_ALL=true
+QUERY_PATTERN=""
+if [ "$1" != "" ]; then
+    RUN_ALL=false
+    QUERY_PATTERN=$1
+    echo "Running specific queries $QUERY_PATTERN"
+else
+    echo "Running all queries"
+fi
+
 # Run docker image
 docker run -i \
   -e GITHUB_EVENT_NAME=push \
   -e GITHUB_EVENT_PATH=/opt/tmp/event.json \
   -e GITHUB_TOKEN=noop \
-  -e RUN_ALL=true \
+  -e RUN_ALL=$RUN_ALL \
+  -e QUERY_PATTERN=$QUERY_PATTERN \
   -e SKIP_COMMENT=true \
   -v $TMP:/opt/tmp:ro \
   -w /opt/tmp/answers \