Skip to content

Latest commit

 

History

History
131 lines (93 loc) · 8.24 KB

Using-WDT.md

File metadata and controls

131 lines (93 loc) · 8.24 KB
Raw

Eclipse / WDT

The WebSphere Development Tools (WDT) for Eclipse can be used to control the server (start/stop/dump etc.). The tools also support incremental publishing with minimal restarts and works with a debugger to allow you to step through your applications plus many more features including:

  • content-assist for server configuration (server configuration is minimal but the tools can help you find what you need)
  • automatic incremental publish of applications so that changes can be written and tested locally without doing a build/publish cycle or restarting the server (the server does restart nice and quickly but it's still nice not being forced to do it!)

Installing WDT on Eclipse is a simple drag and drop process as explained on wasdev.net.

Clone Git Repo

📌 Switch to cmd line example

If the sample git repository hasn't been cloned yet, WDT has git tools integrated into the IDE:

  1. Open the Git repositories view
    • Window -> Show View -> Other
    • Type "git" in the filter box, and select Git Repositories
  2. Copy Git repo url by finding the textbox under "HTTPS clone URL" at the top of this page, and select Copy to clipboard
  3. In the Git repositories view, select the hyperlink Clone a Git repository
  4. The git repo url should already be filled in. Select Next -> Next -> Finish
  5. The "sample.microservices.12factorapp [master]" repo should appear in the view

Building the sample in Eclipse

📌 Switch to cmd line example

This sample can be built using either Gradle or Maven.

Building with Gradle

Import Gradle projects into WDT

This assumes you have the Gradle Buildship tools installed into Eclipse Mars.

  1. In the Git Repository view, expand the 12factorapp repo to see the "Working Directory" folder
  2. Right-click on this folder, and select Copy path to Clipboard
  3. Select menu File -> Import -> Gradle -> Gradle Project
  4. In the Project root directory folder textbox, Paste in the repository directory.
  5. Click Next twice
  6. Three projects should be listed in the Gradle project structure click Finish
  7. This will create 3 projects in Eclipse: sample.microservices.12factorapp, 12-factor-application, and 12-factor-wlpcfg
  8. Go to the Gradle Tasks view in Eclipse and navigate to the sample.microservices.12factorapp project
  9. Double click on the eclipse task to generate all the Eclipse files
  10. In the Enterprise Explorer view in Eclipse right click on the three projects mentioned in step 7 and click refresh

⭐ Note: If you did not use Eclipse/WDT to clone the git repository, follow from step 3, but navigate to the cloned repository directory rather than pasting its name in step 4.

Run Gradle build
  1. Right-click on async-websocket/build.gradle
  2. Run As > Gradle Build...
  3. In the Gradle Tasks section enter "build"
  4. Click Run

Building with Maven

Import Maven projects into WDT
  1. In the Git Repository view, expand the 12factorapp repo to see the "Working Directory" folder
  2. Right-click on this folder, and select Copy path to Clipboard
  3. Select menu File -> Import -> Maven -> Existing Maven Projects
  4. In the Root Directory textbox, Paste in the repository directory
  5. Select *Browse..." button and select Finish (confirm it finds 3 pom.xml files)
  6. This will create 3 projects in Eclipse: sample.microservices.12factorapp, 12-factor-application, and 12-factor-wlpcfg

⭐ Note: If you did not use Eclipse/WDT to clone the git repository, follow from step 3, but navigate to the cloned repository directory rather than pasting its name.

Run Maven install
  1. Right-click on async-websocket/pom.xml
  2. Run As > Maven build...
  3. In the Goals section enter "install"
  4. Click Run

Running the application locally

📌 Switch to cmd line example

Pre-requisite: Download WAS Liberty Pre-requisite: Create a Cloudant database on Bluemix. Make sure you have set the system environment variables 'dbUsername', 'dbPassword' and 'dbUrl' then you are ready to run your application.

For the purposes of this sample, we will create the Liberty server (step 3 in the wasdev.net instructions) a little differently to create and customize a Runtime Environment that will allow the server to directly use the configuration in the 12-factor-wlpcfg project.

Create a Runtime Environment in Eclipse

Before creating a server you need a runtime environment for your server to be based on.

  1. Open the 'Runtime Explorer' view:
    • Window -> Show View -> Other
    • type runtime in the filter box to find the view (it's under the Server heading).
  2. Right-click in the view, and select New -> Runtime Environment
  3. Give the Runtime environment a name, e.g. wlp-2015.6.0.0 if you're using the June 2015 beta.
  4. Either:
    • Select an existing installation (perhaps what you downloaded earlier, if you followed those instructions), or
    • select Install from an archive or a repository to download a new Liberty archive.
  5. Follow the prompts (and possibly choose additional features to install) until you Finish creating the Runtime Environment
Add the User directory from Gradle or Maven project, and create a server
  1. Right-click on the Runtime Environment created above in the 'Runtime Explorer' view, and select Edit
  2. Click the Advanced Options... link
  3. If the 12-factor-wlpcfg directory is not listed as a User Directory, we need to add it:
    1. Click New
    2. Select the 12-factor-wlpcfg project
    3. Select Finish, OK, Finish
  4. Right-click on the 12-factor-wlpcfg user directory listed under the target Runtime Environment in the Runtime Explorer view., and select New Server.
  5. The resulting dialog should be pre-populated with the 12FactorAppServer Liberty profile server.
  6. Click Finish

📌 Note: If the '12-factor-wlpcfg' project does not appear in the dialog to add a project to the User Directory make sure there is a 'shared' folder in the 12-factor-wlpcfg project with an empty .gitkeep file inside it.

Running Liberty and the sample application from WDT
  1. Select the 12-factor-application project
  2. Right-click -> Run As... -> Run On Server
  3. Select the "WebShere Application Server under localhost" folder, and select Finish
  4. Confirm web browser opens on "http://localhost:9082/12-factor-application/" and displays a list of all the databases and the content of the "items" database.
  5. Alternatively open a browser on "http://localhost:9082/12-factor-application/Test" to see a 'hello world' message from the servlet

Tips

  • When importing the existing maven project into Eclipse, Eclipse will (by default) "helpfully" add this project to an (extraneous) ear. To turn this off, go to Preferences -> Java EE -> Project, and uncheck "Add project to an EAR" before you import the project. If you forgot to do this, just delete the ear project; no harm.

Deploying to Bluemix using Eclipse

📌 Switch to cmd line example

To push applications to Bluemix from Eclipse you need the [IBM Eclipse Tools for Bluemix][eclipse-bluemix]. In Eclipse go to help -> Eclipse Marketplace and search for Bluemix. Once you have downloaded the tools you should be able to create a Bluemix server by right clicking in the servers tab, selecting new > server, selecting the server type IBM Bluemix and entering your Bluemix credentials. To push the application to Bluemix simply drag and drop the 12FactorApp.zip file into the Bluemix server. WDT will prompt you to enter a name for the application, environment variables and services to bind. Pick a name for the application and under environment variables specify the following:

  1. dbUsername: 'Cloudant-username-credential'
  2. dbPassword: 'Cloudant-password-credential'
  3. dbUrl: 'Cloudant-url-credential'