ruby-jmeter 3.1.06 → 3.1.07

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5db93664cf0240974b592a329ce2e0fce9208676
-  data.tar.gz: 7f22c6cba517fc8baa43bee0bd56b123bf863dfc
+  metadata.gz: e93d14ee553a7e57821b45d87834334e49969f6b
+  data.tar.gz: 6b3033cebb68373f0b33a0625fa51f2c3063defd
 SHA512:
-  metadata.gz: d608ddc88467133b66be4c943bc1d01f7c005c66eb2750c86f2303d1e63b5baea6d24e38406fd527e96a2d0a9380f2969fd347732968e4a1c33e42b741658e6c
-  data.tar.gz: a398c2432bc260380769b86d7ae572fcf5a99472f624b174363fecfaac2814d50cb0a8cb2b08748cfebbab13a09a50e2b350ca446e252f02c7ee265986bf9373
+  metadata.gz: 93e227a801a68b006880171ee0cbf368db310208611b72114afc951f0b8a5b07f356c3d0671939cf26bd0194e088314dc03a4f555f0f05ad718096b5c506c785
+  data.tar.gz: acc5548644827705c11485770ff10bd36b79e3312729cee46088ed70a4e9b4c6d3a0756645c1e87d7442fddc5dedf98db38fff1b99de49eefea3d6dd53b2f664

data/README.md

@@ -1,8 +1,6 @@
-# RubyJmeter
+# Ruby-JMeter [![Build Status](https://travis-ci.org/flood-io/ruby-jmeter.png)](https://travis-ci.org/flood-io/ruby-jmeter) [![Code Climate](https://codeclimate.com/github/flood-io/ruby-jmeter.png)](https://codeclimate.com/github/flood-io/ruby-jmeter) [![Gem Version](https://badge.fury.io/rb/ruby-jmeter.svg)](http://badge.fury.io/rb/ruby-jmeter)
 
