Fixes #282 - project detection in dashboard

package.json

@@ -240,7 +240,11 @@
 		"buildJakarta": "gulp buildJakartaJdt buildJakartaLs",
 		"test": "npm run test-compile && extest setup-and-run -o .vscode/settings.json 'out/test/*.js'",
 		"test-mac-maven":"npm run test-compile && extest setup-and-run -o .vscode/settings.json 'out/test/M*.js'",
-		"test-mac-gradle": "npm run test-compile && extest setup-and-run -o .vscode/settings.json 'out/test/G*.js'"
+		"test-mac-gradle": "npm run test-compile && extest setup-and-run -o .vscode/settings.json 'out/test/G*.js'",
+		"test-mac-dashboard": "npm run test-compile && extest setup-and-run -o .vscode/settings.json 'out/test/Liberty*.js'",
+		"test-mac-LMP-dashboard": "npm run test-compile && extest setup-and-run -o .vscode/settings.json 'out/test/DashboardLMP*.js'",
+		"test-mac-LGP-dashboard": "npm run test-compile && extest setup-and-run -o .vscode/settings.json 'out/test/DashboardLGP*.js'"
+
 	},
 	"devDependencies": {
 		"@types/chai": "^4.3.4",

src/test/DashboardLGPInitProjects.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) 2023 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
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+import { WebDriver, VSBrowser } from 'vscode-extension-tester';
+import * as utils from './utils/testUtils';
+
+describe('Open Gradle Project', () => {
+
+    let driver: WebDriver;
+
+    before(() => {
+
+        driver = VSBrowser.instance.driver;
+
+    });
+
+    it('Open Sample Gradle Project with no server.xml', async () => {
+
+        await VSBrowser.instance.openResources(utils.getGradleProjectPath());
+
+    }).timeout(15000);
+
+});
+
+

src/test/DashboardLGPTest.ts

@@ -0,0 +1,111 @@
+/**
+ * Copyright (c) 2023 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
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+import { expect } from 'chai';
+import { InputBox, Workbench, SideBarView, ViewItem, ViewSection, EditorView, DefaultTreeItem, DebugView } from 'vscode-extension-tester';
+import * as utils from './utils/testUtils';
+import * as constants from './definitions/constants';
+import path = require('path');
+
+describe('Devmode action tests for Gradle Project', () => {
+  let sidebar: SideBarView;
+  let section: ViewSection;
+  let item: DefaultTreeItem;
+
+  before(() => {
+    sidebar = new SideBarView();
+  });
+
+  /*************************************************************************************
+  ** detect project with LGP config in build file only (ie. no server.xml in project)  **        
+  *************************************************************************************/
+
+  //buildscript + apply plugin method
+
+  it('Delete server.xml from config.', async () => {
+
+    const dest = path.join(utils.getGradleProjectPath(), "src", "main", "liberty", "config", "server.xml");
+    const deleteServerxml = await utils.deleteReports(dest);
+    expect(deleteServerxml).to.be.true;
+
+  }).timeout(80000);
+
+  it('getViewControl works with the correct label', async () => {
+
+    const contentPart = sidebar.getContent();
+    section = await contentPart.getSection('Liberty Dashboard');
+    console.log("Found Liberty Dashboard....");
+    expect(section).not.undefined;
+
+  }).timeout(10000);
+
+  it('Open dasboard shows items - Gradle', async () => {
+
+    await utils.delay(80000);
+    const menu = await section.getVisibleItems();
+    expect(menu).not.empty;
+    item = await section.findItem(constants.GRADLE_PROJECT) as DefaultTreeItem;
+    expect(item).not.undefined;
+
+  }).timeout(300000);
+
+
+
+  // plugins block method
+   it('Copy gradle.build file which uses plugins block method.', async () => {
+
+    await utils.delay(50000);
+    const serverxmlPath = path.join(utils.getGradleProjectPath(), "gradlefile", "build1.gradle");
+    const dest = path.join(utils.getGradleProjectPath(), "build.gradle");
+    await utils.copyFile(serverxmlPath, dest);
+    console.log("Finished copying file....");
+
+  }).timeout(90000);
+
+  it('getViewControl works with the correct label', async () => {
+
+    const contentPart = sidebar.getContent();
+    section = await contentPart.getSection('Liberty Dashboard');
+    console.log("Found Liberty Dashboard....");
+    expect(section).not.undefined;
+
+  }).timeout(10000);
+
+  it('Open dasboard shows items - Gradle', async () => {
+
+    await utils.delay(80000);
+    const menu = await section.getVisibleItems();
+    expect(menu).not.empty;
+    item = await section.findItem(constants.GRADLE_PROJECT) as DefaultTreeItem;
+    expect(item).not.undefined;
+
+  }).timeout(300000);
+
+  it('Copy gradle.build file which uses buildscript + apply plugin method.', async () => {
+
+    await utils.delay(50000);
+    const serverxmlPath = path.join(utils.getGradleProjectPath(), "gradlefile", "build2.gradle");
+    const dest = path.join(utils.getGradleProjectPath(), "build.gradle");
+    await utils.copyFile(serverxmlPath, dest);
+    console.log("Finished copying file....");
+
+  }).timeout(90000);
+
+  // Place server.xml back to the config folder.
+  it('Copy server.xml to config folder', async () => {
+
+    await utils.delay(50000);
+    const serverxmlPath = path.join(utils.getGradleProjectPath(), "src", "main", "liberty", "config", "serverxml", "server.xml");
+    const dest = path.join(utils.getGradleProjectPath(), "src", "main", "liberty", "config", "server.xml");
+    await utils.copyFile(serverxmlPath, dest);
+    console.log("Finished copying file....");
+
+  }).timeout(90000);
+});
+

