Merge pull request #1688 from github/elena/query-history-testing-with-different-items

Make query history tests work with remote queries & variant analyses

Author: elenatanasoiu

extensions/ql-vscode/src/history-item-label-provider.ts

@@ -7,6 +7,7 @@ import { RemoteQueryHistoryItem } from './remote-queries/remote-query-history-it
 import { VariantAnalysisHistoryItem } from './remote-queries/variant-analysis-history-item';
 import { assertNever } from './pure/helpers-pure';
 import { pluralize } from './pure/word';
+import { humanizeQueryStatus } from './query-status';
 
 interface InterpolateReplacements {
   t: string; // Start time
@@ -86,7 +87,7 @@ export class HistoryItemLabelProvider {
       q: `${item.remoteQuery.queryName} (${item.remoteQuery.language})`,
       d: buildRepoLabel(item),
       r: resultCount,
-      s: item.status,
+      s: humanizeQueryStatus(item.status),
       f: path.basename(item.remoteQuery.queryFilePath),
       '%': '%'
     };
@@ -99,7 +100,7 @@ export class HistoryItemLabelProvider {
       q: `${item.variantAnalysis.query.name} (${item.variantAnalysis.query.language})`,
       d: buildRepoLabel(item),
       r: resultCount,
-      s: item.status,
+      s: humanizeQueryStatus(item.status),
       f: path.basename(item.variantAnalysis.query.filePath),
       '%': '%',
     };

extensions/ql-vscode/src/query-status.ts

@@ -21,3 +21,16 @@ export function variantAnalysisStatusToQueryStatus(status: VariantAnalysisStatus
       assertNever(status);
   }
 }
+
+export function humanizeQueryStatus(status: QueryStatus): string {
+  switch (status) {
+    case QueryStatus.InProgress:
+      return 'in progress';
+    case QueryStatus.Completed:
+      return 'completed';
+    case QueryStatus.Failed:
+      return 'failed';
+    default:
+      return 'unknown';
+  }
+}

extensions/ql-vscode/src/vscode-tests/factories/local-queries/local-query-history-item.ts

@@ -4,6 +4,9 @@ import {
   CompletedLocalQueryInfo,
   LocalQueryInfo,
 } from '../../../query-results';
+import { QueryEvaluationInfo, QueryWithResults } from '../../../run-queries-shared';
+import { CancellationTokenSource } from 'vscode';
+import { QueryResultType } from '../../../pure/legacy-messages';
 
 export function createMockLocalQueryInfo(
   startTime: string,
@@ -31,3 +34,56 @@ export function createMockLocalQueryInfo(
     } as unknown) as CompletedQueryInfo,
   } as unknown) as CompletedLocalQueryInfo;
 }
+
+export function createMockLocalQuery(
+  dbName = 'a',
+  queryWithResults?: QueryWithResults,
+  isFail = false
+): LocalQueryInfo {
+  const initialQueryInfo = {
+    databaseInfo: { name: dbName },
+    start: new Date(),
+    queryPath: 'hucairz'
+  } as InitialQueryInfo;
+
+  const cancellationToken = {
+    dispose: () => { /**/ },
+  } as CancellationTokenSource;
+
+  const fqi = new LocalQueryInfo(
+    initialQueryInfo,
+    cancellationToken,
+  );
+
+  if (queryWithResults) {
+    fqi.completeThisQuery(queryWithResults);
+  }
+
+  if (isFail) {
+    fqi.failureReason = 'failure reason';
+  }
+
+  return fqi;
+}
+
+export function createMockQueryWithResults(
+  sandbox: sinon.SinonSandbox,
+  didRunSuccessfully = true,
+  hasInterpretedResults = true
+): QueryWithResults {
+  return {
+    query: {
+      hasInterpretedResults: () => Promise.resolve(hasInterpretedResults),
+      deleteQuery: sandbox.stub(),
+    } as unknown as QueryEvaluationInfo,
+    successful: didRunSuccessfully,
+    message: 'foo',
+    dispose: sandbox.spy(),
+    result: {
+      evaluationTime: 1,
+      queryId: 0,
+      runId: 0,
+      resultType: QueryResultType.SUCCESS,
+    }
+  };
+}

extensions/ql-vscode/src/vscode-tests/factories/remote-queries/remote-query-history-item.ts

@@ -1,31 +1,41 @@
 import { RemoteQueryHistoryItem } from '../../../remote-queries/remote-query-history-item';
