Skip to content

Commit

Permalink
Merge pull request #347 from JoshwinThomasIBM/issue340fix
Browse files Browse the repository at this point in the history 
Fixes for report being created at a new location using the latest surefire plugin
  • Loading branch information
@JoshwinThomasIBM
JoshwinThomasIBM authored Nov 21, 2024
2 parents 06bf3b1 + 1538e7b commit c659329
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 25 deletions.
73 changes: 54 additions & 19 deletions src/liberty/devCommands.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Copyright (c) 2020, 2022 IBM Corporation.
* Copyright (c) 2020, 2024 IBM Corporation.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
Expand Down Expand Up @@ -489,29 +489,27 @@ export async function openReport(reportType: string, libProject?: LibertyProject
const path = Path.dirname(libProject.getPath());
if (path !== undefined) {
let report: any;
if (libProject.getContextValue() === LIBERTY_MAVEN_PROJECT || libProject.getContextValue() === LIBERTY_MAVEN_PROJECT_CONTAINER) {
report = Path.join(path, "target", "site", reportType + "-report.html");
} else if (libProject.getContextValue() === LIBERTY_GRADLE_PROJECT || libProject.getContextValue() === LIBERTY_GRADLE_PROJECT_CONTAINER) {
report = await getGradleTestReport(libProject.path, path);
}
let reportTypeLabel = reportType;
if (reportType === "gradle") {
reportTypeLabel = "test";
}
fs.exists(report, (exists) => {
if (exists) {
const panel = vscode.window.createWebviewPanel(
reportType, // Identifies the type of the webview. Used internally
libProject.getLabel() + " " + reportTypeLabel + " report", // Title of the panel displayed to the user
vscode.ViewColumn.Two, // Open the panel in the second window
{}, // Webview options
);
panel.webview.html = getReport(report); // display HTML content
} else {
const message = localize("test.report.does.not.exist.run.test.first", report);
vscode.window.showInformationMessage(message);
let showErrorMessage: boolean = true;
if (libProject.getContextValue() === LIBERTY_MAVEN_PROJECT || libProject.getContextValue() === LIBERTY_MAVEN_PROJECT_CONTAINER) {
report = getReportFile(path, "reports", reportType + ".html");
// show the error message only if both "reports" and "site" dirs do not contain the test reports
// set to false since this will be the first location checked
showErrorMessage = false;
if (!await checkReportAndDisplay(report, reportType, reportTypeLabel, libProject, showErrorMessage)) {
report = getReportFile(path, "site", reportType + "-report.html");
// show the error message only if both "reports" and "site" dirs do not contain the test reports
// set to true since this will be the second location checked
showErrorMessage = true;
await checkReportAndDisplay(report, reportType, reportTypeLabel, libProject, showErrorMessage);
}
});
} else if (libProject.getContextValue() === LIBERTY_GRADLE_PROJECT || libProject.getContextValue() === LIBERTY_GRADLE_PROJECT_CONTAINER) {
report = await getGradleTestReport(libProject.path, path);
await checkReportAndDisplay(report, reportType, reportTypeLabel, libProject, showErrorMessage);
}
}
} else if (ProjectProvider.getInstance() && reportType) {
showProjects(reportType, openReport, reportType);
Expand Down Expand Up @@ -610,4 +608,41 @@ async function getLocalGradleWrapper(projectFolder: string): Promise<string | un
*/
function isWin(): boolean {
return process.platform.startsWith("win");
}

/*
will return the path of the report, since there are diffrent folders to look into and the file names can be different
we need to get the paths to look for dynamically
*/
function getReportFile(path: any, dir: string, filename: string): any {
return Path.join(path, "target", dir, filename);
}

/*
Function will check if the report is available within the given path and returns a boolean based on it and also
the report will be displayed if it is available
*/
function checkReportAndDisplay(report: any, reportType: string, reportTypeLabel: string, libProject: LibertyProject, showErrorMessage: boolean): Promise<boolean> {
return new Promise((resolve) => {
fs.exists(report, (exists) => {
if (exists) {
const panel = vscode.window.createWebviewPanel(
reportType, // Identifies the type of the webview. Used internally
libProject.getLabel() + " " + reportTypeLabel + " report", // Title of the panel displayed to the user
vscode.ViewColumn.Two, // Open the panel in the second window
{}, // Webview options
);
panel.webview.html = getReport(report); // display HTML content
/*
For Maven projects we need to check for the test report in the 'reports' and 'site' dirs.
We only need to show the message if it is not available in both locations.
The `showErrorMessage` flag will only be set to true when checking the second location.
*/
} else if (showErrorMessage) {
const message = localize("test.report.does.not.exist.run.test.first", report);
vscode.window.showInformationMessage(message);
}
resolve(exists);
});
});
}
18 changes: 12 additions & 6 deletions src/test/MavenTestDevModeActions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,10 @@ it('Run tests for sample maven project', async () => {
it('start maven with options from liberty dashboard', async () => {

const reportPath = path.join(utils.getMvnProjectPath(),"target","site","failsafe-report.html");
const deleteReport = await utils.deleteReports(reportPath);
expect (deleteReport).to.be.true;
const alternateReportPath = path.join(utils.getMvnProjectPath(), "target", "reports", "failsafe.html"); // new path to scan for the reports
let deleteReport = await utils.deleteReports(reportPath);
let deleteAlternateReport = await utils.deleteReports(alternateReportPath);
expect (deleteReport && deleteAlternateReport).to.be.true; // both report files should either not exist or be successfully deleted
await utils.launchDashboardAction(item, constants.START_DASHBOARD_ACTION_WITH_PARAM, constants.START_DASHBOARD_MAC_ACTION_WITH_PARAM);
await utils.setCustomParameter("-DhotTests=true");
await utils.delay(30000);
Expand All @@ -111,7 +113,8 @@ it('start maven with options from liberty dashboard', async () => {
{
console.log("Server succuessfully started");
let checkFile = await utils.checkIfTestReportExists(reportPath);
expect (checkFile).to.be.true;
let checkAlternateFile = await utils.checkIfTestReportExists(alternateReportPath);
expect (checkFile || checkAlternateFile).to.be.true; // check both potential locations for the test report, one of them must exist
await utils.launchDashboardAction(item, constants.STOP_DASHBOARD_ACTION, constants.STOP_DASHBOARD_MAC_ACTION);
const serverStopStatus= await utils.checkTerminalforServerState(constants.SERVER_STOP_STRING);
if(!serverStopStatus){
Expand All @@ -129,8 +132,10 @@ it('start maven with options from liberty dashboard', async () => {
it('start maven with history from liberty dashboard', async () => {

const reportPath = path.join(utils.getMvnProjectPath(),"target","site","failsafe-report.html");
const deleteReport = await utils.deleteReports(reportPath);
expect (deleteReport).to.be.true;
const alternateReportPath = path.join(utils.getMvnProjectPath(), "target", "reports", "failsafe.html");
let deleteReport = await utils.deleteReports(reportPath);
let deleteAlternateReport = await utils.deleteReports(alternateReportPath);
expect (deleteReport && deleteAlternateReport).to.be.true; // both report files should either not exist or be successfully deleted
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;
Expand All @@ -142,7 +147,8 @@ it('start maven with history from liberty dashboard', async () => {
{
console.log("Server succuessfully started");
let checkFile = await utils.checkIfTestReportExists(reportPath);
expect (checkFile).to.be.true;
let checkAlternateFile = await utils.checkIfTestReportExists(alternateReportPath);
expect (checkFile || checkAlternateFile).to.be.true; // check both potential locations for the test report, one of them must exist
await utils.launchDashboardAction(item, constants.STOP_DASHBOARD_ACTION, constants.STOP_DASHBOARD_MAC_ACTION);
const serverStopStatus= await utils.checkTerminalforServerState(constants.SERVER_STOP_STRING);
if(!serverStopStatus){
Expand Down

0 comments on commit c659329

Please sign in to comment.