coursemology-evaluator 0.1.6 → 0.1.7

data/lib/coursemology/evaluator/models/base.rb

@@ -1,50 +1,50 @@
-# frozen_string_literal: true
-class Coursemology::Evaluator::Models::Base < Flexirest::Base
-  class << self
-    attr_accessor :api_user_email
-    attr_accessor :api_token
-
-    def initialize
-      Flexirest::Base.perform_caching = false
-      default_config = Flexirest::Base.faraday_config
-      Flexirest::Base.faraday_config do |faraday|
-        # +follow_redirects+ must be added before declaring the adapter. See faraday_middleware#32,
-        # last comment.
-        faraday.response :follow_redirects
-
-        default_config.call(faraday)
-      end
-    end
-  end
-
-  verbose!
-  before_request :add_authentication
-
-  # Sets the key of the model. This is the key that all attributes are nested under, the same as
-  # the +require+ directive in the controller of the web application.
-  #
-  # @param [String] key The key to prefix all attributes with.
-  def self.model_key(key)
-    before_request do |name, param|
-      fix_put_parameters(key, name, param) if [:post, :patch, :put].include?(param.method[:method])
-    end
-  end
-  private_class_method :model_key
-
-  # Fixes the request parameters when executing a POST, PATCH or PUT.
-  #
-  # @param [String] key The key to prefix all attributes with.
-  # @param [Request] param The request parameter to prepend the key with.
-  def self.fix_put_parameters(key, _, param)
-    param.post_params = { key => param.post_params } unless param.post_params.empty?
-  end
-  private_class_method :fix_put_parameters
-
-  private
-
-  # Adds the authentication email and token to the request.
-  def add_authentication(_, request)
-    request.headers['X-User-Email'] = self.class.api_user_email
-    request.headers['X-User-Token'] = self.class.api_token
-  end
-end
+# frozen_string_literal: true
+class Coursemology::Evaluator::Models::Base < Flexirest::Base
+  class << self
+    attr_accessor :api_user_email
+    attr_accessor :api_token
+
+    def initialize
+      Flexirest::Base.perform_caching = false
+      default_config = Flexirest::Base.faraday_config
+      Flexirest::Base.faraday_config do |faraday|
+        # +follow_redirects+ must be added before declaring the adapter. See faraday_middleware#32,
+        # last comment.
+        faraday.response :follow_redirects
+
+        default_config.call(faraday)
+      end
+    end
+  end
+
+  verbose!
+  before_request :add_authentication
+
+  # Sets the key of the model. This is the key that all attributes are nested under, the same as
+  # the +require+ directive in the controller of the web application.
+  #
+  # @param [String] key The key to prefix all attributes with.
+  def self.model_key(key)
+    before_request do |name, param|
+      fix_put_parameters(key, name, param) if [:post, :patch, :put].include?(param.method[:method])
+    end
+  end
+  private_class_method :model_key
+
+  # Fixes the request parameters when executing a POST, PATCH or PUT.
+  #
+  # @param [String] key The key to prefix all attributes with.
+  # @param [Request] param The request parameter to prepend the key with.
+  def self.fix_put_parameters(key, _, param)
+    param.post_params = { key => param.post_params } unless param.post_params.empty?
+  end
+  private_class_method :fix_put_parameters
+
+  private
+
+  # Adds the authentication email and token to the request.
+  def add_authentication(_, request)
+    request.headers['X-User-Email'] = self.class.api_user_email
+    request.headers['X-User-Token'] = self.class.api_token
+  end
+end

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

