mumuki-sqlite-runner 1.0.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a8e623818974d8e1d0f091e5efa200ae14e80e9
-  data.tar.gz: ddb33cfdb7c7de09781dad8413691c9394721807
+  metadata.gz: e574ef63ec53b93d7841532738042a3be0899079
+  data.tar.gz: a87d92c79f8af4546ef46eb34e6faa7e0d26572c
 SHA512:
-  metadata.gz: fd7ece620802e0aa40b42bd7bb15a205748d0628bc5d27367838572c7669ef67dd3166ce31a6db5120df5a00d94f547ab4d0e9f329b24ccc6a2821762a06b4e3
-  data.tar.gz: ddc60b701bfdc9c86b479cf518512302bca3c6cc21636ef4c902d03a0f84b6f5760f9bde9b40eca422f39da9ce351a103d39d2d01f290d91ef9001dd197a79a0
+  metadata.gz: 28dca88c0eae83a3d5e34173b47b6702d805e1bc3d3ff70a99d7d546001c157386f91ca9d6e8b93c13b43561576caf0b1d2e0e4329b598d79c73e5ab1f8ca4b4
+  data.tar.gz: aeba550111b462b085d48c9b590822ddd03fdefa874303ccadb13c89867c55120c06612ded7402f871fb3cdaffb95c3d2297e45cd4310c2af36a167ed4e66240

data/lib/checker.rb

@@ -6,17 +6,17 @@ module Sqlite
     # when distinct_columns: return failed & render error
     # when distinct_rows: return failed & render error
     def check(result, solution)
-      name = "Dataset #{solution[:id]}"
+      name = I18n.t 'dataset', number: solution[:id]
 
       case solution[:dataset].compare result[:dataset]
         when :equals
           success(name, result)
         when :distinct_columns
-          failed(name, result, solution, 'Las columnas no coinciden')
+          failed(name, result, solution, (I18n.t 'failure.columns'))
         when :distinct_rows
-          failed(name, result, solution, 'Las filas no coinciden')
+          failed(name, result, solution, (I18n.t 'failure.rows'))
         else
-          failed(name, result, solution, 'Las consultas no coinciden')
+          failed(name, result, solution, (I18n.t 'failure.query'))
       end
     end
 

data/lib/dataset.rb

@@ -3,9 +3,12 @@ module Sqlite
     attr_reader :header, :rows
 
     def initialize(data)
-      rows = data.split(/\n+/i)
-      @header = rows.shift.split(/\|/)
-      @rows   = rows.map { |row| row.split(/\|/) }
+      @header = @rows = []
+      rows = split_lines data
+      unless rows.empty?
+        @header = split_pipe rows.shift
+        @rows = rows.map { |item| split_pipe item }
+      end
     end
 
     def compare(other)
@@ -23,6 +26,14 @@ module Sqlite
 
     protected
 
+    def split_lines(str)
+      str.split(/\n+/i)
+    end
+
+    def split_pipe(line)
+      line.split(/\|/)
+    end
+
     def same_header(other_header)
       @header.eql? other_header
     end

data/lib/dataset_solution_parser.rb

@@ -0,0 +1,34 @@
+module Sqlite
+  class DatasetSolutionParser
+
+    # If solutions comes in an explicit datasets,
+    # it was stored in instance variable.
+    # Expected input:
+    # OpenStruct#{
+    #   solution_type: 'datasets',
+    #   examples: [
+    #     {
+    #       dataset: "INSERT INTO ...\nINSERT INTO ...",
+    #       solution_dataset: "id|field\n1|row1..."
+    #     }
+    #   ]
+    # }
+    def parse_test(test)
+      data = []
+      @solutions = []
+      solution_query = '-- none'
+
+      test.examples.each do |item|
+        @solutions << item[:solution_dataset].scan(/(?!\|).+(?<!\|)/).join("\n")
+        data.append item[:data]
+      end
+
+      return solution_query, data
+    end
+
+    def choose(_solution)
+      @solutions
+    end
+
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,7 @@
+module Sqlite
+  class TestSolutionTypeError < StandardError
+    def initialize(msg = 'Yaml Test must have solution_type with one of these values: query or datasets')
+      super
+    end
+  end
+end

data/lib/extensions/hash_extension.rb

@@ -0,0 +1,6 @@
+
+class Hash
+  def to_yaml
+    super.sub('---', '').strip
+  end
+end

