coursemology-evaluator 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb396ac979a791b3d79224f80b88fa8ffb60b142
-  data.tar.gz: d3fd4e275fea14998d7b66a61c36f935f78f85a9
+  metadata.gz: 81bd30cc5392032f6b0baaf8314278f48b3ae384
+  data.tar.gz: 135910bce96d87502a3c4b1bf80729ae35b1187a
 SHA512:
-  metadata.gz: 3d33529e852271ea6c3a81e5e2c0732aea4614623bf550d0dc4ac40740b23d8659b9eaec7a516eedf1c7367af6563353ad9de799f7387687b917c2fce0f0b8a6
-  data.tar.gz: 886203828c1fb1dcc2a42ede52600b23837523ad9ca41594d7322406cec834bdf3b8c8cafac77741bbcfc8e25900b12d06fe41631d5d4942cd30716525588e94
+  metadata.gz: 5460c5ea63f1857fa0a294a35130283e6aa3a6f76278734db13741921e881ff3cdcbae85791cf42b03596eafc8c9fe26f52329a5743e483379bdbbaee50f8366
+  data.tar.gz: 5db7643a681aa5e17a2c5a2a81ea7fa0ca8c7720c3498115b109a4f73a5637645c200b2a87f345fd25bcb5b433f095f348c67d407ecb0f5799417d5eed85cb08

data/README.md

@@ -27,3 +27,26 @@ This is the evaluator program which will query Coursemology for pending evaluati
 
 3. Start the evaluator using the Procfile. You can use [foreman](https://github.com/ddollar/foreman)
    or any similar tool to generate system scripts for boot.
+
+### Command Line Options
+
+#### Compulsory Options
+
+1. `--host`: Coursemology host to connect to
+2. `--api-user-email`: User with autograder flag set
+3. `--api-token`: Authentication token of the user
+
+#### Optional Options
+
+Time options are expected to be strings in [ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601#Durations).
+
+1. `--interval`: Time interval between checks for programming allocations. As this time is
+  expected to be short, specify it with the time components of ISO8601 only. (Hours, minutes, seconds)
+  The time designator `T` must be left out.
+
+2. `--lifetime`: Length of time to cache Docker images. This is expected to be in the order of days.
+  If more granularity is needed, the time designator is required.
+
+  E.g. `1DT2H5M10S`
+
+3. `--one-shot`: Runs once and terminates. Primarily used for testing.

data/coursemology-evaluator.gemspec

@@ -28,10 +28,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'vcr'
 
   spec.add_dependency 'activesupport', '~> 4.2.0', '>= 4.2.2'
+  spec.add_dependency 'iso8601', '~> 0.9.1'
   spec.add_dependency 'flexirest', '~> 1.2', '>= 1.2.6'
   spec.add_dependency 'faraday_middleware'
 
   spec.add_dependency 'coursemology-polyglot', '>= 0.0.3'
-  spec.add_dependency 'docker-api', '>= 1.2.5'
+  spec.add_dependency 'docker-api', '>= 1.29.1'
   spec.add_dependency 'rubyzip'
 end

data/lib/coursemology/evaluator.rb

@@ -9,9 +9,11 @@ Docker.validate_version!
 require 'coursemology/polyglot'
 require 'coursemology/polyglot/extensions'
 require 'coursemology/evaluator/version'
+require 'iso8601'
 
 module Coursemology::Evaluator
   extend ActiveSupport::Autoload
+  include ActiveSupport::Configurable
 
   autoload :Client
   autoload :DockerContainer

data/lib/coursemology/evaluator/cli.rb

@@ -2,7 +2,8 @@
 require 'optparse'
 
 class Coursemology::Evaluator::CLI
-  Options = Struct.new(:host, :api_token, :api_user_email, :one_shot)
+  Options = Struct.new(:host, :api_token, :api_user_email,
+                       :one_shot, :poll_interval, :image_lifetime)
 
   def self.start(argv)
     new.start(argv)
@@ -14,6 +15,13 @@ class Coursemology::Evaluator::CLI
 
   def run(argv)
     options = optparse!(argv)
+    Coursemology::Evaluator.config.poll_interval =
+      ::ISO8601::Duration.new("PT#{options.poll_interval}".upcase).to_seconds
+
+    # Must include the time designator T if hours/minutes/seconds are required.
+    Coursemology::Evaluator.config.image_lifetime =
+      ::ISO8601::Duration.new("P#{options.image_lifetime}".upcase).to_seconds
+
     Coursemology::Evaluator::Client.initialize(options.host, options.api_user_email,
                                                options.api_token)
     Coursemology::Evaluator::Client.new(options.one_shot).run
@@ -27,6 +35,12 @@ class Coursemology::Evaluator::CLI
   # @return [Coursemology::Evaluator::CLI::Options]
   def optparse!(argv) # rubocop:disable Metrics/MethodLength
     options = Options.new
+
+    # default options for optional parameters
+    options.poll_interval = '10S'
+    options.image_lifetime = '1D'
+    options.one_shot = false
+
     option_parser = OptionParser.new do |parser|
       parser.banner = "Usage: #{parser.program_name} [options]"
       parser.on('-hHOST', '--host=HOST', 'Coursemology host to connect to') do |host|
@@ -41,6 +55,14 @@ class Coursemology::Evaluator::CLI
         options.api_user_email = user
       end
 
+      parser.on('-iINTERVAL', '--interval=INTERVAL') do |interval|
+        options.poll_interval = interval
+      end
+
+      parser.on('-lLIFETIME', '--lifetime=LIFETIME') do |lifetime|
+        options.image_lifetime = lifetime
+      end
+
       parser.on('-o', '--one-shot') do
         options.one_shot = true
       end

data/lib/coursemology/evaluator/client.rb

@@ -31,7 +31,7 @@ class Coursemology::Evaluator::Client
       # :nocov:
       # This sleep might not be triggered in the specs, because interruptions to the thread is
       # nondeterministically run by the OS scheduler.
-      sleep(1.minute)
+      sleep(Coursemology::Evaluator.config.poll_interval)
       # :nocov:
     end
 

data/lib/coursemology/evaluator/docker_container.rb

@@ -17,13 +17,14 @@ class Coursemology::Evaluator::DockerContainer < Docker::Container
 
     # Pulls the given image from Docker Hub.
     #
-    # This caches images for 5 minutes, because the overhead for querying for images is quite high.
+    # This caches images for the specified time, because the overhead for querying
+    # for images is quite high.
     #
     # @param [String] image The image to pull.
     def pull_image(image)
       ActiveSupport::Notifications.instrument('pull.docker.evaluator.coursemology',
                                               image: image) do |payload|
-        cached([:image, image], expires_in: 5.minutes) do
+        cached([:image, image], expires_in: Coursemology::Evaluator.config.image_lifetime) do
           Docker::Image.create('fromImage' => image)
           payload[:cached] = false
         end

data/lib/coursemology/evaluator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Coursemology; end
 module Coursemology::Evaluator
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coursemology-evaluator
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Joel Low
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-03 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,6 +142,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.2
+- !ruby/object:Gem::Dependency
+  name: iso8601
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: flexirest
   requirement: !ruby/object:Gem::Requirement
@@ -196,14 +210,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: 1.29.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: 1.29.1
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -278,7 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Coursemology programming package evaluator