Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes for report being created at a new location using the latest surefire plugin #347

Merged
merged 13 commits into from
Nov 21, 2024
Merged
74 changes: 58 additions & 16 deletions src/liberty/devCommands.ts
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 @@ -490,28 +490,30 @@ export async function openReport(reportType: string, libProject?: LibertyProject
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");
report = getReportFile(path, "reports", reportType + ".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);
/*
if its a maven project, check for the report in the initial path , else try for the alternate one and if it doesnt exist in both
display a prompt for its non existance
*/
if(libProject.getContextValue() === LIBERTY_MAVEN_PROJECT || libProject.getContextValue() === LIBERTY_MAVEN_PROJECT_CONTAINER){
console.log("report path ::"+report)
if(!await checkReportAndDisplay(report, reportType, reportTypeLabel, libProject, "reports")){
report = getReportFile(path, "site", reportType + "-report.html");
await checkReportAndDisplay(report, reportType, reportTypeLabel, libProject, "site")
}
});
/*
if its a gradle project, then check existance for the report in the path set and if not display prompt for its non existance
*/
}else
await checkReportAndDisplay(report, reportType, reportTypeLabel, libProject,"")

}
} else if (ProjectProvider.getInstance() && reportType) {
showProjects(reportType, openReport, reportType);
Expand Down Expand Up @@ -610,4 +612,44 @@ 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, directory : string) : 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 report in 'reports' and 'site', we only need to show the message if it is not
available in both the locations, below condition make sure to avoid the message when its a maven project and the directory
is 'reports'
*/
}else if(!((libProject.getContextValue() === LIBERTY_MAVEN_PROJECT || libProject.getContextValue() === LIBERTY_MAVEN_PROJECT_CONTAINER)
&& directory=="reports")){

const message = localize("test.report.does.not.exist.run.test.first", report);
vscode.window.showInformationMessage(message);
}
console.log("report available::"+exists);
resolve(exists);
});
});
}
18 changes: 12 additions & 6 deletions src/test/MavenTestDevModeActions.ts
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; // there should be a report available irrespective of the surefire versions we use , so either one needs to be true
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;
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;
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;
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
Loading