gitlab-org--gitlab-foss/lib/tasks
Yorick Peterse 19893a1c10 Basic setup for an RSpec based benchmark suite
This benchmark suite uses benchmark-ips
(https://github.com/evanphx/benchmark-ips) behind the scenes. Specs can
be turned into benchmark specs by setting "benchmark" to "true" in the
top-level describe block like so:

    describe SomeClass, benchmark: true do

    end

Writing benchmarks can be done using custom RSpec matchers, for example:

    describe MaruTheCat, benchmark: true do
      describe '#jump_in_box' do
        it 'should run 1000 iterations per second' do
          maru = described_class.new

          expect { maru.jump_in_box }.to iterate_per_second(1000)
        end
      end
    end

By default the "iterate_per_second" expectation requires a standard
deviation under 30% (this is just an arbitrary default for now). You can
change this by chaining "with_maximum_stddev" on the expectation:

    expect { maru.jump_in_box }.to iterate_per_second(1000)
      .with_maximum_stddev(10)

This will change the expectation to require a maximum deviation of 10%.

Alternatively you can use the it block style to write specs:

    describe MaruTheCat, benchmark: true do
      describe '#jump_in_box' do
        subject { -> { described_class.new } }

        it { is_expected.to iterate_per_second(1000) }
      end
    end

Because "iterate_per_second" operates on a block, opposed to a static
value, the "subject" method must return a Proc. This looks a bit goofy
but I have been unable to find a nice way around this.
2015-10-02 17:00:23 +02:00
..
ci Disable CI for time of migration 2015-09-21 00:14:07 +02:00
gitlab Merge branch 'orphaned-repo-cleanup' into 'master' 2015-09-29 07:35:59 +00:00
migrate Replace GITLAB with GitLab in rake task descriptions 2015-06-23 16:52:40 +02:00
.gitkeep
brakeman.rake
cache.rake Replace GITLAB with GitLab in rake task descriptions 2015-06-23 16:52:40 +02:00
dev.rake Replace GITLAB with GitLab in rake task descriptions 2015-06-23 16:52:40 +02:00
rubocop.rake
services.rake Added service API endpoint to retrieve service parameters 2015-09-10 18:22:57 +02:00
setup.rake Replace GITLAB with GitLab in rake task descriptions 2015-06-23 16:52:40 +02:00
sidekiq.rake Replace GITLAB with GitLab in rake task descriptions 2015-06-23 16:52:40 +02:00
spec.rake Basic setup for an RSpec based benchmark suite 2015-10-02 17:00:23 +02:00
spinach.rake Refactor rake tasks for tests 2015-06-23 16:48:52 +02:00
test.rake Use teaspoon instead of jasmine:ci 2015-07-03 10:51:44 +02:00