pintoscheck 0.1.0beta

data/bin/ptschk

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# Pintos Check program
+# http://github.com/ChrisKXu/PintosCheck
+# Written by Christopher Xu
+
+require 'pintoscheck'
+
+case ARGV[0]
+when '--help' || '--usage'
+  help
+when 'init'
+  init ARGV[1]
+when 'run'
+  run ARGV[1]
+when '--version' || '-v'
+  version
+else
+  help
+end

data/lib/pintoscheck.rb

@@ -0,0 +1,83 @@
+# Pintos Check program
+# http://github.com/ChrisKXu/PintosCheck
+# Written by Christopher Xu
+
+require 'pintoscheck/pintoscheck_config'
+require 'pintoscheck/mail_checker'
+require 'pintoscheck/file_unzipper'
+require 'pintoscheck/pintos_runner'
+require 'fileutils'
+require 'pathname'
+
+PTSCHK_VERSION = '0.1.0beta'
+
+def version
+  puts PTSCHK_VERSION
+end
+
+def help
+  puts "PintosCheck -- Automatic pintos checker"
+  puts "Version: " + PTSCHK_VERSION
+  puts "Generic commands: "
+  puts "  init <my_config_file.config>\t\t\Generates a default config file"
+  puts "  run <my_config_file.config>\t\t\Run the tasks based on the config file"
+end
+
+def usage
+  help
+end
+
+# Initialize a config script
+def init(file)
+  if file.nil?
+    puts 'Please specify the file name.'
+    help
+  else
+    PintosCheckConfig.default_config.save_to(file)
+  end
+end
+
+# Run tasks according to the config script
+def run(file)
+  if file.nil?
+    puts 'Please specify the file name.'
+    help
+  else
+    # Preparing ...
+    printf 'Reading configurations ... '
+    config = PintosCheckConfig.load_from(file)
+    puts 'done.'
+    
+    # Fetch mail
+    printf 'Fetching mail meta-data ... '
+    mail_checker = MailChecker.new :host => config.host, :port => config.port, :ssl => config.ssl, :mailaddr => config.mailaddr, :username => config.username, :password => config.password
+    msgs = mail_checker.check_mail :mailbox => config.mailbox, :subject => config.search_options[:subject], :sender => config.search_options[:sender], :recipient => config.search_options[:recipient]
+    puts "got #{msgs.count} messages, done."
+    printf 'Fetching mail attachments ... '
+    files = mail_checker.fetch_attachments config.stage_path
+    puts "done. Attachments saved to #{config.stage_path}"
+    
+    files.each do |f|
+      # Unzip files
+      rf = Pathname.new(f).relative_path_from(Pathname.new(config.stage_path))
+      dname = config.stage_path + '/'+ rf + '_test'
+      if !File.exist?(dname)
+        FileUtils.mkdir_p(dname)
+      end
+      printf "Unzipping #{rf} to #{dname} ... "
+      FileUnzipper.unzip(f, dname)
+      puts 'done.'
+      
+      # Run test
+      printf "Running tests, please wait ... "
+      if !File.exist?(config.results_path)
+        FileUtils.mkdir_p(config.results_path)
+      end
+      runner = PintosRunner.new(dname, config.test_dir, config.results_path + '/result_' + rf + '_test.txt')
+      runner.validate_path
+      runner.run_tests
+      puts "done."
+      puts "Results saved to #{config.results_path + '/result_' + rf + '_test.txt'}"
+    end
+  end
+end

data/lib/pintoscheck/file_unzipper.rb

@@ -0,0 +1,25 @@
+# Pintos Check program
+# http://github.com/ChrisKXu/PintosCheck
+# Written by Christopher Xu
+
+require 'fileutils'
+
+class FileUnzipper
+  
+  SUPPORTED_FORMATS = %w[ .zip .tgz .gz .bz2 ]
+  
+  def self.unzip(from, path)
+    ext = File.extname(from)
+    if File.exist?(from) && SUPPORTED_FORMATS.include?(ext)
+      case ext
+      when '.zip'
+        `unzip #{from} -d #{path}`
+      when '.gz' || '.tar.gz' || '.tgz'
+        `tar zxf #{from} -C #{path}`
+      when '.bz2' || '.tar.bz2'
+        `tar jxf #{from} -C #{path}`
+      end
+    end
+  end
+  
+end

data/lib/pintoscheck/mail_checker.rb

