openliberty / liberty-tools-vscode Goto Github PK

Steps to reproduce:

1. Start devmode using the dashboard
2. Stop devmode
3. Change something in the build.gradle (ie. reports.html.destination)
4. Start devmode, notice a new terminal opens

A new terminal should not open and instead use the existing one already created. Otherwise on ever start/stop/modify we are creating a new terminal and it could be confusing to the user.

Investigate whether it is possible and makes sense to list all sub-projects in a drop-down from the parent project in the explorer view. See an example of a drop down tree view below:

Users may have project setup that requires customizing test report locations for the extension to load the reports properly.

An example is the above. Project from the Getting Started guide was used.

Currently we have "Start" and "Start..." to start dev mode with custom parameters. There is no visible command to users to start devc with custom parameters.

Add a table of commands with descriptions similar to the announcement blog post https://openliberty.io/blog/2019/11/13/liberty-dev-mode-vscode.html

Boost Maven plugin has groupId org.microshed.boost. The VS Code extension (and the readme) should refer to this groupId when checking for dev projects.

e.g.

<groupId>org.microshed.boost</groupId>
<artifactId>boost-maven-plugin</artifactId>

Currently if a pom.xml or build.gradle file is added once the extension has started, the extension does not automatically refresh and pick up the new project even if the correct plugins are specified.

The extension should be able to refresh when build files are added, deleted, or modified.

Maven and Gradle start/stop commands are hard-coded. If project uses wrapper it is ignored.
VSCode settings option to use or ignore wrapper is ignored.

Investigate whether the Open Liberty Tools extension should have dependencies on the Red Hat Java Language Support/Debugger/etc. extensions.

https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack

The Maven VSCode extension has a setting: maven.terminal.useJavaHome that will use the java.home setting to find Java, instead of only relying on the JAVA_HOME env var.

That would be nice... it would allow more flexible switching between JDKs across envs for a single user.

The upcoming releases of Liberty Maven/Gradle plugins will have dev mode with container support which is no longer in tech preview. Review "tech preview" wording from the option "Start in container (tech preview)"

Steps to reproduce:

1. Start devmode using the liberty dev dashboard.
2. Kill the terminal either with:

• The kill terminal button
• Killing the terminal with the exit command. (Can be triggered by accidently running Stop from the liberty dev dashboard twice)

3. Try to start devmode again from the liberty-dev dashboard.

Expected output:

Starts dev-mode

Actual output:

Nothing happens

Consider and adopt the use of RSP: https://github.com/redhat-developer/vscode-rsp-ui

Improve detection of multi-module projects, and consider a tree parent/child view in the dashboard for multiple modules.

Should cover both Maven and Gradle projects.

#61 is related.

Provide users with common options that they can easily select and/or customize for the "Start..." command without them needing to know the actual properties that they need to use/specify.

Ex. Searching for OpenLiberty returns no results https://marketplace.visualstudio.com/search?term=openliberty&target=VSCode&category=All%20categories&sortBy=Relevance

Create step-by-step documentation around how to configure your Liberty project and make use of the different actions offered by Open Liberty Tools for VS Code

• How to add the Liberty Maven plugin or Liberty Gradle plugin to a pom.xml and configure a server.xml
• Outline of the different actions available through the Liberty dashboard (starting and stopping dev mode)
• Links to dev mode documentation and which project types are supported by dev mode

stack trace: Error: Cannot find module 'gradle-to-js/lib/parser'
Require stack:

• c:\git\devEx\liberty-dev-vscode-ext\out\utils\libertyProject.js
• c:\git\devEx\liberty-dev-vscode-ext\out\extension.js
• c:\sfs\Microsoft VS Code\resources\app\out\vs\loader.js
• c:\sfs\Microsoft VS Code\resources\app\out\bootstrap-amd.js
• c:\sfs\Microsoft VS Code\resources\app\out\bootstrap-fork.js
  at Function._resolveFilename (internal/modules/cjs/loader.js:627:15)
  at Function. (internal/modules/cjs/loader.js:531:27)
  at Function. (c:\sfs\Microsoft VS Code\resources\app\out\vs\workbench\services\extensions\node\extensionHostProcess.js:837:268)
  at Function. (c:\sfs\Microsoft VS Code\resources\app\out\vs\workbench\services\extensions\node\extensionHostProcess.js:807:106)
  at Function._load (c:\sfs\Microsoft VS Code\resources\app\out\vs\workbench\services\extensions\node\extensionHostProcess.js:803:550)
  at Module.require (internal/modules/cjs/loader.js:685:19)
  at n (c:\sfs\Microsoft VS Code\resources\app\out\vs\loader.js:15:524)
  at ProjectProvider. (c:\git\devEx\liberty-dev-vscode-ext\out\utils\libertyProject.js:89:26)
  at Generator.next ()
  at c:\git\devEx\liberty-dev-vscode-ext\out\utils\libertyProject.js:7:71
  at new Promise ()
  at c:\git\devEx\liberty-dev-vscode-ext\out\utils\libertyProject.js:3:12
  at ProjectProvider.findValidGradleBuildFiles (c:\git\devEx\liberty-dev-vscode-ext\out\utils\libertyProject.js:84:16)

