jmeter-ruby 3.0.0

data/examples/real_redis_data_set_with_setup.rb

@@ -0,0 +1,123 @@
+################################################################################
+# This is an example of how to use a Redis data set with CSV data.
+# The test plan defines a setup thread group with a JSR223 sampler (scripted in
+# Groovy), which pre-populates Redis with the data used for the actual test.
+# The test itself simply calls a REST API with data seeded from Redis.
+#
+# The redis key is "test_data" and the format of the CSV data is:
+#   user_id,start_date,end_date
+#
+# Requires:
+#  JMeter (recommended version: 2.13 or later)
+#  jmeter-plugins extras with libs (this gives us the redis data set config)
+#  Groovy 2.4 or later (put the groovy-all jar into $JMETER_HOME/lib)
+################################################################################
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+# For redis dataset config.
+redis_host = 'localhost'
+redis_port = 6379
+redis_key = 'test_data'
+num_records = 1000 # how many rows of test data to generate
+
+# for HTTP request defaults
+protocol = 'http'
+host = 'localhost'
+port = 8080
+
+# JMeter test plan begins here.
+test do
+
+  # Setup the data set we will use to run the tests.
+  setup_thread_group name: 'Redis Fill',
+    loops: 1 do
+    jsr223_sampler name: 'redis fill',
+      scriptLanguage: 'groovy',
+      cacheKey: 'prefill_user_ids',
+      script: <<-EOS.strip_heredoc
+import redis.clients.jedis.JedisPoolConfig;
+import redis.clients.jedis.JedisPool;
+import redis.clients.jedis.Jedis;
+
+import java.util.Random;
+import java.util.Date;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+
+JedisPoolConfig config = new JedisPoolConfig();
+JedisPool pool = new JedisPool(config, "#{redis_host}", #{redis_port});
+Jedis jedis = null;
+try {
+    jedis = pool.getResource();
+
+    //delete old data, if it exists
+    jedis.del("#{redis_key}");
+
+    // Create a list of the last 90 days. We will seed our test data from this.
+    Date now = new Date();
+    Date oldest = now - 90;
+    Range days = oldest..now;
+
+    Random random = new Random();
+    DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
+
+    /*
+     * Generate CSV data in the form of:
+     *   user_id,start_date,end_date
+     */
+    for (int i = 1; i <= #{num_records}; i++) {
+        Date day = days[random.nextInt(days.size())]
+        String data = [i, df.format(day), df.format(day)].join(',')
+        jedis.sadd("#{redis_key}", data);
+    }
+}finally {
+    if(jedis != null) {
+        pool.returnResource(jedis);
+    }
+}
+        EOS
+  end
+
+  # Defines a thread group. We allow certain parameters to be passed in
+  # as system properties.
+  threads name: 'Test Scenario - REST API query',
+    count: '${__P(threads,1)}',
+    rampup: '${__P(rampup,600)}',
+    duration: '${__P(duration, 600)}' do
+
+    # HTTP request defaults
+    defaults domain: host, # default domain if not specified in URL
+      protocol: protocol, # default protocol if not specified in URL
+      port: port,
+      download_resources: false # download images/CSS/JS (no)
+
+    cookies # om nom nom
+
+    cache clear_each_iteration: true # each thread iteration mimics a new user with an empty browser cache
+
+    with_gzip # add HTTP request headers to allow GZIP compression. Most sites support this nowadays.
+
+    # Test data. Note how the variableNames match the variables used by the
+    # sampler below.
+    redis_data_set 'test data',
+      redisKey: redis_key,
+      host: redis_host,
+      port: redis_port,
+      variableNames: 'user_id,start_date,end_date'
+
+    # User workflow begins here.
+    visit name: 'REST API query',
+      url: '/rest/query',
+      always_encode: true,
+      fill_in: {
+        'user_id' => '${user_id}',
+        'start' => '${start_date}',
+        'end' => '${end_date}'
+      }
+  end
+
+  response_time_graph
+  view_results_tree
+end.jmx(file: 'real_redis_data_set_with_setup.jmx')

data/examples/real_user_objects_github.rb

@@ -0,0 +1,112 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+# Virtual user definitions
+class VirtualUser
+
+  # initializes the VirtualUser object and adds some default test
+  # components.
+  # @param dsl the dsl
+  def initialize(dsl)
+    @dsl = dsl
+
+    defaults domain: 'github.com', # default domain if not specified in URL
+      protocol: 'http', # default protocol if not specified in URL
+      download_resources: true, # download images/CSS/JS
+      use_concurrent_pool: 6, # mimic Chrome/IE parallelism for images/CSS/JS
+      urls_must_match: '(https?.\/\/)?([^\.]*\.)*(github\.com)?\/.*' # only download resources for the target domain
+
+    cookies # om nom nom
+
+    cache clear_each_iteration: true # each thread iteration mimics a new user with an empty browser cache
+
+    with_user_agent 'ie9' # send IE9 browser headers
+
+    with_gzip # add HTTP request headers to allow GZIP compression. Most sites support this nowadays.
+
+  end
+
+  # Adds a user think time. Note that this is slightly different than the
+  # default JMeter think time, in that it executes sequentially with test steps.
+  # @param delay [int] the target pause time, in milliseconds
+  # @param deviation [int] the pause deviation, in milliseconds
+  def pause(delay=30000, deviation=5000)
+    test_action name: 'Think Time', action: 1, target: 0, duration: 0 do
+       think_time delay, deviation
+    end
+  end
+
+  # Requests the home page.
+  def home_page
+    visit name: 'Home page', url: '/'
+    pause
+  end
+
+  # Searches for a repository.
+  # @param repo [String] the repository to search for
+  def search_for_repository(repo)
+    visit name: 'Search for project', url: '/search',
+      always_encode: true,
+      fill_in: {
+        'q' => repo,
+        'ref' => 'cmdform'
+      }
+    pause
+  end
+
+  # Visits a repository page.
+  # @param repo_path [String] the repository URL path
+  def view_repository(repo_path)
+    visit name: 'Repository page', url: repo_path
+    pause
+  end
+
+  # Views a branch/tag page.
+  # @param branch_path [String] the branch URL path
+  def view_branch(branch_path)
+    visit name: 'Branch page', url: branch_path
+    pause
+  end
+
+  ####################################################################
+  private
+
+  # Passes method calls through to the underlying DSL.
+  # @param method the method
+  # @param args the arguments
+  # @param block the block
+  def method_missing method, *args, &block
+    @dsl.__send__ method, *args, &block
+  end
+  ####################################################################
+end
+
+# JMeter test plan begins here.
+test do
+
+  # Defines a thread group. We allow certain parameters to be passed in
+  # as system properties.
+  threads count: '${__P(threads,1)}',
+    rampup: '${__P(rampup,600)}',
+    name: 'Test Scenario - GitHub project navigation',
+    duration: '${__P(duration, 600)}' do
+
+    user = VirtualUser.new(self) # This will add a bunch of test components.
+
+    # In the event of an error, the thread will start a new loop. If this
+    # happens on the first request, we could start flooding the site with
+    # requests.
+    # To prevent this from happening, we insert a quick pause before the
+    # first request.
+    user.pause 1000,0
+
+    # User workflow begins here.
+    # Note that think times are defined inside the page methods.
+    user.home_page
+    user.search_for_repository 'jmeter-ruby'
+    user.view_repository '/flood-io/jmeter-ruby'
+    user.view_branch '/flood-io/jmeter-ruby/tree/v2.11.8'
+
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)
+

