Skip to content

Commit 87967b4

Browse files
committed
Chat command and constants, non functional test with usage example
1 parent 96c65a9 commit 87967b4

5 files changed

Lines changed: 84 additions & 1 deletion

File tree

‎src/main/chat/CxChat.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
export default class CxChat {
2+
conversationId: string;
3+
responses: string[];
4+
5+
constructor(conversationId: string, responses: string[]) {
6+
this.conversationId = conversationId;
7+
this.responses = responses;
8+
}
9+
10+
static parseChat(resultObject: any): CxChat {
11+
return new CxChat(resultObject.conversationId, resultObject.response);
12+
}
13+
}

‎src/main/wrapper/CxConstants.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ export enum CxConstants {
4343
CMD_KICS_REALTIME = "kics-realtime",
4444
CMD_SCA_REALTIME = "sca-realtime",
4545
CMD_SCA_REALTIME_PROJECT_DIR = "--project-dir",
46+
CMD_CHAT = "chat",
47+
CMD_CHAT_APIKEY = "--chat-apikey",
48+
CMD_CHAT_FILE = "--result-file",
49+
CMD_CHAT_LINE = "--result-line",
50+
CMD_CHAT_SEVERITY = "--result-severity",
51+
CMD_CHAT_VULNERABILITY = "--result-vulnerability",
52+
CMD_CHAT_INPUT = "--user-input",
53+
CMD_CHAT_CONVERSATION_ID = "--conversation-id",
54+
CMD_CHAT_MODEL = "--model",
4655
SCAN_INFO_FORMAT = "--scan-info-format",
4756
FORMAT = "--format",
4857
FORMAT_JSON = "json",
@@ -70,6 +79,7 @@ export enum CxConstants {
7079
CODE_BASHING_TYPE = "CxCodeBashing",
7180
KICS_REALTIME_TYPE = "CxKicsRealTime",
7281
SCA_REALTIME_TYPE = "CxScaRealTime",
82+
CHAT_TYPE = "CxChat",
7383
LEARN_MORE_DESCRIPTIONS_TYPE = "CxLearnMoreDescriptions",
7484
KICS_REMEDIATION_TYPE = "CxKicsRemediation",
7585
BFL_TYPE = "CxBFL",

‎src/main/wrapper/CxWrapper.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,26 @@ export class CxWrapper {
299299
return output.has(CxConstants.IDE_SCANS_KEY) && output.get(CxConstants.IDE_SCANS_KEY).toLowerCase() === " true";
300300
}
301301

302+
async chat(apikey: string, file: string, line: number, severity: string, vulnerability: string, input: string, conversationId?: string, model?: string): Promise<CxCommandOutput> {
303+
const commands: string[] = [
304+
CxConstants.CMD_CHAT,
305+
CxConstants.CMD_CHAT_APIKEY, apikey,
306+
CxConstants.CMD_CHAT_FILE, file,
307+
CxConstants.CMD_CHAT_LINE, line.toString(),
308+
CxConstants.CMD_CHAT_SEVERITY, severity,
309+
CxConstants.CMD_CHAT_VULNERABILITY, vulnerability,
310+
CxConstants.CMD_CHAT_INPUT, input,
311+
];
312+
if (!!conversationId) {
313+
commands.push(CxConstants.CMD_CHAT_CONVERSATION_ID, conversationId)
314+
}
315+
if (!!model) {
316+
commands.push(CxConstants.CMD_CHAT_MODEL, model)
317+
}
318+
commands.push(...this.initializeCommands(false));
319+
return new ExecutionService().executeCommands(this.config.pathToExecutable, commands, CxConstants.CHAT_TYPE);
320+
}
321+
302322
prepareAdditionalParams(additionalParameters: string) : string[] {
303323
const params: string[] = [];
304324

‎src/main/wrapper/ExecutionService.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import CxNode from "../results/CxNode";
2020
import CxPackageData from "../results/CxPackageData";
2121
import CxKicsRemediation from "../remediation/CxKicsRemediation";
2222
import CxScaRealTime from "../scaRealtime/CxScaRealTime";
23+
import CxChat from "../chat/CxChat";
2324

2425

2526
function isJsonString(s: string) {
@@ -209,7 +210,11 @@ export class ExecutionService {
209210
const kicsRemediationOutput = CxKicsRemediation.parseKicsRemediation(resultObject)
210211
cxCommandOutput.payload = [kicsRemediationOutput]
211212
break;
212-
default:
213+
case CxConstants.CHAT_TYPE:
214+
const chatOutput = CxChat.parseChat(resultObject)
215+
cxCommandOutput.payload = [chatOutput]
216+
break;
217+
default:
213218
cxCommandOutput.payload = resultObject;
214219
}
215220
}

‎src/tests/ChatTest.test.ts‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
import {CxWrapper} from '../main/wrapper/CxWrapper';
2+
import {CxCommandOutput} from "../main/wrapper/CxCommandOutput";
3+
import {BaseTest} from "./BaseTest";
4+
import CxChat from "../main/chat/CxChat";
5+
6+
describe("Chat", () => {
7+
it('Try call', async () => {
8+
const config = new BaseTest();
9+
config.pathToExecutable = "path\\to\\cli\\dev\\build"
10+
const wrapper = new CxWrapper(config);
11+
let cxCommandOutput: CxCommandOutput = await wrapper.chat(
12+
"apikey",
13+
"path\\to\\result\\file",
14+
3,
15+
"MEDIUM",
16+
"Security Opt Not Set",
17+
"Explain the result",
18+
null,
19+
"gpt-3.5-turbo"
20+
);
21+
expect(cxCommandOutput.exitCode).toBe(0);
22+
const output: CxChat = cxCommandOutput.payload.pop();
23+
cxCommandOutput = await wrapper.chat(
24+
"apikey",
25+
"path\\to\\result\\file",
26+
3,
27+
"MEDIUM",
28+
"Security Opt Not Set",
29+
"Can you provide a snippet with the fix?",
30+
output.conversationId,
31+
"gpt-3.5-turbo"
32+
);
33+
expect(cxCommandOutput.exitCode).toBe(0);
34+
});
35+
});

0 commit comments

Comments
 (0)