jmeter-ruby 3.0.0

data/lib/jmeter-ruby/dsl/transaction_controller.rb

@@ -0,0 +1,26 @@
+module JmeterRuby
+  class DSL
+    def transaction_controller(params={}, &block)
+      node = JmeterRuby::TransactionController.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class TransactionController
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'TransactionController' : (params[:name] || 'TransactionController')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<TransactionController guiclass="TransactionControllerGui" testclass="TransactionController" testname="#{testname}" enabled="true">
+  <boolProp name="TransactionController.parent">true</boolProp>
+  <boolProp name="TransactionController.includeTimers">false</boolProp>
+</TransactionController>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/uniform_random_timer.rb

@@ -0,0 +1,26 @@
+module JmeterRuby
+  class DSL
+    def uniform_random_timer(params={}, &block)
+      node = JmeterRuby::UniformRandomTimer.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class UniformRandomTimer
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'UniformRandomTimer' : (params[:name] || 'UniformRandomTimer')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<UniformRandomTimer guiclass="UniformRandomTimerGui" testclass="UniformRandomTimer" testname="#{testname}" enabled="true">
+  <stringProp name="ConstantTimer.delay">0</stringProp>
+  <stringProp name="RandomTimer.range">100.0</stringProp>
+</UniformRandomTimer>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/user_defined_variables.rb

@@ -0,0 +1,33 @@
+module JmeterRuby
+  class DSL
+    def user_defined_variables(params={}, &block)
+      node = JmeterRuby::UserDefinedVariables.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class UserDefinedVariables
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'UserDefinedVariables' : (params[:name] || 'UserDefinedVariables')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<Arguments guiclass="ArgumentsPanel" testclass="Arguments" testname="#{testname}" enabled="true">
+  <collectionProp name="Arguments.arguments">
+    <elementProp name=" " elementType="Argument">
+      <stringProp name="Argument.name"> </stringProp>
+      <stringProp name="Argument.value"> </stringProp>
+      <stringProp name="Argument.metadata">=</stringProp>
+      <stringProp name="Argument.desc"> </stringProp>
+    </elementProp>
+  </collectionProp>
+  <stringProp name="TestPlan.comments"> </stringProp>
+</Arguments>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/user_parameters.rb

@@ -0,0 +1,30 @@
+module JmeterRuby
+  class DSL
+    def user_parameters(params={}, &block)
+      node = JmeterRuby::UserParameters.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class UserParameters
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'UserParameters' : (params[:name] || 'UserParameters')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<UserParameters guiclass="UserParametersGui" testclass="UserParameters" testname="#{testname}" enabled="true">
+  <collectionProp name="UserParameters.names"/>
+  <collectionProp name="UserParameters.thread_values">
+    <collectionProp name="1"/>
+    <collectionProp name="1"/>
+  </collectionProp>
+  <boolProp name="UserParameters.per_iteration">false</boolProp>
+</UserParameters>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/view_results_in_table.rb

@@ -0,0 +1,55 @@
+module JmeterRuby
+  class DSL
+    def view_results_in_table(params={}, &block)
+      node = JmeterRuby::ViewResultsInTable.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class ViewResultsInTable
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'ViewResultsInTable' : (params[:name] || 'ViewResultsInTable')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<ResultCollector guiclass="TableVisualizer" testclass="ResultCollector" testname="#{testname}" enabled="true">
+  <boolProp name="ResultCollector.error_logging">false</boolProp>
+  <objProp>
+    <name>saveConfig</name>
+    <value class="SampleSaveConfiguration">
+      <time>true</time>
+      <latency>true</latency>
+      <timestamp>true</timestamp>
+      <success>true</success>
+      <label>true</label>
+      <code>true</code>
+      <message>false</message>
+      <threadName>true</threadName>
+      <dataType>false</dataType>
+      <encoding>false</encoding>
+      <assertions>false</assertions>
+      <subresults>false</subresults>
+      <responseData>false</responseData>
+      <samplerData>false</samplerData>
+      <xml>false</xml>
+      <fieldNames>false</fieldNames>
+      <responseHeaders>false</responseHeaders>
+      <requestHeaders>false</requestHeaders>
+      <responseDataOnError>false</responseDataOnError>
+      <saveAssertionResultsFailureMessage>false</saveAssertionResultsFailureMessage>
+      <assertionsResultsToSave>0</assertionsResultsToSave>
+      <bytes>true</bytes>
+      <threadCounts>true</threadCounts>
+      <sampleCount>true</sampleCount>
+    </value>
+  </objProp>
+  <stringProp name="filename"/>
+</ResultCollector>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/view_results_tree.rb

