loadtester 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f6db75fea18b2ffba192f1f0bc51928efada544
+  data.tar.gz: e7c8d72c8a28570fe9ee4a983fe86636da92c097
+SHA512:
+  metadata.gz: d38c9d367a867b2915efc9e6aee0f5daebd16e535d9d1f978fe089f2dd54fbc5d96afadbd99225b66872ffa890d6aea311ec39a245e048fea84b88fbc6c158b9
+  data.tar.gz: 8631bc889af5743861d9cc855f459756d2f319d9e2aa9b8e7d56306a0d2109888b553da43e7dd6ada15efba5ffc721f5663961ee3c580cbce3359d423b81a629

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in loadtester.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Stuart Harland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Loadtester
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/loadtester`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'loadtester'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install loadtester
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/loadtester/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "loadtester"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/loadtester

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'loadtester'
+
+LT.new.iotest

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/loadtester/filedefinition.rb

@@ -0,0 +1,81 @@
+# Module to run Disk I/O benchmarks for various size files
+module LoadTester
+  # A File with random contents of given size
+  class FileDefinition
+    RANDOM_GENERATOR = Random.new
+    attr_accessor :run_time, :source, :size,
+                  :file_source_name, :file_destination_name,
+                  :data, :type, :destination
+
+    def initialize(source, destination, size, file_source_name,
+                   file_destination_name, type)
+      self.source = source
+      self.destination = destination
+      self.size = size
+      self.file_source_name = file_source_name
+      self.file_destination_name = file_destination_name
+      self.type = type
+      populate unless valid?
+      self.load! if type == :write
+    end
+
+    def populate
+      FileUtils.mkdir_p File.dirname src
+      FileUtils.mkdir_p File.dirname target
+      generate unless File.exist? src
+      FileUtils.copy src, target if type == :read
+    end
+
+    def generate
+      FileUtils.mkdir_p File.dirname src
+      random_string = ''
+      size.to_i.times do
+        random_string += RANDOM_GENERATOR.rand(256).chr
+      end
+      IO.binwrite src, random_string
+    end
+
+    def src
+      File.join source,
+                size.pretty,
+                file_source_name.to_s
+    end
+
+    def target
+      File.join destination,
+                type.to_s,
+                size.pretty,
+                file_destination_name.to_s
+    end
+
+    def load!
+      self.data = File.read src
+      FileUtils.mkdir_p File.join(destination, size.pretty)
+    end
+
+    def read
+      self.run_time = Benchmark.measure do
+        IO.binread target
+      end
+      run_time.real
+    end
+
+    def write
+      self.run_time = Benchmark.measure do
+        File.open(target, 'wb') do |fd|
+          fd.write data
+          fd.fsync
+        end
+      end
+      run_time.real
+    end
+
+    def valid?
+      if type == :read
+        File.exist? target
+      else
+        File.exist?(src) && File.directory?(File.dirname(target))
+      end
+    end
+  end
+end

data/lib/loadtester/helpers.rb

@@ -0,0 +1,23 @@
+# Module to run Disk I/O benchmarks for various size files
+module LoadTester
+  class << self
+    # Creates an array set of random integers
+    # http://stackoverflow.com/questions/119107/how-do-i-generate-a-list-of-n-unique-random-numbers-in-rub
+    def rand_n(n, max)
+      randoms = []
+      loop do
+        r = rand(max)
+        randoms << r
+        return randoms if randoms.size >= n
+      end
+    end
+
+    def generate_file_list(random, list_size, pool_size)
+      if random
+        rand_n list_size, pool_size
+      else
+        Array.new(list_size) { |index| index % pool_size }
+      end
+    end
+  end
+end

data/lib/loadtester/optionsparser.rb

@@ -0,0 +1,113 @@
+require 'ostruct'
+require 'optparse'
+module LoadTester
+  # Parses the CLI Arguments passed into LoadTester
+  class OptionsParser
+    attr_accessor :sizes, :source, :destination, :verbose, :random,
+                  :generate, :number, :pool_size, :rw_bias, :opts
+    def initialize
+      self.opts = OptionParser.new
+      self.sizes = Array.new(8).map.with_index do |_x, index|
+        Filesize.from("#{2**(10 + index)}b")
+      end
+      self.source = 'load_tester_files'
+      self.verbose = false
+      self.random = true
+      self.number = 900
+      self.pool_size = 300
+      self.rw_bias = 0.5
+    end
+
+    def option_error(option, err_string, example)
+      $stderr.puts 'load_test.rb: Unable to parse command line options.'
+      $stderr.puts "  #{option} #{err_string}"
+      $stderr.puts "  ruby load_test.rb #{option} #{example}"
+      exit 2
+    end
+
+    def parse_verbose
+      opts.on('-v', '--verbose', 'Run Verbosely') do |v|
+        self.verbose = v
+      end
+    end
+
+    def parse_source_destination
+      opts.on('-d', '--destination DIR', 'Destination') do |d|
+        self.destination = d
+      end
+      opts.on('-s', '--source DIR', 'Path to Source Files') do |s|
+        self.source = s
+      end
+    end
+
+    def parse_sizes
+      opts.on('-x', '--sizes [BYTES]', ' sizes to test') do |size|
+        begin
+          self.sizes = size.split(',').map do |value|
+            Filesize.from(value)
+          end
+        rescue ArgumentError
+          option_error '--size', 'Must be human readable csv',
+                       '4kb,8kb,1mb'
+        end
+      end
+    end
+
+    def parse_number_pool
+      opts.on('-n', '--number [INT]', 'Number of operations') do |n|
+        self.number = n.to_i
+      end
+      opts.on('-p', '--poolsize [INT]', 'Size of random pool') do |p|
+        self.pool_size = p.to_i
+      end
+    end
+
+    def parse_random_generate_bias
+      opts.on('-r', '--random', 'Random IO?') do |r|
+        self.random = r
+      end
+      opts.on('-g', '--generate', 'Generate Source') do |g|
+        self.generate = g
+      end
+      opts.on('-b', '--rw-bias [FLOAT]', 'Read Write Bias') do |b|
+        self.rw_bias = b.to_f
+      end
+    end
+
+    def parse_info
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+      opts.on_tail('--version', 'Show version') do
+        puts ::Version.join('.')
+        exit
+      end
+    end
+
+    def setup_opts
+      opts.banner = 'Usage: load_test.rb [options]'
+      opts.separator ''
+      opts.separator 'Specific options:'
+    end
+
+    def parse!(args)
+      opts.parse!(args)
+      self
+    end
+
+    class << self
+      def factory(args)
+        opt = OptionsParser.new
+        opt.setup_opts
+        opt.parse_verbose
+        opt.parse_source_destination
+        opt.parse_sizes
+        opt.parse_number_pool
+        opt.parse_random_generate_bias
+        opt.parse_info
+        opt.parse!(args)
+      end
+    end
+  end
+end

data/lib/loadtester/version.rb

@@ -0,0 +1,4 @@
+# LoadTester: io Benchmark tool for various sized files
+module LoadTester
+  VERSION = '0.1.0'
+end

data/lib/loadtester.rb

@@ -0,0 +1,126 @@
+# Module to run Disk I/O benchmarks for various size files
+module LoadTester
+  require 'loadtester/version'
+  require 'loadtester/optionsparser'
+  require 'loadtester/filegenerator'
+  require 'loadtester/helpers'
+  require 'loadtester/filedefinition'
+  require 'fileutils'
+  require 'filesize'
+  require 'benchmark'
+
+  # Base object to run Load Test iterations
+  class LT
+    attr_accessor :read_count, :count,
+                  :read_list, :write_list, :options,
+                  :read_time, :write_time,
+                  :read_number, :write_number
+
+    def initialize
+      self.options = OptionsParser.factory(ARGV)
+      generate_files if @options.generate
+      self.read_count = 0
+      self.count = 0
+      self.read_time = 0
+      self.write_time = 0
+      calculate_biases
+    end
+
+    def calculate_biases
+      self.read_number = (options.number * options.rw_bias).round
+      self.write_number = (options.number * (1 - options.rw_bias)).round
+    end
+
+    def speed(type, number, time, size)
+      "#{type}: #{number} files of size #{size.pretty} "\
+        "in #{time} seconds at "\
+        "#{(number * size.to_i / 1024 / 1024 / time).round(2)} MB/s"
+    end
+
+    def total_speed(size)
+      puts speed 'Total', read_number + write_number,
+                 read_time + write_time, size
+    end
+
+    def report(size)
+      puts "Read/Write Bias: #{options.rw_bias}"
+      puts total_speed size
+      puts speed 'Read', read_number, read_time, size
+      puts speed 'Wrote', write_number, write_time, size
+    end
+
+    def iotest
+      options.sizes.each do |size|
+        generate_operations size
+        io_loop
+        report size
+      end
+    end
+
+    # If you are trying to run a benchmark against the write speed
+    # of a distributed file system, you don't want the read speed
+    # of your local infrastructure to be included in that
+    #
+    # This preloads the file contents for a given 'size' into ram
+    def generate_operation_list(size, type, number)
+      file_list = LoadTester.generate_file_list options.random,
+                                                number, options.pool_size
+      files = []
+      file_list.each.with_index do |file_source_name, file_destination_name|
+        files << FileDefinition.new(options.source, options.destination,
+                                    size, file_source_name,
+                                    file_destination_name, type)
+      end
+      files
+    end
+
+    # Pre-generate files for IO test
+    # NB this can take some time for files > 128kb!
+    def generate_files
+      options.sizes.each do |size|
+        options.pool_size.times do |n|
+          FileDefinition.new options.source,
+                             options.destination,
+                             size, n, n, :write
+        end
+      end
+      exit
+    end
+
+    # Create two lists: one for the order of the read operations
+    # and one for the write operations
+    def generate_operations(size)
+      self.read_list = generate_operation_list size, :read, read_number
+      self.write_list =  generate_operation_list size, :write, write_number
+    end
+
+    # loop over the various files in the queue and perform load test
+    def io_loop
+      until write_list.empty? && read_list.empty?
+        if should_read
+          do_read
+        else
+          do_write
+        end
+      end
+    end
+
+    def do_read
+      self.read_time += read_list.pop.read
+      self.read_count += 1
+      self.count += 1
+    end
+
+    def do_write
+      self.write_time += write_list.pop.write
+      self.count += 1
+    end
+
+    def should_read
+      return false if self.count == 0
+      return false if read_list.empty?
+      return true if write_list.empty?
+      return true if (self.read_count / self.count) < options.rw_bias
+    end
+  end
+end

data/loadtester.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'loadtester/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'loadtester'
+  spec.version       = LoadTester::VERSION
+  spec.authors       = ['Stuart Harland']
+  spec.email         = ['s.harand@livelinktechnology.net']
+
+  spec.summary       = %q{File Benchmark Tool}
+  spec.description   = %q{Provides File IO Benchmarking for named file sizes with read/write biasing}
+  spec.homepage      = 'http://github.com/livelink/loadtester'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.require_paths = ['lib']
+  spec.executables   = ['loadtester']
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "filesize"
+  spec.add_dependency "fileutils"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: loadtester
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stuart Harland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: filesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides File IO Benchmarking for named file sizes with read/write biasing
+email:
+- s.harand@livelinktechnology.net
+executables:
+- loadtester
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/loadtester
+- bin/setup
+- lib/loadtester.rb
+- lib/loadtester/filedefinition.rb
+- lib/loadtester/helpers.rb
+- lib/loadtester/optionsparser.rb
+- lib/loadtester/version.rb
+- loadtester.gemspec
+homepage: http://github.com/livelink/loadtester
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: File Benchmark Tool
+test_files: []
+has_rdoc: