mumuki-sqlite-runner 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e971b83ccdad28673f28cfa2ee6c40721ef5584e25d6d15e5ced8bd961e0f766
-  data.tar.gz: 7987a0938706989f590071825bb83842384a3e3d4b61f9a55b3f865f42d98cc5
+  metadata.gz: e2ae7f324d12e24d38f8ac0fbf573406453c0cece8e1853800314feb3ba9b2b8
+  data.tar.gz: c0619a88e63b5df94d0dc9c715a7539dddc6a9b82d38bf7b89461a6b080c8326
 SHA512:
-  metadata.gz: fed2e43fcb1f7f3ed534f4bb26f7e1f512b0ce70ed6ce4d972677fa0cd136418322ec4a189a5e4534ec4191aada64cb549b8ea43b5b3a542582c890fc1047226
-  data.tar.gz: e0c229624b5cf5b524fba4ae1db2b8320459982d346a2f9bf0cec3cf4e51a2c72e50cf13d2e6bf62478b5acebbc0e9ceed4ba6fb52f83e1cb3283d9a501c8e4a
+  metadata.gz: b971e4cc0cac4b5f9d71067bd06e4e9ace57b31c14184fadfb269d35471a101f0a4fda7d35f6148db7c6c4fe417db5d559edf23db2188ef64aaf6d9443544f45
+  data.tar.gz: 6d1fb79de256ba8903fe326da8beef481c28e7b04a26b094f872fe48992bfd273e55c366e03f6c87dfba099a6206b5774be44d01371fafc7e5d44ada0e4b80d7

data/lib/helpers.rb

@@ -0,0 +1,21 @@
+module Sqlite
+  module TestHelper
+
+    def set_test_parsers_hash
+      @test_parsers = {
+          query: Sqlite::QueryTestParser,
+          display: Sqlite::DisplayTestParser,
+          datasets: Sqlite::DatasetTestParser,
+          final_dataset: Sqlite::FinalDatasetTestParser,
+      }
+      @test_parsers.default = Sqlite::InvalidTestParser
+    end
+
+    def load_tests(test)
+      tests = YAML.load test
+      tests = [tests] unless tests.kind_of? Array
+      tests.map(&:to_struct)
+    end
+
+  end
+end

data/lib/locales/en.yml

@@ -7,3 +7,6 @@ en:
       columns: 'Columns do not match'
       rows:    'Rows do not match'
       query:   'Queries do not match'
+      tests:
+        lint: "Invalid tests, It should be a valid YAML format. Try with this validator http://www.yamllint.com/"
+        types: "Unsupported test type '%{type}'. Use one of these: datasets, query, display, final_dataset"

data/lib/locales/es.yml

@@ -7,3 +7,6 @@ es:
       columns: 'Las columnas no coinciden'
       rows:    'Las filas no coinciden'
       query:   'Las consultas no coinciden'
+    tests:
+      lint: "¡Tests inválidos! No tienen el formato YAML correcto. Podés probar en este validador http://www.yamllint.com/"
+      types: "El test type '%{type}' no está soportado. Tenés que usar uno de éstos: datasets, query, display, final_dataset"

data/lib/parsers/common_test_parser.rb

@@ -6,6 +6,7 @@ module Sqlite
     required :parse, 'You need to implement parse method when use CommonTestParse mixin!'
 
     def initialize(test)
+      @test = test
       @result = parse test
     end
 
@@ -13,6 +14,23 @@ module Sqlite
       solution
     end
 
+    def has?(key)
+      !@test[key.to_sym].blank?
+    end
+
+    def get(key)
+      @test[key.to_sym]
+    end
+
+    def has_final?
+      # Only FinalDataset should have final query
+      false
+    end
+
+    def get_final
+      ''
+    end
+
     protected
 
     def final_parse(test, override = {})

data/lib/parsers/dataset_test_parser.rb

@@ -3,11 +3,6 @@ module Sqlite
 
     include Sqlite::CommonTestParser
 
-    def initialize(test)
-      @test = test
-      @result = parse test
-    end
-
     # test = {
     #   type: dataset,
     #   seed: INSERT INTO ...,

data/lib/parsers/display_test_parser.rb

