Class: RubyJmeter::ExtendedDSL

Inherits:
DSL
  • Object
show all
Includes:
Parser
Defined in:
lib/ruby-jmeter/dsl.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Parser

#files, #fill_in, #parse_http_request, #parse_test_type, #parse_uri, #parse_url, #raw_body

Methods inherited from DSL

#access_log_sampler, #aggregate_graph, #aggregate_report, #ajp13_sampler, #assertion_results, #beanshell_assertion, #beanshell_listener, #beanshell_postprocessor, #beanshell_preprocessor, #beanshell_sampler, #beanshell_timer, #bsf_assertion, #bsf_listener, #bsf_postprocessor, #bsf_preprocessor, #bsf_sampler, #bsf_timer, #compare_assertion, #comparison_assertion_visualizer, #constant_timer, #counter, #cssjquery_extractor, #csv_data_set_config, #debug_postprocessor, #debug_sampler, #distribution_graphalpha, #duration_assertion, #foreach_controller, #ftp_request, #ftp_request_defaults, #gaussian_random_timer, #generate_summary_results, #graph_results, #html_assertion, #html_link_parser, #html_parameter_mask, #http_authorization_manager, #http_request, #http_url_rewriting_modifier, #if_controller, #include_controller, #java_request, #java_request_defaults, #jdbc_connection_configuration, #jdbc_postprocessor, #jdbc_preprocessor, #jdbc_request, #jms_pointtopoint, #jms_publisher, #jms_subscriber, #jsr223_assertion, #jsr223_listener, #jsr223_postprocessor, #jsr223_preprocessor, #jsr223_sampler, #jsr223_timer, #junit_request, #keystore_configuration, #ldap_extended_request, #ldap_extended_request_defaults, #ldap_request, #ldap_request_defaults, #login_config_element, #mail_reader_sampler, #mailer_visualizer, #md5hex_assertion, #monitor_results, #once_only_controller, #os_process_sampler, #poisson_random_timer, #random_controller, #random_order_controller, #random_variable, #recording_controller, #regex_user_parameters, #regular_expression_extractor, #response_time_graph, #result_status_action_handler, #runtime_controller, #save_responses_to_a_file, #simple_config_element, #simple_controller, #simple_data_writer, #smime_assertion, #smtp_sampler, #spline_visualizer, #summary_report, #switch_controller, #synchronizing_timer, #tcp_sampler, #tcp_sampler_config, #test_action, #test_plan, #uniform_random_timer, #view_results_in_table, #view_results_tree, #while_controller, #xml_assertion, #xml_schema_assertion, #xpath_assertion, #xpath_extractor

Constructor Details

#initialize(params = {}) ⇒ ExtendedDSL

Returns a new instance of ExtendedDSL.



6
7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/ruby-jmeter/dsl.rb', line 6

def initialize(params = {})
  @root = Nokogiri::XML(<<-EOF.strip_heredoc)
    <?xml version="1.0" encoding="UTF-8"?>
    <jmeterTestPlan version="1.2" properties="2.4" jmeter="2.9 r1437961">
    <hashTree>
    </hashTree>
    </jmeterTestPlan>
  EOF
  node = RubyJmeter::TestPlan.new(params)

  @current_node = @root.at_xpath("//jmeterTestPlan/hashTree")
  @current_node = attach_to_last(node)
end

Instance Attribute Details

#root ⇒ Object

Returns the value of attribute root.



4
5
6
 
# File 'lib/ruby-jmeter/dsl.rb', line 4

def root
  @root
end

Instance Method Details

#console_status_logger(name = "Console Status Logger", params = {}, &block) ⇒ Object Also known as: console 



395
396
397
398
 
# File 'lib/ruby-jmeter/dsl.rb', line 395

def console_status_logger(name="Console Status Logger", params={}, &block)
  node = RubyJmeter::Plugins::ConsoleStatusLogger.new(name, params)
  attach_node(node, &block)
