Merge pull request #1746 from github/koesie10/remote-queries-tests-tar

Change remote queries to test against submitted data

Author: koesie10

extensions/ql-vscode/package-lock.json

@@ -1380,6 +1380,7 @@
     "@types/sinon-chai": "~3.2.3",
     "@types/stream-chain": "~2.0.1",
     "@types/stream-json": "~1.7.1",
+    "@types/tar-stream": "^2.2.2",
     "@types/through2": "^2.0.36",
     "@types/tmp": "^0.1.0",
     "@types/unzipper": "~0.10.1",
@@ -1420,6 +1421,7 @@
     "proxyquire": "~2.1.3",
     "sinon": "~14.0.0",
     "sinon-chai": "~3.5.0",
+    "tar-stream": "^2.2.0",
     "through2": "^4.0.2",
     "ts-jest": "^29.0.1",
     "ts-json-schema-generator": "^1.1.2",

extensions/ql-vscode/package.json

@@ -1,12 +1,14 @@
 import { Credentials } from '../../authentication';
 import { OctokitResponse } from '@octokit/types/dist-types';
+import { RemoteQueriesSubmission } from '../shared/remote-queries';
 import { VariantAnalysisSubmission } from '../shared/variant-analysis';
 import {
   VariantAnalysis,
   VariantAnalysisRepoTask,
   VariantAnalysisSubmissionRequest
 } from './variant-analysis';
 import { Repository } from './repository';
+import { RemoteQueriesResponse, RemoteQueriesSubmissionRequest } from './remote-queries';
 
 export async function submitVariantAnalysis(
   credentials: Credentials,
@@ -116,3 +118,31 @@ export async function createGist(
   }
   return response.data.html_url;
 }
+
+export async function submitRemoteQueries(
+  credentials: Credentials,
+  submissionDetails: RemoteQueriesSubmission
+): Promise<RemoteQueriesResponse> {
+  const octokit = await credentials.getOctokit();
+
+  const { ref, language, repositories, repositoryLists, repositoryOwners, queryPack, controllerRepoId } = submissionDetails;
+
+  const data: RemoteQueriesSubmissionRequest = {
+    ref,
+    language,
+    repositories,
+    repository_lists: repositoryLists,
+    repository_owners: repositoryOwners,
+    query_pack: queryPack,
+  };
+
+  const response: OctokitResponse<RemoteQueriesResponse> = await octokit.request(
+    'POST /repositories/:controllerRepoId/code-scanning/codeql/queries',
+    {
+      controllerRepoId,
+      data
+    }
+  );
+
+  return response.data;
+}

extensions/ql-vscode/src/remote-queries/gh-api/gh-api-client.ts

@@ -0,0 +1,20 @@
+export interface RemoteQueriesSubmissionRequest {
+  ref: string;
+  language: string;
+  repositories?: string[];
+  repository_lists?: string[];
+  repository_owners?: string[];
+  query_pack: string;
+}
+
+export interface RemoteQueriesResponse {
+  workflow_run_id: number,
+  errors?: {
+    invalid_repositories?: string[],
+    repositories_without_database?: string[],
+    private_repositories?: string[],
+    cutoff_repositories?: string[],
+    cutoff_repositories_count?: number,
+  },
+  repositories_queried: string[],
+}

extensions/ql-vscode/src/remote-queries/gh-api/remote-queries.ts

@@ -18,13 +18,14 @@ import * as cli from '../cli';
 import { logger } from '../logging';
 import { getActionBranch, getRemoteControllerRepo, isVariantAnalysisLiveResultsEnabled, setRemoteControllerRepo } from '../config';
 import { ProgressCallback, UserCancellationException } from '../commandRunner';
