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

Merge pull request #1512 from github/koesie10/variant-analysis-header

Browse Source 
Add variant analysis top header
This commit is contained in:
Koen Vlaswinkel
2022-09-19 09:21:21 +02:00
committed by GitHub
parent 29a43c7dc1 1261fdd41e
commit 4b8d611d86
26 changed files with 13627 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.vscode/launch.json vendored
View File

@@ -50,6 +50,18 @@
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen"
},
{
"name": "Launch Unit Tests - React (vscode-codeql)",
"type": "node",
"request": "launch",
"program": "${workspaceFolder}/extensions/ql-vscode/node_modules/.bin/jest",
"showAsyncStacks": true,
"cwd": "${workspaceFolder}/extensions/ql-vscode",
"stopOnEntry": false,
"sourceMaps": true,
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen"
},
{
"name": "Launch Integration Tests - No Workspace (vscode-codeql)",
"type": "extensionHost",

3
.vscode/settings.json vendored
View File

@@ -35,5 +35,6 @@
"editor.formatOnSave": false,
"typescript.preferences.quoteStyle": "single",
"javascript.preferences.quoteStyle": "single",
"editor.wordWrapColumn": 100
"editor.wordWrapColumn": 100,
"jest.rootPath": "./extensions/ql-vscode"
}

2
extensions/ql-vscode/.eslintrc.js
View File

