jmeter-ruby 3.0.0

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

@@ -0,0 +1,50 @@
+module JmeterRuby
+  module Plugins
+    class ResponseTimesOverTime
+      attr_accessor :doc
+      include Helper
+      def initialize(params={})
+        testname = params.kind_of?(Array) ? 'ResponseTimesOverTime' : (params[:name] || 'ResponseTimesOverTime')
+        @doc = Nokogiri::XML(<<-EOF.strip_heredoc)
+          <kg.apc.jmeter.vizualizers.CorrectedResultCollector guiclass="kg.apc.jmeter.vizualizers.ResponseTimesOverTimeGui" testclass="kg.apc.jmeter.vizualizers.CorrectedResultCollector" testname="#{testname}" enabled="#{enabled(params)}">
+            <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>true</message>
+                <threadName>true</threadName>
+                <dataType>true</dataType>
+                <encoding>false</encoding>
+                <assertions>true</assertions>
+                <subresults>true</subresults>
+                <responseData>false</responseData>
+                <samplerData>false</samplerData>
+                <xml>true</xml>
+                <fieldNames>false</fieldNames>
+                <responseHeaders>false</responseHeaders>
+                <requestHeaders>false</requestHeaders>
+                <responseDataOnError>false</responseDataOnError>
+                <saveAssertionResultsFailureMessage>false</saveAssertionResultsFailureMessage>
+                <assertionsResultsToSave>0</assertionsResultsToSave>
+                <bytes>true</bytes>
+              </value>
+            </objProp>
+            <stringProp name="filename"></stringProp>
+            <longProp name="interval_grouping">500</longProp>
+            <boolProp name="graph_aggregated">false</boolProp>
+            <stringProp name="include_sample_labels"></stringProp>
+            <stringProp name="exclude_sample_labels"></stringProp>
+          </kg.apc.jmeter.vizualizers.CorrectedResultCollector>
+        EOF
+        update params
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,51 @@
+module JmeterRuby
+  module Plugins
+    class ResponseTimesPercentiles
+      attr_accessor :doc
+      include Helper
+      def initialize(params={})
+        testname = params.kind_of?(Array) ? 'ResponseTimesPercentiles' : (params[:name] || 'ResponseTimesPercentiles')
+        @doc = Nokogiri::XML(<<-EOF.strip_heredoc)
+          <kg.apc.jmeter.vizualizers.CorrectedResultCollector guiclass="kg.apc.jmeter.vizualizers.ResponseTimesPercentilesGui" testclass="kg.apc.jmeter.vizualizers.CorrectedResultCollector" testname="#{testname}" enabled="#{enabled(params)}">
+            <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>true</message>
+                <threadName>true</threadName>
+                <dataType>true</dataType>
+                <encoding>false</encoding>
+                <assertions>true</assertions>
+                <subresults>true</subresults>
+                <responseData>false</responseData>
+                <samplerData>false</samplerData>
+                <xml>true</xml>
+                <fieldNames>false</fieldNames>
+                <responseHeaders>false</responseHeaders>
+                <requestHeaders>false</requestHeaders>
+                <responseDataOnError>false</responseDataOnError>
+                <saveAssertionResultsFailureMessage>false</saveAssertionResultsFailureMessage>
+                <assertionsResultsToSave>0</assertionsResultsToSave>
+                <bytes>true</bytes>
+              </value>
+            </objProp>
+            <stringProp name="filename"></stringProp>
+            <longProp name="interval_grouping">500</longProp>
+            <boolProp name="graph_aggregated">false</boolProp>
+            <stringProp name="include_sample_labels"></stringProp>
+            <stringProp name="exclude_sample_labels"></stringProp>
+          </kg.apc.jmeter.vizualizers.CorrectedResultCollector>
+        EOF
+        update params
+        update_at_xpath params if params.is_a?(Hash) && params[:update_at_xpath]
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,30 @@
+module JmeterRuby
+  module Plugins
+    class SteppingThreadGroup
+      attr_accessor :doc
+      include Helper
+      def initialize(params={})
+        testname = params.kind_of?(Array) ? 'SteppingThreadGroup' : (params[:name] || 'SteppingThreadGroup')
+        @doc = Nokogiri::XML(<<-EOF.strip_heredoc)
+          <kg.apc.jmeter.threads.SteppingThreadGroup guiclass="kg.apc.jmeter.threads.SteppingThreadGroupGui" testclass="kg.apc.jmeter.threads.SteppingThreadGroup" testname="#{testname}" enabled="true">
+            <stringProp name="ThreadGroup.on_sample_error">continue</stringProp>
+            <stringProp name="ThreadGroup.num_threads">#{params[:total_threads]}</stringProp>
+            <stringProp name="Threads initial delay">#{params[:initial_delay]}</stringProp>
+            <stringProp name="Start users count">#{params[:start_threads]}</stringProp>
+            <stringProp name="Start users count burst">#{params[:add_threads]}</stringProp>
+            <stringProp name="Start users period">#{params[:start_every]}</stringProp>
+            <stringProp name="Stop users count">#{params[:stop_threads]}</stringProp>
+            <stringProp name="Stop users period">#{params[:stop_every]}</stringProp>
+            <stringProp name="flighttime">#{params[:flight_time]}</stringProp>
+            <stringProp name="rampUp">#{params[:rampup]}</stringProp>
+            <elementProp name="ThreadGroup.main_controller" elementType="LoopController" guiclass="LoopControlPanel" testclass="LoopController" testname="Loop Controller" enabled="true">
+              <boolProp name="LoopController.continue_forever">false</boolProp>
+              <intProp name="LoopController.loops">-1</intProp>
+            </elementProp>
+          </kg.apc.jmeter.threads.SteppingThreadGroup>
+        EOF
+        update params
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module JmeterRuby
+  module Plugins
+    class TransactionsPerSecond
+      attr_accessor :doc
+      include Helper
+      def initialize(params={})
+        testname = params.kind_of?(Array) ? 'TransactionsPerSecond' : (params[:name] || 'TransactionsPerSecond')
+        @doc = Nokogiri::XML(<<-EOF.strip_heredoc)
+          <kg.apc.jmeter.vizualizers.CorrectedResultCollector guiclass="kg.apc.jmeter.vizualizers.TransactionsPerSecondGui" testclass="kg.apc.jmeter.vizualizers.CorrectedResultCollector" testname="#{testname}" enabled="#{enabled(params)}">
+            <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>true</message>
+                <threadName>true</threadName>
+                <dataType>true</dataType>
+                <encoding>false</encoding>
+                <assertions>true</assertions>
+                <subresults>true</subresults>
+                <responseData>false</responseData>
+                <samplerData>false</samplerData>
+                <xml>true</xml>
+                <fieldNames>false</fieldNames>
+                <responseHeaders>false</responseHeaders>
+                <requestHeaders>false</requestHeaders>
+                <responseDataOnError>false</responseDataOnError>
+                <saveAssertionResultsFailureMessage>false</saveAssertionResultsFailureMessage>
+                <assertionsResultsToSave>0</assertionsResultsToSave>
+                <bytes>true</bytes>
+              </value>
+            </objProp>
+            <stringProp name="filename"></stringProp>
+            <longProp name="interval_grouping">1000</longProp>
+            <boolProp name="graph_aggregated">false</boolProp>
+            <stringProp name="include_sample_labels"></stringProp>
+            <stringProp name="exclude_sample_labels"></stringProp>
+          </kg.apc.jmeter.vizualizers.CorrectedResultCollector>
+        EOF
+        update params
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,23 @@
+module JmeterRuby
+  module Plugins
+    class UltimateThreadGroup
+      attr_accessor :doc
+      include Helper
+      def initialize(params={})
+        testname = params.kind_of?(Array) ? 'UltimateThreadGroup' : (params[:name] || 'UltimateThreadGroup')
+        @doc = Nokogiri::XML(<<-EOF.strip_heredoc)
+          <kg.apc.jmeter.threads.UltimateThreadGroup guiclass="kg.apc.jmeter.threads.UltimateThreadGroupGui" testclass="kg.apc.jmeter.threads.UltimateThreadGroup" testname="#{testname}" enabled="true">
+           <collectionProp name="ultimatethreadgroupdata">
+           </collectionProp>
+           <elementProp name="ThreadGroup.main_controller" elementType="LoopController" guiclass="LoopControlPanel" testclass="LoopController" testname="Loop Controller" enabled="true">
+             <boolProp name="LoopController.continue_forever">false</boolProp>
+             <intProp name="LoopController.loops">-1</intProp>
+           </elementProp>
+           <stringProp name="ThreadGroup.on_sample_error">continue</stringProp>
+         </kg.apc.jmeter.threads.UltimateThreadGroup>
+        EOF
+        update params
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module JmeterRuby
+  module Plugins
+    class ThroughputShapingTimer
+      attr_accessor :doc
+      include Helper
+      def initialize(params={})
+        testname = params.kind_of?(Array) ? 'ThroughputShapingTimer' : (params[:name] || 'ThroughputShapingTimer')
+        @doc = Nokogiri::XML(<<-EOF.strip_heredoc)
+          <kg.apc.jmeter.timers.VariableThroughputTimer guiclass="kg.apc.jmeter.timers.VariableThroughputTimerGui" testclass="kg.apc.jmeter.timers.VariableThroughputTimer" testname="#{testname}" enabled="true">
+            <collectionProp name="load_profile"/>
+          </kg.apc.jmeter.timers.VariableThroughputTimer>
+        EOF
+        (params.kind_of?(Array) ? params : params[:steps]).each_with_index do |step, index|
+          @doc.at_xpath('//collectionProp') <<
+            Nokogiri::XML(<<-EOF.strip_heredoc).children
+              <collectionProp name="step_#{index}">
+                <stringProp name="start_rps_#{index}">#{step[:start_rps]}</stringProp>
+                <stringProp name="end_rps_#{index}">#{step[:end_rps]}</stringProp>
+                <stringProp name="duration_sec_#{index}">#{step[:duration]}</stringProp>
+              </collectionProp>
+            EOF
+        end
+        update params
+      end
+    end
+  end
+end

