gridinit-jmeter 0.3.2 → 1.0.0.pre

data/Gemfile

@@ -14,7 +14,7 @@ end
 group :development do
   gem 'pry', :require => 'pry'
   gem 'pry-nav', :require => 'pry-nav'
-  gem 'pry-debugger'
+  gem 'pry-debugger', :require => 'pry-debugger'
   gem 'awesome_print', :require => 'ap'
 end
 
@@ -23,4 +23,5 @@ group :test do
   gem 'rspec'
   gem 'sinatra'
   gem 'haml'
+  gem 'pry-debugger', :require => 'pry-debugger'
 end

data/README.md

@@ -28,8 +28,8 @@ Let's create a `test` and save the related `jmx` testplan to file, so we can edi
 
 ```ruby
 test do
-  threads 10 do
-    visit 'Google Search', 'http://google.com'
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
   end
 end.jmx
 ```
@@ -60,8 +60,8 @@ The file that is created can then be executed in the JMeter GUI. If you want to
 
 ```ruby
 test do
-  threads 10 do
-    visit 'Google Search', 'http://google.com'
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
   end
 end.jmx(file: "/tmp/my_testplan.jmx")
 ```
@@ -77,8 +77,8 @@ You can execute the JMeter test plan by calling the `run` method of the test lik
 
 ```ruby
 test do
-  threads 10 do
-    visit 'Google Search', 'http://google.com'
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
   end
 end.run
 ```
@@ -87,8 +87,8 @@ This will launch JMeter in headless (non-GUI mode) and execute the test plan. Th
 
 ```ruby
 test do
-  threads 10 do
-    visit 'Google Search', 'http://google.com'
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
   end
 end.run(
   path: '/usr/share/jmeter/bin/', 
@@ -105,8 +105,8 @@ To execute the test on the Grid, call the `grid` method on the test and pass it
 
 ```ruby
 test do  
-  threads 10 do
-    visit 'Google Search', 'http://google.com'  
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com'
   end  
 end.grid('OxtZ-4v-v0koSz5Y0enEQQ')
 ```
@@ -127,9 +127,9 @@ Blocks let you nest methods within methods, so you can scope the execution of me
 
 ```ruby
 test do
-  threads 100 do
-    visit 'Home', 'http://altentee.com' do
-      extract 'csrf-token', "content='(.+?)' name='csrf-token'"
+  threads count: 100 do
+    visit name: 'Home', url: 'http://altentee.com' do
+      extract regex: "content='(.+?)' name='csrf-token'", name: 'csrf-token'
     end
   end
 end