@@ -0,0 +1,55 @@
+module JmeterRuby
+  class DSL
+    def view_results_tree(params={}, &block)
+      node = JmeterRuby::ViewResultsTree.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class ViewResultsTree
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'ViewResultsTree' : (params[:name] || 'ViewResultsTree')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<ResultCollector guiclass="ViewResultsFullVisualizer" testclass="ResultCollector" testname="#{testname}" enabled="true">
+  <boolProp name="ResultCollector.error_logging">false</boolProp>
+  <objProp>
+    <name>saveConfig</name>
+    <value class="SampleSaveConfiguration">
+      <time>true</time>
+      <latency>true</latency>
+      <timestamp>true</timestamp>
+      <success>true</success>
+      <label>true</label>
+      <code>true</code>
+      <message>false</message>
+      <threadName>true</threadName>
+      <dataType>false</dataType>
+      <encoding>false</encoding>
+      <assertions>false</assertions>
+      <subresults>false</subresults>
+      <responseData>false</responseData>
+      <samplerData>false</samplerData>
+      <xml>false</xml>
+      <fieldNames>false</fieldNames>
+      <responseHeaders>false</responseHeaders>
+      <requestHeaders>false</requestHeaders>
+      <responseDataOnError>false</responseDataOnError>
+      <saveAssertionResultsFailureMessage>false</saveAssertionResultsFailureMessage>
+      <assertionsResultsToSave>0</assertionsResultsToSave>
+      <bytes>true</bytes>
+      <threadCounts>true</threadCounts>
+      <sampleCount>true</sampleCount>
+    </value>
+  </objProp>
+  <stringProp name="filename"/>
+</ResultCollector>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/while_controller.rb

@@ -0,0 +1,25 @@
+module JmeterRuby
+  class DSL
+    def while_controller(params={}, &block)
+      node = JmeterRuby::WhileController.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class WhileController
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'WhileController' : (params[:name] || 'WhileController')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<WhileController guiclass="WhileControllerGui" testclass="WhileController" testname="#{testname}" enabled="true">
+  <stringProp name="WhileController.condition"/>
+</WhileController>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/xml_assertion.rb

@@ -0,0 +1,23 @@
+module JmeterRuby
+  class DSL
+    def xml_assertion(params={}, &block)
+      node = JmeterRuby::XmlAssertion.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class XmlAssertion
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'XmlAssertion' : (params[:name] || 'XmlAssertion')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<XMLAssertion guiclass="XMLAssertionGui" testclass="XMLAssertion" testname="#{testname}" enabled="true"/>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/xml_schema_assertion.rb

@@ -0,0 +1,25 @@
+module JmeterRuby
+  class DSL
+    def xml_schema_assertion(params={}, &block)
+      node = JmeterRuby::XmlSchemaAssertion.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class XmlSchemaAssertion
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'XmlSchemaAssertion' : (params[:name] || 'XmlSchemaAssertion')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<XMLSchemaAssertion guiclass="XMLSchemaAssertionGUI" testclass="XMLSchemaAssertion" testname="#{testname}" enabled="true">
+  <stringProp name="xmlschema_assertion_filename"/>
+</XMLSchemaAssertion>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/xpath_assertion.rb

@@ -0,0 +1,31 @@
+module JmeterRuby
+  class DSL
+    def xpath_assertion(params={}, &block)
+      node = JmeterRuby::XpathAssertion.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class XpathAssertion
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'XpathAssertion' : (params[:name] || 'XpathAssertion')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<XPathAssertion guiclass="XPathAssertionGui" testclass="XPathAssertion" testname="#{testname}" enabled="true">
+  <boolProp name="XPath.negate">false</boolProp>
+  <stringProp name="XPath.xpath">/</stringProp>
+  <boolProp name="XPath.validate">false</boolProp>
+  <boolProp name="XPath.whitespace">false</boolProp>
+  <boolProp name="XPath.tolerant">false</boolProp>
+  <boolProp name="XPath.namespace">false</boolProp>
+  <stringProp name="Assertion.scope">all</stringProp>
+</XPathAssertion>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl/xpath_extractor.rb

@@ -0,0 +1,31 @@
+module JmeterRuby
+  class DSL
+    def xpath_extractor(params={}, &block)
+      node = JmeterRuby::XpathExtractor.new(params)
+      attach_node(node, &block)
+    end
+  end
+
+  class XpathExtractor
+    attr_accessor :doc
+    include Helper
+
+    def initialize(params={})
+      testname = params.kind_of?(Array) ? 'XpathExtractor' : (params[:name] || 'XpathExtractor')
+      @doc = Nokogiri::XML(<<-EOS.strip_heredoc)
+<XPathExtractor guiclass="XPathExtractorGui" testclass="XPathExtractor" testname="#{testname}" enabled="true">
+  <stringProp name="XPathExtractor.default"/>
+  <stringProp name="XPathExtractor.refname"/>
+  <stringProp name="XPathExtractor.xpathQuery"/>
+  <boolProp name="XPathExtractor.validate">false</boolProp>
+  <boolProp name="XPathExtractor.tolerant">false</boolProp>
+  <boolProp name="XPathExtractor.namespace">false</boolProp>
+  <stringProp name="Sample.scope">all</stringProp>
+</XPathExtractor>)
+      EOS
+      update params
+      update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+    end
+  end
+
+end

