Merge pull request #1 from github/additional-workflows

Additional workflows

Author: Sam Lanning

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

@@ -103,32 +103,153 @@ function isConfig(config: any): config is Config {
       commit_sha: event.after
     });
 
-  // Calculate which file paths have changed in this push
-  const {stdout: filesChangedRaw} = await execFile('git', ['diff', '--name-only', `${event.before}..${event.after}`]);
-  const queriesChanged = new Set(filesChangedRaw.split('\n')
-    .map(s => s.trim())
-    .filter(s => s.endsWith('.ql')));
-  console.log(`${pluralize(queriesChanged.size, 'query')} updated in this push`);
-  comment += `${pluralize(queriesChanged.size, 'query')} changed `
-  comment += `[between \`${event.before.substr(0, 7)}\` and \`${event.after.substr(0, 7)}\`]`
-  comment += `(${event.repository.html_url}/compare/${event.before}...${event.after}) after push to \`${event.ref}\``;
-  if (queriesChanged.size > 0) {
-    comment += ':\n';
-    for (const query of queriesChanged) {
-      console.log(`- ${query}`);
-      const exists = await access(query, fs.constants.R_OK).then(() => true, () => false);
-      comment += `* \`${query}\`${exists ? '' : ' *(deleted)*'}\n`;
+  /**
+   * File paths changed by the user (if we're not just running all queries)
+   *
+   * 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) {
+
+    /*
+    * There are a few different ways in which we may determine which queries
+    * are currently interesting to the user, in decreasing usefulness:
+    *
+    * 1. If the user just pushed to a branch that currently has an open pull
+    *    request, the interesting queries are those that are changed in the pull
+    *    request (and not just those changed in the most recent push).
+    * 2. If there's no active pull request, then what's probably most
+    *    interesting are the queries that have changed in the last push (i.e.
+    *    between the previous head and the new head)
+    * 3. If that's not possible (e.g. the push could have created the branch for
+    *    the first time, and so there is no "previous ref"), then comparing this
+    *    branch to the default branch of a repo will probably give the most
+    *    accurate results.
+    * 4. Finally, if all else fails (e.g. the push was the initial push to the
+    *    default branch of the repo), then we should just run every query we
+    *    recognize (as if RUN_ALL was true). We do this by setting
+    *    unableToGetChangedQueries to true.
+    */
+
+    /**
+     * The output from a successful call to `git diff --name-only`
+     */
+    let diff: {
+      baseSha: string;
+      filesChangedRaw: string;
+    } | null = null;
+
+    // Try (1) - find any PR associated with the branch of this push
+
+    // Get branch name
+    // This is expected to fail if e.g. the push was to a tag not a branch
+    const branch = /^refs\/heads\/(.*)$/.exec(event.ref)?.[1];
+
+    if (branch) {
+      try {
+        const pulls = await api.pulls.list({
+          owner: event.repository.owner.login,
+          repo: event.repository.name,
+          head: `${event.repository.owner.login}:${branch}`
+        });
+        if (pulls && pulls.data.length > 0) {
+          // Just use first PR
+          const pr = pulls.data[0];
+          const baseBranch = pr.base.ref;
+          // Ensure we have the commits from that ref
+          await execFile('git', ['fetch', 'origin', baseBranch]);
+          diff = {
+            baseSha: baseBranch,
+            filesChangedRaw: (await execFile(
+              'git', ['diff', '--name-only', `origin/${baseBranch}..${event.after}`]
+            )).stdout
+          }
+        } else {
+          console.log('No pull requests associated with the current push');
+        }
+      } catch (err) {
+        console.warn(err);
+        console.log(`Failed to use PRs to calculate changed files branch ${branch}.`);
+      }
+    } else {
+      console.log(
+        'Push was not for a branch, calculating changed files differently'
+      );
+    }
+
+    // Try (2) - see what files have changed in the last push
+
+    if (!diff) {
+      try {
+        const result = await execFile(
+          'git', ['diff', '--name-only', `${event.before}..${event.after}`]
+        );
+        if (result)
+          diff = {
+            baseSha: event.before,
+            filesChangedRaw: result.stdout
+          };
+      } catch (err) {
+        console.warn(err);
+        console.log('Failed to get diff for push');
+      }
+    }
+
+    // Try (3) - see how the current HEAD differs from the default branch
+
+    if (!diff) {
+      try {
+        const defaultBranchSha = await (await execFile(
+          'git', ['rev-parse', 'refs/remotes/origin/HEAD']
+        )).stdout.trim();
+        const result = await execFile(
+          'git', ['diff', '--name-only', `${defaultBranchSha}..${event.after}`]
+        );
+        if (result)
+          diff = {
+            baseSha: defaultBranchSha,
+            filesChangedRaw: result.stdout
+          }
+      } catch (err) {
+        console.warn(err);
+        console.log('Failed to diff against default branch');
+      }
+    }
+
+    if (!diff) {
+      unableToGetChangedQueries = true;
+    } else {
+      // We have successfully obtained the diff for this push
+      diff.filesChangedRaw.split('\n')
+      .map(s => s.trim())
+      .filter(s => s.endsWith('.ql'))
+      .forEach(s => queriesChanged.add(s));
+      console.log(`${pluralize(queriesChanged.size, 'query')} updated in this push`);
+      comment += `${pluralize(queriesChanged.size, 'query')} changed `
+      comment += `[between \`${diff.baseSha.substr(0, 7)}\` and \`${event.after.substr(0, 7)}\`]`
+      comment += `(${event.repository.html_url}/compare/${diff.baseSha}...${event.after}) after push to \`${event.ref}\``;
+      if (queriesChanged.size > 0) {
+        comment += ':\n';
+        for (const query of queriesChanged) {
+          console.log(`- ${query}`);
+          const exists = await access(query, fs.constants.R_OK).then(() => true, () => false);
+          comment += `* \`${query}\`${exists ? '' : ' *(deleted)*'}\n`;
+        }
+      } else {
+        comment += '\n';
+      }
     }
-  } else {
-    comment += '\n';
   }
 
   // Work out which queries to run, based on config and changed & existing queries
   const queriesToRun: string[] = [];
   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 || queriesChanged.has(query))) {
+    if (exists && (RUN_ALL || unableToGetChangedQueries || queriesChanged.has(query))) {
       queriesToRun.push(query);
     }
   }

codeql-learninglab-check/publish.sh

@@ -5,7 +5,7 @@ set -x
 
 docker login docker.pkg.github.com -u github-actions -p ${GITHUB_TOKEN}
 
-IMAGE_VERSION=v0.0.1
+IMAGE_VERSION=v0.0.2
 IMAGE_TAG=docker.pkg.github.com/github/codeql-learninglab-actions/codeql-learninglab-check:${IMAGE_VERSION}
 
 if docker pull $IMAGE_TAG; then