data/examples/regular_expression_extractor.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 1 do
+    visit name: 'Home', url: 'https://flooded.io' do
+      regex pattern: "content='(.+?)' name='csrf-token'", name: 'csrf-token', match_number: 1, default: '424242'
+      regex pattern: 'pattern', name: 'jmeter_variable_regex', variable: 'test'
+      regex pattern: 'pattern', name: 'jmeter_headers_regex', useHeaders: true
+    end
+  end
+end.run(path: '/usr/local/share/jmeter-3.1/bin/', gui: true)

data/examples/response_assertion.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  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'
+        assert 'substring' => 'Something in frames', variable: 'test'
+        assert pattern: 'pattern', test_field: 'Assertion.response_headers'
+      end
+    end
+  end
+end.run(path: '/usr/local/share/jmeter-3.1/bin/', gui: true)

data/examples/response_time_percentiles_graph.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 100 do
+    response_times_percentiles 'Response Times Percentiles', filename: '/path/to/output', update_at_xpath: [
+      { '//value/xml' => 'false' }
+    ]
+
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/rsync.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 10 do
+    visit name: 'Home Page', url: 'https://flooded.io'
+  end
+end.rsync(
+  remote_host: 'xxx.xxx.xxx.xxx',
+  remote_user: 'user',
+  remote_path: '/path/to/remote',
+  rsync_bin_path: '/usr/bin/rsync',
+  rsync_params: '-az -e "ssh -i /path/to/key.pem"',
+  file: './jmx/' + File.basename(__FILE__, ".rb") + '.jmx',
+  debug: true
+)