+import { QueryStatus } from '../../../query-status';
 
 export function createMockRemoteQueryHistoryItem({
   date = new Date('2022-01-01T00:00:00.000Z'),
+  status = QueryStatus.InProgress,
+  failureReason = undefined,
   resultCount = 16,
-  userSpecifiedLabel = undefined,
   repositoryCount = 0,
+  userSpecifiedLabel = undefined,
 }: {
   date?: Date;
+  status?: QueryStatus;
+  failureReason?: string;
   resultCount?: number;
-  userSpecifiedLabel?: string;
   repositoryCount?: number;
+  userSpecifiedLabel?: string;
 }): RemoteQueryHistoryItem {
   return ({
     t: 'remote',
-    userSpecifiedLabel,
+    failureReason,
+    resultCount,
+    status,
+    completed: false,
+    queryId: 'queryId',
     remoteQuery: {
-      executionStartTime: date.getTime(),
       queryName: 'query-name',
       queryFilePath: 'query-file.ql',
+      queryText: 'select 1',
+      language: 'javascript',
       controllerRepository: {
         owner: 'github',
         name: 'vscode-codeql-integration-tests',
       },
-      language: 'javascript',
+      executionStartTime: date.getTime(),
+      actionsWorkflowRunId: 1,
       repositoryCount,
     },
-    status: 'in progress',
-    resultCount,
-  } as unknown) as RemoteQueryHistoryItem;
+    userSpecifiedLabel,
+  });
 }

extensions/ql-vscode/src/vscode-tests/factories/remote-queries/variant-analysis-history-item.ts

@@ -0,0 +1,23 @@
+import { VariantAnalysisHistoryItem } from '../../../remote-queries/variant-analysis-history-item';
+import { QueryStatus } from '../../../query-status';
+import { VariantAnalysisStatus } from '../../../remote-queries/shared/variant-analysis';
+import { createMockVariantAnalysis } from './shared/variant-analysis';
+
+export function createMockVariantAnalysisHistoryItem(
+  historyItemStatus: QueryStatus = QueryStatus.InProgress,
+  variantAnalysisStatus: VariantAnalysisStatus = VariantAnalysisStatus.Succeeded,
+  failureReason?: string,
+  resultCount?: number,
+  userSpecifiedLabel?: string
+): VariantAnalysisHistoryItem {
+  return ({
+    t: 'variant-analysis',
+    failureReason,
+    resultCount,
+    status: historyItemStatus,
+    completed: false,
+    variantAnalysis: createMockVariantAnalysis(variantAnalysisStatus),
+    userSpecifiedLabel,
+  });
+}
+

extensions/ql-vscode/src/vscode-tests/no-workspace/history-item-label-provider.test.ts

@@ -5,9 +5,7 @@ import { HistoryItemLabelProvider } from '../../history-item-label-provider';
 import { createMockLocalQueryInfo } from '../factories/local-queries/local-query-history-item';
 import { createMockRemoteQueryHistoryItem } from '../factories/remote-queries/remote-query-history-item';
 
-
 describe('HistoryItemLabelProvider', () => {
-
   let labelProvider: HistoryItemLabelProvider;
   let config: QueryHistoryConfig;
   const date = new Date('2022-01-01T00:00:00.000Z');

…st/pure-tests/query-history-info.test.ts …/no-workspace/query-history-info.test.tsextensions/ql-vscode/test/pure-tests/query-history-info.test.ts renamed to extensions/ql-vscode/src/vscode-tests/no-workspace/query-history-info.test.ts extensions/ql-vscode/test/pure-tests/query-history-info.test.ts renamed to extensions/ql-vscode/src/vscode-tests/no-workspace/query-history-info.test.ts

@@ -1,19 +1,18 @@
 import { expect } from 'chai';
-
-import { QueryStatus } from '../../src/query-status';
+import { QueryStatus } from '../../query-status';
 import {
   buildRepoLabel,
   getActionsWorkflowRunUrl,
   getQueryId,
   getQueryText,
   getRawQueryName
-} from '../../src/query-history-info';
-import { VariantAnalysisHistoryItem } from '../../src/remote-queries/variant-analysis-history-item';
-import { createMockVariantAnalysis } from '../../src/vscode-tests/factories/remote-queries/shared/variant-analysis';
-import { createMockScannedRepos } from '../../src/vscode-tests/factories/remote-queries/shared/scanned-repositories';
-import { createMockLocalQueryInfo } from '../../src/vscode-tests/factories/local-queries/local-query-history-item';
-import { createMockRemoteQueryHistoryItem } from '../../src/vscode-tests/factories/remote-queries/remote-query-history-item';
-import { VariantAnalysisRepoStatus, VariantAnalysisStatus } from '../../src/remote-queries/shared/variant-analysis';
+} from '../../query-history-info';
+import { VariantAnalysisHistoryItem } from '../../remote-queries/variant-analysis-history-item';
+import { createMockVariantAnalysis } from '../factories/remote-queries/shared/variant-analysis';
+import { createMockScannedRepos } from '../factories/remote-queries/shared/scanned-repositories';
+import { createMockLocalQueryInfo } from '../factories/local-queries/local-query-history-item';
+import { createMockRemoteQueryHistoryItem } from '../factories/remote-queries/remote-query-history-item';
+import { VariantAnalysisRepoStatus, VariantAnalysisStatus } from '../../remote-queries/shared/variant-analysis';
 
 describe('Query history info', () => {