end

#constant_throughput_timer(params, &block) ⇒ Object Also known as: ConstantThroughputTimer 



338
339
340
341
342
343
344
345
 
# File 'lib/ruby-jmeter/dsl.rb', line 338

def constant_throughput_timer(params, &block)
  params[:value] ||= params[:throughput] || 0.0

  node = RubyJmeter::ConstantThroughputTimer.new(params)
  node.doc.xpath(".//value").first.content = params[:value].to_f

  attach_node(node, &block)
end

#delete(*args, &block) ⇒ Object 



115
116
117
118
119
120
121
122
123
 
# File 'lib/ruby-jmeter/dsl.rb', line 115

def delete(*args, &block)
  params = args.shift || {}
  params = { url: params }.merge(args.shift || {}) if params.class == String
  params[:method] ||= 'DELETE'
  params[:name] ||= params[:url]
  parse_http_request(params)
  node = RubyJmeter::HttpRequest.new(params)
  attach_node(node, &block)
end

#dummy_sampler(name = "Dummy Sampler", params = {}, &block) ⇒ Object Also known as: dummy 



409
410
411
412
 
# File 'lib/ruby-jmeter/dsl.rb', line 409

def dummy_sampler(name="Dummy Sampler", params={}, &block)
  node = RubyJmeter::Plugins::DummySampler.new(name, params)
  attach_node(node, &block)
end

#exists(variable, &block) ⇒ Object 



208
209
210
211
212
213
214
215
 
# File 'lib/ruby-jmeter/dsl.rb', line 208

def exists(variable, &block)
  params ||= {}
  params[:condition] = "\"${#{variable}}\" != \"\\${#{variable}}\""
  params[:useExpression] = false
  params[:name] = "if ${#{variable}}"
  node = RubyJmeter::IfController.new(params)
  attach_node(node, &block)
end

#extract(params, &block) ⇒ Object Also known as: web_reg_save_param 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/ruby-jmeter/dsl.rb', line 308

def extract(params, &block)
  node = if params[:regex]
    params[:refname] = params[:name]
    params[:regex] = params[:regex] #CGI.escapeHTML
    params[:template] = params[:template] || "$1$"
    RubyJmeter::RegularExpressionExtractor.new(params)
  elsif params[:xpath]
    params[:refname] = params[:name]
    params[:xpathQuery] = params[:xpath]
    RubyJmeter::XpathExtractor.new(params)
  elsif params[:json]
    params[:VAR] = params[:name]
    params[:JSONPATH] = params[:json]
    RubyJmeter::Plugins::JsonPathExtractor.new(params)
  end
  attach_node(node, &block)
end

#flood(token, params = {}) ⇒ Object Also known as: grid 



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/ruby-jmeter/dsl.rb', line 462

def flood(token, params={})
  if params[:region] == 'local'
    logger.info "Starting test ..."
    params[:started] = Time.now
    run params
    params[:stopped] = Time.now
    logger.info "Completed test ..."
    logger.debug "Uploading results ..." if params[:debug]
  end
  RestClient.proxy = params[:proxy] if params[:proxy]
  begin
    file = Tempfile.new(['jmeter', '.jmx'])
    file.write(doc.to_xml(:indent => 2))
    file.rewind

    response = RestClient.post "#{params[:endpoint] ? params[:endpoint] : 'https://api.flood.io'}/floods?auth_token=#{token}",
    {
      :flood => {
        :tool => 'jmeter-2.11',
        :url => params[:url],
        :name => params[:name],
        :notes => params[:notes],
        :tag_list => params[:tag_list],
        :threads => params[:threads],
        :rampup => params[:ramup],
        :duration => params[:duration],
        :override_hosts => params[:override_hosts],
        :override_parameters => params[:override_parameters],
        # specials for API
        :started => params[:started],
        :stopped => params[:stopped]
      },
      :flood_files => {
        :file => File.new("#{file.path}", 'rb')
      },
      :results => (File.new("#{params[:jtl] ? params[:jtl] : 'jmeter.jtl'}", 'rb') if params[:region] == 'local'),
      :region => params[:region],
      :multipart => true,
      :content_type => 'application/octet-stream'
    }.merge(params)
    if response.code == 200
      logger.info "Flood results at: #{JSON.parse(response)["response"]["results"]["link"]}"
    else
      logger.fatal "Sorry there was an error: #{JSON.parse(response)["error_description"]}"
    end
  rescue => e
    logger.fatal "Sorry there was an error: #{JSON.parse(e.response)["error_description"]}"
  end
