bcpm 0.11

data/lib/bcpm/tests/suite.rb

@@ -0,0 +1,114 @@
+# :nodoc: namespace
+module Bcpm
+
+# :nodoc: namespace
+module Tests
+
+# Collection of test cases.
+class Suite
+  # All the environments used in the tests.
+  attr_reader :environments
+  # All the matches used in the tests.
+  attr_reader :matches
+  # All test cases.
+  attr_reader :tests
+  # Path to the suite's local repository.
+  attr_reader :local_path
+  
+  # Blank suite.
+  def initialize(local_path)
+    @local_path = local_path
+    @tests = []
+    @matches = []
+    @environments = []
+  end
+  
+  # Adds the given test cases to the suite.
+  def add_cases(case_files)    
+    case_files.each do |file|
+      code = File.read file
+      klass = Class.new Bcpm::Tests::CaseBase
+      klass._setup
+      begin
+        klass.class_eval code, file
+      rescue Exception => e
+        trace = short_backtrace e.backtrace
+        print "Error in test case #{file}\n"
+        print "#{e.class.name}: #{e.to_s}\n#{trace.join("\n")}\n\n"
+        next
+      end
+      klass._post_eval
+      @tests += klass.tests
+      @matches += klass.matches
+      @environments += klass.environments
+    end
+    self
+  end
+  
+  # Runs all the tests in the suite.
+  def run(live = false)
+    environments.each { |e| e.setup local_path }
+
+    wins, fails, errors, skipped, totals = 0, 0, 0, 0, 0
+    failures = []
+    tests.each_with_index do |test, i|
+      unless test.match.environment.available?
+        skipped += 1
+        next
+      end
+      
+      unless test.match.ran?
+        test.match.run live
+        # Only one match can run live, otherwise all hell will break loose.
+        live = false
+      end
+      failure_string = nil
+      begin
+        if failure = test.check_output
+          trace = short_backtrace failure.backtrace
+          failure_string = "#{failure.to_s}\n#{trace.join("\n")}"
+          fails += 1
+          print 'F'
+        else
+          wins += 1
+          print '.'
+        end        
+      rescue Exception => e
+        errors += 1
+        failure_string = "#{e.class.name}: #{e.to_s}\n#{e.backtrace.join("\n")}"
+      end
+      totals += 1
+      if failure_string
+        failures << [test, failure_string]
+      end
+    end
+    print "\n#{totals} tests, #{wins} passed, #{fails} failures, #{errors} errors\n\n"
+    failures.each_with_index do |failure, i|
+      test, string = *failure
+      print "#{'%3d' % (i + 1)}) Failed #{test.description}\n"
+
+      print test.match.stash_data            
+      print "#{string}\n\n"
+    end
+
+    environments.each { |e| e.teardown }
+    self
+  end
+  
+  # Trims backtrace to the confines of the test suite.
+  def short_backtrace(backtrace)
+    trace = backtrace
+    first_line = trace.find_index { |line| line.index local_path }
+    last_line = trace.length - 1 - trace.reverse.find_index { |line| line.index local_path }
+    # Leave the trace untouched if it doesn't go through the test suite.
+    if first_line && last_line
+      trace = trace[first_line..last_line]
+      trace[-1] = trace[-1].sub /in `.*'/, 'in (test case)'
+    end
+    trace
+  end   
+end  # class Bcpm::Tests::Suite
+
+end  # namespace Bcpm::Tests
+
+end  # namespace Bcpm

data/lib/bcpm/tests/test_match.rb

@@ -0,0 +1,166 @@
+require 'tmpdir'
+
+# :nodoc: namespace
+module Bcpm
+
+# :nodoc: namespace
+module Tests
+  
+# A match run for simulation purposes.
+#
+# Each test case is its own anonymous class.
+class TestMatch
+  # Side of the tested player in the match.
+  attr_reader :side
+  # Name of opposing player in the match.
+  attr_reader :vs  
+  # Name of map for the match.
+  attr_reader :map
+  # Custom options for the battlecode simulator.
+  attr_reader :options
+  
+  # The environment that the match runs in.
+  attr_reader :environment
+
+  # Match output. Nil if the match hasn't completed.
+  attr_reader :output
+    
+  # Detailed match data.
+  attr_reader :data
+
+  # Skeleton for a match.
+  def initialize(side, vs, map, environment, options = {})
+    @side = side
+    @vs = vs
+    @map = map
+    @options = options.clone
+    @environment = environment
+    @output = nil
+    @data = nil
+    
+    @output_lines = nil
+    @outcome = nil
+    @winner = nil
+    @reason = nil
+  end
+  
+  # Run the game.
+  def run(live = false)
+    case @side
+    when :a
+      @data = Bcpm::Match.match_data @environment.player_name, @vs, true, @map, live, @options
+    when :b
+      @data = Bcpm::Match.match_data @vs, @environment.player_name, false, @map, live, @options
+    end
+    @output = data[:ant]
+  end
+
+  # True if the test match has run, and its results are available.
+  def ran?
+    !output.nil?
+  end
+
+  # User-readable description of match conditions.
+  def description
+    if File.basename(map) == map
+      map_name = map
+    else
+      map_name = "suite/maps/#{File.basename(map).sub(/\.xml$/, '')}"
+    end
+    desc = "as team #{side.to_s.upcase} vs #{vs} on #{map_name}"
+    unless @options.empty?
+      desc += ' with ' + options.map { |k, v| "#{k}=#{v}" }.join(",")
+    end
+    desc
+  end
+    
+  # The match output, split into lines.
+  def output_lines
+    @output_lines ||= output.split("\n")
+  end
+  
+  # The output printed by map units, without the [source] prefixess.
+  def chatter
+    @chatter ||= output_lines.map { |line| line.gsub /^\[[^\]]+\]\s/, '' }.reject(&:empty?).join("\n")
+  end
+  
+  # The output line showing who won the game.
+  def outcome
+    return @outcome if @outcome
+    @outcome = output_lines[-3] || ''
+    @outcome = '(no victory)' unless outcome.index('wins')
+    @outcome
+  end
+  
+  # The side that own the game
+  def winner
+    return @winner if @winner
+    win_match = /\((.)\) wins/.match outcome
+    @winner = if win_match
+      (win_match[1] == 'A') ? :a : :b
+    else
+      :error
+    end
+    @winner
+  end
+
+  # The output line showing the reason the game ended.
+  def reason
+    return @reason if @reason
+    @reason = output_lines[-2] || ''
+    @reason = '(no reason)' unless reason.index('Reason:')
+    @reason
+  end
+  
+  # Stashes the match data somewhere on the system.
+  #
+  # Returns a string containing user-friendly instructions for accessing the match data.
+  def stash_data
+    path = self.class.gamesave_path
+    FileUtils.mkdir_p path
+    
+    txt_path = File.join path, data[:uid] + '.txt'
+    File.open(txt_path, 'wb') { |f| f.write output } unless File.exist?(txt_path)
+    rms_path = File.join path, data[:uid] + '.rms'
+    File.open(rms_path, 'wb') { |f| f.write data[:rms] }  unless File.exist?(rms_path)
+  
+    "Output: #{open_binary} #{txt_path}\nReplay: bcpm replay #{rms_path}\n"
+  end
+  
+  # All game replays saved by calls to stash_data.
+  def self.stashed_replays
+    Dir.glob File.join(gamesave_path, '*.rms')
+  end
+  
+  # All game outputs saved by calls to stash_data.
+  def self.stashed_outputs
+    Dir.glob File.join(gamesave_path, '*.txt')
+  end
+  
+  # Path where game data (output, replay binlog) is saved.
+  def self.gamesave_path
+    Bcpm::Config[:gamesave_path] ||= default_gamesave_path
+  end
+
+  # Path where game data (output, replay binlog) is saved.
+  def self.default_gamesave_path
+    File.join Dir.tmpdir, 'bcpm'
+  end
+
+  # Name of program for opening text files.
+  def open_binary
+    return ENV['EDITOR'] if ENV['EDITOR']
+    case RUBY_PLATFORM
+    when /darwin/
+      'open'
+    when /win/
+      'notepad'
+    when /linux/
+      'gedit'
+    end
+  end
+end  # class Bcpm::Tests::TestMatch
+
+end  # namespace Bcpm::Tests
+
+end  # namespace Bcpm

data/lib/bcpm/update.rb

@@ -0,0 +1,38 @@
+require 'socket'
+require 'tmpdir'
+
+# :nodoc: namespace
+module Bcpm
+
+# Bcpm updating code.
+module Update
+  # Updates bcpm to the latest version.
+  def self.upgrade(branch = 'master')
+    source_path = tempdir
+    return false unless Bcpm::Git.clone_repo(repo_uri, 'master', source_path)    
+    success = nil
+    Dir.chdir source_path do
+      success = Kernel.system 'rake', 'install'
+    end
+    FileUtils.rm_r source_path
+    success
+  end
+    
+  # Temporary directory name.
+  def self.tempdir
+    File.join Dir.tmpdir, 'bcpm',
+        "update_#{Socket.hostname}_#{(Time.now.to_f * 1000).to_i}_#{$PID}"
+  end
+
+  # Git URI to the bcpm repository.
+  def self.repo_uri
+    Bcpm::Config[:bcpm_repo_uri] ||= default_repo_uri
+  end
+  
+  # Git URI to the bcpm repository.  
+  def self.default_repo_uri
+    'git@git.pwnb.us:six370/bcpm.git'
+  end
+end  # module Bcpm::Update
+
+end  # module Bcpm

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: bcpm
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 11
+  version: "0.11"
+platform: ruby
+authors: 
+- Victor Costan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 2
+        version: "3.2"
+  type: :development
+  version_requirements: *id001
+description: Battlecode (MIT 6.370) package manager.
+email: victor@costan.us
+executables: 
+- bcpm
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- README
+- bin/bcpm
+- lib/bcpm.rb
+- lib/bcpm/cleanup.rb
+- lib/bcpm/cli.rb
+- lib/bcpm/config.rb
+- lib/bcpm/dist.rb
+- lib/bcpm/duel.rb
+- lib/bcpm/git.rb
+- lib/bcpm/match.rb
+- lib/bcpm/player.rb
+- lib/bcpm/regen.rb
+- lib/bcpm/socket.rb
+- lib/bcpm/tests/assertion_error.rb
+- lib/bcpm/tests/assertions.rb
+- lib/bcpm/tests/case_base.rb
+- lib/bcpm/tests/environment.rb
+- lib/bcpm/tests/suite.rb
+- lib/bcpm/tests/test_match.rb
+- lib/bcpm/update.rb
+files: 
+- CHANGELOG
+- Manifest
+- README
+- Rakefile
+- bin/bcpm
+- lib/bcpm.rb
+- lib/bcpm/cleanup.rb
+- lib/bcpm/cli.rb
+- lib/bcpm/config.rb
+- lib/bcpm/dist.rb
+- lib/bcpm/duel.rb
+- lib/bcpm/git.rb
+- lib/bcpm/match.rb
+- lib/bcpm/player.rb
+- lib/bcpm/regen.rb
+- lib/bcpm/socket.rb
+- lib/bcpm/tests/assertion_error.rb
+- lib/bcpm/tests/assertions.rb
+- lib/bcpm/tests/case_base.rb
+- lib/bcpm/tests/environment.rb
+- lib/bcpm/tests/suite.rb
+- lib/bcpm/tests/test_match.rb
+- lib/bcpm/update.rb
+- bcpm.gemspec
+has_rdoc: true
+homepage: http://git.pwnb.us/six370
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Bcpm
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: bcpm
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Battlecode (MIT 6.370) package manager.
+test_files: []
+