@@ -1,55 +1,55 @@
-# frozen_string_literal: true
-class Coursemology::Evaluator::Models::ProgrammingEvaluation < Coursemology::Evaluator::Models::Base
-  extend ActiveSupport::Autoload
-  autoload :Package
-
-  request_body_type :json
-  model_key :programming_evaluation
-
-  get :find, 'courses/assessment/programming_evaluations/:id'.freeze
-  post :allocate, 'courses/assessment/programming_evaluations/allocate'.freeze
-  put :save, 'courses/assessment/programming_evaluations/:id/result'.freeze
-
-  # Gets the language for the programming evaluation.
-  #
-  # @return [nil] If the language does not exist.
-  # @return [Coursemology::Polyglot::Language] The language that the evaluation uses.
-  def language
-    Coursemology::Polyglot::Language.find_by(type: super)
-  end
-
-  # Sets the language for the programming evaluation.
-  #
-  # @param [String|nil|Coursemology::Polyglot::Language] language The language to set. If this is
-  #   a string, it is assumed to be the class name of the language.
-  def language=(language)
-    return super(language) if language.nil? || language.is_a?(String)
-
-    fail ArgumentError unless language.is_a?(Coursemology::Polyglot::Language)
-    super(language.class.name)
-  end
-
-  # Obtains the package.
-  #
-  # @return [Coursemology::Evaluator::Models::ProgrammingEvaluation::Package]
-  def package
-    @package ||= begin
-      body = self.class._plain_request('courses/assessment/programming_evaluations/:id/package',
-                                       :get, id: id)
-      Package.new(Coursemology::Evaluator::StringIO.new(body))
-    end
-  end
-
-  # Evaluates the package, and stores the result in this record.
-  #
-  # Call {Coursemology::Evaluator::Models::ProgrammingEvaluation#save} to save the record to the
-  # server.
-  def evaluate
-    result = Coursemology::Evaluator::Services::EvaluateProgrammingPackageService.
-             execute(self)
-    self.stdout = result.stdout
-    self.stderr = result.stderr
-    self.test_report = result.test_report
-    self.exit_code = result.exit_code
-  end
-end
+# frozen_string_literal: true
+class Coursemology::Evaluator::Models::ProgrammingEvaluation < Coursemology::Evaluator::Models::Base
+  extend ActiveSupport::Autoload
+  autoload :Package
+
+  request_body_type :json
+  model_key :programming_evaluation
+
+  get :find, 'courses/assessment/programming_evaluations/:id'.freeze
+  post :allocate, 'courses/assessment/programming_evaluations/allocate'.freeze
+  put :save, 'courses/assessment/programming_evaluations/:id/result'.freeze
+
+  # Gets the language for the programming evaluation.
+  #
+  # @return [nil] If the language does not exist.
+  # @return [Coursemology::Polyglot::Language] The language that the evaluation uses.
+  def language
+    Coursemology::Polyglot::Language.find_by(type: super)
+  end
+
+  # Sets the language for the programming evaluation.
+  #
+  # @param [String|nil|Coursemology::Polyglot::Language] language The language to set. If this is
+  #   a string, it is assumed to be the class name of the language.
+  def language=(language)
+    return super(language) if language.nil? || language.is_a?(String)
+
+    fail ArgumentError unless language.is_a?(Coursemology::Polyglot::Language)
+    super(language.class.name)
+  end
+
+  # Obtains the package.
+  #
+  # @return [Coursemology::Evaluator::Models::ProgrammingEvaluation::Package]
+  def package
+    @package ||= begin
+      body = self.class._plain_request('courses/assessment/programming_evaluations/:id/package',
+                                       :get, id: id)
+      Package.new(Coursemology::Evaluator::StringIO.new(body))
+    end
+  end
+
+  # Evaluates the package, and stores the result in this record.
+  #
+  # Call {Coursemology::Evaluator::Models::ProgrammingEvaluation#save} to save the record to the
+  # server.
+  def evaluate
+    result = Coursemology::Evaluator::Services::EvaluateProgrammingPackageService.
+             execute(self)
+    self.stdout = result.stdout
+    self.stderr = result.stderr
+    self.test_report = result.test_report
+    self.exit_code = result.exit_code
+  end
+end

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

@@ -1,12 +1,12 @@
-# frozen_string_literal: true
-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
+# frozen_string_literal: true
+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

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-module Coursemology::Evaluator::Services
-  extend ActiveSupport::Autoload
-
-  autoload :EvaluateProgrammingPackageService
-end
+# frozen_string_literal: true
+module Coursemology::Evaluator::Services
+  extend ActiveSupport::Autoload
+
+  autoload :EvaluateProgrammingPackageService
+end

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

@@ -1,151 +1,151 @@
-# frozen_string_literal: true
-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
+# frozen_string_literal: true
+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.force_encoding(Encoding::UTF_8)
+    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