end

#get(*args, &block) ⇒ Object Also known as: visit

HTTP Samplers



91
92
93
94
95
96
97
98
99
 
# File 'lib/ruby-jmeter/dsl.rb', line 91

def get(*args, &block)
  params = args.shift || {}
  params = { url: params }.merge(args.shift || {}) if params.class == String
  params[:method] ||= 'GET'
  params[:name] ||= params[:url]
  parse_http_request(params)
  node = RubyJmeter::HttpRequest.new(params)
  attach_node(node, &block)
end

#http_cache_manager(params = {}, &block) ⇒ Object Also known as: cache 



49
50
51
52
 
# File 'lib/ruby-jmeter/dsl.rb', line 49

def http_cache_manager(params={}, &block)
  params[:clearEachIteration] = true if params.keys.include? :clear_each_iteration
  super
end

#http_cookie_manager(params = {}, &block) ⇒ Object Also known as: cookies 



42
43
44
45
 
# File 'lib/ruby-jmeter/dsl.rb', line 42

def http_cookie_manager(params={}, &block)
  params[:clearEachIteration] = true if params.keys.include? :clear_each_iteration
  super
end

#http_header_manager(params, &block) ⇒ Object Also known as: header 



61
62
63
64
65
66
 
# File 'lib/ruby-jmeter/dsl.rb', line 61

def http_header_manager(params, &block)
  if params.is_a?(Hash)
    params['Header.name'] = params[:name]
  end
  super
end

#http_request_defaults(params = {}, &block) ⇒ Object Also known as: defaults 



32
33
34
35
36
37
38
 
# File 'lib/ruby-jmeter/dsl.rb', line 32

def http_request_defaults(params={}, &block)
  params[:image_parser] = true if params.keys.include? :download_resources
  params[:concurrentDwn] = true if params.keys.include? :use_concurrent_pool
  params[:concurrentPool] = params[:use_concurrent_pool] if params.keys.include? :use_concurrent_pool
  params[:embedded_url_re] = params[:urls_must_match] if params.keys.include? :urls_must_match
  super
end

#jmx(params = {}) ⇒ Object 



422
423
424
425
 
# File 'lib/ruby-jmeter/dsl.rb', line 422

def jmx(params={})
  file(params)
  logger.info "Test plan saved to: #{params[:file]}"
end

#latencies_over_time(name = "Response Latencies Over Time", params = {}, &block) ⇒ Object 



390
391
392
393
 
# File 'lib/ruby-jmeter/dsl.rb', line 390

def latencies_over_time(name="Response Latencies Over Time", params={}, &block)
  node = RubyJmeter::Plugins::LatenciesOverTime.new(name, params)
  attach_node(node, &block)
end

#loop_controller(params, &block) ⇒ Object Also known as: Loop 



219
220
221
222
 
# File 'lib/ruby-jmeter/dsl.rb', line 219

def loop_controller(params, &block)
  params[:loops] = params[:count] || 1
  super
end

#module_controller(params, &block) ⇒ Object

Other Elements



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/ruby-jmeter/dsl.rb', line 262