-[![Build Status](https://travis-ci.org/flood-io/ruby-jmeter.png)](https://travis-ci.org/flood-io/ruby-jmeter)
-[![Code Climate](https://codeclimate.com/github/flood-io/ruby-jmeter.png)](https://codeclimate.com/github/flood-io/ruby-jmeter)
-[![Gem Version](https://badge.fury.io/rb/ruby-jmeter.svg)](http://badge.fury.io/rb/ruby-jmeter)
+> **Ruby-JMeter** is built and maintained by [Flood IO](https://flood.io?utm_source=github), an easy to use load testing platform for any scale of testing.
 
 Tired of using the JMeter GUI or looking at hairy XML files?
 
@@ -198,6 +196,22 @@ test do
 end
 ```
 
+#### User-Defined Cookies
+
+The `cookies` method parameters hash supports `user_defined_cookies`:
+
+```ruby
+test do
+  cookie1 = { value: 'foo', name: 'bar', domain: 'google.co.uk', path: '/' }
+  cookie2 = { value: 'hello', name: 'world', domain: 'google.co.uk', secure: true }
+
+  cookies user_defined_cookies: [ cookie1, cookie2 ]
+end
+```
+
+`name` and `value` are required. `domain` and `path` are optional and default to blank.
+`secure` is optional and defaults to `false`.
+
 ### Cache
 
 You can use the `cache` method to define a Cache Manager:

data/examples/regular_expression_extractor.rb

@@ -6,6 +6,7 @@ test 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/share/jmeter/bin/', gui: true)
+end.run(path: '/usr/local/share/jmeter-3.1/bin/', gui: true)

data/examples/response_assertion.rb

@@ -8,7 +8,8 @@ test 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/share/jmeter/bin/', gui: true)
+end.run(path: '/usr/local/share/jmeter-3.1/bin/', gui: true)

data/examples/user_parameters.rb

@@ -3,7 +3,14 @@ require 'ruby-jmeter'
 
 test do
   # user parameters with multiple values
-  visit name: 'Home Page', url: 'https://flooded.io/' do
+  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: [
@@ -18,4 +25,4 @@ test do
       },
       per_iteration: true
   end
-end.run(path: '/usr/share/jmeter/bin/', gui: true)
+end.run(path: '/usr/local/share/jmeter-3.1/bin/', gui: true)

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

@@ -1,11 +1,36 @@
+# frozen_string_literal: true
+
 module RubyJmeter
   class ExtendedDSL < DSL
     def http_cookie_manager(params = {}, &block)
       params[:clearEachIteration] = true if params.keys.include? :clear_each_iteration
 
-      super
+      node = RubyJmeter::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/ruby-jmeter/version.rb

@@ -1,3 +1,3 @@
 module RubyJmeter
-  VERSION = '3.1.06'
+  VERSION = '3.1.07'
 end

data/spec/http_cookie_manager_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'http_cookie_manager' do
@@ -8,10 +10,160 @@ describe 'http_cookie_manager' do
       end.to_doc
     end
 
-    let(:cookies_fragment) { doc.search("//CookieManager") }
+    let(:cookies_fragment) { doc.search('//CookieManager') }
 
     it 'should match on clearEachIteration' do
-      expect(cookies_fragment.search(".//boolProp[@name='CookieManager.clearEachIteration']").first.text).to eq'true'
+      expect(cookies_fragment.search(".//boolProp[@name='CookieManager.clearEachIteration']").first.text).to eq 'true'
+    end
+  end
+
+  describe 'the user_defined_cookie option should be respected' do
+    context 'when the user_defined_cookie option is empty' do
+      let(:doc) do
+        test do
+          cookies
+        end.to_doc
+      end
+
+      let(:cookies_fragment) { doc.search('//CookieManager') }
+
+      it 'should not populate the collectionProp' do
+        expect(cookies_fragment.search("..//collectionProp[@name='CookieManager.cookies']").children.count).to eq 0
+      end
+    end
+
+    context 'when the user_defined_cookie option is set' do
+      let(:cookie_name) { 'cookie_1' }
+      let(:cookie_value) { 'cookie_value' }
+      let(:cookie_domain) { 'example.com' }
+      let(:cookie_path) { '/' }
+      let(:cookie_secure) { true }
+
+      let(:cookies_fragment) { doc.search('//CookieManager') }
+      let(:elements) { cookies_fragment.search("..//collectionProp[@name='CookieManager.cookies']").children }
+
+      context 'with all the cookie attributes provided' do
+        let(:doc) do
+          test do
+            cookies user_defined_cookies: [
+              {
+                name: cookie_name,
+                value: cookie_value,
+                domain: cookie_domain,
+                path: cookie_path,
+                secure: cookie_secure
+              }
+            ]
+          end.to_doc
+        end
+
+        it 'should add an element to the cookie manager collection' do
+          expect(elements.count).to eq 1
+        end
+
+        it 'should add the correct name to the collection element' do
+          expect(elements.first.attribute('name').value).to eq cookie_name
+        end
+
+        it 'should add the correct elementType to the collection element' do
+          expect(elements.first.attribute('elementType').value).to eq 'Cookie'
+        end
+
+        it 'should add the correct testName to the collection element' do
+          expect(elements.first.attribute('testname').value).to eq cookie_name
+        end
+
+        it 'should add a Cookie.value stringProp to the element' do
+          expect(elements.first.search("//stringProp[@name='Cookie.value']").text).to eq cookie_value
+        end
+
+        it 'should add a Cookie.domain stringProp to the element' do
+          expect(elements.first.search("//stringProp[@name='Cookie.domain']").text).to eq cookie_domain
+        end
+
+        it 'should add a Cookie.path stringProp to the element' do
+          expect(elements.first.search("//stringProp[@name='Cookie.path']").text).to eq cookie_path
+        end
+
+        it 'should add a Cookie.secure boolProp to the element' do
+          expect(elements.first.search("//boolProp[@name='Cookie.secure']").text).to eq 'true'
+        end
+
+        it 'should add a Cookie.expires longProp to the element' do
+          expect(elements.first.search("//longProp[@name='Cookie.expires']").text).to eq '0'
+        end
+
+        it 'should add a Cookie.path_specified boolProp to the element' do
+          expect(elements.first.search("//boolProp[@name='Cookie.path_specified']").text).to eq 'true'
+        end
+
+        it 'should add a Cookie.domain_specified boolProp to the element' do
+          expect(elements.first.search("//boolProp[@name='Cookie.domain_specified']").text).to eq 'true'
+        end
+      end
+
+      context 'without optional cookie attributes provided' do
+        let(:doc) do
+          test do
+            cookies user_defined_cookies: [
+              {
+                name: cookie_name,
+                value: cookie_value
+              }
+            ]
+          end.to_doc
+        end
+
+        it 'should add a default Cookie.secure boolProp to the element' do
+          expect(elements.first.search("//boolProp[@name='Cookie.secure']").text).to eq 'false'
+        end
+
+        it 'should add a default Cookie.domain stringProp to the element' do
+          expect(elements.first.search("//stringProp[@name='Cookie.domain']").text).to eq ''
+        end
+
+        it 'should add a default Cookie.path stringProp to the element' do
+          expect(elements.first.search("//stringProp[@name='Cookie.path']").text).to eq ''
+        end
+      end
+
+      context 'without required cookie attributes provided' do
+        it 'should raise an error if name is not provided' do
+          expect { test { cookies user_defined_cookies: [{ value: cookie_value }] } }
+            .to raise_error('Cookie name must be provided.')
+        end
+        it 'should raise an error if value is not provided' do
+          expect { test { cookies user_defined_cookies: [{ name: cookie_name }] } }
+            .to raise_error('Cookie value must be provided.')
+        end
+      end
+
+      context 'when multiple cookies are set' do
+        let(:doc) do
+          test do
+            cookies user_defined_cookies: [
+              {
+                name: cookie_name,
+                value: cookie_value,
+                domain: cookie_domain,
+                path: cookie_path,
+                secure: cookie_secure
+              },
+              {
+                name: cookie_name,
+                value: cookie_value,
+                domain: cookie_domain,
+                path: cookie_path,
+                secure: cookie_secure
+              }
+            ]
+          end.to_doc
+        end
+
+        it 'should add multiple elements to the cookie manager collection' do
+          expect(elements.count).to eq 2
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jmeter
 version: !ruby/object:Gem::Version
-  version: 3.1.06
+  version: 3.1.07
 platform: ruby
 authors:
 - Tim Koopmans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2017-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -333,7 +333,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby based DSL for writing JMeter test plans