ruby-jmeter 2.0

data/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.log
+*.jmx
+*.jtl
+*.bak

data/.rspec

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

data/Gemfile

@@ -0,0 +1,27 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in ruby-jmeter.gemspec
+gemspec
+
+gem 'nokogiri'
+gem 'rest-client'
+gem 'json'
+
+platforms :jruby do
+  gem 'json-jruby'
+end
+
+group :development do
+  gem 'pry', :require => 'pry'
+  gem 'pry-nav', :require => 'pry-nav'
+  gem 'pry-debugger', :require => 'pry-debugger'
+  gem 'awesome_print', :require => 'ap'
+end
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'sinatra'
+  gem 'haml'
+  gem 'pry-debugger', :require => 'pry-debugger'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,333 @@
+# RubyJmeter
+
+Tired of using the JMeter GUI or looking at hairy XML files?
+
+This gem lets you write test plans for JMeter in your favourite text editor, and optionally run them on [flood.io](http://flood.io). 
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install ruby-jmeter
+
+## Basic Usage
+
+*RubyJmeter* exposes easy-to-use domain specific language for fluent communication with [JMeter](http://jmeter.apache.org/).It also includes API integration with [flood.io](https://flood.io), a cloud based load testing service.
+
+To use the DSL, first let's require the gem:
+
+```ruby
+require 'rubygems'
+require 'ruby-jmeter'
+```
+
+### Basic Example
+Let's create a `test` and save the related `jmx` testplan to file, so we can edit/view it in JMeter.
+
+```ruby
+test do
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
+  end
+end.jmx
+```
+
+So in this example, we just created a test plan, with 10 threads, each of which visited the search page at Google. 
+
+### Generating a JMeter Test Plan (JMX)
+Note also how we called the `jmx` method of the test. Calling this method will write the contents of the JMeter test plan to file like this.
+
+```
+$ ruby testplan.rb
+[2013-04-23T10:29:03.275743 #42060]  INFO -- : Test plan saved to: jmeter.jmx
+```
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<jmeterTestPlan version="1.2" properties="2.1">
+  <hashTree>
+    <TestPlan guiclass="TestPlanGui" testclass="TestPlan" testname="Test Plan" enabled="true">
+      ...
+    </TestPlan>
+  </hashTree>
+</jmeterTestPlan>
+JMX saved to: jmeter.jmx
+```
+
+The file that is created can then be executed in the JMeter GUI. If you want to create the file with a different filename and/or path, just add the `file` parameter to the `jmx` method call like this.
+
+```ruby
+test do
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
+  end
+end.jmx(file: "/tmp/my_testplan.jmx")
+```
+
+Windows users should specify a path like this.
+
+```ruby
+.jmx(file: "C:\\TEMP\\MyTestplan.jmx")
+```
+
+### Running a JMeter Test Plan locally
+You can execute the JMeter test plan by calling the `run` method of the test like this.
+
+```ruby
+test do
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
+  end
+end.run
+```
+
+This will launch JMeter in headless (non-GUI mode) and execute the test plan. This is useful for shaking out the script before you push it to the Grid. There are a few parameters that you can set such as the `path` to the JMeter binary, the `file` path/name for the JMX file, the `log` path/name to output JMeter logs and the `jtl` path/name for JMeter results like this.
+
+```ruby
+test do
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
+  end
+end.run(
+  path: '/usr/share/jmeter/bin/', 
+  file: 'jmeter.jmx', 
+  log: 'jmeter.log', 
+  jtl: 'results.jtl')
+```
+
+### Running a JMeter Test Plan on flood.io
+
+You can also execute JMeter test plans on flood.io using our API. To do so, you require an account and API token. If you don't know your token, sign in to [flood.io](https://flood.io/api) and check your account settings.
+
+To execute the test on flood.io, call the `grid` method on the test and pass it the API token like this.
+
+```ruby
+test do  
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
+  end  
+end.grid('OxtZ-4v-v0koSz5Y0enEQQ')
+```
+
+This will then provide you with a link to the live test results on flood.io like this.
+
+``` 
+Results at: http://prod.flood.io/shared?testguid=73608030311611e2962f123141011033&run_id=339&tags=jmeter&domain=altentee.com&cluster=54.251.48.129&status=running&view=
+```
+
+## Advanced Usage
+
+### Blocks
+
+Each of the methods take an optional block delimited by `do` and `end` or braces `{}`
+
+Blocks let you nest methods within methods, so you can scope the execution of methods as you would in a normal JMeter test plan. For example.
+
+```ruby
+test do
+  threads count: 100 do
+    visit name: 'Home', url: 'http://altentee.com' do
+      extract regex: "content='(.+?)' name='csrf-token'", name: 'csrf-token'
+    end
+  end
+end
+```
+
+This would create a new test plan, with a 100 user thread group, each user visiting the "Home" page and extracting the CSRF token from the response of each visit.
+
+All methods are nestable, but you should only have one test method, and typically only one threads method. For example, it wouldn't make sense to have a test plan within a test plan, or a thread group within a thread group. You can have multiple thread groups per test plan though. This implies *some* knowlege of how JMeter works.
+
+All methods take a parameter hash to configure related options.
+
+### Threads
+
+You can use the `threads` method to define a group of users:
+
+```ruby
+threads count: 100
+threads count: 100, continue_forever: true
+threads count: 100, loops: 10
+threads count: 100, ramup: 30, duration: 60
+threads count: 100, scheduler: true, 
+  start_time: Time.now.to_i * 1000,
+  end_time:   (Time.now.to_i * 1000) + (3600 * 1000)
+```
+
+### Cookies
+
+You can use the `cookies` method to define a Cookie Manager:
+
+```ruby
+test do
+  cookies
+end
+```
+
+This methods takes an optional parameters hash. This is based on the [HTTP Cookie Manager](http://jmeter.apache.org/usermanual/component_reference.html#HTTP_Cookie_Manager).
+
+```ruby
+test do
+  cookies clear_each_iteration: false
+end
+
+test do
+  cookies policy: 'rfc2109', clear_each_iteration: true
+end
+```
+
+### Cache
+
+You can use the `cache` method to define a Cache Manager:
+
+```ruby
+test do
+  cache
+end
+```
+
+This methods takes an optional parameters hash. This is based on the [HTTP Cache Manager](http://jmeter.apache.org/usermanual/component_reference.html#HTTP_Cache_Manager).
+
+```ruby
+test do
+  cache clear_each_iteration: false
+end
+
+test do
+  cache use_expires: true, clear_each_iteration: true
+end
+```
+
+### Authorization
+
+You can use the `auth` method to define an Authorization Manager:
+
+```ruby
+test do
+  auth
+end
+```
+
+This methods takes an optional parameters hash. This is based on the [HTTP Authorization Manager](http://jmeter.apache.org/usermanual/component_reference.html#HTTP_Authorization_Manager).
+
+```ruby
+test do
+  auth url: '/', username: 'tim', password: 'secret', domain: 'altentee.com'
+end
+```
+
+### Navigating
+
+You can use the `visit` method to navigate to pages:
+
+```ruby
+visit name: 'Google Search', url: 'http://google.com'
+visit name: 'Google Search', url: 'http://google.com'
+visit name: 'Google Search', url: 'http://google.com', 
+  method: 'POST', 
+  'DO_MULTIPART_POST': 'true'
+visit name: 'Google Search', url: 'http://google.com',
+  use_keepalive: 'false'
+visit name: 'Google Search', url: 'http://google.com', 
+  connect_timeout: '1000',
+  response_timeout: '60000'
+visit name: 'View Login', url: '/login', 
+  protocol: "https",
+  port: 443
+```
+
+### Submitting a Form
+
+You can use the `submit` method to POST a HTTP form:
+
+```ruby
+submit name: 'Submit Form', url: 'http://altentee.com/',
+  fill_in: {
+    username: 'tim',
+    password: 'password',
+    'csrf-token' => '${csrf-token}'
+  }
+```
+
+This method makes a single request. The fill_in parameter lets you specify key/value pairs for form field parameters. You can also use the built in JMeter `${expression}` language to access run time variables extracted from previous responses.
+
+### Think Time
+
+You can use the `think_time` method to insert pauses into the simulation. This method is aliased as `random_timer`.
+
+```ruby
+think_time 3000
+```
+
+This method takes 2 parameters: the constant delay, and an optional variable delay. Both are specified in milliseconds. This is based on the [Gaussian Random Timer](http://jmeter.apache.org/usermanual/component_reference.html#Gaussian_Random_Timer). This timer pauses each thread request for a random amount of time, with most of the time intervals ocurring near a particular value. The total delay is the sum of the Gaussian distributed value (with mean 0.0 and standard deviation 1.0) times the deviation value you specify, and the offset value.
+
+```ruby
+# constant delay of 3 seconds
+think_time 3000
+# constant delay of 1 seconds with variance up to 6 seconds.
+random_timer 1000,5000
+```
+
+### Response Extractor
+
+You can use the `extract` method to extract values from a server response using a regular expression. This is aliased as the `web_reg_save_param` method. This method is typically used inside a `visit` or `submit` block.
+
+```ruby
+extract regex: "content='(.+?)' name='csrf-token'", name: 'csrf-token'
+
+visit name: 'Google', url: "http://google.com/" do
+  extract regex: 'aria-label="(.+?)"', name: 'button_text'
+  extract xpath: '//button', name: 'button'
+end
+```
+
+This is based on the [Regular Expression Extractor](http://jmeter.apache.org/usermanual/component_reference.html#Regular_Expression_Extractor) and [XPath Extractor](http://jmeter.apache.org/usermanual/component_reference.html#XPath_Extractor)
+
+```ruby
+visit name: "Altentee", url: "http://altentee.com" do
+  extract regex: "content='(.+?)' name='csrf-token'", name: 'csrf-token'
+  extract regex: 'value="(.+?)" name="JESSIONSID"', name: 'JSESSIONID'
+  web_reg_save_param regex: 'value="(.+?)" name="VIEWSTATE"', name: 'VIEWSTATE'
+  extract name: 'username', regex: 'value="(.+?)", name="username"', 
+    default: 'Tim Koopmans',
+    match_number: 1
+  extract name: 'shopping_item', regex: 'id="(.+?)" name="book"', 
+    match_number: 0 # random
+end
+```
+
+### Response Assertion
+
+You can use the `assert` method to extract values from a server response using a regular expression. This is aliased as the `web_reg_find` method. This method is typically used inside a `visit` or `submit` block.
+
+```ruby
+visit "Altentee", "http://altentee.com" do
+  assert contains: "We test, tune and secure your site"
+end
+```
+
+
+This method takes 3 parameters: the matching rule, the test string, and an optional parameters hash. This is based on the [Response Assertion](http://jmeter.apache.org/usermanual/component_reference.html#Response_Assertion). 
+
+```ruby
+visit "Altentee", "http://altentee.com" do
+  assert "contains": "We test, tune and secure your site"
+  assert "not-contains": "We price gouge on cloud services"
+  assert "matches": "genius"
+  assert "not-matches": "fakers"
+  assert "contains": "magic"
+  assert "not-contains": "unicorns", scope: 'all'
+end
+```
+
+## Roadmap
+
+This is very much a work-in-progress. Future work is being sponsored by flood.io. Get in touch with us if you'd like to be involved.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create some specs, make them pass
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

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

data/bin/grid

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ruby-jmeter'
+
+def usage(why = nil)
+  puts "failed for reason: #{why}" if why
+  puts "usage: grid [testplan.rb] "
+  puts "  The tesplan is optional, if you leave it off you'll get an interactive shell."
+  exit(1)
+end
+
+@testplan = ARGV.shift
+
+require 'irb'
+require 'irb/completion'
+
+if File.exists? ".irbrc"
+  ENV['IRBRC'] = ".irbrc"
+end
+
+ARGV.clear
+
+IRB.start
+exit!