def module_controller(params, &block)
  node = RubyJmeter::ModuleController.new(params)

  node_path = params.kind_of?(Array) ? [] : (params[:node_path] || [])
  node_path.each_with_index do |node_name, index|
    node.doc.at_xpath('//collectionProp') <<
      Nokogiri::XML(<<-EOS.strip_heredoc).children
        <stringProp name="node_#{index}">#{node_name}</stringProp>
      EOS
  end

  attach_node(node, &block)
end

#out(params = {}) ⇒ Object

API Methods



418
419
420
 
# File 'lib/ruby-jmeter/dsl.rb', line 418

def out(params={})
  puts doc.to_xml(:indent => 2)
end

#post(*args, &block) ⇒ Object Also known as: submit 



103
104
105
106
107
108
109
110
111
 
# File 'lib/ruby-jmeter/dsl.rb', line 103

def post(*args, &block)
  params = args.shift || {}
  params = { url: params }.merge(args.shift || {}) if params.class == String
  params[:method] ||= 'POST'
  params[:name] ||= params[:url]
  parse_http_request(params)
  node = RubyJmeter::HttpRequest.new(params)
  attach_node(node, &block)
end

#put(*args, &block) ⇒ Object 



125
126
127
128
129
130
131
132
133
 
# File 'lib/ruby-jmeter/dsl.rb', line 125

def put(*args, &block)
  params = args.shift || {}
  params = { url: params }.merge(args.shift || {}) if params.class == String
  params[:method] ||= 'PUT'
  params[:name] ||= params[:url]
  parse_http_request(params)
  node = RubyJmeter::HttpRequest.new(params)
  attach_node(node, &block)
end

#random_timer(delay = 0, range = 0, &block) ⇒ Object Also known as: think_time 



328
329
330
331
332
333
334
 
# File 'lib/ruby-jmeter/dsl.rb', line 328

def random_timer(delay=0, range=0, &block)
  params={}
  params[:delay] = delay
  params[:range] = range
  node = RubyJmeter::GaussianRandomTimer.new(params)
  attach_node(node, &block)
end

#response_assertion(params = {}, &block) ⇒ Object Also known as: assert, web_reg_find 



349
350
351
352
353
354
355
356
 
# File 'lib/ruby-jmeter/dsl.rb', line 349

def response_assertion(params={}, &block)
  params[:test_type] = parse_test_type(params)
  params["0"] = params.values.first
  node = RubyJmeter::ResponseAssertion.new(params)
  node.doc.xpath("//stringProp[@name='Assertion.scope']").remove if
    params[:scope] == 'main' || params['scope'] == 'main'
  attach_node(node, &block)
end

#response_codes_per_second(name = "Response Codes per Second", params = {}, &block) ⇒ Object

JMeter Plugins



365
366
367
368
 
# File 'lib/ruby-jmeter/dsl.rb', line 365

def response_codes_per_second(name="Response Codes per Second", params={}, &block)
  node = RubyJmeter::Plugins::ResponseCodesPerSecond.new(name, params)
  attach_node(node, &block)
end

#response_times_distribution(name = "Response Times Distribution", params = {}, &block) ⇒ Object 



370
371
372
373
 
# File 'lib/ruby-jmeter/dsl.rb', line 370

def response_times_distribution(name="Response Times Distribution", params={}, &block)
  node = RubyJmeter::Plugins::ResponseTimesDistribution.new(name, params)
  attach_node(node, &block)
end

#response_times_over_time(name = "Response Times Over Time", params = {}, &block) ⇒ Object 



375
376
377
378
 
# File 'lib/ruby-jmeter/dsl.rb', line 375

def response_times_over_time(name="Response Times Over Time", params={}, &block)
  node = RubyJmeter::Plugins::ResponseTimesOverTime.new(name, params)
  attach_node(node, &block)
end

#response_times_percentiles(name = "Response Times Percentiles", params = {}, &block) ⇒ Object 



380
381
382
383
 
# File 'lib/ruby-jmeter/dsl.rb', line 380