data/lib/html_renderer.rb

@@ -11,19 +11,51 @@ module Sqlite
 
     def render_error(result, solution, error)
       @error = error
-      @result = {
-          header: result[:dataset].header,
-          rows: result[:dataset].rows
-      }
-      @solution = {
-          header: solution[:dataset].header,
-          rows: solution[:dataset].rows
-      }
+      @result = parse_dataset(result[:dataset].header, result[:dataset].rows)
+      @solution = parse_dataset(solution[:dataset].header, solution[:dataset].rows)
+
       template_file_error.result binding
     end
 
     protected
 
+    def parse_dataset(header, rows)
+      header_sign = header.shift
+      rows = rows.map do |row|
+        {
+            sign: row.shift,
+            row: row
+        }
+      end
+
+      {
+          header: {
+              sign: header_sign,
+              class: diff_class_of(header_sign),
+              fields: header
+          },
+          rows: rows.map do |row|
+            {
+                sign:row[:sign],
+                class: diff_class_of(row[:sign]),
+                fields: row[:row]
+            }
+          end
+      }
+
+    end
+
+    def diff_class_of(value)
+      case value
+        when '+'
+          'required'
+        when '-'
+          'errored'
+        else
+          'nothing'
+      end
+    end
+
     def template_file_success
       ERB.new File.read("#{__dir__}/view/rows_success.html.erb")
     end

data/lib/locales/en.yml

@@ -1,6 +1,8 @@
 en:
-  records: 'Records'
-  memory: 'Memory'
-  special_records: 'Special records'
-  flags: 'Flags'
-  check_equal_failure: "<b>%{record}</b> should be <b>%{expected}</b>, but was <b>%{actual}</b>"
+  dataset: "Dataset %{number}"
+  success:
+    query: 'Correct Query!'
+  failure:
+    columns: 'Columns do not match'
+    rows:    'Rows do not match'
+    query:   'Queries do not match'

data/lib/locales/es.yml

@@ -1,6 +1,8 @@
 es:
-  records: 'Registros'
-  memory: 'Memoria'
-  special_records: 'Registros especiales'
-  flags: 'Banderas'
-  check_equal_failure: "<b>%{record}</b> debería contener el valor <b>%{expected}</b>, pero se encontró <b>%{actual}</b>"
+  dataset: "Set de datos %{number}"
+  success:
+    query: '¡Consulta correcta!'
+  failure:
+    columns: 'Las columnas no coinciden'
+    rows:    'Las filas no coinciden'
+    query:   'Las consultas no coinciden'

data/lib/metadata_hook.rb

