Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions packages/nx-sonarqube/src/executors/scan/executor.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -467,4 +467,46 @@ describe('Scan Executor', (): void => {

expect(output['sonar.projectVersion']).toBe('');
});

it('should handle exclusions as a string', async () => {
jest.spyOn(fs, 'readFileSync').mockReturnValue(jestConfig);
jest.spyOn(sonarQubeScanner, 'scan').mockResolvedValue();

const exclusionsString = "**/index.ts, **/*.client.ts, **/*.config.ts, **/*.controller.ts, **/*.data.ts, **/*.dto.ts, **/*.entity.ts, **/*.event.ts, **/*.interface.ts, **/*.module.ts, **/*.settings.ts, **/*.spec.ts, **/generated.ts, **/main.ts, **/ormconfig*.ts, **/webpack.config.js, **/topics/**/*.ts, **/scripts/**/*.ts, **/ready/**/*.ts, **/health/**/*.ts, **/migrations/**/*.ts, **/mastermind/**/*.ts, **/minion/**/*.ts, **/debouncer/**/*.ts, **/interceptors.ts, **/*.resolver.ts, **/*.sdk.*";

const output = getScannerOptions(
context,
{
hostUrl: 'url',
projectKey: 'key',
qualityGate: true,
exclusions: exclusionsString,
},
'src/',
'coverage/apps'
);

expect(output['sonar.exclusions']).toBe(exclusionsString);
});

it('should handle exclusions as an array', async () => {
jest.spyOn(fs, 'readFileSync').mockReturnValue(jestConfig);
jest.spyOn(sonarQubeScanner, 'scan').mockResolvedValue();

const exclusionsArray = ["**/index.ts", "**/*.client.ts", "**/*.config.ts", "**/*.controller.ts", "**/*.data.ts", "**/*.dto.ts", "**/*.entity.ts", "**/*.event.ts", "**/*.interface.ts", "**/*.module.ts", "**/*.settings.ts", "**/*.spec.ts", "**/generated.ts", "**/main.ts", "**/ormconfig*.ts", "**/webpack.config.js", "**/topics/**/*.ts", "**/scripts/**/*.ts", "**/ready/**/*.ts", "**/health/**/*.ts", "**/migrations/**/*.ts", "**/mastermind/**/*.ts", "**/minion/**/*.ts", "**/debouncer/**/*.ts", "**/interceptors.ts", "**/*.resolver.ts", "**/*.sdk.*"];

const output = getScannerOptions(
context,
{
hostUrl: 'url',
projectKey: 'key',
qualityGate: true,
exclusions: exclusionsArray,
},
'src/',
'coverage/apps'
);

expect(output['sonar.exclusions']).toBe(exclusionsArray.join(','));
});
});
2 changes: 1 addition & 1 deletion packages/nx-sonarqube/src/executors/scan/schema.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ export interface ScanExecutorSchema {
hostUrl: string;
projectKey: string;
branch?: string;
exclusions?: string;
exclusions?: string | string[];
organization?: string;
projectName?: string;
projectVersion?: string;
Expand Down
12 changes: 11 additions & 1 deletion packages/nx-sonarqube/src/executors/scan/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,17 @@
},
"exclusions": {
"description": "Files to exclude from coverage",
"type": "string"
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"organization": {
"description": "Sonar organization",
Expand Down
2 changes: 1 addition & 1 deletion packages/nx-sonarqube/src/executors/scan/utils/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ export function getScannerOptions(
lcovPaths: string
): { [option: string]: string } {
let scannerOptions: { [option: string]: string } = {
'sonar.exclusions': options.exclusions,
'sonar.exclusions': Array.isArray(options.exclusions) ? options.exclusions.join(',') : options.exclusions,
'sonar.javascript.lcov.reportPaths': lcovPaths,
'sonar.language': 'ts',
'sonar.login': process.env.SONAR_LOGIN,
Expand Down