openMSX-builder 1.2.1 → 1.3.1

data/README.markdown

@@ -25,9 +25,8 @@ Set up of the oauth info has to be done manually at the moment, for more informa
 
 ### Commandline Arguments
 
-Currently `build_openmsx` supports the following commandline arguments:
+Currently `build_openmsx` supports the following command-line arguments:
 
-* --debug                 => Generate debug output.
 * --publish               => Publish the created build
 * --publish-current       => Only publish the current build and exit
 * --publish-all           => Only publish all previously created builds and exit
@@ -35,13 +34,21 @@ Currently `build_openmsx` supports the following commandline arguments:
 * --dont-update           => Don't update the SVN repository
 * --report-build-failure  => If an error occurs during build, report failure via e-mail
 
+By default only fatal errors will be output via STDOUT.
+However, the following command-line arguments are available to set the verbosity:
+
+* --log-errors            => Fatal and non-fatal errors.
+* --warn                  => Logs warnings besides the (non-)fatal errors.
+* --verbose               => Besides the --warn output, also outputs info.
+* --debug                 => Most verbose form. --verbose plus debug info.
+
 ### Examples
 
 Simplest way to run it would usually be:
-`build_openmsx --debug --publish --tweet --report-build-failure`
+`build_openmsx --verbose --publish --tweet --report-build-failure`
 
 Or by adding a cronjob for:
-`0 3 * * * build_openmsx --publish --tweet --report-build-failure`
+`0 3 * * * build_openmsx --publish --tweet --report-build-failure --log-errors`
 to have it run daily at 3 at night.
 (Remember to add either `source ~/.profile` or the right PATH to your cron.)
 
@@ -50,7 +57,6 @@ to have it run daily at 3 at night.
 ******************************************************************************
 Current list of tasks is:
 
-+ Replace DebugTools with Log4r
 + Integrate with CIA.vc / Ruby-Rbot
 + Add tests
 + Refactor `#archive_for_revision` and `#dmg_for_revision` into a single method

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.1

data/bin/build_openmsx

@@ -16,9 +16,16 @@ if ARGV.include?('--version')
   exit
 end
 
-debug('-'*50)
-debug("Starting with openMSX")
+# TODO: Refactor this into OpenmsxBuilder; perhaps make @options a class variable.
+log = Logger.new(STDOUT)
+log.level = Logger::FATAL
+log.level = Logger::ERROR if ARGV.include?('--log-errors')
+log.level = Logger::WARN if ARGV.include?('--warn')
+log.level = Logger::INFO if ARGV.include?('--verbose')
+log.level = Logger::DEBUG if ARGV.include?('--debug')
+log.info('-'*50)
+log.info("Starting with openMSX")
 OpenmsxBuilder.new(ARGV,:openmsx).run
-debug('-'*50)
-debug("Proceeding with openMSX-Debugger")
+log.info('-'*50)
+log.info("Proceeding with openMSX-Debugger")
 OpenmsxBuilder.new(ARGV,:openmsx_debugger).run

data/lib/openmsx_builder.rb

@@ -1,12 +1,9 @@
 require 'rubygems'
 require 'mail'
 require 'yaml'
-require 'twitter_oauth'
 require 'tweet_msx'
-load 'debug_tools.rb'
-include DebugTools
+require 'logger'
 class OpenmsxBuilder