@@ -139,26 +139,20 @@ This would create a new test plan, with a 100 user thread group, each user 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 100
-```
-
-This methods takes 2 parameters: the number of threads and an optional parameters hash.
-
-```ruby
-threads 100
-threads 100, {continue_forever: 'true'}
-threads 100, {loops: 10}
-threads 100, {ramp_time: 30, duration: 60}
-threads 100, {
-  scheduler: 'true', 
+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
@@ -228,28 +222,19 @@ end
 You can use the `visit` method to navigate to pages:
 
 ```ruby
-  visit 'Google Search', 'http://google.com'
-```
-
-This method makes a single request and takes 3 parameters: the label, the URL and an optional parameters hash.
-
-```ruby
-visit 'Google Search', 'http://google.com'
-visit 'Google Search', 'http://google.com', {
+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 'Google Search', 'http://google.com', {
+  'DO_MULTIPART_POST': 'true'
+visit name: 'Google Search', url: 'http://google.com',
   use_keepalive: 'false'
-}
-visit 'Google Search', 'http://google.com', {
+visit name: 'Google Search', url: 'http://google.com', 
   connect_timeout: '1000',
-  response_timeout: '60000',
-}
-visit 'View Login', '/login', {
+  response_timeout: '60000'
+visit name: 'View Login', url: '/login', 
   protocol: "https",
   port: 443
-}
 ```
 
 ### Submitting a Form
@@ -257,7 +242,7 @@ visit 'View Login', '/login', {
 You can use the `submit` method to POST a HTTP form:
 
 ```ruby
-submit 'Submit Form', 'http://altentee.com/', {
+submit name: 'Submit Form', url: 'http://altentee.com/',
   fill_in: {
     username: 'tim',
     password: 'password',
@@ -265,7 +250,7 @@ submit 'Submit Form', 'http://altentee.com/', {
   }
 ```
 
-This method makes a single request and takes 3 parameters: the label, the URL and an optional parameters hash. 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.
+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
 
@@ -289,33 +274,26 @@ random_timer 1000,5000
 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 'csrf-token', "content='(.+?)' name='csrf-token'"
-```
+extract regex: "content='(.+?)' name='csrf-token'", name: 'csrf-token'
 
-This method takes 4 parameters: the selector (xpath or regex), the extracted value name, the PCRE regular expression and an optional parameters hash. The selector is optional and defaults to regex. You can specify regex or xpath extractors as follows.
-
-```
-visit 'Google', "http://google.com/" do
-  extract 'button_text', 'aria-label="(.+?)"'
-  extract :regex, 'button_text', 'aria-label="(.+?)"'
-  extract :xpath, 'button', '//button'
+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 "Altentee", "http://altentee.com" do
-  extract 'csrf-token', "content='(.+?)' name='csrf-token'"
-  extract 'JSESSIONID', 'value="(.+?)" name="JESSIONSID"'
-  web_reg_save_param 'VIEWSTATE', 'value="(.+?)" name="VIEWSTATE"'
-  extract 'username', 'value="(.+?)" name="username"', {
+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 'shopping_item', 'id="(.+?)" name="book"', {
+  extract name: 'shopping_item', regex: 'id="(.+?)" name="book"', 
     match_number: 0 # random
-  }
 end
 ```
 
@@ -325,7 +303,7 @@ You can use the `assert` method to extract values from a server response using a
 
 ```ruby
 visit "Altentee", "http://altentee.com" do
-  assert "contains", "We test, tune and secure your site"
+  assert contains: "We test, tune and secure your site"
 end
 ```
 
@@ -334,12 +312,12 @@ This method takes 3 parameters: the matching rule, the test string, and an optio
 
 ```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'}
+  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
 ```
 
@@ -351,6 +329,7 @@ This is very much a work-in-progress. Future work is being sponsored by Gridinit
 
 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
+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/examples/basic_assertion.rb

@@ -2,12 +2,12 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  threads 2 do
-    transaction 'Assertions' do
-      visit 'Altentee', 'http://altentee.com/' do
-        assert "contains", "We test, tune and secure your site"
-        assert "not-contains", "Something in frames", {:scope => 'all'}
+  threads count: 2 do
+    transaction name: 'Assertions' do
+      visit name: 'Altentee', url: 'http://altentee.com/' do
+        assert contains: 'We test, tune and secure your site'
+        assert 'not-contains' => 'Something in frames', scope: 'children'
       end
     end
   end
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_auth.rb

@@ -2,10 +2,10 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  auth :url => '/', :username => 'tim', :password => 'secret', :domain => 'altentee.com'
-  threads 1 do
-    transaction 'Google Search' do
-      visit 'Home Page', 'http://google.com/'
+  auth url: '/', username: 'tim', password: 'secret', domain: 'altentee.com'
+  threads count: 1 do
+    transaction name: 'Google Search' do
+      visit name: 'Home Page', url: 'http://google.com/'
     end
   end
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_cache.rb

@@ -2,10 +2,10 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  cache :clear_each_iteration => true
-  threads 1 do
-    transaction 'Google Search' do
-      visit 'Home Page', 'http://google.com/'
+  cache clear_each_iteration: true
+  threads count: 1 do
+    transaction name: 'Google Search' do
+      visit name: 'Home Page', url: 'http://google.com/'
     end
   end
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_cookies.rb

@@ -2,10 +2,10 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  cookies :clear_each_iteration => false
-  threads 1 do
-    transaction 'Google Search' do
-      visit 'Home Page', 'http://google.com/'
+  cookies clear_each_iteration: false
+  threads count: 1 do
+    transaction name: 'Google Search' do
+      visit name: 'Home Page', url: 'http://google.com/'
     end
   end
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_extract.rb

@@ -2,15 +2,9 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-
-  threads 100 do
-
-    visit 'Google', "http://google.com/" do
-      extract 'button_text', 'aria-label="(.+?)"'
-      extract :regex, 'button_text', 'aria-label="(.+?)"'
-      extract :xpath, 'button', '//button'
+  threads count: 100 do
+    visit name: 'Home', url: 'http://altentee.com' do
+      extract regex: "content='(.+?)' name='csrf-token'", name: 'csrf-token'
     end
-
   end
-
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_gc_results.rb

@@ -2,19 +2,22 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  threads 1, { :loops => 10 } do
-    visit 'Google Search', 'http://google.com'
+  cookies clear_each_iteration: false
+  threads count: 1 do
+    transaction name: 'Google Search' do
+      visit name: 'Home Page', url: 'http://google.com/'
+    end
   end
   
   #
   # You need jmeter-plugins at Google code
   #   http://code.google.com/p/jmeter-plugins
   #
-  gc_latencies_over_time 'Response Latencies Over Time'
-  gc_response_codes_per_second 'Response Codes per Second'
-  gc_response_times_distribution 'Response Times Distribution'
-  gc_response_times_over_time 'Response Times Over Time'
-  gc_response_times_percentiles 'Response Times Percentiles'
-  gc_transactions_per_second 'Transactions per Second'
+  latencies_over_time 'Response Latencies Over Time'
+  response_codes_per_second 'Response Codes per Second'
+  response_times_distribution 'Response Times Distribution'
+  response_times_over_time 'Response Times Over Time'
+  response_times_percentiles 'Response Times Percentiles'
+  transactions_per_second 'Transactions per Second'
 
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_google.rb

@@ -2,7 +2,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  threads 10 do
-    visit 'Google Search', 'http://google.com'
+  threads count: 1 do
+    visit name: 'Home Page', url: 'http://google.com/'
   end
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_grid.rb

@@ -2,10 +2,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  think_time 100
-  threads 100, {:ramp_time => 10, :loops => 10} do
-    transaction 'Home Page' do
-      visit 'Altentee', 'http://127.0.0.1:9200/'
-    end
+  threads count: 1 do
+    visit name: 'Home Page', url: 'http://google.com/'
   end
-end.grid('4dy-zJLEIgpYkKe6p6JhSQ', {:endpoint => '127.0.0.1:3000', :region => 'ap_southeast_1'})
+end.grid('4dy-zJLEIgpYkKe6p6JhSQ', {:region => 'ap_southeast_1'})

data/examples/basic_header.rb

@@ -2,16 +2,18 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  header 'User-Agent' => 'Firefox'
-  threads 1 do
-    transaction 'Google Search' do
-      visit 'Home Page', 'http://google.com/'
-    end
+  header name: 'Accept', value: '*'
+
+  with_user_agent :iphone
+
+  threads count: 1 do
+    visit name: 'Home Page', url: 'http://google.com/'
+  end
 
-    transaction 'Google Search via XHR' do
-      visit 'Home Page', 'http://google.com/' do
-        header 'X-Requested-With' => 'XMLHttpRequest'
-      end
+  transaction name: 'Google Search via XHR' do
+    visit name: 'Home Page', url: 'http://google.com/' do
+      with_xhr
     end
   end
-end.jmx
+  
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_ldap_ext.rb

@@ -2,16 +2,15 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  threads 1 do
-    ldap_ext 'ldap_ext sample', 
-      { 'test'       => 'sbind', 
-        'user_dn'    => 'user_dn',
-        'user_pw'    => 'user_password',
-        'servername' => 'your_ldap_server',
-        'secure'     => true,
-        'port'       => 636
-      }
+  threads count: 1 do
+    ldap_ext name: 'ldap_ext sample', 
+      test:        'sbind', 
+      user_dn:     'user_dn',
+      user_pw:     'user_password',
+      servername:  'your_ldap_server',
+      secure:      true,
+      port:        636
+      
   end
-  view_results     'tree'
-end.jmx
-
+  view_results name: 'debug'
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_post.rb

@@ -3,14 +3,13 @@ require 'gridinit-jmeter'
 
 test do
 
-  threads 1 do
+  threads count: 1 do
 
-    transaction 'Post with a Raw Body', {:parent => true} do
-      post 'Home Page', 'http://google.com', {
-        :raw_body => '{"name":"Big Poncho","price":10,"vendor_attendance_id":24,"product_id":1}'
-      }
+    transaction name: 'Post with a Raw Body', parent: false do
+      post name: 'Home Page', url: 'http://google.com', 
+        raw_body: '{"name":"Big Poncho","price":10,"vendor_attendance_id":24,"product_id":1}'
     end
 
   end
 
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_query_params.rb

@@ -2,7 +2,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  threads 10 do
-    visit 'Google Search', 'http://google.com/?hl=en&tbo=d&sclient=psy-ab&q=gridinit&oq=gridinit'#, {always_encode: true}
+  threads count: 10 do
+    visit name: 'Google Search', url: 'http://google.com/?hl=en&tbo=d&sclient=psy-ab&q=gridinit&oq=gridinit'
   end
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_think_time.rb

@@ -2,11 +2,14 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  threads 100 do
+  threads count: 100 do
+
     think_time 5000,5000
-    transaction 'Google Search' do
-      visit 'Home Page', 'http://google.com/'
+
+    transaction name: 'Google Search' do
+      visit name: 'Home Page', url: 'http://google.com/'
       random_timer 3000
     end
+
   end
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/basic_throughput_shaping_timer.rb

@@ -2,7 +2,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'gridinit-jmeter'
 
 test do
-  threads 100 do # threads = RPS * <max response time ms> / 1000
+  threads count: 100 do # threads = RPS * <max response time ms> / 1000
 
     throughput_shaper 'increasing load test', [
       { :start_rps => 100, :end_rps => 100, :duration => 60 },
@@ -13,9 +13,9 @@ test do
       { :start_rps => 600, :end_rps => 600, :duration => 60 }
     ]
 
-    transaction 'Google Search' do
-      visit 'Home Page', 'http://google.com/'
+    transaction name: 'Google Search' do
+      visit name: 'Home Page', url: 'http://google.com/'
     end
 
   end
-end.jmx
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/etsy_login_browse.rb

@@ -9,30 +9,30 @@ test do
 
   cookies
   
-  threads 1, {:loops => 10} do
+  threads :count => 1, :loops => 10 do
 
     random_timer 1000, 3000
 
     transaction '01_etsy_home' do
-      visit 'home', 'http://www.etsy.com/' do
-        assert 'contains', 'Etsy - Your place to buy and sell all things handmade, vintage, and supplies'
+      visit :name => 'home', :url => 'http://www.etsy.com/' do
+        assert 'contains' => 'Etsy - Your place to buy and sell all things handmade, vintage, and supplies'
       end
     end
 
-    once do
+    Once do
       transaction '02_etsy_signin' do
-        submit 'signin', 'https://www.etsy.com/signin', {
+        submit :name => 'signin', :url => 'https://www.etsy.com/signin',
           :fill_in => {
-            :username =>   'tim.koops@gmail.com',
-            :password =>   ARGV[0],
-            :persistent => 1,
-            :from_page =>  'http://www.etsy.com/',
+            :username    => 'tim.koops@gmail.com',
+            :password    => ARGV[0],
+            :persistent  => 1,
+            :from_page   => 'http://www.etsy.com/',
             :from_action => '',
-            :from_overlay => 1
-          }
-        } do
-          assert 'contains', 'Tim'
-          extract 'random_category', 'a href="(/browse.+?)"'
+            :from_name   => '',
+            :overlay     => 1
+          } do
+            assert 'contains' => 'Tim'
+            extract :regex => 'a href="(/browse.+?)"', :name => 'random_category'
         end
       end
     end   
@@ -40,25 +40,25 @@ test do
     exists 'random_category' do
 
       transaction '03_etsy_browse_random_category' do
-        visit 'browse', '${random_category}' do
-          extract 'random_sub_category', 'a href="(http.+?subcat.+?)"'
+        visit :name => 'browse', :url => '${random_category}' do
+          extract :regex => 'a href="(http.+?subcat.+?)"', :name => 'random_sub_category'
         end
       end
 
       transaction '04_etsy_browse_random_sub_category' do
-        visit 'browse', '${random_sub_category}' do
-          extract 'random_listing', 'a href="(/listing.+?)"'
+        visit :name => 'browse', :url => '${random_sub_category}' do
+          extract :regex => 'a href="(/listing.+?)"', :name => 'random_listing'
         end
       end
 
       transaction '05_etsy_view_random_listing' do
-        visit 'view', '${random_listing}'
+        visit :name => 'view', :url => '${random_listing}'
       end
 
     end
 
   end
 
-end.grid ARGV[1]
+# end.grid ARGV[1]
 # end.jmx
-# end.run(path: '/usr/share/jmeter/bin/')
+end.run(path: '/usr/share/jmeter/bin/', gui: true)