@@ -10,7 +10,7 @@ module.exports = {
node: true,
es6: true,
},
extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:jest-dom/recommended"],
rules: {
"@typescript-eslint/no-use-before-define": 0,
"@typescript-eslint/no-unused-vars": [

214
extensions/ql-vscode/jest.config.js Normal file
View File

@@ -0,0 +1,214 @@
/*
* For a detailed explanation regarding each configuration property and type check, visit:
* https://jestjs.io/docs/configuration
*/
module.exports = {
// All imported modules in your tests should be mocked automatically
// automock: false,
// Stop running tests after `n` failures
// bail: 0,
// The directory where Jest should store its cached dependency information
// cacheDirectory: "/private/var/folders/6m/1394pht172qgd7dmw1fwjk100000gn/T/jest_dx",
// Automatically clear mock calls, instances, contexts and results before every test
// clearMocks: true,
// Indicates whether the coverage information should be collected while executing the test
// collectCoverage: false,
// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: undefined,
// The directory where Jest should output its coverage files
// coverageDirectory: undefined,
// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "/node_modules/"
// ],
// Indicates which provider should be used to instrument code for coverage
coverageProvider: 'v8',
// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],
// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,
// A path to a custom dependency extractor
// dependencyExtractor: undefined,
// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,
// The default configuration for fake timers
// fakeTimers: {
// "enableGlobally": false
// },
// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],
// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: undefined,
// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,
// A set of global variables that need to be available in all test environments
// globals: {},
// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",
// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],
// An array of file extensions your modules use
moduleFileExtensions: [
'js',
'mjs',
'cjs',
'jsx',
'ts',
'tsx',
'json'
],
// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
'moduleNameMapper': {
'\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir>/test/__mocks__/fileMock.ts',
'\\.(css|less)$': '<rootDir>/test/__mocks__/styleMock.ts'
},
// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],
// Activates notifications for test results
// notify: false,
// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",
// A preset that is used as a base for Jest's configuration
preset: 'ts-jest',
// Run tests from one or more projects
// projects: undefined,
// Use this configuration option to add custom reporters to Jest
// reporters: undefined,
// Automatically reset mock state before every test
// resetMocks: false,
// Reset the module registry before running each individual test
// resetModules: false,
// A path to a custom resolver
// resolver: undefined,
// Automatically restore mock state and implementation before every test
// restoreMocks: false,
// The root directory that Jest should scan for tests and modules within
// rootDir: undefined,
// A list of paths to directories that Jest should use to search for files in
// roots: [
// "<rootDir>"
// ],
// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",
// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],
// A list of paths to modules that run some code to configure or set up the testing framework before each test
setupFilesAfterEnv: ['<rootDir>/test/jest.setup.ts'],
// The number of seconds after which a test is considered as slow and reported as such in the results.
// slowTestThreshold: 5,
// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],
// The test environment that will be used for testing
testEnvironment: 'jsdom',
// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},
// Adds a location field to test results
// testLocationInResults: false,
// The glob patterns Jest uses to detect test files
testMatch: [
'**/__tests__/**/*.[jt]s?(x)'
],
// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
// testPathIgnorePatterns: [
// "/node_modules/"
// ],
// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],
// This option allows the use of a custom results processor
// testResultsProcessor: undefined,
// This option allows use of a custom test runner
// testRunner: "jest-circus/runner",
// A map from regular expressions to paths to transformers
transform: {
'^.+\\.tsx?$': [
'ts-jest',
{
tsconfig: 'src/view/tsconfig.spec.json',
},
],
'node_modules': [
'babel-jest',
{
presets: [
'@babel/preset-env'
],
plugins: [
'@babel/plugin-transform-modules-commonjs',
]
}
]
},
// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
'transformIgnorePatterns': [
// These use ES modules, so need to be transformed
'node_modules/(?!(?:@vscode/webview-ui-toolkit|@microsoft/.+|exenv-es6)/.*)'
],
// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,
// Indicates whether each individual test should be reported during the run
// verbose: undefined,
// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],
// Whether to use watchman for file crawling
// watchman: true,
};

13046
extensions/ql-vscode/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

13
extensions/ql-vscode/package.json
View File

@@ -1191,7 +1191,9 @@
"watch": "npm-run-all -p watch:*",
"watch:extension": "tsc --watch",
"watch:webpack": "gulp watchView",
"test": "mocha --exit -r ts-node/register test/pure-tests/**/*.ts",
"test": "npm-run-all -p test:*",
"test:unit": "mocha --exit -r ts-node/register test/pure-tests/**/*.ts",
"test:view": "jest",
"preintegration": "rm -rf ./out/vscode-tests && gulp",
"integration": "node ./out/vscode-tests/run-integration-tests.js no-workspace,minimal-workspace",
"cli-integration": "npm run preintegration && node ./out/vscode-tests/run-integration-tests.js cli-integration",
@@ -1243,6 +1245,7 @@
},
"devDependencies": {
"@babel/core": "^7.18.13",
"@babel/plugin-transform-modules-commonjs": "^7.18.6",
"@storybook/addon-actions": "^6.5.10",
"@storybook/addon-essentials": "^6.5.10",
"@storybook/addon-interactions": "^6.5.10",
@@ -1251,6 +1254,9 @@
"@storybook/manager-webpack5": "^6.5.10",
"@storybook/react": "^6.5.10",
"@storybook/testing-library": "^0.0.13",
"@testing-library/jest-dom": "^5.16.5",
"@testing-library/react": "^12.1.5",
"@testing-library/user-event": "^14.4.3",
"@types/chai": "^4.1.7",
"@types/chai-as-promised": "~7.1.2",
"@types/child-process-promise": "^2.2.1",
@@ -1264,6 +1270,7 @@
"@types/gulp": "^4.0.9",
"@types/gulp-replace": "^1.1.0",
"@types/gulp-sourcemaps": "0.0.32",
"@types/jest": "^29.0.2",
"@types/js-yaml": "^3.12.5",
"@types/jszip": "~3.1.6",
"@types/mocha": "^9.0.0",
@@ -1296,6 +1303,7 @@
"css-loader": "~3.1.0",
"del": "^6.0.0",
"eslint": "~6.8.0",
"eslint-plugin-jest-dom": "^4.0.2",
"eslint-plugin-react": "~7.19.0",
"eslint-plugin-storybook": "^0.6.4",
"file-loader": "^6.2.0",
@@ -1305,6 +1313,8 @@
"gulp-sourcemaps": "^3.0.0",
"gulp-typescript": "^5.0.1",
"husky": "~4.3.8",
"jest": "^29.0.3",
"jest-environment-jsdom": "^29.0.3",
"lint-staged": "~10.2.2",
"mini-css-extract-plugin": "^2.6.1",
"mocha": "^10.0.0",
@@ -1315,6 +1325,7 @@
"sinon": "~13.0.1",
"sinon-chai": "~3.5.0",
"through2": "^4.0.2",
"ts-jest": "^29.0.1",
"ts-loader": "^8.1.0",
"ts-node": "^10.7.0",
"ts-protoc-gen": "^0.9.0",

5
extensions/ql-vscode/src/remote-queries/shared/variant-analysis.ts Normal file
View File

@@ -0,0 +1,5 @@
export enum VariantAnalysisStatus {
InProgress = 'inProgress',
Succeeded = 'succeeded',
Failed = 'failed',
}

42
extensions/ql-vscode/src/stories/variant-analysis/QueryDetails.stories.tsx Normal file
View File

@@ -0,0 +1,42 @@
import React from 'react';
import { ComponentMeta, ComponentStory } from '@storybook/react';
import { VariantAnalysisContainer } from '../../view/variant-analysis/VariantAnalysisContainer';
import { QueryDetails as QueryDetailsComponent } from '../../view/variant-analysis/QueryDetails';
export default {
title: 'Variant Analysis/Query Details',
component: QueryDetailsComponent,
decorators: [
(Story) => (
<VariantAnalysisContainer>
<Story />
</VariantAnalysisContainer>
)
],
argTypes: {
onOpenQueryFileClick: {
action: 'open-query-file-clicked',
table: {
disable: true,
},
},
onViewQueryTextClick: {
action: 'view-query-text-clicked',
table: {
disable: true,
},
},
}
} as ComponentMeta<typeof QueryDetailsComponent>;
const Template: ComponentStory<typeof QueryDetailsComponent> = (args) => (
<QueryDetailsComponent {...args} />
);
export const QueryDetails = Template.bind({});
QueryDetails.args = {
queryName: 'Query name',
queryFileName: 'example.ql',
};

16
extensions/ql-vscode/src/stories/variant-analysis/VariantAnalysis.stories.tsx Normal file
View File

@@ -0,0 +1,16 @@
import React from 'react';
import { ComponentStory, ComponentMeta } from '@storybook/react';
import { VariantAnalysis as VariantAnalysisComponent } from '../../view/variant-analysis/VariantAnalysis';
export default {
title: 'Variant Analysis/Variant Analysis',
component: VariantAnalysisComponent,
} as ComponentMeta<typeof VariantAnalysisComponent>;
const Template: ComponentStory<typeof VariantAnalysisComponent> = () => (
<VariantAnalysisComponent />
);
export const VariantAnalysis = Template.bind({});

60
extensions/ql-vscode/src/stories/variant-analysis/VariantAnalysisActions.stories.tsx Normal file
View File

@@ -0,0 +1,60 @@
import React from 'react';
import { ComponentMeta, ComponentStory } from '@storybook/react';
import { VariantAnalysisContainer } from '../../view/variant-analysis/VariantAnalysisContainer';
import { VariantAnalysisStatus } from '../../remote-queries/shared/variant-analysis';
import { VariantAnalysisActions } from '../../view/variant-analysis/VariantAnalysisActions';
export default {
title: 'Variant Analysis/Variant Analysis Actions',
component: VariantAnalysisActions,
decorators: [
(Story) => (
<VariantAnalysisContainer>
<Story />
</VariantAnalysisContainer>
)
],
argTypes: {
onStopQueryClick: {
action: 'stop-query-clicked',
table: {
disable: true,
},
},
onCopyRepositoryListClick: {
action: 'copy-repository-list-clicked',
table: {
disable: true,
},
},
onExportResultsClick: {
action: 'export-results-clicked',
table: {
disable: true,
},
},
}
} as ComponentMeta<typeof VariantAnalysisActions>;
const Template: ComponentStory<typeof VariantAnalysisActions> = (args) => (
<VariantAnalysisActions {...args} />
);
export const InProgress = Template.bind({});
InProgress.args = {
variantAnalysisStatus: VariantAnalysisStatus.InProgress,
};
export const Succeeded = Template.bind({});
Succeeded.args = {
...InProgress.args,
variantAnalysisStatus: VariantAnalysisStatus.Succeeded,
};
export const Failed = Template.bind({});
Failed.args = {
...InProgress.args,
variantAnalysisStatus: VariantAnalysisStatus.Failed,
};

74
extensions/ql-vscode/src/stories/variant-analysis/VariantAnalysisHeader.stories.tsx Normal file
View File

@@ -0,0 +1,74 @@
import React from 'react';
import { ComponentStory, ComponentMeta } from '@storybook/react';
import { VariantAnalysisContainer } from '../../view/variant-analysis/VariantAnalysisContainer';
import { VariantAnalysisHeader } from '../../view/variant-analysis/VariantAnalysisHeader';
import { VariantAnalysisStatus } from '../../remote-queries/shared/variant-analysis';
export default {
title: 'Variant Analysis/Variant Analysis Header',
component: VariantAnalysisHeader,
decorators: [
(Story) => (
<VariantAnalysisContainer>
<Story />
</VariantAnalysisContainer>
)
],
argTypes: {
onOpenQueryFileClick: {
action: 'open-query-file-clicked',
table: {
disable: true,
},
},
onViewQueryTextClick: {
action: 'view-query-text-clicked',
table: {
disable: true,
},
},
onStopQueryClick: {
action: 'stop-query-clicked',
table: {
disable: true,
},
},
onCopyRepositoryListClick: {
action: 'copy-repository-list-clicked',
table: {
disable: true,
},
},
onExportResultsClick: {
action: 'export-results-clicked',
table: {
disable: true,
},
},
}
} as ComponentMeta<typeof VariantAnalysisHeader>;
const Template: ComponentStory<typeof VariantAnalysisHeader> = (args) => (
<VariantAnalysisHeader {...args} />
);
export const InProgress = Template.bind({});
InProgress.args = {
queryName: 'Query name',
queryFileName: 'example.ql',
variantAnalysisStatus: VariantAnalysisStatus.InProgress,
};
export const Succeeded = Template.bind({});
Succeeded.args = {
...InProgress.args,
variantAnalysisStatus: VariantAnalysisStatus.Succeeded,
};
export const Failed = Template.bind({});
Failed.args = {
...InProgress.args,
variantAnalysisStatus: VariantAnalysisStatus.Failed,
};

6
extensions/ql-vscode/src/view/remote-queries/ViewTitle.tsx
View File

@@ -1,9 +1,13 @@
import styled from 'styled-components';
const ViewTitle = styled.h1`
font-size: large;
font-size: 2em;
margin-bottom: 0.5em;
font-weight: 500;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
`;
export default ViewTitle;

3
extensions/ql-vscode/src/view/tsconfig.json
View File

@@ -12,7 +12,8 @@
"noUnusedLocals": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"experimentalDecorators": true
"experimentalDecorators": true,
"skipLibCheck": true
},
"exclude": ["node_modules"]
}