src/test/DashboardLMPInitProject.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) 2023 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
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+import { WebDriver, VSBrowser } from 'vscode-extension-tester';
+import * as utils from './utils/testUtils';
+
+describe('Open Maven Project', () => {
+
+    let driver: WebDriver;
+
+    before(() => {
+
+        driver = VSBrowser.instance.driver;
+
+    });
+
+    it('Open Sample Maven Project with no server.xml', async () => {
+
+        await VSBrowser.instance.openResources(utils.getMvnProjectPath());
+
+    }).timeout(15000);
+
+});
+
+

src/test/DashboardLMPTest.ts

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2023 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
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+import { expect } from 'chai';
+import { SideBarView, ViewItem, ViewSection, DefaultTreeItem, DebugView } from 'vscode-extension-tester';
+import * as utils from './utils/testUtils';
+import * as constants from './definitions/constants';
+import path = require('path');
+
+describe('Liberty dashboard project detection tests with LMP config in build file only', () => {
+    let sidebar: SideBarView;
+    let section: ViewSection;
+    let item: DefaultTreeItem;
+
+    before(() => {
+        sidebar = new SideBarView();
+    });
+
+    /*************************************************************************************
+    ** detect project with LMP config in build file only (ie. no server.xml in project)  **        
+    *************************************************************************************/
+
+    it('Delete server.xml from config.', async () => {
+
+        const dest = path.join(utils.getMvnProjectPath(), "src", "main", "liberty", "config", "server.xml");
+        const deleteServerxml = await utils.deleteReports(dest);
+        expect(deleteServerxml).to.be.true;
+
+    }).timeout(80000);
+
+    it('getViewControl works with the correct label', async () => {
+
+        const contentPart = sidebar.getContent();
+        section = await contentPart.getSection('Liberty Dashboard');
+        console.log("Found Liberty Dashboard test....");
+        expect(section).not.undefined;
+
+    }).timeout(10000);
+
+    it('Open dasboard shows items - Maven', async () => {
+
+        await utils.delay(50000);
+        const menu = await section.getVisibleItems();
+        expect(menu).not.empty;
+        item = await section.findItem(constants.MAVEN_PROJECT) as DefaultTreeItem;
+        expect(item).not.undefined;
+
+    }).timeout(80000);
+
+    it('Copy server.xml to config folder', async () => {
+
+        await utils.delay(50000);
+        const serverxmlPath = path.join(utils.getMvnProjectPath(), "src", "main", "liberty", "config", "serverxml", "server.xml");
+        const dest = path.join(utils.getMvnProjectPath(), "src", "main", "liberty", "config", "server.xml");
+        await utils.copyFile(serverxmlPath, dest);
+        console.log("Finished copying file....");
+
+    }).timeout(90000);
+
+});