-import { OctokitResponse, RequestError } from '@octokit/types/dist-types';
+import { RequestError } from '@octokit/types/dist-types';
 import { RemoteQuery } from './remote-query';
 import { RemoteQuerySubmissionResult } from './remote-query-submission-result';
 import { QueryMetadata } from '../pure/interface-types';
 import { getErrorMessage, REPO_REGEX } from '../pure/helpers-pure';
 import { pluralize } from '../pure/word';
 import * as ghApiClient from './gh-api/gh-api-client';
+import { RemoteQueriesResponse } from './gh-api/remote-queries';
 import { getRepositorySelection, isValidSelection, RepositorySelection } from './repository-selection';
 import { parseVariantAnalysisQueryLanguage, VariantAnalysisSubmission } from './shared/variant-analysis';
 import { Repository } from './shared/repository';
@@ -39,18 +40,6 @@ export interface QlPack {
   defaultSuiteFile?: string;
 }
 
-interface QueriesResponse {
-  workflow_run_id: number,
-  errors?: {
-    invalid_repositories?: string[],
-    repositories_without_database?: string[],
-    private_repositories?: string[],
-    cutoff_repositories?: string[],
-    cutoff_repositories_count?: number,
-  },
-  repositories_queried: string[],
-}
-
 /**
  * Well-known names for the query pack used by the server.
  */
@@ -172,7 +161,7 @@ function isFileSystemRoot(dir: string): boolean {
   return pathObj.root === dir && pathObj.base === '';
 }
 
-async function createRemoteQueriesTempDirectory() {
+export async function createRemoteQueriesTempDirectory() {
   const remoteQueryDir = await tmp.dir({ dir: tmpDir.name, unsafeCleanup: true });
   const queryPackDir = path.join(remoteQueryDir.path, 'query-pack');
   await fs.mkdirp(queryPackDir);
@@ -389,7 +378,7 @@ async function runRemoteQueriesApiRequest(
   controllerRepo: Repository,
   queryPackBase64: string,
   dryRun = false
-): Promise<void | QueriesResponse> {
+): Promise<void | RemoteQueriesResponse> {
   const data = {
     ref,
     language,
@@ -412,17 +401,18 @@ async function runRemoteQueriesApiRequest(
   }
 
   try {
-    const octokit = await credentials.getOctokit();
-    const response: OctokitResponse<QueriesResponse, number> = await octokit.request(
-      'POST /repositories/:controllerRepoId/code-scanning/codeql/queries',
-      {
-        controllerRepoId: controllerRepo.id,
-        data
-      }
-    );
-    const { popupMessage, logMessage } = parseResponse(controllerRepo, response.data);
+    const response = await ghApiClient.submitRemoteQueries(credentials, {
+      ref,
+      language,
+      repositories: repoSelection.repositories,
+      repositoryLists: repoSelection.repositoryLists,
+      repositoryOwners: repoSelection.owners,
+      queryPack: queryPackBase64,
+      controllerRepoId: controllerRepo.id,
+    });
+    const { popupMessage, logMessage } = parseResponse(controllerRepo, response);
     void showAndLogInformationMessage(popupMessage, { fullMessage: logMessage });
-    return response.data;
+    return response;
   } catch (error: any) {
     if (error.status === 404) {
       void showAndLogErrorMessage(`Controller repository was not found. Please make sure it's a valid repo name.${eol}`);
@@ -436,7 +426,7 @@ const eol = os.EOL;
 const eol2 = os.EOL + os.EOL;
 
 // exported for testing only
-export function parseResponse(controllerRepo: Repository, response: QueriesResponse) {
+export function parseResponse(controllerRepo: Repository, response: RemoteQueriesResponse) {
   const repositoriesQueried = response.repositories_queried;
   const repositoryCount = repositoriesQueried.length;
 

extensions/ql-vscode/src/remote-queries/run-remote-query.ts

@@ -0,0 +1,10 @@
+export interface RemoteQueriesSubmission {
+  ref: string;
+  language: string;
+  repositories?: string[];
+  repositoryLists?: string[];
+  repositoryOwners?: string[];
+  queryPack: string;
+
+  controllerRepoId: number;
+}