ruby-jmeter 2.13.7 → 2.13.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fad51ef27a7e3737b320fbb418db4772ffe6300
-  data.tar.gz: 6b266bfbd9507a0b8f08259d80a110923ef74e0d
+  metadata.gz: 01ab5cb50b02e20695b64b2e420a551117a9af6b
+  data.tar.gz: 4a844acbf379fd95132e773fd46b5dbdb2d317d3
 SHA512:
-  metadata.gz: 590dadd09d7a91119e24acb35af182950e127f4f47be0c4207c8b5b9a2af0655ad00b51ffaab2fa8035f4b034dc021c4666b96d861c941f100c141018aa3a386
-  data.tar.gz: 4b8110856c259925912c3b471f629656000539295ad0d6e137f79ab37419ab6a40d9798ae6144605c2d590cd429706e381c5f27c5ec454d00defa85fbad00ad8
+  metadata.gz: e242b7f6a1f74a4c0adbff263ff5a2d5ef7950aaee5218085bca02e632f6c8bae13ee62cdb2347a6b1a8a8495f09e65c604c26ff9b25c0faf07da6e10a6d01e6
+  data.tar.gz: 0dc1ce59b26da2c80fa14de8db4ad5db04a57cd2fb52104a1cf5e5230904bb5a08303924154e5d491ca1b4cf9b5cfbf2bd18a4c2077a48e4c99e018fffb91b06

data/README.md

@@ -303,7 +303,7 @@ This method takes 2 parameters: the constant delay, and an optional variable del
 # constant delay of 3 seconds
 think_time 3000
 # constant delay of 1 seconds with variance up to 6 seconds.