The newest release of VS Code 1.57 introduces the concept of terminal tabs. This also allows users to easily rename their terminals. Open Liberty Tools for VS Code should still be able to identify the associated terminal after it has been renamed.

https://github.com/microsoft/vscode-docs/blob/vnext/release-notes/v1_57.md#integrated-terminal

1. Generate an Open Liberty project using https://start.microprofile.io/
2. Unzip the project and open it in VS Code
3. Liberty Dev Dashboard does not show the project, because the plugin is defined inside the <profiles><profile><build></build></profile></profiles> section instead of in the top level project's <build></build> section.

e.g. the following is not recognized:

<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>demo</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>
  <properties>
    <openliberty.maven.version>3.1</openliberty.maven.version>
    <final.name>demo</final.name>
    <failOnMissingWebXml>false</failOnMissingWebXml>
    <openliberty.version>[19.0.0.9,)</openliberty.version>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.eclipse.microprofile</groupId>
      <artifactId>microprofile</artifactId>
      <version>3.0</version>
      <type>pom</type>
      <scope>provided</scope>
    </dependency>
  </dependencies>
  <build>
    <finalName>demo</finalName>
  </build>

  <profiles>
    <profile>
      <id>liberty</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
      <build>
        <plugins>
          <plugin>
            <groupId>io.openliberty.tools</groupId>
            <artifactId>liberty-maven-plugin</artifactId>
            <version>${openliberty.maven.version}</version>
            <executions>
              <execution>
                <id>package-server</id>
                <phase>package</phase>
                <goals>
                  <goal>create</goal>
                  <goal>install-feature</goal>
                  <goal>deploy</goal>
                  <goal>package</goal>
                </goals>
                <configuration>
                  <outputDirectory>target/wlp-package</outputDirectory>
                </configuration>
              </execution>
            </executions>
            <configuration>
              <appArchive>${project.build.directory}/${final.name}.war</appArchive>
              <include>runnable</include>
              <serverName>${final.name}</serverName>
              <bootstrapProperties>
                <project.name>${final.name}</project.name>
                <jwt.issuer>https://server.example.com</jwt.issuer>
              </bootstrapProperties>
            </configuration>
          </plugin>
        </plugins>
      </build>
    </profile>
  </profiles>
</project>

If Tools for MicroProfile extension isn't installed already, install it when Open Liberty Tools is installed.

@kathrynkodama

A *-maven-cache folder, which is peer to the project directory, is left behind after devc is launched from OLT and stopped.

Expect there isn't such folder present on user's file system.

Repro steps:

1. Go to Liberty Dev Dashboard

2. Pick one service and Start

3. After service is started, right-click and "Run tests"

4. After tests finishes, right-click and "View integration test report" / "View unit test report"
   

5. "Test report does not exist" was not showing
   

Expected result

1. Test reports should be presented

Since the start command for project under the LIBERTY DEV DASHBOARD is calling mvn liberty:dev, it has an assumption that the liberty-maven-plugin is defined in the project.

Add button to trigger refresh/reload of projects in workspace

Add a command for generating a starter Open Liberty project, using the Open Liberty Starter: https://openliberty.io/start/

