bcpm 0.11

data/bcpm.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bcpm}
+  s.version = "0.11"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Victor Costan"]
+  s.date = %q{2011-01-26}
+  s.default_executable = %q{bcpm}
+  s.description = %q{Battlecode (MIT 6.370) package manager.}
+  s.email = %q{victor@costan.us}
+  s.executables = ["bcpm"]
+  s.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"]
+  s.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"]
+  s.homepage = %q{http://git.pwnb.us/six370}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bcpm", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{bcpm}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Battlecode (MIT 6.370) package manager.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 3.2"])
+    else
+      s.add_dependency(%q<echoe>, [">= 3.2"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 3.2"])
+  end
+end

data/bin/bcpm

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bcpm'
+
+Bcpm::CLI.run ARGV

data/lib/bcpm.rb

@@ -0,0 +1,23 @@
+# Battlecode package manager.
+#
+# See the README for a reference on the command-line interface.
+module Bcpm  
+end
+
+require 'bcpm/cleanup.rb'
+require 'bcpm/cli.rb'
+require 'bcpm/config.rb'
+require 'bcpm/dist.rb'
+require 'bcpm/duel.rb'
+require 'bcpm/git.rb'
+require 'bcpm/match.rb'
+require 'bcpm/player.rb'
+require 'bcpm/regen.rb'
+require 'bcpm/socket.rb'
+require 'bcpm/tests/assertions.rb'
+require 'bcpm/tests/assertion_error.rb'
+require 'bcpm/tests/case_base.rb'
+require 'bcpm/tests/environment.rb'
+require 'bcpm/tests/suite.rb'
+require 'bcpm/tests/test_match.rb'
+require 'bcpm/update.rb'

data/lib/bcpm/cleanup.rb

@@ -0,0 +1,24 @@
+require 'tmpdir'
+
+# :nodoc: namespace
+module Bcpm
+
+# Cleans up all the messes left behind by bcpm crashes.
+module Cleanup
+  # Cleans up all the messes left behind by bcpm crashes.
+  def self.run
+    Bcpm::Player.list.each do |player|
+      Bcpm::Player.uninstall player if /^bcpmtest/ =~ player
+    end
+        
+    temp_path = File.join(Dir.tmpdir, 'bcpm')
+    return unless File.exist?(temp_path)
+    Dir.entries(temp_path).each do |entry|
+      next if ['.', '..'].include? entry
+      path = File.join temp_path, entry
+      FileUtils.rm_rf path if File.directory? path
+    end
+  end
+end  # module Bcpm::Cleanup
+
+end  # namespace Bcpm

data/lib/bcpm/cli.rb

@@ -0,0 +1,262 @@
+require 'fileutils'
+
+# :nodoc: namespace
+module Bcpm
+
+# Command-line interface.
+module CLI
+  # Entry point for commands.
+  def self.run(args)
+    if args.length < 1
+      help
+      exit 1
+    end
+    
+    case args.first
+    when 'self', 'gem'  # Upgrade bcpm.
+      Bcpm::Update.upgrade
+    when 'dist'  # Install or upgrade the battlecode distribution.
+      Bcpm::Dist.upgrade
+    when 'reset'  # Uninstalls the distribution and players, and removes the config file.
+      Bcpm::Cleanup.run
+      Bcpm::Player.uninstall_all
+      Bcpm::Dist.uninstall
+      Bcpm::Config.reset
+    when 'install'  # Add a player project to the workspace, from a git repository.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+      
+      if args.length < 2
+        puts "Please supply the path to the player repository!"
+        exit 1
+      end 
+      exit 1 unless Bcpm::Player.install(args[1], args[2] || 'master')
+    when 'copy', 'copyplayer'  # Create a new player project using an existing project as a template.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+
+      if args.length < 3
+        puts "Please supply the new player name, and the path to the template player repository!"
+        exit 1
+      end 
+      exit 1 unless Bcpm::Player.checkpoint(args[2], args[3] || 'master', args[1])
+    when 'new', 'newplayer'  # Create a new player project from the built-in template.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+
+      if args.length < 2
+        puts "Please supply the new player name!"
+        exit 1
+      end
+      exit 1 unless Bcpm::Player.create(args[1])
+    when 'uninstall', 'remove'  # Remove a player project from the workspace.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+
+      if args.length < 2
+        puts "Please supply the player name!"
+        exit 1
+      end 
+      Bcpm::Player.uninstall args[1]
+    when 'rewire'  # Re-write a player project's configuration files.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+      
+      if args.length == 1
+        # Try using the current dir as the player name.
+        args[1, 0] = [File.basename(Dir.pwd)]
+      end
+
+      if args.length < 2
+        puts "Please supply the player name!"
+        exit 1
+      end 
+      Bcpm::Player.reconfigure args[1]
+    when 'list', 'ls'  # Displays the installed players.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+      puts Bcpm::Player.list_active.sort.join("\n")
+    when 'match', 'livematch', 'debugmatch', 'debug'  # Run a match in live or headless mode.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+      
+      if args.length == 3
+        # Try using the current dir as a player name.
+        args[1, 0] = [File.basename(Dir.pwd)]
+      end
+      
+      if args.length < 4
+        puts "Please supply the player names and the map name!"
+        exit 1
+      end
+      mode = if args[0][0, 4] == 'live'
+        :live
+      elsif args[0][0, 5] == 'debug'
+        :debug
+      else
+        :file
+      end
+      puts Bcpm::Match.run(args[1], args[2], args[3], mode)
+    when 'duel'  # Have two players fight it out on all maps.
+      if args.length < 3
+        puts "Pleas supply the player names!"
+        exit 1
+      end
+      if args.length >= 4
+        maps = args[3..-1]
+      else
+        maps = nil
+      end
+      outcome = Bcpm::Duel.duel_pair args[1], args[2], true, maps
+      puts "#{'%+3d' % outcome[:score]} points, " +
+           "#{'%3d' % outcome[:wins].length} wins, " +
+           " #{'%3d' % outcome[:losses].length} losses, " +
+           "#{'%3d' % outcome[:errors].length} errors"
+    when 'rank'  # Ranks all the players.
+      if args.length < 2
+        players = Bcpm::Player.list_active.sort
+      else
+        players = args[1..-1]
+      end
+      outcome = Bcpm::Duel.rank_players players, true
+      outcome.each { |score, player| print "%+4d %s\n" % [score, player] }
+    when 'pit'  # Pits one player against all the other players.
+      if args.length < 2
+        puts "Please supply a player name!"
+      end
+      player = args[1]
+      if args.length >= 3
+        enemies = args[2..-1]
+      else
+        enemies = Bcpm::Player.list_active.sort - [player]
+      end
+      outcome = Bcpm::Duel.score_player player, enemies, true
+      puts "#{'%+4d' % outcome[:points]} points"
+      outcome[:scores].each do |score, player|
+        print "%+4d vs %s\n" % [score, player]
+      end
+    when 'replay'  # Replay a match using its binlog (.rms file).
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+      
+      if args.length == 1
+        # Replay the last game.
+        replays = Bcpm::Tests::TestMatch.stashed_replays
+        args[1, 0] = [replays.max] unless replays.empty?
+      end
+      
+      if args.length < 2
+        puts "Please supply the path to the match binlog (.rms file)!"
+        exit 1
+      end
+      Bcpm::Match.replay args[1]
+    when 'test'  # Run the entire test suite against a player.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+
+      if args.length == 1
+        # Try using the current dir as the player name.
+        args[1, 0] = [File.basename(Dir.pwd)]
+      end
+
+      if args.length < 2
+        puts "Please supply the player name!"
+        exit 1
+      end
+      Bcpm::Player.run_suite args[1]
+    when 'case', 'testcase', 'livecase', 'live'  # Run a single testcase against a player.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+      
+      if args.length == 2
+        # Try using the current dir as the player name.
+        args[1, 0] = [File.basename(Dir.pwd)]
+      end
+
+      if args.length < 3
+        puts "Please supply the player name and the testcase name!"
+        exit 1
+      end
+      Bcpm::Player.run_case args[2], args[0][0, 4] == 'live', args[1]
+    
+    when 'clean', 'cleanup'  # Removes all temporaries left behind by crashes.
+      Bcpm::Cleanup.run
+    
+    when 'config', 'set'
+      if args.length < 2
+        Bcpm::Config.print_config
+      else
+        Bcpm::Config.ui_set(args[1], args[2])
+      end
+      
+    when 'regen'  # Regenerates automatically generated source code.  
+      if args.length < 2
+        puts "Please supply the source file(s)."
+        exit 1        
+      end
+      Bcpm::Regen.run args[1..-1]
+    
+    when 'lsmaps', 'lsmap', 'maps', 'map'  # Lists the maps in the distribution.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+      puts Bcpm::Dist.maps.sort.join("\n")
+    when 'copymap', 'cpmap'  # Clones a distribution map for testing.
+      unless Bcpm::Dist.installed?
+        puts "Please install a battlecode distribution first!"
+        exit 1
+      end
+      if args.length < 2
+        puts "Please supply the map name and destination"
+        exit 1
+      end
+      if args.length < 3
+        # Default destination.
+        if File.exist?('suite') && File.directory?('suite')
+          FileUtils.mkdir_p 'maps'
+          args[2] = 'suite/maps'
+        else
+          puts "Please supply map destination or cd into a player directory"
+          exit 1
+        end
+      end
+      Bcpm::Dist.copy_map args[1], args[2]
+    else
+      help
+      exit 1
+    end
+  end
+  
+  # Prints the CLI help.
+  def self.help
+    print <<END_HELP
+Battlecode (MIT 6.470) package manager.
+
+See the README file for usage instructions.
+
+END_HELP
+  end
+end  # module Bcpm::CLI
+  
+end  # namespace Bcpm

data/lib/bcpm/config.rb

@@ -0,0 +1,100 @@
+require 'yaml'
+
+# :nodoc: namespace
+module Bcpm
+
+# Persistent, per-user bcpm configuration information.
+module Config
+  # Hash-style access to the configuration dictionary.
+  def self.[](key)
+    config[key.to_sym]
+  end
+  
+  # Hash-style access to configuration dictionary.
+  def self.[]=(key, new_value)
+    if new_value.nil?
+      config.delete key.to_sym
+    else
+      config[key.to_sym] = new_value      
+    end
+    write_config
+  end
+  
+  # The configuration dictionary.
+  def self.config
+    @config ||= read_config
+  end
+  
+  # Reads the YAML configuration file.
+  def self.read_config
+    if File.exists? config_file
+      @config = File.open(config_file) { |f| YAML.load f }
+    else
+      @config = {}
+    end
+  end
+  
+  # Writes the configuration to the YAML file.
+  def self.write_config
+    File.open(config_file, 'wb') { |f| YAML.dump config, f }
+  end
+
+  # Path to the configuration YAML file.
+  def self.config_file
+    File.expand_path '~/.bcpm_config'
+  end
+  
+  # Removes the configuration YAML file and resets the configuration hash.
+  def self.reset
+    File.unlink config_file if File.exist?(config_file)
+    @config = nil
+  end
+  
+  # Outputs the configuration.
+  def self.print_config
+    config.keys.sort_by(&:to_s).each do |key|
+      print "#{key}: #{config[key]}\n"
+    end
+  end
+  
+  # Executes a config command from the UI.
+  def self.ui_set(key, value)    
+    # Normalize values.
+    case value && value.downcase
+    when 'on', 'true'
+      value = true
+    when 'off', 'false'
+      value = false
+    end
+    
+    # Process keys that include values.
+    prefix = key[0]
+    
+    toggle = false
+    if [?+, ?-, ?^].include? prefix
+      key = key[1..-1]
+      case prefix
+      when ?+
+        value = true
+      when ?-
+        value = false
+      when ?^
+        toggle = true
+      end
+      self[key]
+    end
+    
+    # Normalize keys.
+    key = key.downcase
+    
+    # Execute the configuration change.
+    if toggle
+      self[key] = !self[key]
+    else
+      self[key] = value
+    end
+    print "#{key} set to #{value}\n"
+  end
+end  # module Bcpm::Config
+
+end  # namespace Bcpm