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

Add unit tests for remote queries in logs

Browse Source 
Also, change text slightly.
This commit is contained in:
Andrew Eisenberg
2022-04-14 13:39:36 -07:00
parent 37de2e7f52
commit c0e39886eb
2 changed files with 112 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -337,18 +337,22 @@ async function runRemoteQueriesApiRequest(
}
}
function parseResponse(owner: string, repo: string, response: QueriesResponse) {
const popupMessage = `Successfully scheduled runs. [Click here to see the progress](https://github.com/${owner}/${repo}/actions/runs/${response.workflowRunId}).`
// exported for testng only
export function parseResponse(owner: string, repo: string, response: QueriesResponse) {
const popupMessage = `Successfully scheduled runs. [Click here to see the progress](https://github.com/${owner}/${repo}/actions/runs/${response.workflow_run_id}).`
+ (response.errors ? '\n\nSome repositories could not be scheduled. See extension log for details.' : '');
let logMessage = `Successfully scheduled runs. See https://github.com/${owner}/${repo}/actions/runs/${response.workflow_run_id}.`;
if (response.repositories_queried) {
logMessage += `\n\nRepositories queried:\n${response.repositories_queried.join(', ')}`;
}
if (response.errors) {
logMessage += '\nSome repositories could not be scheduled.';
logMessage += '\n\nSome repositories could not be scheduled.';
if (response.errors.invalid_repositories?.length) {
logMessage += `\nInvalid repositories: ${response.errors.invalid_repositories.join(', ')}`;
logMessage += `\n\nInvalid repositories:\n${response.errors.invalid_repositories.join(', ')}`;
}
if (response.errors.repositories_without_database?.length) {
logMessage += `\nRepositories without databases: ${response.errors.repositories_without_database.join(', ')}`;
logMessage += `\n\nRepositories without databases:\n${response.errors.repositories_without_database.join(', ')}`;
}
}

103
extensions/ql-vscode/src/vscode-tests/no-workspace/remote-queries/run-remote-queries.test.ts Normal file
View File

@@ -0,0 +1,103 @@
import { expect } from 'chai';
import { parseResponse } from '../../../remote-queries/run-remote-query';
describe('run-remote-queries', () => {
describe('parseResponse', () => {
it('should parse a successful response', () => {
const result = parseResponse('org', 'name', {
workflow_run_id: 123,
repositories_queried: ['a/b', 'c/d'],
});
expect(result.popupMessage).to.equal('Successfully scheduled runs. [Click here to see the progress](https://github.com/org/name/actions/runs/123).');
expect(result.logMessage).to.equal(
['Successfully scheduled runs. See https://github.com/org/name/actions/runs/123.',
'',
'Repositories queried:',
'a/b, c/d'].join('\n')
);
});
it('should parse a response with invalid repos', () => {
const result = parseResponse('org', 'name', {
workflow_run_id: 123,
repositories_queried: ['a/b', 'c/d'],
errors: {
invalid_repositories: ['e/f', 'g/h'],
}
});
expect(result.popupMessage).to.equal(
['Successfully scheduled runs. [Click here to see the progress](https://github.com/org/name/actions/runs/123).',
'',
'Some repositories could not be scheduled. See extension log for details.'].join('\n')
);
expect(result.logMessage).to.equal(
['Successfully scheduled runs. See https://github.com/org/name/actions/runs/123.',
'',
'Repositories queried:',
'a/b, c/d',
'',
'Some repositories could not be scheduled.',
'',
'Invalid repositories:',
'e/f, g/h'].join('\n')
);
});
it('should parse a response with repos w/o databases', () => {
const result = parseResponse('org', 'name', {
workflow_run_id: 123,
repositories_queried: ['a/b', 'c/d'],
errors: {
repositories_without_database: ['e/f', 'g/h'],
}
});
expect(result.popupMessage).to.equal(
['Successfully scheduled runs. [Click here to see the progress](https://github.com/org/name/actions/runs/123).',
'',
'Some repositories could not be scheduled. See extension log for details.'].join('\n')
);
expect(result.logMessage).to.equal(
['Successfully scheduled runs. See https://github.com/org/name/actions/runs/123.',
'',
'Repositories queried:\na/b, c/d',
'',
'Some repositories could not be scheduled.',
'',
'Repositories without databases:\ne/f, g/h'].join('\n')
);
});
it('should parse a response with invalid repos and repos w/o databases', () => {
const result = parseResponse('org', 'name', {
workflow_run_id: 123,
repositories_queried: ['a/b', 'c/d'],
errors: {
invalid_repositories: ['e/f', 'g/h'],
repositories_without_database: ['i/j', 'k/l'],
}
});
expect(result.popupMessage).to.equal(
['Successfully scheduled runs. [Click here to see the progress](https://github.com/org/name/actions/runs/123).',
'',
'Some repositories could not be scheduled. See extension log for details.'].join('\n')
);
expect(result.logMessage).to.equal(
['Successfully scheduled runs. See https://github.com/org/name/actions/runs/123.',
'',
'Repositories queried:\na/b, c/d',
'',
'Some repositories could not be scheduled.',
'',
'Invalid repositories:',
'e/f, g/h',
'',
'Repositories without databases:',
'i/j, k/l'].join('\n')
);
});
});
});