7
extensions/ql-vscode/src/view/tsconfig.spec.json Normal file
View File

@@ -0,0 +1,7 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"module": "commonjs"
},
"exclude": []
}

8
extensions/ql-vscode/src/view/variant-analysis/LinkIconButton.tsx Normal file
View File

@@ -0,0 +1,8 @@
import { VSCodeLink } from '@vscode/webview-ui-toolkit/react';
import styled from 'styled-components';
export const LinkIconButton = styled(VSCodeLink)`
.codicon {
vertical-align: text-bottom;
}
`;

44
extensions/ql-vscode/src/view/variant-analysis/QueryDetails.tsx Normal file
View File

@@ -0,0 +1,44 @@
import * as React from 'react';
import styled from 'styled-components';
import ViewTitle from '../remote-queries/ViewTitle';
import { LinkIconButton } from './LinkIconButton';
export type QueryDetailsProps = {
queryName: string;
queryFileName: string;
onOpenQueryFileClick: () => void;
onViewQueryTextClick: () => void;
};
const Container = styled.div`
max-width: 100%;
`;
const QueryActions = styled.div`
display: flex;
gap: 1em;
`;
export const QueryDetails = ({
queryName,
queryFileName,
onOpenQueryFileClick,
onViewQueryTextClick,
}: QueryDetailsProps) => {
return (
<Container>
<ViewTitle>{queryName}</ViewTitle>
<QueryActions>
<LinkIconButton onClick={onOpenQueryFileClick}>
<span slot="start" className="codicon codicon-file-code"></span>
{queryFileName}
</LinkIconButton>
<LinkIconButton onClick={onViewQueryTextClick}>
<span slot="start" className="codicon codicon-code"></span>
View query
</LinkIconButton>
</QueryActions>
</Container>
);
};

