coursemology-evaluator 0.0.0 → 0.1.0

data/lib/coursemology/evaluator/models/programming_evaluation/package.rb

@@ -0,0 +1,11 @@
+class Coursemology::Evaluator::Models::ProgrammingEvaluation::Package
+  # The stream comprising the package.
+  attr_reader :stream
+
+  # Constructs a new Package.
+  #
+  # @param [IO] stream The stream comprising the package.
+  def initialize(stream)
+    @stream = stream
+  end
+end

data/lib/coursemology/evaluator/services.rb

@@ -0,0 +1,5 @@
+module Coursemology::Evaluator::Services
+  extend ActiveSupport::Autoload
+
+  autoload :EvaluateProgrammingPackageService
+end

data/lib/coursemology/evaluator/services/evaluate_programming_package_service.rb

@@ -0,0 +1,150 @@
+class Coursemology::Evaluator::Services::EvaluateProgrammingPackageService
+  Result = Struct.new(:stdout, :stderr, :test_report, :exit_code)
+
+  # The path to the Coursemology user home directory.
+  HOME_PATH = '/home/coursemology'.freeze
+
+  # The path to where the package will be extracted.
+  PACKAGE_PATH = File.join(HOME_PATH, 'package')
+
+  # The path to where the test report will be at.
+  REPORT_PATH = File.join(PACKAGE_PATH, 'report.xml')
+
+  # The ratio to multiply the memory limits from our evaluation to the container by.
+  MEMORY_LIMIT_RATIO = 1.megabyte / 1.kilobyte
+
+  # Executes the given package in a container.
+  #
+  # @param [Coursemology::Evaluator::Models::ProgrammingEvaluation] evaluation The evaluation
+  #   from the server.
+  # @return [Coursemology::Evaluator::Services::EvaluateProgrammingPackageService::Result] The
+  #   result of the evaluation.
+  def self.execute(evaluation)
+    new(evaluation).send(:execute)
+  end
+
+  # Creates a new service object.
+  def initialize(evaluation)
+    @evaluation = evaluation
+    @package = evaluation.package
+  end
+
+  private
+
+  # Evaluates the package.
+  #
+  # @return [Coursemology::Evaluator::Services::EvaluateProgrammingPackageService::Result]
+  def execute
+    container = create_container(@evaluation.language.class.docker_image)
+    copy_package(container)
+    execute_package(container)
+
+    extract_result(container)
+  ensure
+    destroy_container(container) if container
+  end
+
+  def create_container(image)
+    image_identifier = "coursemology/evaluator-image-#{image}"
+    Coursemology::Evaluator::DockerContainer.create(image_identifier, argv: container_arguments)
+  end
+
+  def container_arguments
+    result = []
+    result.push("-c#{@evaluation.time_limit}") if @evaluation.time_limit
+    result.push("-m#{@evaluation.memory_limit * MEMORY_LIMIT_RATIO}") if @evaluation.memory_limit
+
+    result
+  end
+
+  # Copies the contents of the package to the container.
+  #
+  # @param [Docker::Container] container The container to copy the package into.
+  def copy_package(container)
+    tar = tar_package(@package)
+    container.archive_in_stream(HOME_PATH) do
+      tar.read(Excon.defaults[:chunk_size]).to_s
+    end
+  end
+
+  # Converts the zip package into a tar package for the container.
+  #
+  # This also adds an additional +package+ directory to the start of the path, following tar
+  # convention.
+  #
+  # @param [Coursemology::Evaluator::Models::ProgrammingEvaluation::Package] package The package
+  #   to convert to a tar.
+  # @return [IO] A stream containing the tar.
+  def tar_package(package)
+    tar_file_stream = StringIO.new
+    tar_file = Gem::Package::TarWriter.new(tar_file_stream)
+    Zip::File.open_buffer(package.stream) do |zip_file|
+      copy_archive(zip_file, tar_file, File.basename(PACKAGE_PATH))
+      tar_file.close
+    end
+
+    tar_file_stream.seek(0)
+    tar_file_stream
+  end
+
+  # Copies every entry from the zip archive to the tar archive, adding the optional prefix to the
+  # start of each file name.
+  #
+  # @param [Zip::File] zip_file The zip file to read from.
+  # @param [Gem::Package::TarWriter] tar_file The tar file to write to.
+  # @param [String] prefix The prefix to add to every file name in the tar.
+  def copy_archive(zip_file, tar_file, prefix = nil)
+    zip_file.each do |entry|
+      next unless entry.file?
+
+      zip_entry_stream = entry.get_input_stream
+      new_entry_name = prefix ? File.join(prefix, entry.name) : entry.name
+      tar_file.add_file(new_entry_name, 0664) do |tar_entry_stream|
+        IO.copy_stream(zip_entry_stream, tar_entry_stream)
+      end
+
+      zip_entry_stream.close
+    end
+  end
+
+  def execute_package(container)
+    container.start!
+    container.wait
+  end
+
+  def extract_result(container)
+    logs = container.logs(stdout: true, stderr: true)
+
+    _, stdout, stderr = Coursemology::Evaluator::Utils.parse_docker_stream(logs)
+    Result.new(stdout, stderr, extract_test_report(container), container.exit_code)
+  end
+
+  def extract_test_report(container)
+    stream = extract_test_report_archive(container)
+
+    tar_file = Gem::Package::TarReader.new(stream)
+    tar_file.each do |file|
+      return file.read
+    end
+  rescue Docker::Error::NotFoundError
+    return nil
+  end
+
+  # Extracts the test report from the container.
+  #
+  # @return [StringIO] The stream containing the archive, the pointer is reset to the start of the
+  #   stream.
+  def extract_test_report_archive(container)
+    stream = StringIO.new
+    container.archive_out(REPORT_PATH) do |bytes|
+      stream.write(bytes)
+    end
+
+    stream.seek(0)
+    stream
+  end
+
+  def destroy_container(container)
+    container.delete
+  end
+end