@@ -0,0 +1,111 @@
+# Pintos Check program
+# http://github.com/ChrisKXu/PintosCheck
+# Written by Christopher Xu
+
+require 'net/imap'
+require 'fileutils'
+
+# This class checks certain mailbox for special kind of mail messages
+# It uses IMAP protocol
+class MailChecker
+  attr_accessor :host, :port, :ssl, :mailaddr, :username, :password
+  
+  # ctor
+  def initialize(options = {})
+    self.host = options[:host]          # The imap server, e.g. mail.google.com
+    self.port = options[:port] || 143   # The port number, defaults to 143
+    self.ssl = options[:ssl] || false   # Whether to use ssl
+    self.mailaddr = options[:mailaddr]  # The email address, e.g. chriskxu@chriskxu.com
+    self.username = options[:username]  # The username to access the email
+    self.password = options[:password]  # The password to access the email
+  end
+  
+  # Returns a list of message numbers to investigate
+  def check_mail(options = {})
+    @mailbox = options[:mailbox] || "inbox" # Defaults to inbox
+    # regex = options[:regex] # The subject pattern to match
+    @subject = options[:subject] # The keyword in the subject to search
+    @recipient = options[:recipient] || self.mailaddr # The recipient to match, a string or a list of strings
+    @sender = options[:sender] # The sender to match, a string or a list of strings
+    @ret = [] # an array of message numbers
+    
+    t = Thread.new do
+      # Now we check the email based on the parameters
+      imap = Net::IMAP.new(self.host, self.port, self.ssl)
+      imap.login(self.username, self.password)
+    
+      imap.examine(@mailbox)
+    
+      if !@subject.nil?
+        if @subject.class != Array # subject is NOT an array
+          @subject = [@subject]
+        end
+        @subject.each do |s|
+          @ret = imap.search(["SUBJECT", s])
+        end
+      end
+    
+      if @recipient.class != Array # recipient is NOT an array
+        @recipient = [@recipient]
+      end
+      @recipient.each do |r|
+        @ret &= imap.search(["TO", r])
+      end
+    
+      if !@sender.nil?
+        if @sender.class != Array # sender is NOT an array
+          @sender = [@sender]
+        end
+        @sender.each do |s|
+          @ret &= imap.search(["FROM", s])
+        end
+      end
+    
+      imap.logout
+      #imap.close
+    end
+    
+    t.join
+    @ret = @ret.uniq
+  end
+  
+  def fetch_attachments(path)
+    imap = Net::IMAP.new(self.host, self.port, self.ssl)
+    imap.login(self.username, self.password)
+    files = []
+    
+    imap.examine(@mailbox)
+    t = Thread.new do
+      @ret.each do |mail|
+        message = imap.fetch(mail, ["BODY", "ENVELOPE"])[0]
+        body = message.attr["BODY"]
+        sender = message.attr["ENVELOPE"].sender[0]
+        i = 1
+        while body.parts[i] != nil && body.parts[i].media_type == "TEXT"
+          i += 1
+        end
+        while body.parts[i] != nil
+          attachment = imap.fetch(mail, "BODY[#{i + 1}]")[0].attr["BODY[#{i + 1}]"]
+          filename = body.parts[i].param["NAME"]
+          # Save the attachment to file
+          if !File.exist?(path)
+            FileUtils.mkdir_p(path)
+          end
+          filename = path + "/#{sender.mailbox}_#{filename}"
+          files << filename
+          file = File.new(filename, 'wb+')
+          file.write(attachment.unpack('m'))
+          file.close
+          i += 1
+        end
+      end
+    
+      imap.logout
+    end
+    # imap.close
+    
+    t.join
+    files
+  end
+  
+end

data/lib/pintoscheck/pintos_runner.rb

@@ -0,0 +1,39 @@
+# Pintos Check program
+# http://github.com/ChrisKXu/PintosCheck
+# Written by Christopher Xu
+
+class PintosRunner
+  attr_reader :result
+  
+  def initialize(root, testpath, resultspath)
+    @root = root
+    @testpath = testpath
+    @resultspath = resultspath
+  end
+  
+  def validate_path
+    ret = ''
+    if File.exist?("#{@root}/#{@testpath}")
+      ret = "#{@root}/#{@testpath}"
+    elsif File.exist?("#{@root}/src/#{@testpath}")
+      ret = "#{@root}/src/#{@testpath}"
+    elsif File.exist?("#{@root}/pintos/#{@testpath}")
+      ret = "#{@root}/pintos/#{@testpath}"
+    elsif File.exist?("#{@root}/pintos/src/#{@testpath}")
+      ret = "#{@root}/pintos/src/#{@testpath}"
+    end
+    
+    @runpath = ret
+  end
+  
+  def run_tests
+    t = Thread.new do
+      @result = `cd #{@runpath} && make check 2>/dev/null | tail -n1`
+    end
+    
+    t.join
+    `cp #{@runpath}/build/results #{@resultspath} && echo "#{@result}" >> #{@resultspath}`
+    @result
+  end
+  
+end

