mrva/vscode-codeql
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Small cleanups around remote-queries tests

Browse Source 
- More explicit test helper module names
- Fix unit test names
- Better sanitization of repo names in tests
This commit is contained in:
Andrew Eisenberg
2022-02-25 09:57:15 -08:00
parent 4a928f1298
commit 791e7e9c4d
6 changed files with 34 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
extensions/ql-vscode/src/pure/disposable-object.ts
View File

@@ -83,17 +83,3 @@ export abstract class DisposableObject implements Disposable {
}
}
}
/**
* A simple disposable object that does nothing other than contain a list of disposable objects.
* This is useful for implementing a `Disposable` that owns other disposable objects.
*/
export class DisposableBucket extends DisposableObject {
/**
* Add a disposable object to this bucket.
* @param obj The object to add.
*/
public push<T extends Disposable>(obj: T): T {
return super.push(obj);
}
}

2
extensions/ql-vscode/src/vscode-tests/test-helpers.ts → extensions/ql-vscode/src/vscode-tests/directory-walker.ts
View File

@@ -6,6 +6,8 @@ import * as fs from 'fs-extra';
* Note that this function uses synchronous fs calls, so it should only be used in tests.
*
* @param dir the directory to walk
*
* @return An iterator of the full path to all files recursively found in the directory.
*/
export function* walk(dir: string): IterableIterator<string> {
const files = fs.readdirSync(dir);

16
extensions/ql-vscode/src/vscode-tests/disposable-bucket.ts Normal file
View File

@@ -0,0 +1,16 @@
import { Disposable } from 'vscode';
import { DisposableObject } from '../pure/disposable-object';
/**
* A simple disposable object that does nothing other than contain a list of disposable objects.
* This is useful for implementing a `Disposable` that owns other disposable objects.
*/
export class DisposableBucket extends DisposableObject {
/**
* Add a disposable object to this bucket.
* @param obj The object to add.
*/
public push<T extends Disposable>(obj: T): T {
return super.push(obj);
}
}

4
extensions/ql-vscode/src/vscode-tests/no-workspace/data/remote-queries/queries/MRVA Integration test 1-6sBi6oaky_fxqXW2NA4bx/query-result.json
View File

@@ -7,7 +7,7 @@
"fileSizeInBytes": 191025,
"downloadLink": {
"id": "171543249",
"urlPath": "/repos/dsp-testing/qc-run2/actions/artifacts/171543249",
"urlPath": "/repos/avocado-corp/hucairz/actions/artifacts/171543249",
"innerFilePath": "results.sarif",
"queryId": "MRVA Integration test 1-6sBi6oaky_fxqXW2NA4bx"
}
@@ -18,7 +18,7 @@
"fileSizeInBytes": 191025,
"downloadLink": {
"id": "11111111",
"urlPath": "/repos/dsp-testing/qc-run2/actions/artifacts/11111111",
"urlPath": "/repos/avocado-corp/hucairz/actions/artifacts/11111111",
"innerFilePath": "results.sarif",
"queryId": "MRVA Integration test 1-6sBi6oaky_fxqXW2NA4bx"
}

2
extensions/ql-vscode/src/vscode-tests/no-workspace/data/remote-queries/queries/MRVA Integration test 2-UL-vbKAjP8ffObxjsp7hN/query-result.json
View File

@@ -7,7 +7,7 @@
"fileSizeInBytes": 81237,
"downloadLink": {
"id": "171544171",
"urlPath": "/repos/dsp-testing/qc-run2/actions/artifacts/171544171",
"urlPath": "/repos/avocado-corp/hucairz/actions/artifacts/171544171",
"innerFilePath": "results.sarif",
"queryId": "MRVA Integration test 2-UL-vbKAjP8ffObxjsp7hN"
}

24
extensions/ql-vscode/src/vscode-tests/no-workspace/remote-query-history.test.ts
View File

@@ -12,12 +12,12 @@ import { DatabaseManager } from '../../databases';
import { tmpDir } from '../../helpers';
import { QueryHistoryManager } from '../../query-history';
import { QueryServerClient } from '../../queryserver-client';
import { DisposableBucket } from '../../pure/disposable-object';
import { Credentials } from '../../authentication';
import { AnalysesResultsManager } from '../../remote-queries/analyses-results-manager';
import { RemoteQueryResult } from '../../remote-queries/shared/remote-query-result';
import { walk } from '../test-helpers';
import { DisposableBucket } from '../disposable-bucket';
import { testDisposeHandler } from '../test-dispose-handler';
import { walk } from '../directory-walker';
chai.use(chaiAsPromised);
const expect = chai.expect;
@@ -42,6 +42,8 @@ describe('Remote queries and query history manager', function() {
let openTextDocumentSpy: sinon.SinonSpy;
beforeEach(() => {
// Since these tests change the state of the query history manager, we need to copy the original
// to a temporary folder where we can manipulate it for tests
copyHistoryState();
});
@@ -96,7 +98,7 @@ describe('Remote queries and query history manager', function() {
expect(qhm.treeDataProvider.allHistory.length).to.eq(2);
});
it('should remove and then a query from history', async () => {
it('should remove and then add query from history', async () => {
await qhm.readQueryHistory();
const addSpy = sandbox.spy();
disposables.push(qhm.onDidAddQueryItem(addSpy));
@@ -189,7 +191,7 @@ describe('Remote queries and query history manager', function() {
);
});
it('should avoid downloading an analysis result', async () => {
it('should avoid re-downloading an analysis result', async () => {
// because the analysis result is already in on disk, it should not be downloaded
const publisher = sandbox.spy();
const analysisSummary = remoteQueryResult0.analysisSummaries[0];
@@ -292,14 +294,16 @@ describe('Remote queries and query history manager', function() {
await arm.downloadAnalysesResults(analysisSummaries1, undefined, publisher);
const result0 = arm.getAnalysesResults(rawQueryHistory[0].queryId);
const result1 = arm.getAnalysesResults(rawQueryHistory[1].queryId);
const result0Again = arm.getAnalysesResults(rawQueryHistory[0].queryId);
// Shoule be equal, but not equivalent
expect(result0).to.deep.eq((arm as any).analysesResults.get(rawQueryHistory[0].queryId));
expect(result0).not.to.eq((arm as any).analysesResults.get(rawQueryHistory[0].queryId));
expect(result0).to.deep.eq(result0Again);
expect(result0).not.to.eq(result0Again);
expect(result1).to.deep.eq((arm as any).analysesResults.get(rawQueryHistory[1].queryId));
expect(result1).not.to.eq((arm as any).analysesResults.get(rawQueryHistory[1].queryId));
const result1 = arm.getAnalysesResults(rawQueryHistory[1].queryId);
const result1Again = arm.getAnalysesResults(rawQueryHistory[1].queryId);
expect(result1).to.deep.eq(result1Again);
expect(result1).not.to.eq(result1Again);
});
// This test is failing on windows in CI.
@@ -317,8 +321,6 @@ describe('Remote queries and query history manager', function() {
});
});
// Since this test changes the state of the query history manager, we need to copy the original
// to a temporary folder where we can manipulate it for tests
function copyHistoryState() {
fs.ensureDirSync(STORAGE_DIR);
fs.copySync(path.join(__dirname, 'data/remote-queries/'), path.join(tmpDir.name, 'remote-queries'));