-  include DebugTools
   class NotConfigured < RuntimeError;end
   CONFIG_FILENAME = File.expand_path('~/.openMSX-builder.yaml')
   DEFAULTS = {
@@ -47,9 +44,16 @@ class OpenmsxBuilder
     @current_revision = `svnversion -n #{setting(:source_dir)}`.to_i
     @options = options
     @fails = 0
+    @log = Logger.new(STDOUT)
+    @log.level = Logger::FATAL
+    @log.level = Logger::ERROR if @options.include?('--log-errors')
+    @log.level = Logger::WARN if @options.include?('--warn')
+    @log.level = Logger::INFO if @options.include?('--verbose')
+    @log.level = Logger::DEBUG if @options.include?('--debug')
+    @log.debug("Logger created with level #{@log.level}")
     config
   rescue NotConfigured => e
-    puts e.message
+    @log.fatal e.message
     exit
   end
 
@@ -80,10 +84,10 @@ class OpenmsxBuilder
       publish_current
       return
     end
-    debug "openMSX is currently at #{@current_revision}."
+    @log.info "openMSX is currently at #{@current_revision}."
     update_svn
     if @new_revision >= @current_revision
-      debug "Revision #{@new_revision} is not older than #{@current_revision}. Proceeding with build."
+      @log.info "Revision #{@new_revision} is not older than #{@current_revision}. Proceeding with build."
       build
     end
   end
@@ -96,30 +100,30 @@ private
   def dmg_for_revision?(revision)
     return false unless openmsx?
     files = Dir.glob(File.join(setting(:source_dir),setting(:builds_subdir),"openmsx-*-#{revision}-mac-x86-bin.dmg"))
-    debug files.to_yaml unless files.size == 0
+    @log.debug files.to_yaml unless files.size == 0
     files.size > 0
   end
 
   def archive_for_revision?(revision)
     return false unless openmsx_debugger?
     filename = File.join(setting(:source_dir),setting(:builds_subdir),"openMSX-debugger-#{revision}-mac-x86.tbz")
-    debug filename
+    @log.debug filename
     File.exist?(filename)
   end
 
   def publish_build(revision,infile,outfile='',location=setting(:publish_location))
-    debug ""
+    @log.debug "\n#publish_build"
     outfile = File.basename(infile) if outfile == ''
     destination = File.join(location,outfile)
-    debug "Will publish #{infile} to #{setting(:publish_location)} now."
+    @log.info "Will publish #{infile} to #{setting(:publish_location)} now."
     publish_output = `scp -p "#{infile}" #{destination}`
-    debug publish_output unless publish_output.nil? || publish_output.strip == ''
+    @log.debug publish_output unless publish_output.nil? || publish_output.strip == ''
     url = File.join(setting(:site_path),File.basename(destination))
     twitter_update = tweetmsx.update("[#{setting(:nice_name)}] Revision #{revision} is now available:\r\n #{url}") if @options.include?('--tweet')
-    debug(twitter_update) unless twitter_update.nil?
+    @log.info(twitter_update) unless twitter_update.nil?
     nil
   rescue TweetMsx::NotConfigured => e
-    debug e.message
+    @log.error e.message
   end
 
   def publish
@@ -134,7 +138,7 @@ private
   end
 
   def publish_all
-    debug "Publishing all #{@type} builds found"
+    @log.info "Publishing all #{@type} builds found"
     if openmsx?
       files = Dir.glob(File.join(setting(:source_dir),setting(:builds_subdir),"openmsx-*-mac-x86-bin.dmg")).sort.map do |f|
         if f =~ /openmsx-.+-(\d+)-mac-x86-bin.dmg$/
@@ -175,38 +179,38 @@ private
     if @options.include?('--dont-update')
       update = 'Update skipped'
     else
-      debug "Proceeding with update."
+      @log.info "Proceeding with update."
       update = `cd #{setting(:source_dir)} && svn up` 
     end
     @new_revision = `svnversion -n #{setting(:source_dir)}`.to_i
-    debug update
-    debug "Now at revision #{@new_revision}"
+    @log.debug update
+    @log.info "Now at revision #{@new_revision}"
     nil
   end
 
   def tweetmsx
-    @tweetmsx ||= TweetMsx.new
+    @tweetmsx ||= TweetMsx.new(@log.level)
   end
 
   def build
     if openmsx?
       if dmg_for_revision?(@new_revision)
-        debug "Revision already build as #{Dir.glob(File.join(setting(:source_dir),setting(:builds_subdir),"openmsx-*-#{@new_revision}-mac-x86-bin.dmg")).first}"
+        @log.info "Revision already build as #{Dir.glob(File.join(setting(:source_dir),setting(:builds_subdir),"openmsx-*-#{@new_revision}-mac-x86-bin.dmg")).first}"
         return nil
       end
       cleanup_dmg_locks
     elsif openmsx_debugger?
       if archive_for_revision?(@new_revision)
-        debug "Revision already build as #{File.join(setting(:source_dir),setting(:builds_subdir),"openMSX-debugger-#{@new_revision}-mac-x86.tbz")}"
+        @log.info "Revision already build as #{File.join(setting(:source_dir),setting(:builds_subdir),"openMSX-debugger-#{@new_revision}-mac-x86.tbz")}"
         return nil
       end
     end
-    debug("Will attempt to build revision #{@new_revision}.")
+    @log.info("Will attempt to build revision #{@new_revision}.")
     build_output = `cd #{setting(:source_dir)} && make clean && make #{'staticbindist' if openmsx?} 2>&1`
     if $?.success?
-      debug "++++++SUCCESS++++++"
+      @log.info "++++++SUCCESS++++++"
       build_output.each_line do |line|
-        debug "     %s" % line
+        @log.debug "     %s" % line
       end
       publish if @options.include?('--publish')
       nil
@@ -214,17 +218,18 @@ private
       #Capture the weird random build error that seems to be more OSX related than openMSX related.
       if build_output.include?('hdiutil: create failed - error 49168')
         @fails += 1
-        debug build_output
-        debug "Weird bug (attempt #{@fails}/3)"
+        @log.error build_output
+        @log.error "Weird bug (attempt #{@fails}/3)"
         if @fails == 3
+          @log.fatal "Encountered the weird 'hdiutil error 49168'-bug #{@fails} times; failing."
           exit
         else
           return build
         end
       end
-      debug "!!!!!!FAILED!!!!!!"
+      @log.error "!!!!!!FAILED!!!!!!"
       build_output.each_line do |line|
-        debug "     %s" % line
+        @log.error "     %s" % line
       end
       if @options.include?('--report-build-failure')
         report_build_failure(build_output)
@@ -234,13 +239,14 @@ private
   end
 
   def cleanup_dmg_locks
-    debug("Checking for existing filelocks on DMGs.")
+    @log.info("Checking for existing filelocks on DMGs.")
     locks = `/usr/sbin/lsof | grep #{@new_revision}-mac-x86-bin.dmg`
-    debug locks
+    @log.debug locks
     locks.each_line do |lock_line|
       pid = lock_line.split[1].to_i
-      debug "Killing pid #{pid} from lock '#{lock_line}'"
-      `kill -9 #{pid}`
+      @log.info "Killing pid #{pid} from lock '#{lock_line}'"
+      kill_output = `kill -9 #{pid}`
+      @log.debug kill_output
     end
   end
 
@@ -251,10 +257,10 @@ private
     smtp_settings = config[:smtp_settings]
     mail_from = setting(:report_from)
     mail_bcc = setting(:report_bcc)
-    Mail.defaults do
+    @log.debug Mail.defaults do
       delivery_method :smtp, smtp_settings
     end
-    Mail.deliver do
+    @log.debug Mail.deliver do
       from mail_from
         to mail_from
         bcc mail_bcc.join(', ')

data/lib/tweet_msx.rb

@@ -1,4 +1,6 @@
-load 'debug_tools.rb'
+require 'logger'
+require 'twitter_oauth'
+require 'yaml'
 # Patch for Ruby 1.9.2
 module Net
   module HTTPHeader
@@ -10,7 +12,6 @@ module Net
   end
 end
 class TweetMsx
-  include DebugTools
   class NotConfigured < RuntimeError;end
   CONFIG_FILENAME = File.expand_path('~/.openMSX-builder-TweetMSX.yaml')
   DEFAULTS = {
@@ -22,35 +23,42 @@ class TweetMsx
     }
   }
   attr_reader :client, :twitter_down