src/test/LibertyDashboardInitProject.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2023 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
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */import { WebDriver, VSBrowser } from 'vscode-extension-tester';
+import * as utils from './utils/testUtils';
+
+describe('Open Maven Server xml Project', () => {
+
+    let driver: WebDriver;
+
+    before(() => {
+        driver = VSBrowser.instance.driver;
+    });
+
+    it('Open Sample Maven Project with no LMP or LGP defined in build file', async () => {
+        await VSBrowser.instance.openResources(utils.getMvnServerXmlProjectPath());
+    }).timeout(15000);
+
+});
+
+

src/test/LibertyDashboardTest.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) 2023 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
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+import { expect } from 'chai';
+import { SideBarView, ViewItem, ViewSection, DefaultTreeItem, DebugView } from 'vscode-extension-tester';
+import * as utils from './utils/testUtils';
+import * as constants from './definitions/constants';
+import path = require('path');
+
+describe('Liberty dashboard project detection tests', () => {
+    let sidebar: SideBarView;
+    let section: ViewSection;
+    let item: DefaultTreeItem;
+
+    before(() => {
+        sidebar = new SideBarView();
+    });
+
+    /*************************************************************************************
+    ******* detect project with src/main/liberty/config/server.xml file only  ************           
+    *************************************************************************************/
+
+    it('Delete server.xml from config.', async () => {
+
+        const dest = path.join(utils.getMvnServerXmlProjectPath(), "src", "main", "liberty", "config", "server.xml");
+        const deleteServerxml = await utils.deleteReports(dest);
+        expect(deleteServerxml).to.be.true;
+
+    }).timeout(80000);
+
+    it('getViewControl works with the correct label', async () => {
+
+        const contentPart = sidebar.getContent();
+        section = await contentPart.getSection('Liberty Dashboard');
+        console.log("Found Liberty Dashboard test....");
+        expect(section).not.undefined;
+
+    }).timeout(10000);
+
+    it('Liberty dashboard is empty', async () => {
+
+        await utils.delay(30000);
+        const isEmpty = await utils.isViewSectionEmpty(section);
+        expect(isEmpty).true;
+
+    }).timeout(70000);
+
+    it('Copy server.xml to config folder', async () => {
+
+        await utils.delay(50000);
+        const serverxmlPath = path.join(utils.getMvnServerXmlProjectPath(), "src", "main", "liberty", "config", "serverxml", "server.xml");
+        const dest = path.join(utils.getMvnServerXmlProjectPath(), "src", "main", "liberty", "config", "server.xml");
+        await utils.copyFile(serverxmlPath, dest);
+        console.log("Finished copying file....");
+
+    }).timeout(90000);
+
+    it('Open dasboard shows items - Maven', async () => {
+
+        await utils.delay(50000);
+        const menu = await section.getVisibleItems();
+        expect(menu).not.empty;
+        item = await section.findItem(constants.MAVEN_SERVERXML_PROJECT) as DefaultTreeItem;
+        expect(item).not.undefined;
+
+    }).timeout(80000);
+
+});

src/test/definitions/constants.ts

@@ -9,6 +9,7 @@
  */
 
 export const MAVEN_PROJECT = "liberty.maven.test.wrapper.app";
+export const MAVEN_SERVERXML_PROJECT = "liberty.maven.serverxml.test.wrapper.app";
 export const GRADLE_PROJECT= "liberty.gradle.test.wrapper.app";
 export const START_DASHBOARD_ACTION = "Start";
 export const STOP_DASHBOARD_ACTION = "Stop";