prspec 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzJiMzljMjRiMDc4MDZhYzhmYWZmMWM0NWMzM2RjZDU3MDhiYTdlYw==
+  data.tar.gz: !binary |-
+    ZjhiODdhMTNlNWVhOGQzMTM1ZGI3MjNhYTJkMzQ3NDYyZTRkYTcyOA==
+SHA512:
+  metadata.gz: !binary |-
+    NThiMGE2YThiZDk2M2FiMjQ1YTcxMzZmMTJlZWM4MTk4Y2Q4ZGE3YTE0ODA3
+    ZDdhMDdkOGUyMGU3ZDgzZWRlYzQyZjA4OWU3NWJlYzI2NWQwOWM5NmZjY2Ri
+    MWIxZmEwY2E0Mzg1ZTcwMzllYzU4NTRhYWIwNjQxN2YzOTUxZTk=
+  data.tar.gz: !binary |-
+    MjJjMTllMGYxZmE0NThmYjU2NjQ5YjJjNTgyZDExNzgxNWFmODY2MTA5MjEy
+    NzA0NjA0NjhhYmEyNzRjYzQ5YzgwYjNiMmNlYWE3ZDE1MzA5ZjgyYTEyYTk0
+    ODI3ZmMwMjNiMDdjZGE3YmRlYWJmYjg5MDJjZTlhNTI3Yjc2Y2U=

data/bin/prspec

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'prspec'
+
+PRSpec.new(ARGV)

data/lib/prspec.rb