def response_times_percentiles(name="Response Times Percentiles", params={}, &block)
  node = RubyJmeter::Plugins::ResponseTimesPercentiles.new(name, params)
  attach_node(node, &block)
end

#run(params = {}) ⇒ Object 



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/ruby-jmeter/dsl.rb', line 435

def run(params={})
  file(params)
  logger.warn "Test executing locally ..."
  properties = params.has_key?(:properties) ? params[:properties] : "#{File.dirname(__FILE__)}/helpers/jmeter.properties"
  properties = "-q #{properties}" if properties

  if params[:remote_hosts]
    remote_hosts = params[:remote_hosts]
    remote_hosts = remote_hosts.join(',') if remote_hosts.kind_of?(Array)
    remote_hosts = "-R #{remote_hosts}"
  end

  cmd = "#{params[:path]}jmeter #{"-n" unless params[:gui] } -t #{params[:file]} -j #{params[:log] ? params[:log] : 'jmeter.log' } -l #{params[:jtl] ? params[:jtl] : 'jmeter.jtl' } #{properties} #{remote_hosts}"
  logger.debug cmd if params[:debug]
  Open3.popen2e("#{cmd}") do |stdin, stdout_err, wait_thr|
    while line = stdout_err.gets
      logger.debug line.chomp if params[:debug]
    end

    exit_status = wait_thr.value
    unless exit_status.success?
      abort "FAILED !!! #{cmd}"
    end
  end
  logger.info "Local Results at: #{params[:jtl] ? params[:jtl] : 'jmeter.jtl'}"
end

#soapxmlrpc_request(params, &block) ⇒ Object Also known as: soap

Other Samplers



180
181
182
183
 
# File 'lib/ruby-jmeter/dsl.rb', line 180

def soapxmlrpc_request(params, &block)
  params[:method] ||= 'POST'
  super
end

#test_data(*args, &block) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/ruby-jmeter/dsl.rb', line 150

def test_data(*args, &block)
  params = args.shift || {}
  params = { key: params.to_s }.merge(args.shift || {}) if(params.class == String || params.class == Symbol)
  params[:command] ||= 'SRANDMEMBER'
  params[:name] ||= 'testdata'
  params[:regex] ||= '"(.+?)"'
  params[:match_num] ||= -1
  params[:default] ||= ''

  params[:host] ||= '54.252.206.143'

  params[:url] = params[:key] if URI.parse(URI::encode(params[:key])).scheme

  params[:url] = if params[:host]
    "http://#{params[:host]}/data/#{params[:command]}/#{params[:key]}?type=text"
  end

  params[:url] = 'http://54.252.206.143/data/' if params[:stub]

  get name: '__testdata', url: params[:url] do
    extract name: params[:name],
      regex: params[:regex],
      match_num: params[:match_num],
      default: params[:default]
  end
end

#thread_group(*args, &block) ⇒ Object Also known as: threads 



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ruby-jmeter/dsl.rb', line 72

def thread_group(*args, &block)
  params = args.shift || {}
  params = { count: params }.merge(args.shift || {}) if params.class == Fixnum
  params[:num_threads]        = params[:count] || 1
  params[:ramp_time]          = params[:rampup] || (params[:num_threads]/2.0).ceil
  params[:start_time]         = params[:start_time] || Time.now.to_i * 1000
  params[:end_time]           = params[:end_time] || Time.now.to_i * 1000
  params[:duration]         ||= 60
  params[:continue_forever] ||= false
  params[:loops]              = -1 if params[:continue_forever]
  node = RubyJmeter::ThreadGroup.new(params)
  attach_node(node, &block)
end

#throughput_controller(params, &block) ⇒ Object Also known as: Throughput 



226
227
228
229
230
231
232
233
234
 
# File 'lib/ruby-jmeter/dsl.rb', line 226

def throughput_controller(params, &block)
  params[:style] = 1 if params[:percent]
  params[:maxThroughput] = params[:total] || params[:percent] || 1

  node = RubyJmeter::ThroughputController.new(params)
  node.doc.xpath(".//FloatProperty/value").first.content = params[:maxThroughput].to_f

  attach_node(node, &block)