18
extensions/ql-vscode/src/view/variant-analysis/VariantAnalysis.tsx
View File

@@ -1,5 +1,21 @@
import * as React from 'react';
import { VariantAnalysisStatus } from '../../remote-queries/shared/variant-analysis';
import { VariantAnalysisContainer } from './VariantAnalysisContainer';
import { VariantAnalysisHeader } from './VariantAnalysisHeader';
export function VariantAnalysis(): JSX.Element {
return <span>Hello!</span>;
return (
<VariantAnalysisContainer>
<VariantAnalysisHeader
queryName="Example query"
queryFileName="example.ql"
variantAnalysisStatus={VariantAnalysisStatus.InProgress}
onOpenQueryFileClick={() => console.log('Open query')}
onViewQueryTextClick={() => console.log('View query')}
onStopQueryClick={() => console.log('Stop query')}
onCopyRepositoryListClick={() => console.log('Copy repository list')}
onExportResultsClick={() => console.log('Export results')}
/>
</VariantAnalysisContainer>
);
}

50
extensions/ql-vscode/src/view/variant-analysis/VariantAnalysisActions.tsx Normal file
View File

@@ -0,0 +1,50 @@
import * as React from 'react';
import styled from 'styled-components';
import { VSCodeButton } from '@vscode/webview-ui-toolkit/react';
import { VariantAnalysisStatus } from '../../remote-queries/shared/variant-analysis';
type Props = {
variantAnalysisStatus: VariantAnalysisStatus;
onStopQueryClick: () => void;
onCopyRepositoryListClick: () => void;
onExportResultsClick: () => void;
};
const Container = styled.div`
margin-left: auto;
display: flex;
gap: 1em;
`;
const Button = styled(VSCodeButton)`
white-space: nowrap;
`;
export const VariantAnalysisActions = ({
variantAnalysisStatus,
onStopQueryClick,
onCopyRepositoryListClick,
onExportResultsClick
}: Props) => {
return (
<Container>
{variantAnalysisStatus === VariantAnalysisStatus.InProgress && (
<Button appearance="secondary" onClick={onStopQueryClick}>
Stop query
</Button>
)}
{variantAnalysisStatus === VariantAnalysisStatus.Succeeded && (
<>
<Button appearance="secondary" onClick={onCopyRepositoryListClick}>
Copy repository list
</Button>
<Button appearance="primary" onClick={onExportResultsClick}>
Export results
</Button>
</>
)}
</Container>
);
};