data/lib/jmeter-ruby/dsl.rb

@@ -0,0 +1,102 @@
+module JmeterRuby
+  class ExtendedDSL < DSL
+    include Parser
+    attr_accessor :root
+
+    def initialize(params = {})
+      @root = Nokogiri::XML(<<-EOF.strip_heredoc)
+        <?xml version="1.0" encoding="UTF-8"?>
+        <jmeterTestPlan version="1.2" properties="3.1" jmeter="3.1" jmeter-ruby="3.0">
+        <hashTree>
+        </hashTree>
+        </jmeterTestPlan>
+      EOF
+      node = JmeterRuby::TestPlan.new(params)
+
+      @current_node = @root.at_xpath('//jmeterTestPlan/hashTree')
+      @current_node = attach_to_last(node)
+    end
+
+    def out(params = {})
+      puts doc.to_xml(indent: 2)
+    end
+
+    def jmx(params = {})
+      file(params)
+      logger.info "Test plan saved to: #{params[:file]}"
+    end
+
+    def to_xml
+      doc.to_xml(indent: 2)
+    end
+
+    def to_doc
+      doc.clone
+    end
+
+    def run(params = {})
+      file(params)
+      logger.warn 'Test executing locally ...'
+
+      cmd = "#{params[:path] ? File.join(params[:path], 'jmeter') : 'jmeter'} #{"-n" unless params[:gui] } -t #{params[:file]} -j #{params[:log] ? params[:log] : 'jmeter.log' } -l #{params[:jtl] ? params[:jtl] : 'jmeter.jtl' } #{build_properties(params[:properties]) if params[:properties]}"
+      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
+        abort "FAILED !!! #{cmd}" unless exit_status.success?
+      end
+      logger.info "Local Results at: #{params[:jtl] ? params[:jtl] : 'jmeter.jtl'}"
+    end
+
+    private
+
+    def hash_tree
+      Nokogiri::XML::Node.new("hashTree", @root)
+    end
+
+    def attach_to_last(node)
+      ht = hash_tree
+      last_node = @current_node
+      last_node << node.doc.children << ht
+      ht
+    end
+
+    def attach_node(node, &block)
+      ht = attach_to_last(node)
+      previous = @current_node
+      @current_node = ht
+      instance_exec(&block) if block
+      @current_node = previous
+    end
+
+    def file(params = {})
+      params[:file] ||= 'jmeter-ruby.jmx'
+      File.open(params[:file], 'w') { |file| file.write(doc.to_xml(indent: 2)) }
+    end
+
+    def doc
+      Nokogiri::XML(@root.to_s, &:noblanks)
+    end
+
+    def build_properties(properties)
+      if properties.kind_of?(String)
+        "-q #{properties}"
+      elsif properties.kind_of?(Hash)
+        properties.map{ |k,v| "-J#{k}=#{v}" }.join(" ")
+      end
+    end
+
+    def logger
+      @log ||= Logger.new(STDOUT)
+      @log.level = Logger::DEBUG
+      @log
+    end
+  end
+end
+
+def test(params = {}, &block)
+  JmeterRuby.dsl_eval(JmeterRuby::ExtendedDSL.new(params), &block)
+end

data/lib/jmeter-ruby/extend/assertions/response_assertion.rb

@@ -0,0 +1,36 @@
+module JmeterRuby
+  class ExtendedDSL < DSL
+    def response_assertion(params, &block)
+      params[:test_type] = parse_test_type(params)
+      params['0'] = params.values.first
+
+      if params[:json]
+        params[:EXPECTED_VALUE] = params[:value]
+        params[:JSON_PATH] = params[:json]
+        node = JmeterRuby::Plugins::JsonPathAssertion.new(params)
+      end
+
+      node ||= JmeterRuby::ResponseAssertion.new(params).tap do |node|
+        if params[:variable]
+          params['Scope.variable'] = params[:variable]
+          node.doc.xpath("//stringProp[@name='Assertion.scope']").first.content = 'variable'
+
+          node.doc.children.first.add_child (
+            Nokogiri::XML(<<-EOS.strip_heredoc).children
+              <stringProp name="Scope.variable">#{params[:variable]}</stringProp>
+            EOS
+          )
+        end
+
+        if params[:scope] == 'main'
+          node.doc.xpath("//stringProp[@name='Assertion.scope']").remove
+        end
+      end
+
+      attach_node(node, &block)
+    end
+
+    alias assert response_assertion
+    alias web_reg_find response_assertion
+  end
+end