data/lib/coursemology/evaluator/string_io.rb

@@ -0,0 +1,13 @@
+# Adapter for StringIO for compatibility with RubyZip.
+#
+# StringIO does not inherit from IO, so RubyZip does not accept StringIO in place of IO.
+class Coursemology::Evaluator::StringIO < ::StringIO
+  def is_a?(klass)
+    klass == IO || super
+  end
+
+  # RubyZip assumes all IO objects respond to path.
+  def path
+    self
+  end
+end

data/lib/coursemology/evaluator/utils.rb

@@ -0,0 +1,41 @@
+module Coursemology::Evaluator::Utils
+  # Represents one block of the Docker Attach protocol.
+  DockerAttachBlock = Struct.new(:stream, :length, :bytes)
+
+  # Parses a Docker +attach+ protocol stream into its constituent protocols.
+  #
+  # See https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#attach-to-a-container.
+  #
+  # This drops all blocks belonging to streams other than STDIN, STDOUT, or STDERR.
+  #
+  # @param [String] string The input stream to parse.
+  # @return [Array<(String, String, String)>] The stdin, stdout, and stderr output.
+  def self.parse_docker_stream(string)
+    result = ['', '', '']
+    stream = StringIO.new(string)
+
+    while (block = parse_docker_stream_read_block(stream))
+      next if block.stream >= result.length
+      result[block.stream] << block.bytes
+    end
+
+    stream.close
+    result
+  end
+
+  # Reads a block from the given stream, and parses it according to the Docker +attach+ protocol.
+  #
+  # @param [IO] stream The stream to read.
+  # @raise [IOError] If the stream is corrupt.
+  # @return [DockerAttachBlock] If there is data in the stream.
+  # @return [nil] If there is no data left in the stream.
+  def self.parse_docker_stream_read_block(stream)
+    header = stream.read(8)
+    return nil if header.blank?
+    fail IOError unless header.length == 8
+
+    console_stream, _, _, _, length = header.unpack('C4N')
+    DockerAttachBlock.new(console_stream, length, stream.read(length))
+  end
+  private_class_method :parse_docker_stream_read_block
+end

data/lib/coursemology/evaluator/version.rb

@@ -1,4 +1,4 @@
 module Coursemology; end
 module Coursemology::Evaluator
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

data/lib/coursemology/polyglot/extensions.rb

@@ -0,0 +1,2 @@
+# This augments the base polyglot library with methods needed for the evaluator.
+Dir[File.join(__dir__, '**/*.rb')].each { |f| require f }

data/lib/coursemology/polyglot/extensions/language.rb

@@ -0,0 +1,23 @@
+class Coursemology::Polyglot::Language
+  # Finds the language class with the specified name.
+  #
+  # @param [String] type The name of the class.
+  # @return [nil] If the type is not defined.
+  # @return [Class] If the type was found.
+  def self.find_by(type:)
+    class_ = concrete_languages.find { |language| language.name == type }
+    class_.new if class_
+  end
+
+  # Finds the language class with the specified name.
+  #
+  # @param [String] type The name of the class.
+  # @return [Class] If the type was found.
+  # @raise [ArgumentError] When the type was not found.
+  def self.find_by!(type:)
+    language = find_by(type: type)
+    fail ArgumentError, "Cannot find the language #{type}" unless language
+
+    language
+  end
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: coursemology-evaluator
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Joel Low
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-12 00:00:00.000000000 Z
+date: 2016-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,23 +52,201 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: flexirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coursemology-polyglot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Sets up a consistent environment for evaluating programming packages.
 email:
 - joel@joelsplace.sg
-executables: []
+executables:
+- evaluator
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env"
 - ".gitignore"
+- ".hound.yml"
 - ".idea/Coursemology Evaluator.iml"
 - ".rspec"
+- ".rubocop.unhound.yml"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
+- Procfile
 - README.md
 - Rakefile
+- bin/evaluator
 - coursemology-evaluator.gemspec
 - lib/coursemology/evaluator.rb
+- lib/coursemology/evaluator/cli.rb
+- lib/coursemology/evaluator/client.rb
+- lib/coursemology/evaluator/docker_container.rb
+- lib/coursemology/evaluator/logging.rb
+- lib/coursemology/evaluator/logging/client_log_subscriber.rb
+- lib/coursemology/evaluator/logging/docker_log_subscriber.rb
+- lib/coursemology/evaluator/models.rb
+- lib/coursemology/evaluator/models/base.rb
+- lib/coursemology/evaluator/models/programming_evaluation.rb
+- lib/coursemology/evaluator/models/programming_evaluation/package.rb
+- lib/coursemology/evaluator/services.rb
+- lib/coursemology/evaluator/services/evaluate_programming_package_service.rb
+- lib/coursemology/evaluator/string_io.rb
+- lib/coursemology/evaluator/utils.rb
 - lib/coursemology/evaluator/version.rb
+- lib/coursemology/polyglot/extensions.rb
+- lib/coursemology/polyglot/extensions/language.rb
 homepage: http://coursemology.org
 licenses:
 - MIT
@@ -89,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Coursemology programming package evaluator