@@ -4,7 +4,7 @@ class SqliteMetadataHook < Mumukit::Hook
       language: {
         name: 'sqlite',
         icon: { type: 'devicon', name: 'sql' },
-        version: 'v0.2.2',
+        version: '3.13.0',
         extension: 'sql',
         ace_mode: 'sql',
         graphic: true

data/lib/query_solution_parser.rb

@@ -0,0 +1,25 @@
+module Sqlite
+  class QuerySolutionParser
+
+    # Expected input:
+    # OpenStruct#{
+    #   solution_type: 'query',
+    #   solution_query: 'select * from motores;',
+    #   examples: [
+    #     { dataset: "INSERT INTO ...\nINSERT INTO ..." }
+    #   ]
+    # }
+    def parse_test(test)
+      data = test.examples.map do |item|
+        item[:data]
+      end
+
+      return test.solution_query, data
+    end
+
+    def choose(solution)
+      solution
+    end
+
+  end
+end

data/lib/sqlite_runner.rb

@@ -5,11 +5,12 @@ I18n.load_translations_path File.join(__dir__, 'locales', '*.yml')
 
 Mumukit.runner_name = 'sqlite'
 Mumukit.configure do |config|
-  config.docker_image = 'leandrojdl/mumuki-sqlite-worker'
-  config.content_type = 'plain'
+  config.docker_image = 'mumuki/mumuki-sqlite-worker'
+  config.content_type = 'html'
   config.structured = true
 end
 
+require_relative './extensions/hash_extension'
 require_relative './version_hook'
 require_relative './test_hook'
 require_relative './metadata_hook'
@@ -17,3 +18,6 @@ require_relative './checker'
 require_relative './multiple_executions_runner'
 require_relative './html_renderer'
 require_relative './dataset'
+require_relative './dataset_solution_parser'
+require_relative './query_solution_parser'
+require_relative './errors'

data/lib/test_hook.rb

@@ -1,7 +1,8 @@
 require 'json'
+require 'diffy'
 
 ##
-# This Hook allow to run Sqlite Worker from an adhoc program that receives .sql files.
+# This Hook allow to run Sqlite Worker from an ad-hoc program that receives .json files.
 
 class SqliteTestHook < Mumukit::Templates::FileHook
 
@@ -18,22 +19,22 @@ class SqliteTestHook < Mumukit::Templates::FileHook
     "runsql #{filename}"
   end
 
-  # Define the .sql file template from request structure
-  # request = {
-  #   test: (string) teacher's code that define which testing verification student code should pass,
-  #   extra: (string) teacher's code that prepare field where student code should run,
-  #   content: (string) student code,
-  #   expectations: [mulang verifications] todo: better explain
+  # Define the .json file template from request structure
+  # Input: request = {
+  #   test: (yaml string) teacher's code that define which testing verification student code should pass,
+  #   extra: (sql string) teacher's code that prepare field where student code should run,
+  #   content: (sql string) student code,
+  #   expectations: [] not using for now
   # }
   #
   def compile_file_content(request)
-    solution, datasets = parse_test request.test.strip
+    solution, data = parse_test request.test
 
     content = {
         init: request.extra.strip,
         solution: solution,
         student: request.content.strip,
-        datasets: datasets
+        datasets: data
     }
 
     content.to_json
@@ -56,8 +57,7 @@ class SqliteTestHook < Mumukit::Templates::FileHook
 
     case status
       when :passed
-        results   = post_process_datasets(output['results'])
-        solutions = post_process_datasets(output['solutions'])
+        solutions, results = parse_output output
         framework.test solutions, results
       when :failed
         [output['output'], status]
@@ -66,6 +66,42 @@ class SqliteTestHook < Mumukit::Templates::FileHook
     end
   end
 
+  protected
+
+  def parse_output(output)
+    results   = output['results']
+    solutions = output['solutions']
+    unless @solution_parser.nil?
+      solutions = @solution_parser.choose solutions
+    end
+
+    diff(solutions, results)
+  end
+
+  def diff(solutions, results)
+    zipped = solutions.zip(results).map do |solution, result|
+
+      diff = Diffy::SplitDiff.new result << "\n", solution << "\n"
+
+      if diff.left.blank?
+        [solution, result]
+      else
+        res = post_process_diff diff.left
+        sol = post_process_diff diff.right
+        [sol, res]
+      end
+
+    end
+
+    zipped.transpose.map { |dataset| post_process_datasets dataset }
+  end
+
+  def post_process_diff(data)
+    data.scan(/^(\s|-|\+)(.+)/)
+        .map { |mark, content| mark << '|' << content }
+        .join("\n")
+  end
+
   # Transforms array datasets into hash with :id & :rows
   def post_process_datasets(datasets)
     datasets.map.with_index do |dataset, i|
@@ -76,18 +112,37 @@ class SqliteTestHook < Mumukit::Templates::FileHook
     end
   end
 
-  # Split query by '-- DATASET' line match
-  # First match is teacher's solution
-  # Rest are Datasets
-  # Example:
-  #   select * from table
-  #   -- DATASET
-  #   insert into 1
-  #   -- dataset
-  #   insert into 2
-  def parse_test(content)
-    query = content.split(/\s*--\s*dataset\s*\n+/i)
-    return query.shift, query
+  # Test should have one of these formats:
+  #
+  # Solution by query:
+  # { solution_type: 'query',
+  #   solution_query: 'SELECT * FROM ...',
+  #   examples: [
+  #     { data: "INSERT INTO..." }
+  #   ]
+  # }
+  #
+  # Solution by datasets:
+  # { solution_type: 'datasets',
+  #   examples: [
+  #     { data: "INSERT INTO...",
+  #       solution: "id|field\n1|row1..."
+  #     }
+  #   ]
+  # }
+  def parse_test(test)
+    test = OpenStruct.new YAML.load(test).deep_symbolize_keys
+
+    case test.solution_type.to_sym
+      when :query
+        @solution_parser = Sqlite::QuerySolutionParser.new
+      when :datasets
+        @solution_parser = Sqlite::DatasetSolutionParser.new
+      else
+        raise Sqlite::TestSolutionTypeError
+    end
+
+    @solution_parser.parse_test test
   end
 
   # Initialize Metatest Framework with Checker & Runner

data/lib/version_hook.rb

@@ -1,3 +1,3 @@
 module SqliteVersionHook
-  VERSION = '1.0.1'
-end
+  VERSION = '2.2.1'
+end

data/lib/view/rows_error.html.erb

@@ -3,13 +3,13 @@
     width: auto;
   }
   table.sqlite_result {
-    border: 3px solid #0B465D;
+    border: none;
   }
   table.sqlite_solution {
-    border: 3px solid darkred;
+    border: none;
   }
   table.sqlite_error tr:nth-child(even) {
-    background-color: #DDDDDD;
+    background-color: #EEEEEE;
   }
   table.sqlite_error tr:nth-child(odd) {
     background-color: #FFFFFF;
@@ -23,6 +23,34 @@
     width: auto;
     text-align: left;
   }