@@ -0,0 +1,18 @@
+module Sqlite
+  class DisplayTestParser
+    include Sqlite::CommonTestParser
+
+    def has_final?
+      has?(:query)
+    end
+
+    def get_final
+      # Assume has_final? is true
+      get(:query)
+    end
+
+    def parse(test)
+      final_parse test, { expected: get_final }
+    end
+  end
+end

data/lib/parsers/final_dataset_test_parser.rb

@@ -1,9 +1,13 @@
 module Sqlite
   class FinalDatasetTestParser < DatasetTestParser
 
-    def initialize(test)
-      super(test)
-      @final = test[:query] || test[:final]
+    def has_final?
+      has?(:final) || has?(:query)
+    end
+
+    def get_final
+      # Assume has_final? is true
+      has?(:final) ? get(:final) : get(:query)
     end
 
   end

data/lib/parsers/invalid_test_parser.rb

@@ -3,16 +3,8 @@ module Sqlite
 
     include Sqlite::CommonTestParser
 
-    # return {
-    #   seed: -- NONE,
-    #   expected: -- NONE
-    # }
     def parse(test)
-      final_parse(test, {
-          seed: COMMENT,
-          expected: COMMENT
-      })
+      raise I18n.t('message.failure.tests.types', type: test.type)
     end
-
   end
 end

data/lib/sqlite_runner.rb

@@ -10,16 +10,19 @@ Mumukit.configure do |config|
   config.structured = true
 end
 
+require_relative './dataset'
+require_relative './checker'
 require_relative './version_hook'
-require_relative './test_hook'
 require_relative './metadata_hook'
-require_relative './checker'
-require_relative './multiple_executions_runner'
 require_relative './html_renderer'
-require_relative './dataset'
+require_relative './multiple_executions_runner'
 require_relative './parsers/common_test_parser'
 require_relative './parsers/query_test_parser'
+require_relative './parsers/display_test_parser'
 require_relative './parsers/dataset_test_parser'
 require_relative './parsers/final_dataset_test_parser'
 require_relative './parsers/invalid_test_parser'
+require_relative './helpers'
+require_relative './test_hook'
+require_relative './validation_hook'
 require_relative './errors'

data/lib/test_hook.rb

@@ -5,67 +5,36 @@ require 'diffy'
 # This Hook allow to run Sqlite Worker from an ad-hoc program that receives .json files.
 
 class SqliteTestHook < Mumukit::Templates::FileHook
-
-  # Define that worker runs on a freshly-cleaned environment
   isolated
+  include Sqlite::TestHelper
 
   def initialize(config = nil)
     super(config)
-    @test_parsers = {
-        query: Sqlite::QueryTestParser,
-        datasets: Sqlite::DatasetTestParser,
-        final_dataset: Sqlite::FinalDatasetTestParser,
-    }
-    @test_parsers.default = Sqlite::InvalidTestParser
+    set_test_parsers_hash
   end
 
-  # Just define file extension
   def tempfile_extension
     '.json'
   end
 
-  # Define the command to be run by sqlite worker
   def command_line(filename)
     "runsql #{filename}"
   end
 
   # Transform Mumuki Request into Docker file style
-  # Request = {
-  #   test: {
-  #     type: (string) query|dataset,
-  #     seed: (string) sql code to populate tables,
-  #     expected: (string) query sentence | resulting table
-  #   },
-  #   extra: (string) sql code to create tables,
-  #   content: (string) student's solution,
-  #   expectations: []    # not using
-  # }
-  #
   def compile_file_content(request)
     tests = parse_tests request.test
     final = get_final_query
     {
-        init:    request.extra.strip,
-        student: request.content.strip << final,
+        init:    "#{request.extra&.strip}",
+        student: "#{request.content&.strip}#{final}",
         tests:   tests
     }.to_json
   end
 
-  # Define how output results
-  # Expected:
-  # {
-  #     "expected": [
-  #         "name\nTest 1.1\nTest 1.2\nTest 1.3\n",
-  #         "name\nTest 2.1\nTest 2.2\nTest 2.3\n"
-  #     ],
-  #     "student": [
-  #         "id|name\n1|Test 1.1\n2|Test 1.2\n3|Test 1.3\n",
-  #         "id|name\n1|Test 2.1\n2|Test 2.2\n3|Test 2.3\n"
-  #     ]
-  # }
+  # Transform Docker result into Response to Mumuki
   def post_process_file(_file, result, status)
