stormforge-ruby 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 246410660bb62a59942c33d6e258f0205248793b
+  data.tar.gz: 727e4fb96552319e584f48f08859536198c73ab4
+SHA512:
+  metadata.gz: 715e40725762bfcbd01fc85af424ceca102b3746ce81c6d4ea3ce9f7c8967eb64cb7aff516d862e9d0c1ffa3bfc9129a605747025a726ef7cb6d631c094e2b94
+  data.tar.gz: 47fe2145b5a12446211e74935c228a71a0f71f86e8aafb85cd5ac1bfebfd932e67265a143c6dec5979ef2d6443ae8a102f937c7356033928afb6ef9ef206d347

data/.gitignore

@@ -0,0 +1,5 @@
+coverage
+tmp
+Gemfile.lock
+examples/fixtures/tmp
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+bundler_args: #--without development
+rvm:
+  - ruby-head
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-2.2.1
+notifications:
+  recipients:
+    - travis-ci.org@tisba.de
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-19mode
+    - rvm: rbx-2.2.1
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stormforge_ruby.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sebastian Cohnen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+[![Build Status](https://travis-ci.org/tisba/stormforge-ruby.png)](https://travis-ci.org/tisba/stormforge-ruby)
+
+# StormForge
+
+`stormforge` is the command line client tool to use StormForger from
+your command line. It can also be used as a ruby gem for deeper
+integration with your tools.
+
+**Please note** that StormForger is in closed beta right now and you
+need an account to use it. Visit https://stormforger.com/ to get more
+information.
+
+
+## Dependencies
+
+stormorge-ruby supports
+
+* Ruby 1.9.3
+* Ruby 2.0.0
+* JRuby 1.7.8 (1.9 mode only)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "stormforge-ruby", require: "stormforge"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stormforge-ruby
+
+
+## CLI Usage
+
+To get started, run
+
+    stormforge auth
+
+This will ask you for your StormForger credentials, aquires your API
+token and stores it in `~/.stormforger`. Those credentials will be used
+for all other requests afterwards.
+
+To set up StormForger for your project, run
+
+    stormforge init
+
+This will create a `Stormfile` with an example test case so you can get
+started.
+
+To get more usage information, run
+
+    stormforge [SUBCOMMAND] help
+
+
+## GEM Usage
+
+This gem will be usable as a library for closer integration to your
+projects. Right now this isn't officially supported.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/stormforge

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "pp"
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require "stormforge"
+
+module StormForge::Thor; end
+
+require "thor/generators/init"
+require "thor/storm_forge_base"
+require "thor/testrun"
+require "thor/testcase"
+require "thor/main"
+
+StormForge::Thor::Main.start(ARGV)

data/examples/README.md

@@ -0,0 +1,27 @@
+# StormForge Test Case Examples
+
+Test Cases are definied in a custom Ruby DSL. They basically look like this:
+
+```ruby
+StormForge.define_case :simple_test_case do
+  title "Very simple test case"
+  version "0.1"
+  description "Simple and short test to examine test run process."
+  targets "app.example.com"
+
+  arrival_phase duration: 5.minutes, rate: 1.per_second
+
+  session "hit start page", 100.percent do
+    get "/"
+  end
+end
+```
+
+You can specify test cases directly in your `Stormfile` (run `stormforge
+init` to generate one). For more advanced usage, or if you have many
+test cases to manage, you can put them in separate files which you can
+load in your `Stormfile`. Take a look at a fresh generated `Stormfile`
+for further examples and documentation.
+
+A comprehensive example for a test case can be found in
+https://github.com/tisba/stormforge-ruby/blob/master/examples/test_case_definition_v1.rb.

data/examples/Stormfile

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), "*.rb")].each { |test_case| load test_case }

data/examples/demo_case.rb

@@ -0,0 +1,12 @@
+StormForge.define_case :demo do
+  title "StormForger Demo"
+  version "0.1"
+  description "Simple and short test to examine test run process."
+  targets "testapp.stormforger.com"
+
+  arrival_phase duration: 5.minutes, rate: 1.per_second
+
+  session "hit start page", 100.percent do
+    get "/knock-knock"
+  end
+end

data/examples/file_upload.rb