+
+  .required {
+    color: #5cb85c;
+    font-style: italic;
+  }
+  .errored {
+    color: #d9534f;
+    font-style: italic;
+  }
+
+  .required :first-child,
+  .errored :first-child,
+  .nothing :first-child {
+    font-style: normal;
+    padding-left: 2px;
+    padding-right: 2px;
+    background-color: white;
+    border-left: none;
+    border-bottom: 1px solid white;
+  }
+  .required :first-child {
+    color: white;
+    background-color: #5cb85c;
+  }
+  .errored :first-child {
+    color: white;
+    background-color: #d9534f;
+  }
 </style>
 
 <h5><%= @error %></h5>
@@ -34,8 +62,9 @@
     <h6>Se esperaba:</h6>
     <table class="table table-bordered sqlite_error sqlite_result">
       <thead>
-      <tr>
-        <% @result[:header].each do |field| %>
+      <tr class="<%= @result[:header][:class] %>">
+        <th><%= @result[:header][:sign] %></th>
+        <% @result[:header][:fields].each do |field| %>
             <th><%= field %></th>
         <% end %>
       </tr>
@@ -43,8 +72,9 @@
 
       <tbody>
       <% @result[:rows].each do |row| %>
-          <tr>
-            <% row.each do |field| %>
+          <tr class="<%= row[:class] %>">
+            <td><%= row[:sign] %></td>
+            <% row[:fields].each do |field| %>
                 <td><%= field %></td>
             <% end %>
           </tr>
@@ -58,8 +88,9 @@
     <h6>Se obtuvo:</h6>
     <table class="table table-bordered sqlite_error sqlite_solution">
       <thead>
-      <tr>
-        <% @solution[:header].each do |field| %>
+      <tr class="<%= @result[:header][:class] %>">
+        <th><%= @result[:header][:sign] %></th>
+        <% @solution[:header][:fields].each do |field| %>
             <th><%= field %></th>
         <% end %>
       </tr>
@@ -67,8 +98,9 @@
 
       <tbody>
       <% @solution[:rows].each do |row| %>
-          <tr>
-            <% row.each do |field| %>
+          <tr class="<%= row[:class] %>">
+            <td><%= row[:sign] %></td>
+            <% row[:fields].each do |field| %>
                 <td><%= field %></td>
             <% end %>
           </tr>

data/lib/view/rows_success.html.erb

@@ -20,7 +20,7 @@
   }
 </style>
 
-<h5>Consulta correcta!</h5>
+<h5><%= I18n.t 'success.query' %></h5>
 <table class="table table-bordered sqlite_success">
   <thead>
   <tr>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-sqlite-runner
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Leandro Di Lorenzo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mumukit
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -159,11 +173,15 @@ extra_rdoc_files: []
 files:
 - lib/checker.rb
 - lib/dataset.rb
+- lib/dataset_solution_parser.rb
+- lib/errors.rb
+- lib/extensions/hash_extension.rb
 - lib/html_renderer.rb
 - lib/locales/en.yml
 - lib/locales/es.yml
 - lib/metadata_hook.rb
 - lib/multiple_executions_runner.rb
+- lib/query_solution_parser.rb
 - lib/sqlite_runner.rb
 - lib/test_hook.rb
 - lib/version_hook.rb
@@ -189,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: SQLite Runner for Mumuki