...
Documents setting up code, config, and data in a development environment using Eclipse.
Prerequisites
- Git client (i.e. Tortoise Git)
- Java 7 8 installed
- Mysql 5.5 or 5.6 6.3 installed
- Maven 3.23.9. + installed
- Tomcat 7 8 installed and configured
- Eclipse Oxygen - J2EE edition
- Note that the below are likely deprecated (added in 2015) but leaving them here in case needed for reference
- Use version 4.4 (Luna) - J2EE edition
- m2e (the maven integration for eclipse - download from the market place)
- m2e-egit connector
- eGit - http://eclipse.github.com/
- Jautodoc - import configuration from Code and XML Formatting in Eclipse
- ObjectAid UML Diagram tool for class hierarchy visualization. Installed via Help->Install New Software. Instructions athttp://www.objectaid.net/installation
- FindBugs (static code analysis)
- AngularJS - see https://github.com/angelozerr/angularjs-eclipse/wiki/Getting-Started
- m2e (the maven integration for eclipse - download from the market place)
Details
Step 1 - Create directories
...
Step 2 - Clone repository
Clone the Github repository to the directory created to hold the code.
...
- NOTE: this uses the standard "dev-windows" configuration. To use a different configuration artifact pass the following three parameters:
- -Dconfig.groupId=...
- -Dconfig.artifactId=...
- -Dconfig.version=...
- NOTE: the specified configuration artifact must either have been built locally or be an a repository accessible based on the settings.xml file
- For most dev deployments, the default build is fine because the only setting really used for the rest/webapp packages is the "base.url" which by default is set to http://localhost:8080/termumls-server-rest./
- For a production deployment, you would want to use a different setting. For example, see Deploy Instructions for the prod deployment instructions.
Step 4 - Setup Configuration
Choose a "dev-windows", "uat" , or "prod" config project target and unzip it into the directory created to hold your config files.
- config/dev-windows/target/term-server-config-dev-windows.*.zip
- config/prod/target/term-server-config-prod.*.zipconfig/uat/target/term-server-config-uat.*.zip
Unzip the config/target/term-server-config.*.zip file into the directory created to hold your data files (these are the sample SNOMED and ICD9CM data artifacts).
...
- Download and install apache tomcat 7 in c:/apache-tomcat-XXXX
- In Eclipse use the J2EE perspective and click on the "Servers" tab.
- From here, you can add a server which simply involves pointing Eclipse to the install directory for Tomcat.
- You can right-click on term-server-rest.war file and use "Run As->Run on Server" to deploy to Tomcat.
- NOTE: sometimes in Eclipse this doesn't work and the tomcat does not properly recognize or deploy the app.
- In this event, double-click on the tomcat server installation in the servers tab.
- In the configuration screen click "Open launch configuration"
There, look on the Arguments tab and find the -D setting for "catalina.base", e.g.
Code Block -Dcatalina.base="C:\Users\Brian Carlsen\workspace-luna\.metadata\.plugins\org.eclipse.wst.server.core\tmp0"
- If you open this directory you'll see a "webapps" folder. To deploy you simply build and copy term-server-rest.war to that directory and launch the server in Eclipse.
The Tomcat server needs to be able to find the run configuration. Double-click on the Tomcat server you installed, open the launch configuration and add this setting:
Code Block -Drun.config.ts=/path/to/your/config.properties
...
http://localhost:8080/term-server-rest/index.html
This should be a demo app that links to a "swagger" Api documenting the current state of the APIserver. You You should be able to test services by using authenticating with "guest" username and "guest" as the authToken parameterpassword..
Step 10 - Integration test
Run the integration tests (only do this if you know what you're doing):
Code Block |
---|
# configured to ponit ot DB loaded above. mvn -Prest -DskipTests=false -Drun.config.ts=/path/to/config.properties # configured to point to empty db mvn -Pmojo -DskipTests=false -Drun.config.testts=/path/to/config-test.properties test |
References/Links
...