Bench

Benchmarking Dotty

Usage

• bin/master: for benchmarking the master
• bin/run: for manually benchmarking a specific period
• bin/pull: for testing a specific pull request

Check the documentation in the source code of each command for more detail.

Add Test

Update the profiles in the project. For example, for Dotty:

• bench/profiles/default.yml
• bench/profiles/ci.yml

Schedule one test job

Put regression jobs as scripts under jobs/.

bin/gauge 6514 49f254a

The command bin/gauge accepts the following options:

• -o File: output file for test data, defaults to FILE in bin/config
• -p PLAN: the test plan to execute, defaults to PLAN in bin/config

To only measure a specific test target, just create a test plan for that test.

Regressional benchmarks

The command bin/run allows schedule history benchmarks for a designated test target. It accepts the following options:

• -p PLAN: the test plan to execute
• -f PR: from which PR (excluded)
• -t PR: to which PR (excluded)
• -s STEP: execute test plan every n pull requests, defaults to 0
• -o FILE: output file for test data, defaults to FILE in bin/config

The command only schedules the tasks under the directory jobs/, which will be executed by the scheduler.

How to debug a test

cp profiles/default.plan profiles/scalapb.plan
# edit profiles/scalapb.plan to only keep the test relevant for debug

# run test with a PR and commit hash -- PR can be a random number
bin/gauge -p profiles/scalapb.plan -o test.csv  6179 54fb992

Dependencies

• jq
• coursier
• sed
• cron
• ghi
• git
• sbt

Deployment

Current kernel: 4.4.0-78-generic #99-Ubuntu

• Install all dependencies listed above and make sure they are available in command line
• Disable system update to use a fixed version of kernel

# edit file /etc/apt/apt.conf.d/10periodic
APT::Periodic::Update-Package-Lists "0";
APT::Periodic::Download-Upgradeable-Packages "0";
APT::Periodic::AutocleanInterval "0";

• Clone current project, and under the project root:
  • git clone [email protected]:lampepfl/dotty.git
• Update configuration in bin/config
• Authorize ghi config --auth, make sure it works from command line
• Make sure git can push to current project
• Setup cron jobs listed in bin/cron
• Make a git repo under the directory site for displaying the charts
  • Make sure that the web server sets the HTTP header Cache-Control: no-cache (see #1193)
  • Adapt the function publish_site in bin/common
• Make a git repo under the directory data for storing test data, make sure git push origin master:master works for the repo.
• In dotty folder, run git remote add staging https://github.com/dotty-staging/dotty.git
• Create a symbolic link: ln -s dotty/bench/profiles profiles
• run bin/cpu once
• start bin/poll and bin/queue as long-running service