Added a single method to modify and revert pom file

Author: JoshwinThomasIBM

src/test/MavenTestDevModeActions.ts

@@ -225,7 +225,7 @@ it('View Integration test report for maven project', async () => {
 it('Run tests for sample maven project with surefire version 3.4.0', async () => {
 
   await utils.clearMavenPluginCache();// Clears the cache to ensure the specific surefire versions are downloaded for the next test
-  await utils.modifyPomFile();// Modifies pom.xml to inlcude surefire version 3.4.0
+  await utils.modifyFileContent(constants.MAVEN_TEST_WRAPPER_APP_POM_PATH, constants.COMMENT_REGEX, constants.SUREFIRE_3_4_0_PLUGIN_CONTENT);// Modifies pom.xml to inlcude surefire version 3.4.0
   await utils.launchDashboardAction(item, constants.START_DASHBOARD_ACTION_WITH_PARAM, constants.START_DASHBOARD_MAC_ACTION_WITH_PARAM);
   const foundCommand = await utils.chooseCmdFromHistory("-DhotTests=true");
   expect(foundCommand).to.be.true;
@@ -237,7 +237,7 @@ it('Run tests for sample maven project with surefire version 3.4.0', async () =>
     console.log("Server succuessfully started");
     await utils.launchDashboardAction(item, constants.STOP_DASHBOARD_ACTION, constants.STOP_DASHBOARD_MAC_ACTION);
     const serverStopStatus = await utils.checkTerminalforServerState(constants.SERVER_STOP_STRING);
-    await utils.revertPomFile();// Removes specific verison of the surefire plugin added in pom file for testing
+    await utils.modifyFileContent(constants.MAVEN_TEST_WRAPPER_APP_POM_PATH, constants.PLUGIN_BLOCK_REGEX,constants.POM_COMMENT);// Removes specific verison of the surefire plugin added in pom file for testing
     await utils.clearMavenPluginCache();// Clear the plugin cache to remove the current versions and ensure the latest plugins are used for the next tests.
     if (!serverStopStatus) {
       console.error("Server stopped message not found in the terminal");

src/test/definitions/constants.ts

@@ -47,4 +47,15 @@ export const SITE = "site";
 export const FAILSAFE_HTML = "failsafe.html";
 export const SUREFIRE_HTML = "surefire.html";
 export const SUREFIRE_REPORT_HTML ="surefire-report.html";
-export const FAILSAFE_REPORT_HTML ="failsafe-report.html";
+export const FAILSAFE_REPORT_HTML ="failsafe-report.html";
+export const COMMENT_REGEX = /<!--\s*Test report insertion point, do not remove\s*-->/;
+export const PLUGIN_BLOCK_REGEX = /<!--\s*replace this content\s*-->([\s\S]*?)<!--\s*replace this content end\s*-->/;
+export const SUREFIRE_3_4_0_PLUGIN_CONTENT = `<!-- replace this content -->
+                                                 <plugin>
+                                                    <groupId>org.apache.maven.plugins</groupId>
+                                                    <artifactId>maven-surefire-report-plugin</artifactId>
+                                                    <version>3.4.0</version>
+                                                 </plugin>
+                                              <!-- replace this content end -->`;
+export const POM_COMMENT = '<!-- Test report insertion point, do not remove -->';
+export const MAVEN_TEST_WRAPPER_APP_POM_PATH = 'src/test/resources/maven/liberty.maven.test.wrapper.app/pom.xml'; 

src/test/utils/testUtils.ts

@@ -232,65 +232,30 @@ export async function removeDirectoryByPath(projectPath: string): Promise<void>
   }
 }
 
-// Function to modify content inside pom XML to add surefire version 3.4.0 plugin
-export async function modifyPomFile() {
-  //Read the POM file
-  fs.readFile('src/test/resources/maven/liberty.maven.test.wrapper.app/pom.xml', 'utf8', (err, data) => {
+// General function to modify any file content using RegExp for searching
+export async function modifyFileContent(filePath: string, searchPattern: RegExp, replaceString: string) {
+  // Read the file
+  fs.readFile(filePath, 'utf8', (err, data) => {
     if (err) {
-      console.log('Error reading the file:', err);
       console.error('Error reading the file:', err);
       return;
     }
-    //Find the specific comment and replace its content
-    const commentRegex = /<!--\s*Test report insertion point, do not remove\s*-->/;
-    const newContent = `<plugin>
-                                <groupId>org.apache.maven.plugins</groupId>
-                                <artifactId>maven-surefire-report-plugin</artifactId>
-                                <version>3.4.0</version>
-                          </plugin>`;
-    // Check if the comment is found
-    if (commentRegex.test(data)) {
-      const updatedData = data.replace(commentRegex, `<!-- replace this content -->\n${newContent}\n<!-- replace this content end -->`);
-      //Write the modified content back to the POM file
-      fs.writeFile('src/test/resources/maven/liberty.maven.test.wrapper.app/pom.xml', updatedData, 'utf8', (err) => {
-        if (err) {
-          console.log('Error writing to the file:', err);
-          console.error('Error writing to the file:', err);
-        } else {
-          console.log('POM file updated successfully');
-        }
-      });
-    } else {
-      console.log('Comment with the specified marker not found in the POM file');
-    }
-  });
-}
- 
-// Function to revert changes made on the pom file for including surefire 3.4.0 
-export async function revertPomFile() {
-  //path to pom.xml in the test project
-  const pomFilePath = 'src/test/resources/maven/liberty.maven.test.wrapper.app/pom.xml';
-  //Read the POM file
-  fs.readFile(pomFilePath, 'utf8', (err, data) => {
-    if (err) {
-      console.error('Error reading the file:', err);
-      return;
-    }
-    //Find the inserted plugin block and revert it back to the original comment
-    const pluginBlockRegex = /<!--\s*replace this content\s*-->([\s\S]*?)<!--\s*replace this content end\s*-->/;
-    // Check if the inserted plugin block exists
-    if (pluginBlockRegex.test(data)) {
-      const revertedData = data.replace(pluginBlockRegex, `<!-- Test report insertion point, do not remove -->`);
-      //Write the reverted content back to the POM file
-      fs.writeFile(pomFilePath, revertedData, 'utf8', (err) => {
+
+    // Check if the searchPattern matches any content in the file
+    if (searchPattern.test(data)) {
+      // Replace the matched content with the replaceString
+      const updatedData = data.replace(searchPattern, replaceString);
+
+      // Write the modified content back to the file
+      fs.writeFile(filePath, updatedData, 'utf8', (err) => {
         if (err) {
           console.error('Error writing to the file:', err);
         } else {
-          console.log('POM file reverted successfully');
+          console.log('File updated successfully');
         }
       });
     } else {
-      console.log('Plugin block not found, nothing to revert.');
+      console.log(`The pattern "${searchPattern}" was not found in the file.`);
     }
   });
 }