Git Product home page Git Product logo

microclimate-eclipse-tools's Introduction

Microclimate Developer Tools for Eclipse

Build Status License

You can use Microclimate Developer Tools for Eclipse to develop your Microclimate projects from within Eclipse. Use the tools to access Microclimate features in the comfort of your IDE.

How to install

Complete the following steps to install Microclimate Developer Tools for Eclipse:

  1. Download and install the latest Eclipse IDE for Java EE Developers or use an existing installation. The earliest supported version of the Eclipse IDE for Microclimate Developer Tools for Eclipse is 4.8 (Photon).
  2. Install and start a local instance of Microclimate version 18.12 or later.
  3. Install the Microclimate Developer Tools from Eclipse Marketplace.

How to use

  • Create a new connection to Microclimate:
    • From the File menu select New > Other > Microclimate > New Microclimate Connection
    • Fill in the host (only localhost is supported) and port (usually 9090)
    • Click the Test Connection and then click Finish
  • This should open the Microclimate Explorer view with the connection expanded to show your projects. If it does not open the view then open it manually:
    • From the Window menu select Show View > Other > Microclimate > Microclimate Explorer
    • Click Open
  • Right click on the connection to see the available actions for connections
  • Right click on a project to see the available actions for projects

Features

  • View all Microclimate projects for a connection including the application and build status
  • Import your Microclimate project into the Eclipse workspace
  • Debug Microprofile/Java EE and Spring applications
  • View application and build logs in the Console view
  • Integrate Microclimate validation errors into the Markers view
  • Open a shell session into a Microclimate application container
  • Toggle the project auto build setting and manually initiate project builds
  • Open your application and the application monitor in a browser

For more information see the documentation

Contributing

We welcome issues and contributions. For more information, see CONTRIBUTING.md.

Enabling Debug Logs

  1. Create a file called .options in your Eclipse install directory (the same directory with the eclipse executable) with the following content:

com.ibm.microclimate.core/debug/info=true

  1. Launch eclipse with the -debug flag.
  2. The logs are written to the Eclipse workspace directory, to .metadata/.log.

Building

  1. Clone the repository to your system.

    git clone https://github.com/microclimate-dev2ops/microclimate-eclipse-tools

  2. [Optional] Copy 'microclimate-eclipse-tools' folder to 'build' to get a test build. This will keep your source folder intact.

  3. Run a gradle build.

    cd build/dev

    ./gradlew

  4. Test the driver built from Step. 3

    build/dev/ant_build/artifacts/microclimate-eclipse-tools-[Version].vYYYYMMDD_hhmm.zip

Builds

License

EPL 2.0

Dependencies

Dependency License
socket.io-client-1.0.0.jar MIT
engine.io-client-1.0.0.jar MIT
json-20090211.jar The JSON License
okhttp-3.8.1.jar Apache 2.0
okio-1.13.0.jar Apache 2.0

microclimate-eclipse-tools's People

Contributors

eharris369 avatar josephca avatar lentheivendra avatar sishida avatar tetchel avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

microclimate-eclipse-tools's Issues

Support multiple log files

Retrieve the set of log files from Microclimate for a project and allow the user to display any or all of those log files. For older versions of Microclimate the previous mechanism where there is one app log and one build log (except for Node.js) per project needs to be maintained.

Deleted Microclimate applications still show in view

I ran into a situation where some Microclimate applications that were deleted are still showing in the view. This should not happen because there should be a deleted event when an application is removed and whenever Eclipse is restarted a fresh list of applications is retrieved. It would still be better, however, to make sure the app lists are in sync and remove any applications that don't show in the list returned by Microclimate.

Improve the delete message

Improve the delete message to make it clear that the project and all of its source files will be deleted from the Microclimate workspace.

Delete project operation is blocking the UI

When deleting a project, the UI gets blocked by the delete confirmation dialog until the delete operation completes. This probably means that we are doing the delete in the main UI thread. Consider to move it a background job instead given that the delete operation can sometimes takes long.

Speed up tests by disabling auto build

The tests wait for all jobs to be finished when importing a Microclimate project into Eclipse. This includes waiting for Maven build jobs which can take some time. Turning off auto build helps speed up the tests quite a bit.

Project shows as debugging after switching to run mode

When switching the project from debug mode to run mode it goes through the usual states: stopping, stopped, starting but the final state is debugging instead of running.

The problem is that the started event:

message: projectStatusChanged
data: {
"projectID": "82eb2070-264f-11e9-b3c3-cd8ce10e8088",
"appStatus": "started"
}

is coming before the restart event with the mode:

message: projectRestartResult
data: {
"projectID": "82eb2070-264f-11e9-b3c3-cd8ce10e8088",
"status": "success",
"startMode": "run",
"ports": {
"exposedPort": "32801",
"internalPort": "9080"
}
}

So the tools should be doing a refresh on the project in the view when the restart event is received.

Add change log

Add a CHANGELOG.md file to keep track of significant enhancements and bug fixes.

Screen reader does not read project template group name in new project wizard

The screen reader does not read the project template group name in the new project wizard. Tabbing from the project name field goes directly to the filter text field and the reader just reads: "Type filter text". It skips the "Project Template" group name so the user would not know what to do here. Use a read only text field instead of a group name so that the reader picks it up.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.