A test report location can be specified in a build.gradle the following way:
test.reports.html.destination = file("$buildDir/reports/intTests”)

The extension should recognize custom locations and open the corresponding html file as opposed to simply looking in the default location for the test report (/build/reports/tests/test/index.html).

All the commands in this extension do not have a category specified. In this case, it's really hard for users to discover those commands. Check out how it looks like in the command palette:

It's really hard to tell those two commands are related to your product and users could be very easily confused.

Please check out this example. This extension uses the "Java" category to group all its command.
https://github.com/redhat-developer/vscode-java/blob/master/package.json#L404
And it looks like this:

So here to suggest that you guys add category field to all your commands in here:
https://github.com/OpenLiberty/liberty-dev-vscode-ext/blob/master/package.json#L45

Use the tslint:recommended ruleset
https://github.com/palantir/tslint/blob/master/src/configs/recommended.ts

Add a "Start in container (tech preview)" action to the Liberty Dev Dashboard using mvn liberty:devc or gradle libertyDevc
https://github.com/OpenLiberty/ci.maven/blob/master/docs/dev.md#devc-container-mode
https://github.com/OpenLiberty/ci.gradle/blob/master/docs/libertyDev.md#libertydevc-task-container-mode

This would need to check that the Liberty Maven Plugin is 3.3-M1 or higher, or the Liberty Gradle Plugin is 3.1-M1 or higher.

Completion

• server.xml schema elements
• Open Liberty features

Diagnostics

• Unknown/invalid server.xml elements
• Duplicate features
• Unknown features

Hover

• Hover documentation of server.xml schema elements
• Hover documentation for liberty server features

Other

• Handle version of liberty

The "View integration test report" and "View unit test report" commands should not appear unless the reports exist.

Editors like vscodium and gitpod use https://open-vsx.org/ as the extension registry. Would be good to publish there.

I think Theia might use it too.

I don't know if I'm just missing something or if there's a good way to do this, but I would love to be able to debug tests and I didn't see that option available.

There's not much context to this one since it's a feature request I suppose, but for what it's worth I am using Maven and right-clicked on my server in the Liberty dev dashboard, then checked the docs for an explanation of what the options in the right-click menu were. I didn't see one that looked like an obvious way to debug tests. I also checked whether this extension somehow interacted with the test runner for Java and the Maven support extension but nothing jumped out at me.

I believe the reason the test runner for Java plugin doesn't work for me has to do with variables set in pom.xml and server.xml - for instance, I attempted to run the tests in this guide but the default ports specified in the <liberty.var. ... > tags in pom.xml were null, so my tests failed. Evidently the way to debug Maven goals in VS Code is to right-click on the goals in the panel added by the Maven support extension, but there doesn't seem to be a goal to ONLY test liberty, I suppose since it needs to be run before tests can happen. So I thought an extension for Open Liberty projects might be a way to patch that, though it could also be me setting up Maven in VS Code wrong!

Current code is only checking the command starts with "-", since dev-model supports multiple parameters, we should verify each of them.

• Maven starts with -D, Gradle starts with --
• Parameters separated by a space
• Check each parameter is in the support list. (https://github.com/OpenLiberty/ci.gradle/blob/master/docs/libertyDev.md)

Related to #113

For reference look at this project: https://github.com/OpenLiberty/guide-maven-multimodules

In the /finish/ear folder there exists a pom.xml with the liberty-maven-plugin defined in it. This should be picked up by the dashboard and display the corresponding project. Currently the dashboard is empty.

After importing this boost project, https://github.com/OpenLiberty/demo-devex into vscode, it is not rendering under the LIBERTY DEV DASHBOARD

The boost runtime dependency is defined within an <profile/> element in the project pom and not under project pom dependencies section.

               <profile>
                        <id>ol</id>
                        <activation>
                                <activeByDefault>true</activeByDefault>
                                <property>
                                        <name>boostRuntime</name>
                                        <value>ol</value>
                                </property>
                        </activation>
                        <dependencies>
                                <dependency>
                                        <groupId>boost.runtimes</groupId>
                                        <artifactId>openliberty</artifactId>
                                </dependency>
                        </dependencies>
                </profile>

This is related to OpenLiberty/ci.maven#1374.

The tool failed to start a project in container if the project name contains special characters.

Ensure extension works w/ Eclipse Theia / Che / RH CodeReady Workspaces.

Could also maybe try VSCodium and gitpod etc.

Automated UI testing for the extension

See https://code.visualstudio.com/api/working-with-extensions/testing-extension

This link may be helpful as well: https://developers.redhat.com/blog/2019/11/18/new-tools-for-automating-end-to-end-tests-for-vs-code-extensions#

RedHat's Tools for MicroProfile (vscode-microprofile) has tests set up that may provide some guidance: https://github.com/redhat-developer/vscode-microprofile/tree/master/src/test

Generating a new Liberty Gradle project with https://start.openliberty.io/ and the Liberty dev dashboard does not detect this project

See OpenLiberty/liberty-tools-intellij#63

Currently the extension does support starting dev-mode custom parameters but you have to re-type them every time you re-launch devmode.

Would be nice if dev-mode remembered your previously used input or allowed you to specify parameters to always use in the vscode settings. So users do not have to re-type them each time.

List of custom parameters for reference
https://github.com/OpenLiberty/ci.gradle/blob/master/docs/libertyDev.md

Enable version updates and configure dependabot to handle them according to what we need for this project.

Extension gave a "No Liberty dev found" error when stopping a devc instance started from the dashboard using the "Start in containers" option.

2 terminals opened in VS Code. The one started by extension for devc is named "xyz (liberty dev)".

Steps to reproduce

1. Start devmode using the liberty dev dashboard.
2. Do something that causes a refresh of the ProjectProvider Ex. edit / save pom.xml

You are then unable to Stop or Run tests from the liberty dev dashboard, and are shown a warning liberty:dev has not been started on project-name. (running tests or stopping devmode from the actual terminal still works).

Ex:

Currently it is very difficult to tell maven and gradle projects with the same name apart. Ex. People trying out devmode using the demo-devmode project. https://github.com/OpenLiberty/demo-devmode

Would be nice to have a way to quickly tell which type of project you are running dev-mode for.

One option could be adding the maven / gradle logo in the corner of the icon.

Currently, Gradle support for the extension will detect a subproject Gradle project if:

• the subproject is listed in the include block of the parent settings.gradle
• the liberty-gradle-plugin is in the subprojects or allprojects section of the parent build.gradle

However, from the parent build.gradle there are ways to apply plugins only to specific subprojects (see example 4: https://docs.gradle.org/current/userguide/plugins.html). We should support these custom conditions when detecting subprojects.