5
extensions/ql-vscode/src/view/variant-analysis/VariantAnalysisContainer.tsx Normal file
View File

@@ -0,0 +1,5 @@
import styled from 'styled-components';
export const VariantAnalysisContainer = styled.div`
max-width: 55em;
`;

52
extensions/ql-vscode/src/view/variant-analysis/VariantAnalysisHeader.tsx Normal file
View File

@@ -0,0 +1,52 @@
import * as React from 'react';
import styled from 'styled-components';
import { VariantAnalysisStatus } from '../../remote-queries/shared/variant-analysis';
import { QueryDetails } from './QueryDetails';
import { VariantAnalysisActions } from './VariantAnalysisActions';
export type VariantAnalysisHeaderProps = {
queryName: string;
queryFileName: string;
variantAnalysisStatus: VariantAnalysisStatus;
onOpenQueryFileClick: () => void;
onViewQueryTextClick: () => void;
onStopQueryClick: () => void;
onCopyRepositoryListClick: () => void;
onExportResultsClick: () => void;
};
const Container = styled.div`
display: flex;
align-items: center;
`;
export const VariantAnalysisHeader = ({
queryName,
queryFileName,
variantAnalysisStatus,
onOpenQueryFileClick,
onViewQueryTextClick,
onStopQueryClick,
onCopyRepositoryListClick,
onExportResultsClick
}: VariantAnalysisHeaderProps) => {
return (
<Container>
<QueryDetails
queryName={queryName}
queryFileName={queryFileName}
onOpenQueryFileClick={onOpenQueryFileClick}
onViewQueryTextClick={onViewQueryTextClick}
/>
<VariantAnalysisActions
variantAnalysisStatus={variantAnalysisStatus}
onStopQueryClick={onStopQueryClick}
onCopyRepositoryListClick={onCopyRepositoryListClick}
onExportResultsClick={onExportResultsClick}
/>
</Container>
);
};

51
extensions/ql-vscode/src/view/variant-analysis/__tests__/QueryDetails.spec.tsx Normal file
View File

