TicketMonster - a JBoss example

TicketMonster is an online ticketing demo application that gets you started with JBoss technologies, and helps you learn and evaluate them.

Here are a few instructions for building and running it. You can learn more about the example from the tutorial.

Updating the Performance dates

NOTE: This step is optional. It is necessary only if you want to update the dates of the Performances in the import.sql script in an automated manner. Updating the performance dates ensure that they are always set to some timestamp in the future, and ensures that all performances are visible in the Monitor section of the TicketMonster application.

1. Run the update_import_sql Perl script. You'll need the DateTime, DateTime::Format::Strptime and Tie::File Perl modules. These are usually available by default in your Perl installation.

    $ perl update_import_sql.pl src/main/resources/import.sql
   

Generating the administration site

NOTE: This step is optional. The administration site is already present in the source code. If you want to regenerate it from Forge, and apply the changes outlined in the tutorial, you may continue to follow the steps outlined here. Otherwise, you can skip this step and proceed to build TicketMonster.

Before building and running TicketMonster, you must generate the administration site with Forge.

1. Ensure that you have JBoss Forge installed. The current version of TicketMonster supports version 2.6.0.Final or higher of JBoss Forge. JBoss Developer Studio 8 is recommended, since it contains JBoss Forge 2 with all the necessary plugins for the TicketMonster app.

2. Start the JBoss Forge console in JBoss Developer Studio. This can be done from the Forge Console view. If the view is not already visible, it can be opened through the 'Window' menu: Window -> Show View -> Other.... Select the 'Forge Console' item in the dialog to open the Forge Console. Click the Start button in the Forge Console tab, to start Forge.

3. From the JBoss Forge prompt, browse to the 'demo' directory of the TicketMonster sources and execute the script for generating the administration site

    $ cd ticket-monster/demo
    $ run admin_layer.fsh
   

   The git patches need to be applied manually. Both the patches are located in the patches sub-directory. To apply the manual changes, first apply the patch located in file admin_layer_functional.patch. Then perform the same for the file admin_layer_graphics.patch if you want to apply the style changes for the generated administration site. You can do so in JBoss Developer Studio, by opening the context-menu on the project (Right-click on the project) and then apply a git patch via Team -> Apply Patch.... Locate the patch file in the Workspace, select it and click the 'Next' button. In the next dialog, select to apply the patch on the 'ticket-monster' project in the workspace. Click Finish in the final page of the wizard after satisfying that the patch applies cleanly.

4. Deployment to JBoss EAP 6.3 is optional. The project can be built and deployed to a running instance of JBoss EAP through the following command in JBoss Forge:

    $ build clean package jboss-as:deploy
   

Building TicketMonster

TicketMonster can be built from Maven, by runnning the following Maven command:

mvn clean package

Building TicketMonster with tests

If you want to run the Arquillian tests as part of the build, you can enable one of the two available Arquillian profiles.

For running the tests in an already running application server instance, use the arq-jbossas-remote profile.

mvn clean package -Parq-jbossas-remote

If you want the test runner to start an application server instance, use the arq-jbossas-managed profile. You must set up the JBOSS_HOME property to point to the server location, or update the src/main/test/resources/arquillian.xml file.

mvn clean package -Parq-jbossas-managed

Building TicketMonster with Postgresql (for OpenShift)

If you intend to deploy into OpenShift, you can use the postgresql-openshift profile

mvn clean package -Ppostgresql-openshift

Building TicketMonster with MySQL (for OpenShift)

If you intend to deploy into OpenShift, you can use the mysql-openshift profile

mvn clean package -Pmysql-openshift

Running TicketMonster

You can run TicketMonster into a local JBoss EAP 6.3 instance or on OpenShift.

Running TicketMonster locally

Start JBoss Enterprise Application Platform 6.3

1. Open a command line and navigate to the root of the JBoss server directory.

2. The following shows the command line to start the server with the web profile:

    For Linux:   JBOSS_HOME/bin/standalone.sh
    For Windows: JBOSS_HOME\bin\standalone.bat
   

Deploy TicketMonster

1. Make sure you have started the JBoss Server as described above.

2. Type this command to build and deploy the archive into a running server instance.

    mvn clean package jboss-as:deploy
   

   (You can use the arq-jbossas-remote profile for running tests as well)

3. This will deploy target/ticket-monster.war to the running instance of the server.

4. Now you can see the application running at http://localhost:8080/ticket-monster

Running TicketMonster in OpenShift

Create an OpenShift project