data/lib/pintoscheck/pintoscheck_config.rb

@@ -0,0 +1,46 @@
+# Pintos Check program
+# http://github.com/ChrisKXu/PintosCheck
+# Written by Christopher Xu
+
+require 'yaml'
+
+class PintosCheckConfig
+  attr_accessor :mailaddr, :mailbox, :username, :password, :host, :port, :ssl, :stage_path, :test_dir, :results_path
+  attr_accessor :search_options
+  
+  def self.default_config
+    config = PintosCheckConfig.new do |c|
+      c.mailaddr = 'mail@example.com'
+      c.mailbox = 'inbox'
+      c.username = 'johndoe'
+      c.password = 'secret'
+      c.host = 'imap.gmail.com'
+      c.port = 993
+      c.ssl = true
+      c.stage_path = '/tmp/pintoscheck'
+      c.test_dir = 'threads'
+      c.results_path = '/tmp/pintoscheck/results'
+      c.search_options[:subject] = 'pintos'
+      c.search_options[:sender] = [ 'someone@example.com', 'sometwo@example.com' ]
+      c.search_options[:recipient] = 'somethree@example.com'
+    end
+
+    config
+  end
+  
+  def self.load_from(filepath)
+    data = File.new(filepath, 'r').read
+    config = YAML.load(data)
+  end
+  
+  def save_to(filepath)
+    save = self.to_yaml
+    File.new(filepath, 'w+').write(save)
+  end
+  
+  def initialize(&block)
+    @search_options = {}
+    yield(self)
+  end
+  
+end

data/tests/test_file_unzipper.rb

@@ -0,0 +1,40 @@
+# Pintos Check program
+# http://github.com/ChrisKXu/PintosCheck
+# Written by Christopher Xu
+
+require 'pintoscheck/file_unzipper'
+require 'pintoscheck/mail_checker'
+require 'test/unit'
+require 'fileutils'
+
+class TestFileUnzipper < Test::Unit::TestCase
+  
+  def setup
+    @host = 'imap.gmail.com'
+    @username = 'pintoscheck@chriskxu.com'
+    @password = 'pintoscheck'
+    @port = 993
+    @ssl = true
+    
+    @mail_checker = MailChecker.new :host => @host, :port => @port, :username => @username, :password => @password, :ssl => @ssl, :mailaddr => @username
+  end
+  
+  def test_unzip
+    messages = @mail_checker.check_mail :mailbox => 'inbox', :subject => 'attachment'
+    assert_equal [4], messages
+    
+    # Now we fetch the attachments
+    path = '/tmp/pintoscheck'
+    @mail_checker.fetch_attachments(path)
+    assert File.exist?(path)
+    # assert File.exist?(path + '/xuhotdogs@gmail.com_s3-qrc-20060301.pdf')
+    assert File.exist?(path + '/xuhotdogs@gmail.com_ospdf09.zip')
+    
+    # Now the FileUnzipper comes in
+    FileUtils.mkdir_p(path + '/xuhotdogs@gmail.com_ospdf09')
+    FileUnzipper.unzip(path + '/xuhotdogs@gmail.com_ospdf09.zip', path + '/xuhotdogs@gmail.com_ospdf09')
+    assert File.exist?(path + '/xuhotdogs@gmail.com_ospdf09/ospdf09')
+    assert File.exist?(path + '/xuhotdogs@gmail.com_ospdf09/ospdf09/09_0.pdf')
+  end
+  
+end

data/tests/test_mail_checker.rb

