Introduction

The drop wizard example application was developed to, as its name implies, provide examples of some of the features present in drop wizard.

Overview

Included with this application is an example of the optional db API module. The examples provided illustrate a few of the features available in (JDBI)[http://jdbi.org], along with demonstrating how these are used from within dropwizard.

This database example is comprised of the following classes.

• The PersonDAO illustrates using the SQL Object Queries and string template features in JDBI.

• The PeopleDAO.sql.stg stores all the SQL statements for use in the PersonDAO, note this is located in the src/resources under the same path as the PersonDAO class file.

• The SetupDatabaseCommand illustrates building a "setup" command which can create your database prior to running dropwizard your application for the first time.

• The PersonResource and PeopleResource are the REST resource which use the PersonDAO to retrieve data from the database, note the injection of the PersonDAO in their constructors.

As with all the modules the db example is wired up in the initialize function of the HelloWorldService.

Running The Application

To test the example application run the following commands.

• To package the example run.

    mvn package
  

• To setup the h2 database run.

    java -jar target/dropwizard-example-0.6.0-SNAPSHOT.jar db migrate example.yml 
  

• To run the server run.

    java -jar target/dropwizard-example-0.6.0-SNAPSHOT.jar server example.yml
  

• To test the server after it has been started run.

    curl  -H "Content-Type: application/json" -H "Accept: application/json"  -X POST -d @src/test/resources/fixtures/contact.json http://localhost:8080/contacts
    curl http://localhost:8080/contacts
  

Testing with Maven

Currently only the unit tests are exposed to maven and intellij must be used to run the integration tests. To run the tests execute:

    mvn test

Building with Gradle

I think it would be worth a discussion on the best workflow for the build but this is a good proof of concept. Currently the fatJar step is fairly slow so running that every time we run tests is not what we would want to do. Currently the fatJar step takes around 3:30 to complete and this could be made much faster (like shade for mvn) by updating how it is created.

• Download and install gradle (Tested v1.3) http://gradle.org/downloads

• To run the unit tests:

    gradle test
  

• To run the integration tests:

    gradle integrationTest
  

• To build a fat jar

    gradle fatJar
  

• To build a regular jar and run tests (currently does not build a fat jar):

    gradle build
  

• Once the fat jar is build it will be located at the below path and can be used similar to the instructions above.

    build/libs/dropwizard-example-groovy-0.6.0-SNAPSHOT.jar