Add screenshot archiving to Gradle tests, move logic to testUtils

Author: mattbsox

src/test/GradleTestDevModeActions.ts

@@ -7,6 +7,8 @@ import { InputBox, Workbench, SideBarView, ViewSection, EditorView, DefaultTreeI
 import * as utils from './utils/testUtils';
 import * as constants from './definitions/constants';
 import { logger } from './utils/testLogger';
+import * as fs from 'fs';
+import { VSBrowser } from 'vscode-extension-tester';
 import path = require('path');
 
 describe('Devmode action tests for Gradle Project', () => {
@@ -447,4 +449,11 @@ describe('Devmode action tests for Gradle Project', () => {
             throw error;
         }
     }).timeout(100000);
+
+    /**
+     * The following after hook copies the screenshot from the temporary folder in which it is saved to a known permanent location in the project folder.
+     */
+    after(() => {
+        utils.copyScreenshotsToProjectFolder('gradle');
+    });
 });

src/test/MavenTestDevModeActions.ts

@@ -468,36 +468,9 @@ describe('Devmode action tests for Maven Project', () => {
 
     /**
      * The following after hook copies the screenshot from the temporary folder in which it is saved to a known permanent location in the project folder.
-     * The MavenTestDevModeAction is the last test file that will be executed. Hence the after hook placed here
-     * ensures that all the screenshots will be copied to a known permanent location in the project folder.
      */
     after(() => {
-        const sourcePath = VSBrowser.instance.getScreenshotsDir();
-        const destinationPath = './screenshots';
-
-        copyFolderContents(sourcePath, destinationPath);
+        utils.copyScreenshotsToProjectFolder('maven');
     });
-
-    function copyFolderContents(sourceFolder: string, destinationFolder: string): void {
-        if (!fs.existsSync(sourceFolder)) {
-            return;
-        }
-
-        if (!fs.existsSync(destinationFolder)) {
-            fs.mkdirSync(destinationFolder);
-        }
-
-        const files = fs.readdirSync(sourceFolder);
-        for (const file of files) {
-            const sourcePath = path.join(sourceFolder, file);
-            const destinationPath = path.join(destinationFolder, file);
-
-            if (fs.statSync(sourcePath).isDirectory()) {
-                copyFolderContents(sourcePath, destinationPath);
-            } else {
-                fs.copyFileSync(sourcePath, destinationPath);
-            }
-        }
-    }
 });
 

src/test/utils/testUtils.ts

@@ -182,4 +182,44 @@ export async function clearCommandPalette() {
     const buttons = await dialog.getButtons();
     expect(buttons.length).equals(2);
     await dialog.pushButton('Clear');
+}
+
+/**
+ * Copies screenshots from the temporary VSCode screenshots directory to a permanent location
+ * organized by build tool (maven or gradle).
+ * @param buildTool The build tool name ('maven' or 'gradle') to organize screenshots
+ */
+export function copyScreenshotsToProjectFolder(buildTool: string): void {
+    const VSBrowser = require('vscode-extension-tester').VSBrowser;
+    const sourcePath = VSBrowser.instance.getScreenshotsDir();
+    const destinationPath = path.join('./screenshots', buildTool);
+
+    copyFolderContents(sourcePath, destinationPath);
+}
+
+/**
+ * Recursively copies all files from source folder to destination folder.
+ * @param sourceFolder Source directory path
+ * @param destinationFolder Destination directory path
+ */
+function copyFolderContents(sourceFolder: string, destinationFolder: string): void {
+    if (!fs.existsSync(sourceFolder)) {
+        return;
+    }
+
+    if (!fs.existsSync(destinationFolder)) {
+        fs.mkdirSync(destinationFolder, { recursive: true });
+    }
+
+    const files = fs.readdirSync(sourceFolder);
+    for (const file of files) {
+        const sourcePath = path.join(sourceFolder, file);
+        const destinationPath = path.join(destinationFolder, file);
+
+        if (fs.statSync(sourcePath).isDirectory()) {
+            copyFolderContents(sourcePath, destinationPath);
+        } else {
+            fs.copyFileSync(sourcePath, destinationPath);
+        }
+    }
 }