@@ -0,0 +1,44 @@
+# Pintos Check program
+# http://github.com/ChrisKXu/PintosCheck
+# Written by Christopher Xu
+
+require 'pintoscheck/mail_checker'
+require 'test/unit'
+
+class TestMailChecker < Test::Unit::TestCase
+  def setup
+    @host = 'imap.gmail.com'
+    @username = 'pintoscheck@chriskxu.com'
+    @password = 'pintoscheck'
+    @port = 993
+    @ssl = true
+    
+    @mail_checker = MailChecker.new :host => @host, :port => @port, :username => @username, :password => @password, :ssl => @ssl, :mailaddr => @username
+  end
+  
+  def test_initialize
+    assert_equal @host, @mail_checker.host
+    assert_equal @username, @mail_checker.username
+    assert_equal @password, @mail_checker.password
+    assert_equal @port, @mail_checker.port
+    assert_equal @username, @mail_checker.mailaddr
+    assert_equal @ssl, @mail_checker.ssl
+  end
+  
+  def test_check_mail
+    result1 = @mail_checker.check_mail :mailbox => 'inbox', :subject => 'gmail'
+    assert_equal [1, 2], result1
+  end
+  
+  def test_fetch_attachments
+    messages = @mail_checker.check_mail :mailbox => 'inbox', :subject => 'attachments'
+    assert_equal [3], messages
+    
+    # Now we fetch the attachments
+    path = '/tmp/pintoscheck'
+    @mail_checker.fetch_attachments(path)
+    assert File.exist?(path)
+    assert File.exist?(path + '/xuhotdogs@gmail.com_s3-qrc-20060301.pdf')
+  end
+
+end

data/tests/test_pintos_runner.rb

@@ -0,0 +1,24 @@
+# Pintos Check program
+# http://github.com/ChrisKXu/PintosCheck
+# Written by Christopher Xu
+
+require 'pintoscheck/pintos_runner'
+require 'test/unit'
+
+class TestPintosRunner < Test::Unit::TestCase
+  
+  def setup
+    @runner = PintosRunner.new '/tmp/pintos', 'threads', '/tmp/pintoscheck/results'
+  end
+  
+  def test_validate_path
+    assert_equal '/tmp/pintos/threads', @runner.validate_path
+  end
+  
+  def test_run_tests
+    @runner.validate_path
+    result = @runner.run_tests
+    assert File.exist?('/tmp/pintoscheck/results')
+  end
+  
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: pintoscheck
+version: !ruby/object:Gem::Version 
+  version: 0.1.0beta
+platform: ruby
+authors: 
+- Christopher Xu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-05 00:00:00 +08:00
+default_executable: ptschk
+dependencies: []
+
+description: |
+  == PintosCheck -- Auto Pintos Checker to Save the Day ==
+  
+  == Functionalities ==
+  The functionality of this simple script is to download pintos homework assignments from the mail inbox and then run through all the desired tests and finally generate reports in plain text or html formats, all automatically.
+  
+  == Requirements For Running PintosCheck ==
+  Since all the scripts are written in ruby, PintosCheck require ruby installed on the system. I use ruby 1.8.7 for development, but ruby 1.9.* versions are expected to function as well. However, ruby 1.8.6 and lower versions are not supported. For information of downloading and installing ruby, see http://www.ruby-lang.org/en/downloads/.
+  In addition to ruby itself, RubyGems 1.3.* is also required because it hosts the installation source for this project and almost all other ruby projects as well. To download or update RubyGems, please go to http://gemcutter.org/pages/download for more information.
+  
+  == Installation ==
+  Once you have all the requirements on your system, it's really easy to install PintosCheck. In the UNIX shell or Windows command line environment, type the following command(sudo if needed):
+    gem install pintoscheck --include-dependencies
+  Go grab a cup of coffee, and PintosCheck will automatically download and install itself onto the system.
+  To check the installation, type 'ptschk --version', and if something like 'PintosCheck 0.1.0' pops up then you're green to go!
+  
+  == Finally, how do I check my students' pintos homework? ==
+  This project ships with a 'ptschk' command tool. This tool needs a task configuration file to actually do everything. The configuration file is in YAML format, which is basically a recursive key-value pair representation. If you're using PintosCheck for the first time, there's a very nice command line option to generate the skeleton for you. Just run 'ptschk init my_first_task.config' and a file named 'my_first_task.config' will be generated for you. Inside this file there is a set of the minimal options for the task to run properly, and you just have to fill in what you need. After you set up your configuration file, run 'ptschk run my_first_task.config' and the tasks will kick off immediately, and after a while the report will be generated. A detailed configuration options for advanced task setup will be available in production release of this project.
+
+email: XuHotdogs@gmail.com
+executables: 
+- ptschk
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/pintoscheck/file_unzipper.rb
+- lib/pintoscheck/mail_checker.rb
+- lib/pintoscheck/pintos_runner.rb
+- lib/pintoscheck/pintoscheck_config.rb
+- lib/pintoscheck.rb
+- bin/ptschk
+has_rdoc: true
+homepage: http://github.com/ChrisKXu/pintoscheck
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Auto Pintos Checker to Save the Day
+test_files: 
+- tests/test_file_unzipper.rb
+- tests/test_mail_checker.rb
+- tests/test_pintos_runner.rb