[BUG] SARIF report is not generated for server on local host #340 (#344)

- fogging unification for local/remote scenario
- global refactoring with renaming
- remmove wrong plugin dependences

Author: alexey-utkin

server/src/SARIFGenerator.cpp

@@ -47,7 +47,7 @@ namespace sarif {
     void sarifAddTestsToResults(const utbot::ProjectContext &projectContext,
                                 const Tests &tests,
                                 json &results) {
-        LOG_S(INFO) << "{stack";
+        LOG_SCOPE_FUNCTION(DEBUG);
         for (const auto &it : tests.methods) {
             for (const auto &methodTestCase : it.second.testCases) {
                 json result;
@@ -180,11 +180,9 @@ namespace sarif {
                 }
             }
         }
-        LOG_S(INFO) << "}stack";
     }
 
     std::string sarifPackResults(const json &results) {
-        // POINT 3
         json sarifJson;
         sarifJson["$schema"] = "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.5.json";
         sarifJson["version"] = "2.1.0";

server/src/streams/tests/ServerTestsWriter.cpp

@@ -48,9 +48,9 @@ bool ServerTestsWriter::writeFileAndSendResponse(const tests::Tests &tests,
         testSource->set_filepath(tests.testSourceFilePath);
         if (synchronizeCode) {
             testSource->set_code(tests.code);
-            testSource->set_errormethodsnumber(tests.errorMethodsNumber);
-            testSource->set_regressionmethodsnumber(tests.regressionMethodsNumber);
         }
+        testSource->set_errormethodsnumber(tests.errorMethodsNumber);
+        testSource->set_regressionmethodsnumber(tests.regressionMethodsNumber);
 
         auto testHeader = response.add_testsources();
         testHeader->set_filepath(tests.testHeaderFilePath);
@@ -69,19 +69,18 @@ void ServerTestsWriter::writeReport(const std::string &content,
                                     const std::string &message,
                                     const fs::path &pathToStore) const
 {
-    if (synchronizeCode || fs::exists(pathToStore)) {
-        testsgen::TestsResponse response;
-        if (synchronizeCode) {
-            TestsWriter::writeReport(content, message, pathToStore);
-        }
-        auto testSource = response.add_testsources();
-        testSource->set_filepath(pathToStore);
-        if (synchronizeCode) {
-            testSource->set_code(content);
-        }
-        LOG_S(INFO) << message;
-        auto progress = GrpcUtils::createProgress(message, 100, false);
-        response.set_allocated_progress(progress.release());
-        writeMessage(response);
+    testsgen::TestsResponse response;
+    TestsWriter::writeReport(content, message, pathToStore);
+
+    auto testSource = response.add_testsources();
+    testSource->set_filepath(pathToStore);
+    if (synchronizeCode) {
+        // write the content only for real data transfer
+        // `synchronizeCode` is false if client and server share the same FS
+        testSource->set_code(content);
     }
+    LOG_S(INFO) << message;
+    auto progress = GrpcUtils::createProgress(message, 100, false);
+    response.set_allocated_progress(progress.release());
+    writeMessage(response);
 }

vscode-plugin/package.json

@@ -580,9 +580,5 @@
 		"randomstring": "1.2.2",
 		"source-map-support": "0.5.21",
 		"typescript": "3.9.4"
-	},
-	"extensionPack": [
-		"Natizyskunk.sftp",
-		"MS-SarifVSCode.sarif-viewer"
-	] 
+	}
 }

vscode-plugin/src/responses/responseHandler.ts

@@ -28,91 +28,110 @@ export class TestsResponseHandler implements ResponseHandler<TestsResponse> {
     constructor(
         private readonly client: Client,
         private readonly testsRunner: TestsRunner,
-        private readonly batched: boolean) {
+        private readonly generateForMultipleSources: boolean) {
     }
 
     public async handle(response: TestsResponse): Promise<void> {
         const testsSourceList = response.getTestsourcesList();
 
-        testsSourceList.forEach(testsSourceInfo => {
-            this.testsRunner.testResultsVizualizer.clearTestsByTestFileName(testsSourceInfo.getFilepath(), false);
-        });
+        // Delete/backup old info
+        for (const test of testsSourceList) {
+            const localPath = pathUtils.substituteLocalPath(test.getFilepath());
+            if (isSarifReportFile(localPath)) {
+                if (Prefs.isRemoteScenario()) {
+                    // do not back up the SARIF for local scenario - server did it
+                    await backupPreviousClientSarifReport(localPath);
+                }
+            }
+            else {
+                this.testsRunner.testResultsVizualizer.removeFileFromData(localPath, false);
+            }
+        }
+
+        // Transfer files' code if need
         if (Prefs.isRemoteScenario()) {
+            //  do not write files for local scenario - server did it
             const stubs = response.getStubs();
             if (stubs) {
                 const stubsFiles = stubs.getStubsourcesList();
-                await Promise.all(stubsFiles.map(async (stub) => {
+                for (const stub of stubsFiles) {
                     const localPath = pathUtils.substituteLocalPath(stub.getFilepath());
-                    const stubfile = vs.Uri.file(localPath);
                     logger.info(`Write stub file ${stub.getFilepath()} to ${localPath}`);
-                    await vs.workspace.fs.writeFile(stubfile, Buffer.from(stub.getCode()));
-                }));
+                    await vs.workspace.fs.writeFile(vs.Uri.file(localPath), Buffer.from(stub.getCode()));
+                }
             }
-            await Promise.all((testsSourceList).map(async (test) => {
+            for (const test of testsSourceList) {
                 const localPath = pathUtils.substituteLocalPath(test.getFilepath());
-                const testfile = vs.Uri.file(localPath);
-                
-                if (isTestFileSourceFile(testfile)) {
+                await vs.workspace.fs.writeFile(vs.Uri.file(localPath), Buffer.from(test.getCode()));
+            }
+        }
+
+        // Show and log the results in UI
+        {
+            let firstTest = true;
+            const SarifReportFiles = [];
+            for (const test of testsSourceList) {
+                const localPath = pathUtils.substituteLocalPath(test.getFilepath());
+
+                if (isSarifReportFile(localPath)) {
+                    logger.info(`Generated SARIF file ${localPath}`);
+                    SarifReportFiles.push(vs.Uri.file(localPath));
+                } else if (isTestFileSourceFile(localPath)) {
                     const testsNumberInErrorSuite = test.getErrormethodsnumber();
                     const testsNumberInRegressionSuite = test.getRegressionmethodsnumber();
                     logger.info(`Generated test file ${localPath} with ${testsNumberInRegressionSuite} tests in regression suite and ${testsNumberInErrorSuite} tests in error suite`);
+                    if (!this.generateForMultipleSources && firstTest) {
+                        // show generated test file for line, class, function, single source file
+                        firstTest = false;
+                        await vs.window.showTextDocument(vs.Uri.file(localPath), {preview: false});
+                    }
                 } else {
                     logger.info(`Generated test file ${localPath}`);
                 }
-
-                const isSarifReport = testfile.path.endsWith("project_code_analysis.sarif");
-                if (isSarifReport && fs.existsSync(testfile.fsPath)) {
-                    const ctime = fs.lstatSync(testfile.fsPath).ctime;
-
-                    // eslint-disable-next-line no-inner-declarations
-                    function pad2(num: number): string {
-                        return ("0" + num).slice(-2);
+            }
+            if (SarifReportFiles.length > 0) {
+                const sarifExt = vs.extensions.getExtension(messages.defaultSARIFViewer);
+                // eslint-disable-next-line eqeqeq
+                if (sarifExt == null) {
+                    messages.showWarningMessage(messages.intstallSARIFViewer);
+                } else {
+                    if (!sarifExt.isActive) {
+                        await sarifExt.activate();
                     }
-
-                    const newName = "project_code_analysis-"
-                    + ctime.getFullYear()
-                    + pad2(ctime.getMonth() + 1)
-                    + pad2(ctime.getDate())
-                    + pad2(ctime.getHours())
-                    + pad2(ctime.getMinutes())
-                    + pad2(ctime.getSeconds())
-                    + ".sarif";
-                    await vs.workspace.fs.rename(testfile, Uri.file(path.join(path.dirname(testfile.fsPath), newName)));
-                }
-
-                await vs.workspace.fs.writeFile(testfile, Buffer.from(test.getCode()));
-                if (isSarifReport) {
-                    const sarifExt = vs.extensions.getExtension(messages.defaultSARIFViewer);
-                    // eslint-disable-next-line eqeqeq
-                    if (sarifExt == null) {
-                        messages.showWarningMessage(messages.intstallSARIFViewer);
-                    } else {
-                        if (!sarifExt.isActive) {
-                            await sarifExt.activate();
-                        }
-                        await sarifExt.exports.openLogs([
-                            testfile,
-                        ]);    
-                    }                 
-                }
-                return testfile;
-            }));
-        }
-        if (!this.batched) {
-            const localPaths = testsSourceList.map(testsSourceInfo => pathUtils.substituteLocalPath(testsSourceInfo.getFilepath()));
-            if (localPaths.length > 0) {
-                const cppLocalPaths = localPaths.filter(fileName => fileName.endsWith('_test.cpp'));
-                if (cppLocalPaths.length > 0) {
-                    const fileToOpen = vs.Uri.file(cppLocalPaths[0]);
-                    await vs.window.showTextDocument(fileToOpen, { preview: false });
+                    sarifExt.exports.openLogs(SarifReportFiles);
                 }
             }
         }
     }
 }
 
-function isTestFileSourceFile(testfile: any): boolean {
-    return testfile.path.endsWith('_test.cpp');
+function isSarifReportFile(testfile: string): boolean {
+    return testfile.endsWith("project_code_analysis.sarif");
+}
+
+async function backupPreviousClientSarifReport(localPath: string): Promise<void> {
+    if (fs.existsSync(localPath)) {
+        const ctime = fs.lstatSync(localPath).ctime;
+
+        // eslint-disable-next-line no-inner-declarations
+        function pad2(num: number): string {
+            return ("0" + num).slice(-2);
+        }
+
+        const newName = "project_code_analysis-"
+            + ctime.getFullYear()
+            + pad2(ctime.getMonth() + 1)
+            + pad2(ctime.getDate())
+            + pad2(ctime.getHours())
+            + pad2(ctime.getMinutes())
+            + pad2(ctime.getSeconds())
+            + ".sarif";
+        await vs.workspace.fs.rename(vs.Uri.file(localPath), Uri.file(path.join(path.dirname(localPath), newName)));
+    }
+}
+
+function isTestFileSourceFile(localpath: string): boolean {
+    return localpath.endsWith('_test.cpp');
 }
 
 export class SnippetResponseHandler implements ResponseHandler<TestsResponse> {
@@ -133,5 +152,4 @@ export class SnippetResponseHandler implements ResponseHandler<TestsResponse> {
                 await vs.window.showTextDocument(doc, { preview: false });
             });
     }
-
 }

vscode-plugin/src/visualizers/testResultsVisualizer.ts

@@ -35,14 +35,14 @@ export class TestResultsVisualizer implements Visualizer, DataLoader<TestResultO
         });
         vs.workspace.onDidDeleteFiles((event) => {
             event.files.forEach(fileUri => {
-                this.clearTestsByTestFileName(fileUri.fsPath);
+                this.removeFileFromData(fileUri.fsPath);
             });
         });
         vs.workspace.onDidChangeTextDocument((event) => {
             this.editors.forEach((editor) => {
                 if (editor.document.uri === event.document.uri) {
                     this.hide(editor);
-                    this.clearEditorTests(editor);
+                    this.removeFileFromData(editor.document.fileName, false);
                 }
             });
         });
@@ -80,15 +80,11 @@ export class TestResultsVisualizer implements Visualizer, DataLoader<TestResultO
         this.testsWithStatuses = [];
     }
 
-    public clearEditorTests(editor: vs.TextEditor): void {
-        this.clearTestsByTestFileName(editor.document.fileName, false);
-    }
+    public removeFileFromData(localFileName: string, canBeFolder: boolean = true): void {
+        const serverFileName = Prefs.isRemoteScenario()
+           ? pathUtils.substituteRemotePath(localFileName)
+           : localFileName;
 
-    public clearTestsByTestFileName(filename: string, canBeFolder: boolean = true): void {
-        let serverFileName = filename;
-        if (Prefs.isRemoteScenario()) {
-            serverFileName = pathUtils.substituteRemotePath(serverFileName);
-        }
         if (canBeFolder) {
             this.testsWithStatuses = this.testsWithStatuses.filter(test => !test.testInfo.filePath.startsWith(serverFileName));
         } else {