end

#throughput_shaper(name = "Throughput Shaping Timer", steps = [], params = {}, &block) ⇒ Object Also known as: shaper 



402
403
404
405
 
# File 'lib/ruby-jmeter/dsl.rb', line 402

def throughput_shaper(name="Throughput Shaping Timer", steps=[], params={}, &block)
  node = RubyJmeter::Plugins::ThroughputShapingTimer.new(name, steps)
  attach_node(node, &block)
end

#to_doc ⇒ Object 



431
432
433
 
# File 'lib/ruby-jmeter/dsl.rb', line 431

def to_doc
  doc.clone
end

#to_xml ⇒ Object 



427
428
429
 
# File 'lib/ruby-jmeter/dsl.rb', line 427

def to_xml
  doc.to_xml(:indent => 2)
end

#transaction_controller(*args, &block) ⇒ Object Also known as: transaction

Controllers



197
198
199
200
201
202
203
204
 
# File 'lib/ruby-jmeter/dsl.rb', line 197

def transaction_controller(*args, &block)
  params = args.shift || {}
  params = { name: params }.merge(args.shift || {}) if params.class == String
  params[:parent] = params[:parent] || false
  params[:includeTimers] = params[:include_timers] || false
  node = RubyJmeter::TransactionController.new(params)
  attach_node(node, &block)
end

#transactions_per_second(name = "Transactions per Second", params = {}, &block) ⇒ Object 



385
386
387
388
 
# File 'lib/ruby-jmeter/dsl.rb', line 385

def transactions_per_second(name="Transactions per Second", params={}, &block)
  node = RubyJmeter::Plugins::TransactionsPerSecond.new(name, params)
  attach_node(node, &block)
end

#user_defined_variables(params, &block) ⇒ Object Also known as: variables

Config Elements



23
24
25
26
27
28
 
# File 'lib/ruby-jmeter/dsl.rb', line 23

def user_defined_variables(params, &block)
  if params.is_a?(Hash)
    params['Argument.name'] = params[:name]
  end
  super
end

#user_parameters(params, &block) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/ruby-jmeter/dsl.rb', line 276

def user_parameters(params, &block)
  if params.is_a?(Hash)
    params['Argument.name'] = params[:name]
  end

  params[:names] = Nokogiri::XML::Builder.new do |b|
    b.builder do
      params[:names].each do |name|
        b.stringProp name, name: name
      end
    end
  end

  params[:thread_values] = Nokogiri::XML::Builder.new do |b|
    b.builder do
      params[:thread_values].map do |user, values|
        b.collectionProp name: user do
          values.each_with_index.map do |value, index|
            b.stringProp value, name: index
          end
        end
      end
    end
  end

  super
end

#with_gzip ⇒ Object 



140
141
142
143
 
# File 'lib/ruby-jmeter/dsl.rb', line 140

def with_gzip
  http_header_manager name: 'Accept-Encoding',
                      value: 'gzip, deflate'
end

#with_json ⇒ Object 



145
146
147
148
 
# File 'lib/ruby-jmeter/dsl.rb', line 145

def with_json
  http_header_manager name: 'Accept',
                      value: 'text/html, application/xhtml+xml, application/xml;q=0.9, */*;q=0.8, application/json'
end

#with_user_agent(device) ⇒ Object 



56
57
58
59
 
# File 'lib/ruby-jmeter/dsl.rb', line 56

def with_user_agent(device)
  http_header_manager name: 'User-Agent',
                      value: RubyJmeter::UserAgent.new(device).string
end

#with_xhr ⇒ Object 



135
136
137
138
 
# File 'lib/ruby-jmeter/dsl.rb', line 135

def with_xhr
  http_header_manager name: 'X-Requested-With',
                      value: 'XMLHttpRequest'
end