-random_timer 1000,5000
+random_timer 1000, 6000
 ```
 
 ### Response Extractor
@@ -381,3 +381,78 @@ This work is being sponsored by Flood IO. Get in touch with us if you'd like to
 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
+
+### IDL
+
+We use an interface description language (IDL) as a bridge between JMeter's components expressed as XML in a `.jmx` test plan to Ruby's DSL objects in this repository.
+
+To automate this `lib/ruby-jmeter/idl.rb` can be executed from the command line which will read from `lib/ruby-jmeter/idl.xml` and output to `lib/ruby-jmeter/dsl`
+
+For example:
+
+```sh
+flood/ruby-jmeter - [master●] » ruby lib/ruby-jmeter/idl.rb
+flood/ruby-jmeter - [master●] » git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes not staged for commit:
+  (use "git add <file>..." to update what will be committed)
+  (use "git checkout -- <file>..." to discard changes in working directory)
+
+  modified:   lib/ruby-jmeter/DSL.md
+  modified:   lib/ruby-jmeter/dsl/foreach_controller.rb
+  modified:   lib/ruby-jmeter/dsl/http_request.rb
+  modified:   lib/ruby-jmeter/dsl/http_request_defaults.rb
+  modified:   lib/ruby-jmeter/dsl/regular_expression_extractor.rb
+  modified:   lib/ruby-jmeter/dsl/response_assertion.rb
+  modified:   lib/ruby-jmeter/dsl/test_fragment.rb
+  modified:   lib/ruby-jmeter/dsl/user_parameters.rb
+```
+
+You **should never manually update** code in `lib/ruby-jmeter/dsl` as this is automatically overwritten whenever we run the IDL script. As new components / plugins are added, or major versions of JMeter are updated, we open `lib/ruby-jmeter/idl.xml` in the JMeter UI with those updates prior to running the IDL script. This makes updating between versions more easy.
+
+### DSL
+
+Much of the behaviour of the gem is defined in `lib/ruby-jmeter/dsl.rb` which is where you should be updating code. This is now a very long module and in much need of refactoring. PR's are welcomed.
+
+### Plugins
+
+Some custom code has been contributed particularly for support of JMeter plugins. These are not included in the IDL and as such should be added to `lib/ruby-jmeter/plugins`. Please follow some of the other examples.
+
+### Bundler
+
+We recommend using the Ruby gem bundle to manage your dependencies. Typical setup would be:
+
+
+```sh
+gem install bundler
+cd <your local clone>
+bundle install
+```
+
+Then you can run any rake / test tasks with the prefix `bundle exec`
+
+### Tests
+
+If contributing please add an appropriate test. See `spec/dsl_spec.rb` for examples. Tests can be run from the command line as follows:
+
+    $ bundle exec rspec
+
+### Examples
+
+It is often useful to add an appropriate example for other users and for testing your changes locally with the JMeter UI. See `examples` for different types of examples. To let your examples work locally from your own changes / commits simply prefix the examples with:
+
+```ruby
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+```
+
+    $ flood/ruby-jmeter - [master●] » ruby examples/basic_assertion.rb
+      W, [2015-10-17T19:31:12.021004 #33216]  WARN -- : Test executing locally ...
+
+Note: most of the examples assume the JMeter binary is installed in `/usr/share/jmeter-2.13/bin/` however you can modify this in your example to something that suits your installation e.g.:
+
+
+```ruby
+...
+end.run(path: 'C/Program Files/JMeter-2.13/bin/', gui: true)
+```

data/examples/basic_json_path_assertion.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ruby-jmeter'
+
+test do
+  threads count: 1, loop: 1 do
+    visit 'https://api.github.com/orgs/flood-io/repos' do
+      assert json: '.name', value: 'ruby-jmeter'
+    end
+  end
+end.run(path: '/usr/share/jmeter-2.13/bin/', gui: true)

data/examples/basic_perfmon.rb

@@ -20,7 +20,8 @@ test do
   # You need perfmon agent running
   #   http://jmeter-plugins.org/wiki/PerfMonAgent/
   #
-  perfmon_collector 'Perfmon Metrics Collector', [
+  perfmon_collector name: 'Perfmon Metrics Collector',
+  nodes: [
    {
        server: 'localhost',
        port: 4444,

data/lib/ruby-jmeter/dsl.rb

@@ -401,13 +401,7 @@ module RubyJmeter
     def response_assertion(params = {}, &block)
       params[:test_type] = parse_test_type(params)
       params['0'] = params.values.first
-      node = RubyJmeter::ResponseAssertion.new(params)
-      if params[:variable] then
-        params['Scope.variable'] = params[:variable]
-        node.doc.xpath("//stringProp[@name='Assertion.scope']").first.content = 'variable'
-      end
-      node.doc.xpath("//stringProp[@name='Assertion.scope']").remove if
-        params[:scope] == 'main' || params['scope'] == 'main'
+      node = params[:json] ? json_path_assertion(params) : assertion(params)
       attach_node(node, &block)
     end
 
@@ -511,8 +505,8 @@ module RubyJmeter
 
     alias_method :active_threads, :active_threads_over_time
 
-    def perfmon_collector(name, params = {}, filename="perfMon.jtl", &block)
-      node = RubyJmeter::Plugins::PerfmonCollector.new(name, params, filename)
+    def perfmon_collector(params = {}, &block)
+      node = RubyJmeter::Plugins::PerfmonCollector.new(params)
       attach_node(node, &block)
     end
 
@@ -672,6 +666,25 @@ module RubyJmeter
       @log.level = Logger::DEBUG
       @log
     end
+
+    def json_path_assertion(params)
+      params[:EXPECTED_VALUE] = params[:value]
+      params[:JSON_PATH] = params[:json]
+      RubyJmeter::Plugins::JsonPathAssertion.new(params)
+    end
+
+    def assertion(params)
+      RubyJmeter::ResponseAssertion.new(params).tap do |node|
+        if params[:variable]
+          params['Scope.variable'] = params[:variable]
+          node.doc.xpath("//stringProp[@name='Assertion.scope']").first.content = 'variable'
+        end
+
+        if params[:scope] == 'main' || params['scope'] == 'main'
+          node.doc.xpath("//stringProp[@name='Assertion.scope']").remove
+        end
+      end
+    end
   end
 end
 

data/lib/ruby-jmeter/plugins/json_path_assertion.rb

@@ -0,0 +1,18 @@
+module RubyJmeter
+  module Plugins
+    class JsonPathAssertion
+      attr_accessor :doc
+      include Helper
+      def initialize(params={})
+        @doc = Nokogiri::XML(<<-EOF.strip_heredoc)
+          <com.atlantbh.jmeter.plugins.jsonutils.jsonpathassertion.JSONPathAssertion guiclass="com.atlantbh.jmeter.plugins.jsonutils.jsonpathassertion.gui.JSONPathAssertionGui" testclass="com.atlantbh.jmeter.plugins.jsonutils.jsonpathassertion.JSONPathAssertion" testname="jp@gc - JSON Path Assertion" enabled="true">
+            <stringProp name="EXPECTED_VALUE"></stringProp>
+            <stringProp name="JSON_PATH"></stringProp>
+            <boolProp name="JSONVALIDATION">true</boolProp>
+          </com.atlantbh.jmeter.plugins.jsonutils.jsonpathassertion.JSONPathAssertion>
+        EOF
+        update params
+      end
+    end
+  end
+end

data/lib/ruby-jmeter/plugins/perfmon_collector.rb

@@ -3,26 +3,10 @@ module RubyJmeter
     class PerfmonCollector
       attr_accessor :doc
       include Helper
-      def initialize(name, params={}, filename="perfMon.jtl")
-        metricNodes = params.collect do |m|
-          "
-            <collectionProp name=\"\">
-              <stringProp name=\"\">#{m[:server]}</stringProp>
-              <stringProp name=\"\">#{m[:port]}</stringProp>
-              <stringProp name=\"\">#{m[:metric]}</stringProp>
-              <stringProp name=\"\">#{m[:parameters]}</stringProp>
-            </collectionProp>
-          "
-        end
-
-        metricConnections = Nokogiri::XML(<<-XML.strip_heredoc)
-          <collectionProp name="metricConnections">
-              #{metricNodes.join "\n"}
-          </collectionProp>
-        XML
 
+      def initialize(params = {})
         @doc = Nokogiri::XML(<<-XML.strip_heredoc)
-          <kg.apc.jmeter.perfmon.PerfMonCollector guiclass="kg.apc.jmeter.vizualizers.PerfMonGui" testclass="kg.apc.jmeter.perfmon.PerfMonCollector" testname="#{name}" enabled="true">
+          <kg.apc.jmeter.perfmon.PerfMonCollector guiclass="kg.apc.jmeter.vizualizers.PerfMonGui" testclass="kg.apc.jmeter.perfmon.PerfMonCollector" testname="#{params[:name] || 'PerfmonCollector'}" enabled="true">
             <boolProp name="ResultCollector.error_logging">false</boolProp>
             <objProp>
               <name>saveConfig</name>
@@ -41,7 +25,7 @@ module RubyJmeter
                 <subresults>false</subresults>
                 <responseData>false</responseData>
                 <samplerData>false</samplerData>
-                <xml>true</xml>
+                <xml>#{(params[:xml] || false).to_s}</xml>
                 <fieldNames>false</fieldNames>
                 <responseHeaders>false</responseHeaders>
                 <requestHeaders>false</requestHeaders>
@@ -53,7 +37,7 @@ module RubyJmeter
                 <sampleCount>true</sampleCount>
               </value>
             </objProp>
-            <stringProp name="filename">#{filename}</stringProp>
+            <stringProp name="filename">#{params[:filename] || 'perfmon.jtl'}</stringProp>
             <longProp name="interval_grouping">1000</longProp>
             <boolProp name="graph_aggregated">false</boolProp>
             <stringProp name="include_sample_labels"></stringProp>
@@ -62,11 +46,34 @@ module RubyJmeter
             <stringProp name="end_offset"></stringProp>
             <boolProp name="include_checkbox_state">false</boolProp>
             <boolProp name="exclude_checkbox_state">false</boolProp>
-            #{metricConnections.root.to_s}
+            #{metric_connections(params).root.to_s}
           </kg.apc.jmeter.perfmon.PerfMonCollector>
         XML
         update params
       end
+
+      private
+
+      def metric_connections(params)
+        Nokogiri::XML(<<-XML.strip_heredoc)
+          <collectionProp name="metricConnections">
+              #{metric_nodes(params[:nodes]).join "\n"}
+          </collectionProp>
+        XML
+      end
+
+      def metric_nodes(nodes)
+        nodes.collect do |node|
+          %(
+            <collectionProp name="">
+              <stringProp name="">#{node[:server]}</stringProp>
+              <stringProp name="">#{node[:port]}</stringProp>
+              <stringProp name="">#{node[:metric]}</stringProp>
+              <stringProp name="">#{node[:parameters]}</stringProp>
+            </collectionProp>
+          )
+        end
+      end
     end
   end
 end

data/lib/ruby-jmeter/version.rb

@@ -1,3 +1,3 @@
 module RubyJmeter
-  VERSION = '2.13.7'
+  VERSION = '2.13.8'
 end

data/spec/dsl_spec.rb

@@ -225,7 +225,6 @@ describe 'DSL' do
 
     let(:fragment) { doc.search("//kg.apc.jmeter.threads.SteppingThreadGroup").first }
     it 'should match on on_sample_error' do
-      puts fragment
       fragment.search(".//stringProp[@name='ThreadGroup.on_sample_error']").text.should == 'startnextloop'
     end
 
@@ -794,6 +793,30 @@ describe 'DSL' do
       end
     end
 
+    describe 'json assertion' do
+      let(:doc) do
+        test do
+          visit '/' do
+            assert json: '.key', value: 'value'
+          end
+        end.to_doc
+      end
+
+      let(:fragment) { doc.search('//com.atlantbh.jmeter.plugins.jsonutils.jsonpathassertion.JSONPathAssertion').first }
+
+      it 'should match on expected value' do
+        fragment.search(".//stringProp[@name='EXPECTED_VALUE']").text.should == "value"
+      end
+
+      it 'should match on json path' do
+        fragment.search(".//stringProp[@name='JSON_PATH']").text.should == ".key"
+      end
+
+      it 'should have json validation by default' do
+        fragment.search(".//boolProp[@name='JSONVALIDATION']").text.should == "true"
+      end
+    end
+
     describe 'scope main' do
       let(:doc) do
         test do
@@ -1045,6 +1068,37 @@ describe 'DSL' do
     it 'should match on response data' do
       fragment.search("//stringProp[@name='RESPONSE_DATA']").text.should == 'Some response data'
     end
-
   end
+
+  describe 'perfmon collector' do
+      let(:doc) do
+        test do
+          threads do
+            perfmon_collector name: 'perfmon collector name',
+            nodes:
+              [
+                {server: '1.1.1.1', port: 4444, metric: 'CPU', parameters: ''},
+                {server: '2.2.2.2', port: 4444, metric: 'CPU', parameters: ''}
+              ],
+            filename: 'perf.jtl',
+            xml: false
+          end
+        end.to_doc
+      end
+
+      let(:fragment) { doc.search("//kg.apc.jmeter.perfmon.PerfMonCollector").first }
+      let(:metric_connections) { fragment.search("//collectionProp[@name='metricConnections']").first }
+
+      it 'should match on name' do
+        fragment.attributes['testname'].value.should == 'perfmon collector name'
+      end
+
+      it 'should match on xml flag' do
+        fragment.search(".//xml").first.text.should == 'false'
+      end
+
+      it 'should match on first server ip' do
+        metric_connections.search("//stringProp[@name='']").first.text.should == '1.1.1.1'
+      end
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jmeter
 version: !ruby/object:Gem::Version
-  version: 2.13.7
+  version: 2.13.8
 platform: ruby
 authors:
 - Tim Koopmans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -79,6 +79,7 @@ files:
 - examples/basic_header.rb
 - examples/basic_http_request_defaults.rb
 - examples/basic_http_request_with_files.rb
+- examples/basic_json_path_assertion.rb
 - examples/basic_json_path_extractor.rb
 - examples/basic_ldap_ext.rb
 - examples/basic_loadosophia.rb
@@ -242,6 +243,7 @@ files:
 - lib/ruby-jmeter/plugins/composite_graph.rb
 - lib/ruby-jmeter/plugins/console_status_logger.rb
 - lib/ruby-jmeter/plugins/dummy_sampler.rb
+- lib/ruby-jmeter/plugins/json_path_assertion.rb
 - lib/ruby-jmeter/plugins/json_path_extractor.rb
 - lib/ruby-jmeter/plugins/latencies_over_time.rb
 - lib/ruby-jmeter/plugins/loadosophia_uploader.rb