@@ -0,0 +1,364 @@
+require 'thread'
+require 'optparse'
+require 'log4r'
+require 'parallel'
+require 'tempfile'
+include Log4r
+
+$log = Logger.new('prspec')
+$log.outputters = Outputter.stdout
+level = ENV['log_level'] || ''
+case level.downcase
+when 'all'
+  $log.level = ALL
+when 'debug'
+  $log.level = DEBUG
+when 'info'
+  $log.level = INFO
+when 'warn'
+  $log.level = WARN
+else
+  $log.level = ERROR
+end
+
+class PRSpec
+  attr_accessor :num_threads, :processes, :tests
+  SPEC_FILE_FILTER = '_spec.rb'
+
+  def initialize(args)
+    if (!args.nil? && args.length > 0 && !args[0].nil?)
+      opts = parse_args(args)
+      if (!opts[:help])
+        @num_threads = opts[:thread_count]
+
+        @tests = get_spec_tests(opts)
+        if (tests.length > 0)
+          process_tests = divide_spec_tests(tests)
+          $log.debug "#{tests.length} Spec tests divided among #{@num_threads} arrays."
+        else
+          $log.error "No spec tests found.  Exiting."
+          exit 1
+        end
+
+        $log.info "Creating array of Child Processes..."
+        @processes = build_process_array(process_tests, opts)
+        
+        begin_run(@processes, opts)
+      end
+    end
+  end
+
+  def parse_args(args)
+    $log.debug("Parsing arguments of: #{args}")
+    options = {
+      :dir=>'.',
+      :path=>'spec',
+      :thread_count=>get_number_of_threads,
+      :test_mode=>false,
+      :help=>false,
+      :excludes=>nil,
+      :rspec_args=>[],
+      :tag_name=>'',
+      :tag_value=>'',
+      :ignore_pending=>false
+    }
+    o = OptionParser.new do |opts|
+      opts.banner = "Usage: prspec [options]"
+      opts.on("-p", "--path PATH", "Relative path from the base directory to search for spec files") do |v|
+        $log.debug "path specified... value: #{v}"
+        options[:path] = v
+      end
+      opts.on("-e", "--exclude REGEX", "Regex string used to exclude files") do |v|
+        $log.debug "excludes specified... value: #{v}"
+        options[:excludes] = v
+      end
+      opts.on("-d", "--dir DIRECTORY", "The base directory to run from") do |v|
+        $log.debug "directory specified... value: #{v}"
+        options[:dir] = v
+      end
+      opts.on("-n", "--num-threads THREADS", "The number of threads to use") do |v|
+        $log.debug "number of threads specified... value: #{v}"
+        options[:thread_count] = v.to_i
+      end
+      opts.on("-t", "--tag TAG", "A rspec tag value to filter by") do |v|
+        $log.debug "tag filter specified... value: #{v}"
+        tag = v
+        value = 'true'
+        if (v.include?(':')) # split to tag and value
+          tag_value = v.split(':')
+          tag = ":#{tag_value[0]}"
+          value = "#{tag_value[1]}"
+        end
+        options[:tag_name] = tag
+        options[:tag_value] = value
+      end
+      opts.on("-r", "--rspec-args \"RSPEC_ARGS\"", "Additional arguments to be passed to rspec (must be surrounded with double quotes)") do |v|
+        $log.debug "rspec arguments specified... value: #{v}"
+        options[:rspec_args] = v.gsub(/"/,'').split(' ') # create an array of each argument
+      end
+      opts.on("--test-mode", "Do everything except actually starting the test threads") do
+        $log.debug "test mode specified... threads will NOT be started."
+        options[:test_mode] = true
+      end
+      opts.on("-q", "--quiet", "Quiet mode. Do not display parallel thread output") do
+        $log.debug "quiet mode specified... thread output will not be displayed"
+        options[:quiet_mode] = true
+      end
+      opts.on("-h", "--help", "Display a help message") do 
+        $log.debug "help message requested..."
+        options[:help] = true
+        puts opts
+      end
+      opts.on("--ignore-pending", "Ignore all pending tests") do
+        $log.debug "ignore pending specified... all pending tests will be excluded"
+        options[:ignore_pending] = true
+      end
+    end
+
+    # handle invalid options
+    begin 
+      o.parse! args
+    rescue OptionParser::InvalidOption => e
+      $log.error e
+      puts o
+      exit 1
+    end
+
+    return options
+  end
+
+  def get_number_of_threads
+    count = Parallel.processor_count
+    return count
+  end
+
+  def self.get_number_of_running_threads
+    cmd = "ps -ef"
+    if (PRSpec.is_windows?)
+      cmd = "wmic process get commandline"
+    end
+    result = `#{cmd}`
+    count = 0
+    lines = result.split("\n")
+    lines.each do |line|
+      if (line.include?('TEST_ENV_NUMBER='))
+        count += 1
+      end
+    end
+    $log.debug "Found #{count} occurrances of TEST_ENV_NUMBER"
+    return count
+  end
+
+  def get_spec_tests(options)
+    files = get_spec_files(options)
+    tests = get_tests_from_files(files, options)
+    $log.debug "Found #{tests.length} tests in #{files.length} files"
+    return tests
+  end
+
+  def get_spec_files(options)
+    base_dir = options[:dir]
+    path = options[:path]
+    if (path.nil? || path == '')
+      path = '.'
+    end
+    full_path = ""
+    if (path.end_with?('.rb'))
+      full_path = File.join(base_dir, path.to_s)
+    else
+      full_path = File.join(base_dir, path.to_s, '**', "*#{SPEC_FILE_FILTER}")
+    end
+    $log.debug "full_path: #{full_path}"
+
+    files = []
+    if (options[:excludes].nil?)
+      files = Dir.glob(full_path)
+    else
+      files = Dir.glob(full_path).reject { |f| f[options[:excludes]] }
+    end
+
+    return files
+  end
+
+  def get_tests_from_files(files, options)
+    tests = []
+    get_test_description = /(?<=')([\s\S]*)(?=')/
+    match_test_name_format = /^[\s]*(it)[\s]*(')[\s\S]*(')[\s\S]*(do)/
+    files.each do |file|
+      lines = File.readlines(file)
+      for i in 0..lines.length-1
+        if lines[i] =~ match_test_name_format 
+          m = lines[i]
+          match = true
+          if (options[:tag_name] != '')
+            if (m.rindex(options[:tag_name]).nil? || (m.rindex(options[:tag_value]) <= m.rindex(options[:tag_name]))) 
+              match = false
+            end
+          end
+          # if ignore_pending specified then skip tests containing 'pending' on next line
+          if (options[:ignore_pending])
+            if (i+1 < lines.length-1 && lines[i+1].include?('pending'))
+              match = false
+            end
+          end
+          if (match)
+            tests.push('"'+m.match(get_test_description)[0].gsub(/["]/,'\"')+'"')
+          end
+        end
+      end
+    end
+
+    return tests
+  end
+
+  def divide_spec_tests(tests)
+    if (tests.length < @num_threads)
+      @num_threads = tests.length
+      $log.info "reducing number of threads due to low number of spec tests found: Threads = #{@num_threads}"
+    end
+    spec_arrays = Array.new(@num_threads)
+    num_per_thread = tests.length.fdiv(@num_threads).ceil
+    $log.debug "Approximate number of tests per thread: #{num_per_thread}"
+    # ensure an even distribution
+    i = 0
+    tests.each do |tname|
+      if (i >= @num_threads)
+        i = 0
+      end
+      if (spec_arrays[i].nil?)
+        spec_arrays[i] = []
+      end
+      
+      spec_arrays[i].push(tname)
+
+      i+=1
+    end
+
+    return spec_arrays
+  end
+
+  def build_process_array(process_tests, opts)
+    processes = []
+    for i in 0..@num_threads-1
+      processes[i] = PRSpecThread.new(i, process_tests[i], {'TEST_ENV_NUMBER'=>i, 'HOME'=>nil}, opts)
+    end
+    return processes
+  end
+
+  def begin_run(processes, options)
+    if (!processes.nil? && processes.length > 0)
+      $log.info "Starting all Child Processes..."
+      processes.each do |proc|
+        if (proc.is_a?(PRSpecThread) && options.is_a?(Hash))
+          proc.start unless options[:test_mode]
+        else
+          raise "Invalid datatype where PRSpecThread or Hash exepcted.  Found: #{proc.class.to_s}, #{options.class.to_s}"
+        end
+      end
+      $log.info "Processes started..."
+      continue = true
+      while continue
+        continue = false
+        processes.each do |proc|
+          if (!proc.done?) # confirm threads are running
+            continue = true
+            $log.debug "Thread#{proc.id}: alive..."
+          else
+            $log.debug "Thread#{proc.id}: done."
+            puts proc.output unless options[:quiet_mode]
+            proc.output = '' unless options[:quiet_mode] # prevent outputting same content multiple times
+          end
+        end
+        if (continue)
+          sleep(5) # wait a bit for processes to run and then re-check their status
+        end
+      end
+      $log.info "Processes complete."
+    else
+      raise "Invalid input passed to method: 'processes' must be a valid Array of PRSpecThread objects"
+    end
+  end
+
+  def running?
+    @processes.each do |proc|
+      if (!proc.done?)
+        $log.debug "Found running process..."
+        return true
+      end
+    end
+    return false
+  end
+
+  def close
+    @processes.each do |proc|
+      proc.close
+    end
+  end
+
+  def self.is_windows?
+    return (RUBY_PLATFORM.match(/mingw/i)) ? true : false
+  end
+end
+
+class PRSpecThread
+  attr_accessor :thread, :id, :tests, :env, :args, :output
+  def initialize(id, tests, environment, args)
+    @id = id
+    @tests = tests
+    @env = environment
+    @args = args
+    @output = ''
+    @out = "prspec-t-#{@id}.out"
+    @err = "prspec-t-#{@id}.err"
+  end
+
+  def start
+    filter_str = @tests.join(" -e ")
+    filter_str = "-e " + filter_str
+    exports = get_exports
+    rspec_args = @args[:rspec_args].join(' ')
+    cmd = "#{exports}rspec #{@args[:path]} #{filter_str} #{rspec_args}"
+    $log.debug "Starting child process for thread#{@id}: #{cmd}"
+    @thread = Thread.new do 
+      Thread.current[:id] = @id
+      Dir::chdir @args[:dir] do # change directory for process execution
+        begin
+          pid = Process.spawn(cmd, :out=>@out, :err=>@err) # capture both sdtout and stderr in the same pipe
+          Process.wait(pid)
+          @output = File.readlines(@out).join("\n")
+        rescue
+          error = "ErrorCode: #{$?.errorcode}; ErrorOutput: "+File.readlines(@err).join("\n")
+          $log.error "Something bad happened while executing thread#{@id}: #{error}"
+        end
+        close
+      end
+    end
+  end
+
+  def done?
+    return !@thread.alive?
+  rescue
+    return true # if there's a problem with @thread we're done
+  end
+
+  def close
+    @thread.sleep
+    @thread.kill
+    @thread = nil
+    File.delete(@out) unless !File.exist?(@out)
+    File.delete(@err) unless !File.exist?(@err)
+  end
+
+  def get_exports
+    separator = PRSpec.is_windows? ? ' & ' : ';'
+    exports = @env.map do |k,v|
+      if PRSpec.is_windows?
+        "(SET \"#{k}=#{v}\")"
+      else
+        "#{k}=#{v};export #{k}"
+      end
+    end.join(separator)
+
+    return exports+separator
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: prspec
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jason Holt Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Allows for simple parallel execution of rspec tests.
+email: bicarbon8@gmail.com
+executables:
+- prspec
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/prspec
+- lib/prspec.rb
+homepage: https://github.com/bicarbon8/prspec.git
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Parallel rspec execution
+test_files: []
+has_rdoc: