Skip to content

Commit 680f25b

Browse files
tiagobcxtiagobcx
committed
fix formatting
1 parent 6bd5172 commit 680f25b

File tree

7 files changed

+42
-84
lines changed

7 files changed

+42
-84
lines changed

‎src/main/wrapper/CxWrapper.ts‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@ import {CxConstants} from "./CxConstants";
44
import {ExecutionService} from "./ExecutionService";
55
import {CxCommandOutput} from "./CxCommandOutput";
66
import { logger } from "./loggerConfig";
7-
87
import * as fs from "fs"
98
import * as os from "os";
109

11-
12-
1310
type ParamTypeMap = Map<CxParamType, string>;
1411

1512
export class CxWrapper {
@@ -32,7 +29,6 @@ export class CxWrapper {
3229
logger.info("Did not receive ClientId/Secret or ApiKey from cli arguments");
3330
}
3431
let executablePath: string;
35-
3632
if (cxScanConfig.pathToExecutable) {
3733
this.pathToExecutable = cxScanConfig.pathToExecutable;
3834
} else if (process.platform === 'win32') {
@@ -47,11 +43,9 @@ export class CxWrapper {
4743
this.pathToExecutable = executablePath;
4844
fs.chmodSync(this.pathToExecutable, 0o777);
4945
}
50-
5146
if (cxScanConfig.baseUri) {
5247
this.baseUri = cxScanConfig.baseUri;
5348
}
54-
5549
if (cxScanConfig.tenant) {
5650
this.tenant = cxScanConfig.tenant;
5751
}
@@ -106,7 +100,6 @@ export class CxWrapper {
106100
}
107101
}
108102
});
109-
110103
const exec = new ExecutionService();
111104
return await exec.executeCommands(this.pathToExecutable, commands, CxConstants.SCAN_TYPE);
112105
}
@@ -121,7 +114,6 @@ export class CxWrapper {
121114
async scanShow(id: string): Promise<CxCommandOutput> {
122115
const commands: string[] = [CxConstants.CMD_SCAN, CxConstants.SUB_CMD_SHOW, CxConstants.SCAN_ID, id];
123116
commands.push(...this.initializeCommands(true));
124-
125117
const exec = new ExecutionService();
126118
return await exec.executeCommands(this.pathToExecutable, commands, CxConstants.SCAN_TYPE);
127119
}
@@ -130,7 +122,6 @@ export class CxWrapper {
130122
const validated_filters = this.filterArguments(filters);
131123
const commands: string[] = [CxConstants.CMD_SCAN, "list"].concat(validated_filters);
132124
commands.push(...this.initializeCommands(true));
133-
134125
const exec = new ExecutionService();
135126
return await exec.executeCommands(this.pathToExecutable, commands, CxConstants.SCAN_TYPE);
136127
}
@@ -139,7 +130,6 @@ export class CxWrapper {
139130
const validated_filters = this.filterArguments(filters);
140131
const commands: string[] = [CxConstants.CMD_PROJECT, "list"].concat(validated_filters);
141132
commands.push(...this.initializeCommands(true));
142-
143133
const exec = new ExecutionService();
144134
return await exec.executeCommands(this.pathToExecutable, commands, CxConstants.PROJECT_TYPE);
145135
}
@@ -149,15 +139,13 @@ export class CxWrapper {
149139
const validated_filters = this.filterArguments(CxConstants.BRANCH_NAME + filters)
150140
const commands: string[] = [CxConstants.CMD_PROJECT , CxConstants.SUB_CMD_BRANCHES, CxConstants.PROJECT_ID, projectId].concat(validated_filters);
151141
commands.push(...this.initializeCommands(false));
152-
153142
const exec = new ExecutionService();
154143
return await exec.executeCommands(this.pathToExecutable, commands, CxConstants.PROJECT_TYPE);
155144
}
156145

157146
async projectShow(projectId: string): Promise<CxCommandOutput> {
158147
const commands: string[] = [CxConstants.CMD_PROJECT, CxConstants.SUB_CMD_SHOW, CxConstants.PROJECT_ID,projectId];
159148
commands.push(...this.initializeCommands(true));
160-
161149
const exec = new ExecutionService();
162150
return await exec.executeCommands(this.pathToExecutable, commands, CxConstants.PROJECT_TYPE);
163151
}
@@ -184,14 +172,12 @@ export class CxWrapper {
184172

185173
async getResults(scanId: string, resultType:string, outputFileName: string, outputFilePath: string) {
186174
const commands = this.createResultCommand(scanId, resultType, outputFileName, outputFilePath)
187-
188175
const exec = new ExecutionService();
189176
return await exec.executeCommands(this.pathToExecutable, commands);
190177
}
191178

192179
createResultCommand(scanId: string, reportFormat: string, outputFileName: string, outputPath: string): string[] {
193180
const commands: string[] = [CxConstants.CMD_RESULT, CxConstants.SCAN_ID, scanId,CxConstants.REPORT_FORMAT , reportFormat];
194-
195181
if (outputFileName) {
196182
commands.push(CxConstants.OUTPUT_NAME);
197183
commands.push(outputFileName);
@@ -201,7 +187,6 @@ export class CxWrapper {
201187
commands.push(outputPath);
202188
}
203189
commands.push(...this.initializeCommands(false));
204-
205190
return commands;
206191
}
207192

‎src/main/wrapper/ExecutionService.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ export class ExecutionService {
5353
}
5454
});
5555
cp.stdout.on('close', (data: any) => {
56-
console.log("fim",output_string);
5756
logger.info(`${output_string.toString().trim()}`);
57+
// Check if the json is valid
5858
if (isJsonString(output_string.toString())) {
5959
let resultObject = JSON.parse(output_string.toString().split('\n')[0]);
6060
// Some cli outputs have array format, must be checked
@@ -96,6 +96,7 @@ export class ExecutionService {
9696
});
9797
});
9898
}
99+
99100
executeResultsCommands(pathToExecutable: string, commands: string[]): Promise<CxCommandOutput> {
100101
return new Promise(function (resolve, reject) {
101102
let stderr = '';
@@ -120,7 +121,6 @@ export class ExecutionService {
120121
}
121122

122123
async executeResultsCommandsFile(scanId: string, resultType: string, fileExtension: string,commands: string[], pathToExecutable: string,fileName:string): Promise<CxCommandOutput> {
123-
124124
const filePath = path.join(os.tmpdir(), fileName + fileExtension)
125125
let read = fs.readFileSync(filePath,'utf8');
126126
let cxCommandOutput = new CxCommandOutput();
@@ -136,7 +136,7 @@ export class ExecutionService {
136136
cxCommandOutput.status = "Error in the json file."
137137
}
138138
}
139-
// in case of html output
139+
// In case of html output
140140
else{
141141
let html_arrray:any = []
142142
html_arrray.push(read)

‎src/main/wrapper/loggerConfig.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { configure, getLogger } from 'log4js';
22

3-
// appenders
3+
// Appenders
44
configure({
55
appenders: {
66
console: { type: 'stdout', layout: { type: "messagePassThrough" } },
@@ -10,5 +10,5 @@ categories: {
1010
}
1111
});
1212

13-
// fetch logger and export
13+
// Fetch logger and export
1414
export const logger = getLogger();

‎src/tests/AuthTest.test.ts‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,23 @@ import {CxCommandOutput} from "../main/wrapper/CxCommandOutput";
33
import {CxScanConfig} from "../main/scan/CxScanConfig";
44
import {BaseTest} from "./BaseTest";
55

6-
76
describe("Authentication validation",() => {
8-
let cxScanConfig = new BaseTest();
7+
const cxScanConfig = new BaseTest();
98
it('Result authentication successful case', async () => {
109
const auth = new CxWrapper(cxScanConfig);
11-
const data = await auth.authValidate();
12-
const cxCommandOutput: CxCommandOutput = data
10+
const cxCommandOutput: CxCommandOutput = await auth.authValidate();
1311
expect(cxCommandOutput.exitCode).toBe(0);
1412
});
13+
1514
it('Result authentication failed case', async () => {
16-
let cxScanConfig_fail = new CxScanConfig();
15+
const cxScanConfig_fail = new CxScanConfig();
1716
cxScanConfig_fail.baseUri = "error";
1817
cxScanConfig_fail.clientId = "error";
1918
cxScanConfig_fail.clientSecret = "error";
2019
cxScanConfig_fail.tenant = process.env["CX_TENANT"];
2120
cxScanConfig_fail.apiKey = "error";
22-
2321
const auth = new CxWrapper(cxScanConfig_fail);
24-
const data = await auth.authValidate();
25-
const cxCommandOutput: CxCommandOutput = data;
22+
const cxCommandOutput: CxCommandOutput = await auth.authValidate();
2623
expect(cxCommandOutput.exitCode).toBe(1);
2724
});
2825
});

‎src/tests/ProjectTest.test.ts‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ import {BaseTest} from "./BaseTest";
44
import {CxParamType} from "../main/wrapper/CxParamType";
55

66
describe("ProjectList cases",() => {
7-
let cxScanConfig = new BaseTest();
8-
7+
const cxScanConfig = new BaseTest();
8+
let params = new Map();
99
it('ProjectList Successful case', async () => {
1010
const auth = new CxWrapper(cxScanConfig);
1111
const data = await auth.projectList("");
@@ -14,32 +14,28 @@ describe("ProjectList cases",() => {
1414
});
1515

1616
it('ProjectShow Successful case',async () =>{
17-
const params = new Map();
1817
params.set(CxParamType.PROJECT_NAME, "ast-cli-javascript-integration-success");
1918
params.set(CxParamType.S, "./src");
2019
params.set(CxParamType.FILTER, "*.ts,!**/node_modules/**/*");
2120
params.set(CxParamType.BRANCH, "master");
22-
23-
const auth = new CxWrapper(cxScanConfig);
24-
const data = await auth.scanCreate(params);
21+
let auth = new CxWrapper(cxScanConfig);
22+
let data = await auth.scanCreate(params);
2523
let cxCommandOutput: CxCommandOutput = data;
26-
const ScanObject = cxCommandOutput.payload.pop();
24+
let ScanObject = cxCommandOutput.payload.pop();
2725
cxCommandOutput = await auth.projectShow(ScanObject.ProjectID);
2826
console.log(" Json object from ProjectShow Successful case: " + JSON.stringify(cxCommandOutput));
2927
expect(cxCommandOutput.payload.length).toBeGreaterThan(0);
3028
});
3129

3230
it('ProjectBranches Successful case',async () =>{
33-
const params = new Map();
3431
params.set(CxParamType.PROJECT_NAME, "ast-cli-javascript-integration-success");
3532
params.set(CxParamType.S, "./src");
3633
params.set(CxParamType.FILTER, "*.ts,!**/node_modules/**/*");
3734
params.set(CxParamType.BRANCH, "master");
38-
39-
const auth = new CxWrapper(cxScanConfig);
40-
const data = await auth.scanCreate(params);
35+
let auth = new CxWrapper(cxScanConfig);
36+
let data = await auth.scanCreate(params);
4137
let cxCommandOutput: CxCommandOutput = data;
42-
const ScanObject = cxCommandOutput.payload.pop();
38+
let ScanObject = cxCommandOutput.payload.pop();
4339
cxCommandOutput = await auth.projectBranches(ScanObject.ProjectID,"");
4440
console.log("Json object from projectBranches Successful case: " + JSON.stringify(cxCommandOutput))
4541
expect(cxCommandOutput.payload.length).toBeGreaterThan(0);

‎src/tests/ResultTest.test.ts‎

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,39 @@ import {CxCommandOutput} from "../main/wrapper/CxCommandOutput";
33
import {BaseTest} from "./BaseTest";
44
import * as fs from "fs";
55

6-
76
describe("Results cases",() => {
8-
let cxScanConfig = new BaseTest();
7+
const cxScanConfig = new BaseTest();
98
it('Result Test Successful case', async () => {
109
const auth = new CxWrapper(cxScanConfig);
11-
const data = await auth.scanList("");
12-
const cxCommandOutput: CxCommandOutput = data
10+
const cxCommandOutput: CxCommandOutput = await auth.scanList("");
1311
let sampleId = cxCommandOutput.payload.pop().ID;
14-
await auth.getResults(sampleId,"json","jsonList", ".")
12+
await auth.getResults(sampleId,"json","jsonList", ".");
1513
const file = await fileExists("./jsonList.json");
1614
expect(file).toBe(true);
1715
});
1816

1917
it('Result List Successful case', async () => {
2018
const auth = new CxWrapper(cxScanConfig);
21-
const data = await auth.scanList("");
22-
const cxCommandOutput: CxCommandOutput = data
19+
const cxCommandOutput: CxCommandOutput = await auth.scanList("");
2320
let sampleId = cxCommandOutput.payload.pop().ID;
24-
const written = await auth.getResultsList(sampleId)
21+
const written = await auth.getResultsList(sampleId);
2522
expect(written.status).toEqual("");
2623
});
2724

2825
it('Result summary html file generation successful case', async () => {
2926
const auth = new CxWrapper(cxScanConfig);
30-
const data = await auth.scanList("");
31-
const cxCommandOutput: CxCommandOutput = data
27+
const cxCommandOutput: CxCommandOutput = await auth.scanList("");
3228
let sampleId = cxCommandOutput.payload.pop().ID;
33-
await auth.getResults(sampleId,"summaryHTML","test", ".")
29+
await auth.getResults(sampleId,"summaryHTML","test", ".");
3430
const file = await fileExists("./test.html");
3531
expect(file).toBe(true);
3632
});
3733

3834
it('Result summary html string successful case', async () => {
3935
const auth = new CxWrapper(cxScanConfig);
40-
const data = await auth.scanList("");
41-
const cxCommandOutput: CxCommandOutput = data
36+
const cxCommandOutput: CxCommandOutput = await auth.scanList("");
4237
let sampleId = cxCommandOutput.payload.pop().ID;
43-
const written = await auth.getResultsSummary(sampleId)
38+
const written = await auth.getResultsSummary(sampleId);
4439
expect(written.payload.length).toBeGreaterThan(0);
4540
});
4641

‎src/tests/ScanTest.test.ts‎

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,80 +4,65 @@ import {CxParamType} from "../main/wrapper/CxParamType";
44
import {BaseTest} from "./BaseTest";
55

66
describe("ScanCreate cases",() => {
7-
let cxScanConfig = new BaseTest();
7+
let params = new Map();
8+
const cxScanConfig = new BaseTest();
89
it('ScanCreate Successful case wait mode', async () => {
9-
const params = new Map();
1010
params.set(CxParamType.PROJECT_NAME, "ast-cli-javascript-integration-success");
1111
params.set(CxParamType.S, "./src");
1212
params.set(CxParamType.FILTER, "*.ts,!**/node_modules/**/*");
1313
params.set(CxParamType.BRANCH, "master");
14-
1514
const auth = new CxWrapper(cxScanConfig);
16-
const data = await auth.scanCreate(params);
17-
const cxCommandOutput: CxCommandOutput = data;
18-
const ScanObject = cxCommandOutput.payload.pop();
19-
const scanShowObject = await auth.scanShow(ScanObject.ID);
15+
const cxCommandOutput: CxCommandOutput = await auth.scanCreate(params);
16+
const scanObject = cxCommandOutput.payload.pop();
17+
const scanShowObject = await auth.scanShow(scanObject.ID);
2018
console.log(" Json object from successful wait mode case: " + JSON.stringify(scanShowObject));
2119
expect(scanShowObject.payload.pop().Status).toEqual("Completed");
2220
})
2321

2422
it('ScanCreate Successful case with Branch', async () => {
25-
const params = new Map();
2623
params.set(CxParamType.PROJECT_NAME, "ast-cli-javascript-integration-success-branch");
2724
params.set(CxParamType.S, "./src");
2825
params.set(CxParamType.FILTER, "*.ts,!**/node_modules/**/*");
2926
params.set(CxParamType.BRANCH, "master");
30-
3127
const auth = new CxWrapper(cxScanConfig);
32-
33-
const data = await auth.scanCreate(params);
34-
const cxCommandOutput: CxCommandOutput = data;
35-
const ScanObject = cxCommandOutput.payload.pop();
36-
const scanShowObject = await auth.scanShow(ScanObject.ID);
28+
const cxCommandOutput: CxCommandOutput = await auth.scanCreate(params);
29+
const scanObject = cxCommandOutput.payload.pop();
30+
const scanShowObject = await auth.scanShow(scanObject.ID);
3731
console.log(" Json object from successful wait mode case with branch: " +JSON.stringify(scanShowObject));
3832
expect(scanShowObject.payload.pop().Status).toEqual("Completed");
3933

4034
})
4135

4236
it('ScanCreate Failure case', async () => {
43-
const params = new Map();
4437
params.set(CxParamType.PROJECT_NAME, "ast-cli-javascript-integration-failure");
4538
params.set(CxParamType.S, "./src");
4639
params.set(CxParamType.SAST_PRESET_NAME, "Checkmarx Default Fake");
4740
params.set(CxParamType.BRANCH, "master");
48-
4941
const auth = new CxWrapper(cxScanConfig);
50-
51-
const data = await auth.scanCreate(params);
52-
const cxCommandOutput: CxCommandOutput = data;
53-
const ScanObject = cxCommandOutput.payload.pop();
54-
const scanShowObject = await auth.scanShow(ScanObject.ID);
42+
const cxCommandOutput: CxCommandOutput = await auth.scanCreate(params);
43+
const scanObject = cxCommandOutput.payload.pop();
44+
const scanShowObject = await auth.scanShow(scanObject.ID);
5545
console.log(" Json object from failure case: " + JSON.stringify(scanShowObject));
5646
expect(scanShowObject.payload.pop().Status).toEqual("Failed");
5747
})
5848

5949
it('ScanCreate Successful case no wait mode', async () => {
60-
const params = new Map();
6150
params.set(CxParamType.PROJECT_NAME, "ast-cli-javascript-integration-nowait");
6251
params.set(CxParamType.S, "./src");
6352
params.set(CxParamType.SAST_PRESET_NAME, "Checkmarx Default Fake");
6453
params.set(CxParamType.ADDITIONAL_PARAMETERS, "--async");
6554
params.set(CxParamType.BRANCH, "master");
66-
6755
const auth = new CxWrapper(cxScanConfig);
68-
69-
const data = await auth.scanCreate(params);
70-
const cxCommandOutput: CxCommandOutput = data;
71-
const ScanObject = cxCommandOutput.payload.pop();
72-
const scanShowObject = await auth.scanShow(ScanObject.ID);
56+
const cxCommandOutput: CxCommandOutput = await auth.scanCreate(params);
57+
const scanObject = cxCommandOutput.payload.pop();
58+
const scanShowObject = await auth.scanShow(scanObject.ID);
7359
console.log(" Json object from successful no wait mode case: " + JSON.stringify(scanShowObject))
7460
expect(scanShowObject.payload.pop().Status).toEqual("Running")
7561
})
7662

7763
it('ScanList Successful case', async () => {
7864
const auth = new CxWrapper(cxScanConfig);
79-
const data = await auth.scanList("");
80-
const cxCommandOutput: CxCommandOutput = data;
65+
const cxCommandOutput: CxCommandOutput = await auth.scanList("");
8166
expect(cxCommandOutput.payload.length).toBeGreaterThan(0);
8267
});
8368
});

0 commit comments

Comments
 (0)