data/lib/jmeter-ruby/version.rb

@@ -0,0 +1,12 @@
+module JmeterRuby
+  module VERSION
+    MAJOR = 3
+    MINOR = 0
+    PATCH = 0
+    PRE = nil
+
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
+  end
+end
+
+puts JmeterRuby::VERSION::STRING if __FILE__ == $PROGRAM_NAME

data/lib/jmeter-ruby.rb

@@ -0,0 +1,27 @@
+require 'nokogiri'
+require 'rest_client'
+require 'json'
+require 'cgi'
+require 'open3'
+
+require 'jmeter-ruby/version'
+
+lib = File.dirname(File.absolute_path(__FILE__))
+
+Dir.glob(lib + '/jmeter-ruby/helpers/**/*.rb').each do |file|
+  require file
+end
+
+Dir.glob(lib + '/jmeter-ruby/dsl/**/*.rb').each do |file|
+  require file
+end
+
+Dir.glob(lib + '/jmeter-ruby/extend/**/*.rb').each do |file|
+  require file
+end
+
+Dir.glob(lib + '/jmeter-ruby/plugins/**/*.rb').each do |file|
+  require file
+end
+
+require 'jmeter-ruby/dsl'

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4.2"

data/script/release

@@ -0,0 +1,162 @@
+#!/usr/bin/env bash
+
+fetch() {
+  git fetch --all
+}
+
+branch_name() {
+  git symbolic-ref --short HEAD
+}
+
+local_history_is_clean() {
+  history=$(git rev-list --count --right-only @{u}...HEAD)
+  [ "$history" == "0" ]
+}
+
+remote_history_is_clean() {
+  history=$(git rev-list --count --left-only @{u}...HEAD)
+  [ "$history" == "0" ]
+}
+
+tag_exists_on_remote() {
+  git rev-parse --quiet --verify refs/tags/$1.$2.$3 > /dev/null
+}
+
+working_tree_is_clean() {
+  status=$(git status --porcelain)
+  [ "$status" == "" ]
+}
+
+create_release_branch() {
+  git switch -c release-$1-$2-$3
+}
+
+update_readme() {
+  sed -i '' "/## main/ {a\
+  \\
+\\
+## $1.$2.$3
+  }" docs/CHANGELOG.md
+}
+
+update_ruby_version() {
+  # Update version file
+  sed -E -i '' \
+      -e "s/MAJOR = [0-9]+/MAJOR = $1/g" \
+      -e "s/MINOR = [0-9]+/MINOR = $2/g" \
+      -e "s/PATCH = [0-9]+/PATCH = $3/g" \
+      lib/jmeter-ruby/version.rb
+
+  # Update deprecation horizon version
+  major=$1
+  sed -E -i '' \
+      -e "s/DEPRECATION_HORIZON = [0-9]+/DEPRECATION_HORIZON = $((major + 1))/g" \
+      lib/jmeter-ruby/deprecation.rb
+}
+
+update_gemfiles() {
+  # Update Gemfile.lock
+  bundle
+}
+
+add_changed_files() {
+  git add \
+    Gemfile.lock \
+    lib/jmeter-ruby/version.rb
+}
+
+commit() {
+  git commit -m "release $1.$2.$3"
+}
+
+push() {
+  git push origin release-$1-$2-$3
+
+  echo "####################################################"
+  echo "Now, open a PR with this branch and merge it to main"
+  echo "Then, run script/publish on main to release the gem"
+  echo "Finally, create a GitHub release https://github.com/reeganviljoen/jmeter-ruby/releases/new with the changes from docs/CHANGELOG"
+  echo "####################################################"
+}
+
+main() {
+  version=$(ruby ./lib/jmeter-ruby/version.rb)
+  version=(${version//./ })
+  major=${version[0]}
+  minor=${version[1]}
+  patch=${version[2]}
+
+  echo "==================="
+  echo "Prerequisite Checks"
+  echo "==================="
+
+  if ! working_tree_is_clean; then
+    echo "Error: unclean working tree"
+    exit 1
+  fi
+
+  if [ "$(branch_name)" != "main" ]; then
+    echo "Error: can only make a release on the main branch"
+    exit 1
+  fi
+
+  fetch
+
+  if ! remote_history_is_clean; then
+    echo "Error: changes exist on origin not pulled into this branch. Please pull"
+    exit 1
+  fi
+
+  if ! local_history_is_clean; then
+    echo "Error: changes exist that haven't been pushed to origin. Please pull"
+    exit 1
+  fi
+
+  echo "Type the number of an option to bump, or pick Manual to enter a version number"
+  select bump in Major Minor Patch Manual
+  do
+    if [ "$bump" == "Major" ]; then
+      major=$((major + 1))
+      minor=0
+      patch=0
+    elif [ "$bump" == "Minor" ]; then
+      minor=$((minor + 1))
+      patch=0
+    elif [ "$bump" == "Patch" ]; then
+      patch=$((patch + 1))
+    else
+      read -p "What version? (Currently $major.$minor.$patch): " new_version
+      if [ "$new_version" == "$major.$minor.$patch" ]; then
+        echo "Error: Can't be the same version"
+        exit 1
+      fi
+
+      new_version=(${new_version//./ })
+
+      major=${new_version[0]}
+      minor=${new_version[1]}
+      patch=${new_version[2]}
+    fi
+
+    if tag_exists_on_remote $major $minor $patch; then
+      echo "Error: tag exists on remote"
+      exit 1
+    fi
+
+    echo "==============================="
+    echo "Creating release for $major.$minor.$patch"
+    echo "==============================="
+
+    create_release_branch $major $minor $patch
+    update_readme $major $minor $patch
+    update_ruby_version $major $minor $patch
+    update_gemfiles $major $minor $patch
+    echo "version: $major.$minor.$patch" > docs/_data/library.yml
+    add_changed_files $major $minor $patch
+    commit $major $minor $patch
+    push $major $minor $patch
+    exit 0
+  done
+}
+
+main

data/spec/constant_throughput_timer_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'constant_throughput_timer' do
+  let(:doc) do
+    test do
+      threads do
+        constant_throughput_timer value: 60.0
+        constant_throughput_timer throughput: 70.0
+      end
+    end.to_doc
+  end
+
+  it 'should match on throughput using value' do
+    expect(doc.search('//ConstantThroughputTimer[1]/stringProp[@name="throughput"]').first.content).to eq '60.0'
+  end
+  
+  it 'should match on throughput using throughput' do
+    expect(doc.search('//ConstantThroughputTimer[2]/stringProp[@name="throughput"]').first.content).to eq '70.0'
+  end
+end

data/spec/csv_data_set_config_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'csv_data_set_config' do
+  describe 'the options should be respected' do
+    let(:doc) do
+      test do
+        csv_data_set_config delimiter: '|',
+                            filename: 'test.csv',
+                            ignoreFirstLine: true,
+                            variableNames: 'test1,test2'
+      end.to_doc
+    end
+
+    let(:csv_data_set) { doc.search("//CSVDataSet") }
+
+    it 'should match on variableNames' do
+      expect(csv_data_set.search(".//stringProp[@name='variableNames']").first.text).to eq 'test1,test2'
+    end
+
+    it 'should match on delimiter' do
+      expect(csv_data_set.search(".//stringProp[@name='delimiter']").first.text).to eq '|'
+    end
+
+    it 'should match on filename' do
+      expect(csv_data_set.search(".//stringProp[@name='filename']").first.text).to eq 'test.csv'
+    end
+
+    it 'should match on ignoreFirstLine' do
+      expect(csv_data_set.search(".//boolProp[@name='ignoreFirstLine']").first.text).to eq 'true'
+    end
+  end
+
+end

data/spec/header_manager_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'header manager' do
+  let(:doc) do
+    test do
+      header name: 'Accept', value: '*'
+    end.to_doc
+  end
+
+  let(:fragment) { doc.search('//HeaderManager').first }
+
+  it 'should match on accept' do
+    expect(fragment.search(".//stringProp[@name='Header.name']").text).to eq 'Accept'
+    expect(fragment.search(".//stringProp[@name='Header.value']").text).to eq '*'
+  end
+end
+
+describe 'header manager multiple values' do
+  let(:doc) do
+    test do
+      header [ { name: 'Accept', value: '1' }, { name: 'Accept', value: '2' }]
+    end.to_doc
+  end
+
+  let(:fragment) { doc.search('//HeaderManager') }
+
+
+  it 'should match on accept for fragment_first' do
+    expect(fragment.search(".//stringProp[@name='Header.name']").first.text).to eq 'Accept'
+    expect(fragment.search(".//stringProp[@name='Header.value']").first.text).to eq '1'
+  end
+
+  it 'should match on accept for fragment_last' do
+    expect(fragment.search(".//stringProp[@name='Header.name']").last.text).to eq 'Accept'
+    expect(fragment.search(".//stringProp[@name='Header.value']").last.text).to eq '2'
+  end
+end

data/spec/http_cache_manager_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'http_cache_manager' do
+  describe 'the clear_each_iteration option should be respected' do
+    let(:doc) do
+      test do
+        cache clear_each_iteration: true
+      end.to_doc
+    end
+
+    let(:cache_fragment) { doc.search("//CacheManager") }
+
+    it 'should match on clearEachIteration' do
+      expect(cache_fragment.search(".//boolProp[@name='clearEachIteration']").first.text).to eq 'true'
+    end
+  end
+
+  describe 'the use_expires option should be respected' do
+    let(:doc) do
+      test do
+        cache use_expires: true
+      end.to_doc
+    end
+     let(:cache_fragment) { doc.search("//CacheManager") }
+     it 'should match on useExpires' do
+      expect(cache_fragment.search(".//boolProp[@name='useExpires']").first.text).to eq 'true'
+    end
+  end
+end