-  def initialize
+  def initialize(log_level=Logger::FATAL)
     @client = TwitterOAuth::Client.new(config[:client])
+    @log = Logger.new(STDOUT)
+    @log.level = log_level
   end
 
   def config
     create_default_config unless File.exist?(CONFIG_FILENAME)
     @config ||= YAML.load_file(CONFIG_FILENAME)
-    raise NotConfigured.new("You need to set up your config file at #{CONFIG_FILENAME} first") if @config == DEFAULTS
+    @log.debug @config.to_yaml
+    if @config == DEFAULTS
+      @log.error "TweetMSX config at #{CONFIG_FILENAME} matches DEFAULTS"
+      raise NotConfigured.new("You need to set up your config file at #{CONFIG_FILENAME} first")
+    end
     @config
   end
 
   def create_default_config
     system("mkdir -p #{File.dirname(CONFIG_FILENAME)}")
+    @log.debug "Creating default config at #{CONFIG_FILENAME}"
     File.open(CONFIG_FILENAME,'w') do |f|
       f.write DEFAULTS.to_yaml
     end
   end
 
   def update(message)
-    debug "#{message} [#{message.size} chars]"
+    @log.info "Tweeting message:\n #{message}"
+    @log.debug "[#{message.size} characters]"
     if @client.rate_limit_status == 0
-      debug "You've exceeded your rate limit"
+      @log.error "You've exceeded your rate limit"
       return nil
     end
-    puts message.to_yaml
     @client.update(message.to_s)
     nil
   rescue SocketError
-    debug "Could not send '#{message}'. Twitter or your connection might be down."
+    @log.error "Could not send '#{message}'. Twitter or your connection might be down."
     nil
   end
 end

data/openMSX-builder.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{openMSX-builder}
-  s.version = "1.2.1"
+  s.version = "1.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Filip H.F. \"FiXato\" Slagter"]
@@ -26,7 +26,6 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "bin/build_openmsx",
-     "lib/debug_tools.rb",
      "lib/openmsx_builder.rb",
      "lib/tweet_msx.rb",
      "openMSX-builder.gemspec",

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 2
+  - 3
   - 1
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Filip H.F. "FiXato" Slagter
@@ -77,7 +77,6 @@ files:
 - Rakefile
 - VERSION
 - bin/build_openmsx
-- lib/debug_tools.rb
 - lib/openmsx_builder.rb
 - lib/tweet_msx.rb
 - openMSX-builder.gemspec

data/lib/debug_tools.rb

@@ -1,9 +0,0 @@
-module DebugTools
-  def debug(*args)
-    if ARGV.include?('--debug')
-      args.each do |arg|
-        puts "[#{Time.now.strftime("%H:%M:%S")}] #{arg}"
-      end
-    end
-  end
-end