@@ -0,0 +1,51 @@
import * as React from 'react';
import { render as reactRender, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { QueryDetails, QueryDetailsProps } from '../QueryDetails';
describe(QueryDetails.name, () => {
const onOpenQueryFileClick = jest.fn();
const onViewQueryTextClick = jest.fn();
const onStopQueryClick = jest.fn();
const onCopyRepositoryListClick = jest.fn();
const onExportResultsClick = jest.fn();
afterEach(() => {
onOpenQueryFileClick.mockReset();
onViewQueryTextClick.mockReset();
onStopQueryClick.mockReset();
onCopyRepositoryListClick.mockReset();
onExportResultsClick.mockReset();
});
const render = (props: Partial<QueryDetailsProps> = {}) =>
reactRender(
<QueryDetails
queryName="Query name"
queryFileName="example.ql"
onOpenQueryFileClick={onOpenQueryFileClick}
onViewQueryTextClick={onViewQueryTextClick}
{...props}
/>
);
it('renders correctly', () => {
render();
expect(screen.getByText('Query name')).toBeInTheDocument();
});
it('renders the query file name as a button', async () => {
render();
await userEvent.click(screen.getByText('example.ql'));
expect(onOpenQueryFileClick).toHaveBeenCalledTimes(1);
});
it('renders a view query button', async () => {
render();
await userEvent.click(screen.getByText('View query'));
expect(onViewQueryTextClick).toHaveBeenCalledTimes(1);
});
});

66
extensions/ql-vscode/src/view/variant-analysis/__tests__/VariantAnalysisActions.spec.tsx Normal file
View File

@@ -0,0 +1,66 @@
import * as React from 'react';
import { render as reactRender, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { VariantAnalysisStatus } from '../../../remote-queries/shared/variant-analysis';
import { VariantAnalysisActions } from '../VariantAnalysisActions';
describe(VariantAnalysisActions.name, () => {
const onStopQueryClick = jest.fn();
const onCopyRepositoryListClick = jest.fn();
const onExportResultsClick = jest.fn();
afterEach(() => {
onStopQueryClick.mockReset();
onCopyRepositoryListClick.mockReset();
onExportResultsClick.mockReset();
});
const render = (variantAnalysisStatus: VariantAnalysisStatus) =>
reactRender(
<VariantAnalysisActions
variantAnalysisStatus={variantAnalysisStatus}
onStopQueryClick={onStopQueryClick}
onCopyRepositoryListClick={onCopyRepositoryListClick}
onExportResultsClick={onExportResultsClick}
/>
);
it('renders 1 button when in progress', async () => {
const { container } = render(VariantAnalysisStatus.InProgress);
expect(container.querySelectorAll('vscode-button').length).toEqual(1);
});
it('renders the stop query button when in progress', async () => {
render(VariantAnalysisStatus.InProgress);
await userEvent.click(screen.getByText('Stop query'));
expect(onStopQueryClick).toHaveBeenCalledTimes(1);
});
it('renders 2 buttons when succeeded', async () => {
const { container } = render(VariantAnalysisStatus.Succeeded);
expect(container.querySelectorAll('vscode-button').length).toEqual(2);
});
it('renders the copy repository list button when succeeded', async () => {
render(VariantAnalysisStatus.Succeeded);
await userEvent.click(screen.getByText('Copy repository list'));
expect(onCopyRepositoryListClick).toHaveBeenCalledTimes(1);
});
it('renders the export results button when succeeded', async () => {
render(VariantAnalysisStatus.Succeeded);
await userEvent.click(screen.getByText('Export results'));
expect(onExportResultsClick).toHaveBeenCalledTimes(1);
});
it('does not render any buttons when failed', () => {
const { container } = render(VariantAnalysisStatus.Failed);
expect(container.querySelectorAll('vscode-button').length).toEqual(0);
});
});

1
extensions/ql-vscode/test/__mocks__/fileMock.ts Normal file
View File

@@ -0,0 +1 @@
export default 'test-file-stub';

1
extensions/ql-vscode/test/__mocks__/styleMock.ts Normal file
View File

@@ -0,0 +1 @@
export default {};

16
extensions/ql-vscode/test/jest.setup.ts Normal file
View File

@@ -0,0 +1,16 @@
import '@testing-library/jest-dom';
// https://jestjs.io/docs/26.x/manual-mocks#mocking-methods-which-are-not-implemented-in-jsdom
Object.defineProperty(window, 'matchMedia', {
writable: true,
value: jest.fn().mockImplementation(query => ({
matches: false,
media: query,
onchange: null,
addListener: jest.fn(), // deprecated
removeListener: jest.fn(), // deprecated
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
dispatchEvent: jest.fn(),
})),
});

1
extensions/ql-vscode/tsconfig.json
View File

@@ -10,6 +10,7 @@
"moduleResolution": "node",
"sourceMap": true,
"rootDir": "src",
"skipLibCheck": true,
"strictNullChecks": true,
"noFallthroughCasesInSwitch": true,
"preserveWatchOutput": true,