data/examples/sample_transaction.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 1 do
+    # this will let you sample 1 in every N (e.g. 100) transactions on Flood IO
+    get name: 'Home Page', sample: 100, url: 'http://google.com/'
+
+    post name: 'create session', url: '/api/oauth', sample: 100,
+      fill_in: {
+        username: 'Michel Rosen',
+        password: 4141414141
+      } do
+        extract json: '.access_token', name: 'access_token'
+      with_xhr
+    end
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/simple_data_writer_listener.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 1 do
+    visit name: 'Home Page', url: 'https://flooded.io/'
+
+    # write errors to a simple data writer with the log alias
+    log filename: '/var/log/flood/custom.log', error_logging: true
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/stepping_thread_group.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+
+  defaults domain: 'example.com'
+
+  with_user_agent :chrome
+
+  header [
+    { name: 'Accept-Encoding', value: 'gzip,deflate,sdch' },
+    { name: 'Accept', value: 'text/javascript, text/html, application/xml, text/xml, */*' }
+  ]
+
+  step  name: 'stepping thread group example',
+        total_threads: 200,
+        initial_delay: 0,
+        start_threads: 20,
+        add_threads: 0,
+        start_every: 30,
+        stop_threads: 50,
+        stop_every: 5,
+        flight_time: 1800,
+        rampup: 5 do
+
+    random_timer 1000, 3000
+
+    get name: 'home', url: '/'
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/test_fragment.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+
+  test_fragment name: 'anonymous_user', enabled: false do
+    get name: 'Home Page', url: 'http://google.com'
+  end
+
+  threads count: 1 do
+    module_controller test_fragment: 'WorkBench/TestPlan/anonymous_user'
+  end
+
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/think_time.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 100 do
+
+    think_time 5000, 5000
+
+    transaction name: 'Google Search' do
+      visit name: 'Home Page', url: 'https://flooded.io/'
+      random_timer 3000
+    end
+
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/thread_groups.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 100, rampup: 3600, loops: 10, scheduler: false do
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/throughput_controller.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 100 do
+
+    think_time 5000,5000
+
+    throughput_controller percent: 99 do
+      transaction name: "TC_01", parent: true, include_timers: true
+    end
+
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/throughput_shaping_timer.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 100 do # threads = RPS * <max response time ms> / 1000
+
+    throughput_shaper name: 'increasing load test', steps: [
+      { :start_rps => 100, :end_rps => 100, :duration => 60 },
+      { :start_rps => 200, :end_rps => 200, :duration => 60 },
+      { :start_rps => 300, :end_rps => 300, :duration => 60 },
+      { :start_rps => 400, :end_rps => 400, :duration => 60 },
+      { :start_rps => 500, :end_rps => 500, :duration => 60 },
+      { :start_rps => 600, :end_rps => 600, :duration => 60 }
+    ]
+
+    transaction name: 'Google Search' do
+      visit name: 'Home Page', url: 'https://flooded.io/'
+    end
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/ultimate_thread_group.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+
+  defaults domain: 'example.com'
+
+  with_user_agent :chrome
+
+  header [
+    { name: 'Accept-Encoding', value: 'gzip,deflate,sdch' },
+    { name: 'Accept', value: 'text/javascript, text/html, application/xml, text/xml, */*' }
+  ]
+
+  ultimate  name: 'ultimate thread group example',
+            on_sample_error: 'startnextloop',
+            threads: [
+              {
+                start_threads: 200,
+                initial_delay: 0,
+                start_time: 30,
+                hold_time: 60,
+                stop_time: 5
+              },
+              {
+                start_threads: 200,
+                initial_delay: 60,
+                start_time: 30,
+                hold_time: 60,
+                stop_time: 5
+              }
+          ] do
+
+    random_timer 1000, 3000
+
+    get name: 'home', url: '/'
+
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/unicode.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 1 do
+    visit 'https://flood.io/?unicode=åß∂˙∆¬¬'
+  end
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/user_defined_variables.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  # user defined with multiple values
+  variables [
+    { name: 'email', value: 'support@flood.io' },
+    { name: 'password', value: 'password' }
+  ]
+end.run(path: '/usr/share/jmeter/bin/', gui: true)