data/lib/jmeter-ruby/extend/config_elements/header_manager.rb

@@ -0,0 +1,13 @@
+module JmeterRuby
+  class ExtendedDSL < DSL
+    def http_header_manager(params, &block)
+      if params.is_a?(Hash)
+        params['Header.name'] = params[:name]
+      end
+
+      super
+    end
+
+    alias header http_header_manager
+  end
+end

data/lib/jmeter-ruby/extend/config_elements/http_cache_manager.rb

@@ -0,0 +1,12 @@
+module JmeterRuby
+  class ExtendedDSL < DSL
+    def http_cache_manager(params = {}, &block)
+      params[:clearEachIteration] = true if params.keys.include? :clear_each_iteration
+      params[:useExpires] = true if params.keys.include? :use_expires
+
+      super
+    end
+
+    alias cache http_cache_manager
+  end
+end

data/lib/jmeter-ruby/extend/config_elements/http_cookie_manager.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module JmeterRuby
+  class ExtendedDSL < DSL
+    def http_cookie_manager(params = {}, &block)
+      params[:clearEachIteration] = true if params.keys.include? :clear_each_iteration
+
+      node = JmeterRuby::HttpCookieManager.new(params)
+
+      params[:user_defined_cookies]&.each { |cookie| add_cookie_to_collection(cookie, node) }
+
+      attach_node(node, &block)
+    end
+
+    alias cookies http_cookie_manager
+
+    private
+
+    def add_cookie_to_collection(cookie, node)
+      raise 'Cookie name must be provided.' unless cookie[:name]
+      raise 'Cookie value must be provided.' unless cookie[:value]
+      node.doc.at_xpath('//collectionProp') <<
+          Nokogiri::XML(<<-EOS.strip_heredoc).children
+              <elementProp name="#{cookie[:name]}" elementType="Cookie" testname="#{cookie[:name]}">
+                <stringProp name="Cookie.value">#{cookie[:value]}</stringProp>
+                <stringProp name="Cookie.domain">#{cookie[:domain]}</stringProp>
+                <stringProp name="Cookie.path">#{cookie[:path]}</stringProp>
+                <boolProp name="Cookie.secure">#{cookie[:secure] || false}</boolProp>
+                <longProp name="Cookie.expires">0</longProp>
+                <boolProp name="Cookie.path_specified">true</boolProp>
+                <boolProp name="Cookie.domain_specified">true</boolProp>
+              </elementProp>
+      EOS
+    end
+  end
+end

data/lib/jmeter-ruby/extend/config_elements/http_request_defaults.rb

@@ -0,0 +1,39 @@
+module JmeterRuby
+  class ExtendedDSL < DSL
+    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
+
+      node = JmeterRuby::HttpRequestDefaults.new(params).tap do |node|
+        node.doc.children.first.add_child (
+          Nokogiri::XML(<<-EOS.strip_heredoc).children
+            <stringProp name="HTTPSampler.embedded_url_re">#{params[:urls_must_match]}</stringProp>
+          EOS
+        ) if params[:urls_must_match]
+
+        node.doc.children.first.add_child (
+          Nokogiri::XML(<<-EOS.strip_heredoc).children
+            <boolProp name="HTTPSampler.md5">true</stringProp>
+          EOS
+        ) if params[:md5]
+
+        node.doc.children.first.add_child (
+          Nokogiri::XML(<<-EOS.strip_heredoc).children
+            <stringProp name="HTTPSampler.proxyHost">#{params[:proxy_host]}</stringProp>
+          EOS
+        ) if params[:proxy_host]
+
+        node.doc.children.first.add_child (
+          Nokogiri::XML(<<-EOS.strip_heredoc).children
+            <stringProp name="HTTPSampler.proxyPort">#{params[:proxy_port]}</stringProp>
+          EOS
+        ) if params[:proxy_port]
+      end
+
+      attach_node(node, &block)
+    end
+
+    alias defaults http_request_defaults
+  end
+end

data/lib/jmeter-ruby/extend/config_elements/user_defined_variables.rb

@@ -0,0 +1,13 @@
+module JmeterRuby
+  class ExtendedDSL < DSL
+    def user_defined_variables(params, &block)
+      if params.is_a?(Hash)
+        params['Argument.name'] = params[:name]
+      end
+
+      super
+    end
+
+    alias variables user_defined_variables
+  end
+end

data/lib/jmeter-ruby/extend/config_elements/user_parameters.rb

@@ -0,0 +1,31 @@
+module JmeterRuby
+  class ExtendedDSL < DSL
+    def user_parameters(params, &block)
+      params['Argument.name'] = params[:name] if params.is_a?(Hash)
+
+      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
+
+    alias parameters user_parameters
+  end
+end