@@ -0,0 +1,28 @@
+StormForge.define_case :file_upload do
+  def create_test_file(file_name, size)
+    FileUtils.mkdir_p(File.dirname(file_name))
+    File.open(file_name, "w") do |file|
+      file.write "x" * size
+    end
+  end
+  create_test_file("fixtures/tmp/large_file_1mb.dat", 1.megabyte)
+
+  title "Upload Test"
+  version "0.1"
+  description "Testing Uploads."
+  targets "testapp.stormforger.com"
+
+  arrival_phase duration: 5.minutes, rate: 1.per_second
+
+  data_sources do
+    file :large_file_1mb, source: "fixtures/large_file_1mb.dat", simple_file: true
+  end
+
+  session "hit start page", 100.percent do
+    put "/file-upload", {
+      payload_from_file: :large_file_1mb
+    }
+
+    delete "/files/delete-this"
+  end
+end

data/examples/fixtures/requests.csv

@@ -0,0 +1,2 @@
+/ad/1
+/ad/2

data/examples/fixtures/users.csv

@@ -0,0 +1,2 @@
+1;joe@example.com;password1
+2;marry@example.com;anotherpassword

data/examples/simple_and_long.rb

@@ -0,0 +1,12 @@
+StormForge.define_case :simple_and_long do
+  title "Simple and Long :)"
+  version "0.1"
+  description "Simple and short test to examine test run process."
+  targets "testapp.stormforger.com"
+
+  arrival_phase duration: 50.minutes, rate: 50.per_second
+
+  session "hit start page", 100.percent do
+    get "/"
+  end
+end

data/examples/simple_and_short.rb

@@ -0,0 +1,12 @@
+StormForge.define_case :simple_and_short do
+  title "Simple and Short"
+  version "0.1"
+  description "Simple and short test to examine test run process."
+  targets "testapp.stormforger.com"
+
+  arrival_phase duration: 5.minutes, rate: 1.per_second
+
+  session "hit start page", 100.percent do
+    get "/"
+  end
+end

data/examples/test_case_definition_v1.rb

