At Mind Candy we have a number of different Scala REST services to provide common aspects to our games, for example authentication and moderation.
A standard we have developed is to use an Unfiltered Netty standalone server wrapped with the apache-commons daemon library. Also, we want our services to be well tested, easily deployable, and stable under heavy load. For ease of deployment we use Fabric scripts, and for load testing we use Gatling to hammer the services under different stress-tests to check they are up to standard.
We have quite a few services that have a similar setup, and it was getting tedious to create and configure a new project. So, we created a giter8 script to do it all for us!
Giter8 is an awesome command line tool which can create a template project structure for you with example files and sbt configuration.
There are quite a few templates contributed by the community already but none did exactly what we want, so we created our own which we’d like to share.
The template will create an example sbt project that:
- Uses unfiltered and netty to give you a very simple starting endpoint service which will output ‘Hello, <project>’ when hit
- Gives you some basic test stubs using Specs2
- Is setup with gatling load testing with an example scenario
- Is configured with the sbt-idea plugin (IntelliJ IDEA is our preferred IDE)
- Is configured with the sbt-assembly, sbt-release, and sbt-dependency-graph plugins
- Has a simple fabric deploy file, unix start/stop scripts, and an example init script
The generated project is structured with 3 sub projects:
- example-core // Business logic
- example-resources // Containing the Unfiltered Netty request plan
- example-server // To control the server hosting the plan
First make sure you have setup giter8 using the instructions here. Then fire open a terminal and run:
There are some options to enter, but most can be left as default (See here for more info). The important ones are:
name => The main projects name
project => The name prepended to each of the sub projects
organization => Used as the basis for packages
Once you’ve entered the properties, giter8 will do its magic and whip you up a full sbt project. After it completes, you can cd to the directory, and run sbt.
Now open up your favourite browser and go to http://localhost:8889/<project> where <project> is whatever you specified above, and you should get a “hello, project” message back.
Load test it:
Start the server running in one terminal. In another terminal do:
cd yourproject sbt project <project>-server test-load:run
You should get presented with a choice of different classes to run:
- Engine → Executes the gatling Engine in interactive mode prompting you which scenario to run
- BatchEngine → Runs all simulations available in a batch with no user prompts
- Recorder → Starts the pretty cool Gatling recorder which you can use to create scenarios. Basically, you setup your web browser to use the recorder’s proxy, and then just browse as normal on your webpage. Gatling records all of your actions as a scenario that can be replayed and customised.
Results from Gatling are put in the gatling/results directory. In the example scenario in the giter8 skeleton we simulate 10 users hitting the simple endpoint, ramping up over a 3s duration. The results are rendered in a nice html page with graphs showing exactly what happened during the simulation. The full gatling feature set is quite extensive and worth checking out.
Create IntelliJ IDEA project files:
Run from start script:
First setup jsvc. Then :
sbt assembly cd bin chmod +x start.sh ./start.sh
This has the same affect as ‘sbt run’, but using the apache-commons daemon wrapper. Try opening the service in your browser again and it should work as before. Don’t forget to stop the server when you’re done with the ../stop.sh script :)
There is also a sample init script that is configured for the skeleton in the bin folder, which is a good starting point for creating a complete init script.
Last to mention is there is a small fabric file that provides a (very) basic setup for copying over the built assembly onto a test/integration server. You’d need to configure your host and change the paths as appropriate to use it, but it’s useful as a starting point.
Let us know if you find this useful, and thanks to n8han for providing a great tool!