TechEmpower.FrameworkBenchmarks/toolset/scaffolding

Congratulations!

You have successfully built a new test in the suite!

There are some remaining tasks to do before you are ready to open a pull request, however.

Next Steps

1. Gather your source code.

You will need to ensure that your source code is beneath this directory. The most common solution is to include a src directory and place your source code there.

1. Edit source_files

A metric we capture, in addition to the actual benchmark numbers, is the significant lines of code required to run your application. To help our suite identify your source code, we require you to list your source files in source_files.

1. Edit benchmark_config.json

The initialization process made some assumptions about your test implementation that may or may not be true. For example, it laid out two separate tests: the non-database tests; and the database tests. You, on the other hand, may only want to implement the JSON test, so you will need alter benchmark_config.json.

Additionally, benchmark_config.json has, for each test, a key called "setup_file". This value refers to the next bullet.

1. Create $NAME.dockerfile

This is the dockerfile that is built into a docker image and run when a benchmark test is run. Specifically, this file tells the suite how to build and start your test application.

You can create multiple implementations and they will all conform to [name in benchmark_config.json].dockerfile. For example, the default implementation in benchmark_config.json will be $NAME.dockerfile, but if you wanted to make another implementation that did only the database tests for MySQL, you could make $NAME-mysql.dockerfile and have an entry in your benchmark_config.json for $NAME-mysql.

1. Test your application

   $ tfb --mode verify --test $NAME
   

This will run the suite in verify mode for your test. This means that no benchmarks will be captured and we will test that we can hit your implementation end-points specified by benchmark_config.json and that the response is correct.

Once you are able to successfully run your test through our suite in this way and your test passes our validation, you may move on to the next step.

1. Add your test to .travis.yml

Edit .travis.yml to ensure that Travis-CI will automatically run our verification tests against your new test. This file is kept in alphabetical order, so find where TESTDIR=$LANGUAGE/$NAME should be inserted under env > matrix and put it there.

1. Fix this README.md and open a pull request

Starting on line 59 is your actual README.md that will sit with your test implementation. Update all the dummy values to their correct values so that when people visit your test in our Github repository, they will be greated with information on how your test implementation works and where to look for useful source code.

After you have the real README.md file in place, delete everything above line 59 and you are ready to open a pull request.

Thanks and Cheers!

$DISPLAY_NAME Benchmarking Test

Test Type Implementation Source Code

• JSON
• PLAINTEXT
• DB
• QUERY
• CACHED QUERY
• UPDATE
• FORTUNES

Important Libraries

The tests were run with:

• Software
• Example

Test URLs

JSON

http://localhost:8080/json

PLAINTEXT

http://localhost:8080/plaintext

DB

http://localhost:8080/db

QUERY

http://localhost:8080/query?queries=

CACHED QUERY

http://localhost:8080/cached_query?queries=

UPDATE

http://localhost:8080/update?queries=

FORTUNES

http://localhost:8080/fortunes