-    output = JSON.parse(result)
-
+    output = JSON.parse result
     case status
       when :passed
         expected, student = parse_output output
@@ -83,12 +52,12 @@ class SqliteTestHook < Mumukit::Templates::FileHook
     student  = output['student']
     expected = output['expected']
     expected.map!.with_index do |expect, i|
-      @expected_parser[i].choose expect
+      @tests[i].choose expect
     end
-
     diff(expected, student)
   end
 
+  # Make diff between expected and student dataset result and mark each line one according comparision
   def diff(expected, student)
     zipped = expected.zip(student).map do |expected_i, student_i|
       diff = Diffy::SplitDiff.new student_i << "\n", expected_i << "\n"
@@ -119,34 +88,17 @@ class SqliteTestHook < Mumukit::Templates::FileHook
     end
   end
 
-  # This method receives a list of test cases.
-  # Each one could be like one of these:
-  #
-  #   type: query
-  #   seed: INSERT INTO ...
-  #   expected: SELECT * FROM ...
-  #
-  #   type: dataset
-  #   seed: INSERT INTO ...
-  #   expected: |
-  #     id|field
-  #     1|row 1
-  #     ...
+  # This method receives a list of test cases and transforms each one according it parser
   def parse_tests(tests)
-    tests = YAML.load tests
-    tests = [tests] unless tests.kind_of? Array
-    @tests = tests.map do | test |
-      test = test.to_struct
+    @tests = load_tests(tests).map do | test |
       @test_parsers[test.type.to_sym].new test
     end
-
-    @expected_parser = @tests
     @tests.map(&:result)
   end
 
   def get_final_query
-    parsers = @expected_parser.select { |parser| !parser.final.blank? }
-    parsers.empty? ? '' : parsers.first.final
+    tests = @tests.select { |test| test.has_final? }
+    tests.empty? ? '' : tests.first.get_final
   end
 
   # Initialize Metatest Framework with Checker & Runner

data/lib/validation_hook.rb

@@ -0,0 +1,31 @@
+class SqliteValidationHook < Mumukit::Hook
+
+  include Sqlite::TestHelper
+
+  def initialize(config = nil)
+    super(config)
+    set_test_parsers_hash
+  end
+
+  def validate!(request)
+    lint_tests request.test
+    types_tests request.test
+  end
+
+  def lint_tests(tests)
+    begin
+      YAML.load tests
+    rescue
+      raise Mumukit::RequestValidationError, I18n.t('message.failure.tests.lint')
+    end
+  end
+
+  def types_tests(tests)
+    # Assumes that pass lint_tests
+    load_tests(tests).each do |test|
+      valid = @test_parsers.has_key? test.type.to_sym
+      raise Mumukit::RequestValidationError, I18n.t('message.failure.tests.types', type: test.type) unless valid
+    end
+  end
+
+end

data/lib/version_hook.rb

@@ -1,3 +1,3 @@
 module SqliteVersionHook
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-sqlite-runner
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Leandro Di Lorenzo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2017-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mumukit
@@ -174,6 +174,7 @@ files:
 - lib/checker.rb
 - lib/dataset.rb
 - lib/errors.rb
+- lib/helpers.rb
 - lib/html_renderer.rb
 - lib/locales/en.yml
 - lib/locales/es.yml
@@ -181,11 +182,13 @@ files:
 - lib/multiple_executions_runner.rb
 - lib/parsers/common_test_parser.rb
 - lib/parsers/dataset_test_parser.rb
+- lib/parsers/display_test_parser.rb
 - lib/parsers/final_dataset_test_parser.rb
 - lib/parsers/invalid_test_parser.rb
 - lib/parsers/query_test_parser.rb
 - lib/sqlite_runner.rb
 - lib/test_hook.rb
+- lib/validation_hook.rb
 - lib/version_hook.rb
 - lib/view/rows_error.html.erb
 - lib/view/rows_success.html.erb