data/examples/user_parameters.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  # user parameters with multiple values
+  post name: 'oauth', url: 'https://flooded.io/api/oauth',  raw_body: '${token}' do
+    user_parameters names: ['token'],
+    thread_values: {
+      user_1: [
+        '<xml>fidget widget</xml>'
+      ]
+    }
+
+    user_parameters names: ['name1', 'name2'],
+      thread_values: {
+        user_1: [
+          'user1_value1',
+          'user1_value2'
+        ],
+
+        user_2: [
+          'user2_value1',
+          'user2_value2'
+        ]
+      },
+      per_iteration: true
+  end
+end.run(path: '/usr/local/share/jmeter-3.1/bin/', gui: true)

data/examples/uuid_per_iteration.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jmeter-ruby'
+
+test do
+  threads count: 1, loops: 5, scheduler: false do
+    # Helper method to generate a single UUID per iteration
+    uuid_per_iteration
+
+    dummy_sampler name: '${__threadNum} - ${UUID}'
+    dummy_sampler name: '${__threadNum} - ${UUID}'
+    dummy_sampler name: '${__threadNum} - ${UUID}'
+
+    view_results
+  end
+end.run(path: '/usr/local/share/jmeter-3.1/bin', gui: true)

data/jmeter-ruby.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jmeter-ruby/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'jmeter-ruby'
+  gem.version       = JmeterRuby::VERSION::STRING
+  gem.authors       = ['Reegan Viljoen']
+  gem.email         = ['reeganviljoen@outlook.com']
+  gem.description   = %q{Ruby based DSL for writing JMeter test plans}
+  gem.summary       = %q{Ruby based DSL for writing JMeter test plans}
+  gem.homepage      = 'https://github.com/reeganviljoen/jmeter-ruby/issues'
+  gem.required_ruby_version = ">= 3.1.0"
+
+  gem.add_dependency 'rest-client'
+  gem.add_dependency 'nokogiri'
+  gem.add_runtime_dependency('json-jruby') if RUBY_PLATFORM == 'java'
+
+  gem.add_development_dependency "simplecov", "~> 0.22.0"
+  gem.add_development_dependency "simplecov-console", "~> 0.9.1"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.license       = 'MIT'
+end