The following variables are used in these instructions. Be sure to replace them as follows:

• APP_NAME should be replaced with the name of the application you create on OpenShift.
• YOUR_DOMAIN_NAME should be replaced with the OpenShift domain name.
• APPLICATION_UUID should be replaced with the UUID generated by OpenShift for your application, for example: 52864af85973ca430200006f
• TICKETMONSTER_MAVEN_PROJECT_ROOT is the location of the Maven project sources for the TicketMonster application.

1. Open a shell command prompt and change to a directory of your choice. Enter the following command to create a JBoss EAP 6 application:

    rhc app create -a APP_NAME -t jbosseap-6
   

   This command creates an OpenShift application named APP_NAME and will run the application inside the jbosseap-6 container. You should see some output similar to the following:

    Application Options
    -------------------
    Domain:     YOUR_DOMAIN
    Cartridges: jbosseap-6 (addtl. costs may apply)
    Gear Size:  default
    Scaling:    no
    
    Creating application 'APP_NAME' ... done
    
    
    Waiting for your DNS name to be available ... done
    
    Cloning into 'APP_NAME'...
    Warning: Permanently added the RSA host key for IP address '54.90.10.115' to the list of known hosts.
    
    Your application 'APP_NAME' is now available.
    
      URL:        http://APP_NAME-YOUR_DOMAIN.rhcloud.com/
      SSH to:     APPLICATION_UUID@APP_NAME-YOURDOMAIN.rhcloud.com
      Git remote: ssh://APPLICATION_UUID@APP_NAME-YOUR_DOMAIN.rhcloud.com/~/git/APP_NAME.git/
      Cloned to:  /Users/vineet/openshiftapps/APP_NAME
    
    Run 'rhc show-app APP_NAME' for more details about your app.
   

2. The create command creates a git repository in the current directory with the same name as the application.

   You do not need the generated default application, so navigate to the new git repository directory created by the OpenShift command and tell git to remove the source and pom files:

    cd APP_NAME
    git rm -r src pom.xml
   

3. Copy the TicketMonster application sources into this new git repository:

    cp -r TICKETMONSTER_MAVEN_PROJECT_ROOT/src .
    cp -r TICKETMONSTER_MAVEN_PROJECT_ROOT/pom.xml .
   

Use MySQL as the database

1. Add the MySQL 5.5 cartridge to the ticketmonster application:

    rhc cartridge add mysql-5.5 -a ticketmonster
   

2. Configure the OpenShift build process, to use the mysql-openshift profile within the project POM. To do so, create a file named pre_build_jbosseap under the .openshift/action_hooks directory located in the git repository of the OpenShift application, with the following contents:

    export MAVEN_ARGS="clean package -Popenshift,mysql-openshift -DskipTests"
   

3. Set the executable bit for the action hook:

    chmod +x TICKET_MONSTER_OPENSHIFT_GIT_REPO/.openshift/build_hooks/pre_build_jbosseap
   

   On Windows, you will need to run the following command to set the executable bit to the pre_build_jbosseap file:

    git update-index --chmod=+x .openshift/build_hooks/pre_build_jbosseap
   

Use PostgreSQL as the database

1. Add the PostgreSQL 9.2 cartridge to the ticketmonster application:

    rhc cartridge add postgresql-9.2 -a ticketmonster
   

2. Configure the OpenShift build process, to use the postgresql-openshift profile within the project POM. To do so, create a file named pre_build_jbosseap under the .openshift/action_hooks directory located in the git repository of the OpenShift application, with the following contents:

    export MAVEN_ARGS="clean package -Popenshift,postgresql-openshift -DskipTests"
   

3. Set the executable bit for the action hook:

    chmod +x TICKET_MONSTER_OPENSHIFT_GIT_REPO/.openshift/build_hooks/pre_build_jbosseap
   

   On Windows, you will need to run the following command to set the executable bit to the pre_build_jbosseap file:

    git update-index --chmod=+x .openshift/build_hooks/pre_build_jbosseap
   

Deploying to OpenShift

1. You can now deploy the changes to your OpenShift application using git as follows:

    git add -A
    git commit -m "TicketMonster on OpenShift"
    git push
   

   The final push command triggers the OpenShift infrastructure to build and deploy the changes.

   Note that the openshift profile in pom.xml is activated by OpenShift, and causes the WAR build by OpenShift to be copied to the deployments/ directory, and deployed without a context path.

   Now you can see the application running at http://APP_NAME-YOUR_DOMAIN.rhcloud.com/.