@@ -0,0 +1,206 @@
+StormForge.define_case :test_case_dsl_draft do
+  def create_test_file(file_name, size)
+    FileUtils.mkdir_p(File.dirname(file_name))
+    File.open(file_name, "w") do |file|
+      file.write "x" * size
+    end
+  end
+
+  create_test_file("fixtures/tmp/large_file_1mb.dat", 1.megabyte)
+
+
+  # Test case title
+  #
+  # You can specify a title or summary of what your test case does. The title will be used to
+  # identify a test case and therefore it should be unique.
+  #
+  # title is mandatory
+  title "My first Test Case"
+
+  # Test case version
+  #
+  # version specifies **your** version of the test specification. You can use this to differentiate
+  # between evolving test cases.
+  #
+  # Currently this information is purely informational and will be visible in your StormForger
+  # account.
+  #
+  # version is mandatory.
+  version "0.4"
+
+  # Description of the test case
+  #
+  # The given description is purely informal and will be visible in your
+  # account at StormForger.
+  description <<-EOS.undent
+    This is an example of how a possbile TestCase DSL could look like.
+
+    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+    eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim
+    ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
+    aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit
+    in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+    Excepteur sint occaecat cupidatat non proident, sunt in culpa qui
+    officia deserunt mollit anim id est laborum.
+  EOS
+
+  # Targets for load test
+  #
+  # Specify a list of target hosts (FQDN is required). Each node is hit with requests in a round
+  # robin fashion.
+  #
+  # All specified requests in sessions will have the specified host.
+  #
+  # This option is mandatory, at least one node must be specified.
+  targets "_1.api.example.com", "_2.api.example.com"
+
+  # Cloud provider for traffic generation
+  #
+  # Specify a cloud provider to use to generate traffic. Currently, only :aws is available.
+  #
+  # This setting is optional. It will default to use Amazon Web Services (:aws) and no specific
+  # security group.
+  cloud :aws do
+    # Security Group of load generating instances
+    #
+    # The given SG is used on launched instances. You can add this SG to allow incoming traffic to
+    # your instances.
+    security_group "sg-XXXXXXXX"
+  end
+
+
+  # Arrival Phases
+  #
+  # Arrival phases describe how many users are launched for a specified time. You need at least one
+  # phase.
+  #
+  # You can flag a phase as a "warm up" phase. This is purely informational currently.
+  arrival_phase warmup: true, duration: 10.minutes, rate: 10.per_second
+  arrival_phase duration: 30.minutes, rate: 5.per_minute
+  arrival_phase duration: 1.hour, rate: 10.per_minute
+
+  # Data Sources
+  #
+  # data_sources specifies one or more data source to be used in sessions. For usage of the sources,
+  # take a look at the session definition.
+  data_sources do
+    # There are two kinds of test data providers right now:
+    #
+    #  * file based and
+    #  * random generators
+    #
+    # File based data sources are expected to contain one line per entity. If you have multiple
+    # fields per line, you can name them using the `fields` options. If you have multiple fields per
+    # line and don't specify the fields, only the first field is going to be used.
+    #
+    # Available options:
+    #
+    #  * `source`    Specifies the relative or absolute location on the local file system of the
+    #                fixture. This is mandatory.
+    #  * `fields`    Specifies a list of the available fields per row in the source file. This is
+    #                optional.
+    #  * `delimiter` Specifies the field delimiter, defaults to ";". This is optional.
+    #  * `order`     Specifies if the file should be use :sequentially or :randomly. Defaults
+    #                to :sequentially.
+    #
+    # fixtures/users.csv could look like this:
+    #
+    #   1;joe@example.com;password1
+    #   2;marry@example.com;anotherpassword
+    #
+    # fixtures/requests.csv could look like this:
+    #
+    #  /path/to/endpoint
+    #  /path/to/endpoint?with=query&debug=1
+    #
+    file :ad_request, source: "fixtures/requests.csv"
+    file :user, source: "fixtures/users.csv", fields: [:id, :email, :password]
+
+    # FIXME simple_file is really a bad name. Other "file" data sources are
+    # translated to tsung's file_servers. But in some cases, we just want to have
+    # a file available, e.g. to be used for uploads
+    file :large_file_1mb, source: "fixtures/tmp/large_file_1mb.dat", simple_file: true
+
+    # In addition to file based data sources, you can also use random generators:
+    #
+    #  * random_number: Generates a random number (integer) within a given range
+    #  * random_string: Generates a random, alpha-numeric string with the given length
+    #
+    random_number :phone, range: 1..45000000
+    random_number :campaign_id, range: 10000..999999
+    random_string :referrer_token, length: 10
+    random_string :user_uid, length: 32
+  end
+
+
+  # Sessions
+  #
+  # A session represents a user or clients's interaction with your service. You have to specify
+  # at least one session.
+  #
+  # A session consists of a name and a likelyhood of a session beeing executed (probability). The
+  # summed up probability of all sessions has to be 100.
+  #
+  # You need at least one session.
+  #
+  # To access data sources within your session, you need to use the the `pick` method. Dependening
+  # on specified data source, you get back a item from a fixture file, or a generated value (see
+  # "Data Sources"). Notice, that you have to assign the result of `pick` to a variable, in case you
+  # need to use the same value multiple times. Every invocation of `pick` with the same data source,
+  # yields in a new value when running a test.
+  #
+  session "login only", 20.percent do
+    # You can access a data source by using `pick`. In case of a file source with multiple fields,
+    # you get back an object, where you can use the specified field names as methods:
+    user = pick(:user)
+
+    # To make an HTTP POST request, you can do this:
+    post "/users/login", payload: { email: user.email, password: user.password }
+  end
+
+  session "sign up with referrer token and login", 5.percent do
+    # Hit the status endpoint with a simple GET request
+    get "/status"
+
+    # Wait a bit
+    wait 2.seconds
+
+    user = pick(:user)
+    # Using `pick` with a generated data source, like :token (random string) or :phone (random
+    # number):
+    post "/users/sign_up", {
+      payload: {
+        email: user.email,
+        password: user.password,
+        ref_token: pick(:referrer_token),
+        phone: "+4917#{pick(:phone)}"
+      }
+    }
+
+    wait 1.minute
+
+    # Notice, that you can use `user`multiple times.
+    post "/users/login", payload: { email: user.email, password: user.password }
+  end
+
+  session "upload something", 5.percent do
+    # FIXME the API for all HTTP requests is quite sub optimal right now. The 'payload_from_file' is
+    # particular ugly. How could a saner API look like for options like this?
+    # FIXME 'payload_from_file' cannot accept a dynamic value right now
+    put "/upload/my-file", {
+      payload_from_file: :large_file_1mb
+    }
+  end
+
+  # The follow session demos how to make GET requests
+  session "get ads", 70.percent do
+    get "#{pick(:ad_request)}/#{pick(:campaign_id)}",
+      gzip: true,
+      cookies: {
+        "user_uid" => pick(:user_uid)
+      },
+      headers: {
+        "X-Forwared-For" => "1.2.3.4"
+      }
+  end
+end