mumuki-sqlite-runner 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d075a041f2a6a4d3e8ee0c156fb9533443625287
+  data.tar.gz: 6d7e335083a7442e80ce5e83ecda14d1e214fa26
+SHA512:
+  metadata.gz: 7e8082c65194aba7d81a10db77aac0884cb1773d0604a7eb0e83b87a10a147e284568677fde04cab048ffcaa7485137981af5507e4c15dc6acd73b8428c3f8ab
+  data.tar.gz: 57cf7a92f1805f7df7cf2c733c7c8e42e8d065cc66b58ad3947c17497874b6ebe054a55ccf23cada3b79d554d83e8d88d45a20cd3c6c3984c557f6910a28a479

data/lib/checker.rb

@@ -0,0 +1,47 @@
+module Sqlite
+  class Checker < Mumukit::Metatest::Checker
+
+    # Verify if solution dataset is equals than result
+    # when equals: Return passed & render success
+    # when distinct_columns: return failed & render error
+    # when distinct_rows: return failed & render error
+    def check(result, solution)
+      name = "Dataset #{solution[:id]}"
+
+      case solution[:dataset].compare result[:dataset]
+        when :equals
+          success(name, result)
+        when :distinct_columns
+          failed(name, result, solution, 'Las columnas no coinciden')
+        when :distinct_rows
+          failed(name, result, solution, 'Las filas no coinciden')
+        else
+          failed(name, result, solution, 'Las consultas no coinciden')
+      end
+    end
+
+    def success(name, result)
+      [name, :passed, render_success(result)]
+    end
+
+    def failed(name, result, solution, error)
+      [name, :failed, render_error(result, solution, error)]
+    end
+
+    # Return success page rendered with results
+    def render_success(result)
+      renderer.render_success result
+    end
+
+    # Return error page rendered with results & solutions
+    def render_error(result, solution, error)
+      renderer.render_error result, solution, error
+    end
+
+    private
+
+    def renderer
+      @renderer ||= Sqlite::HtmlRenderer.new
+    end
+  end
+end

data/lib/dataset.rb

@@ -0,0 +1,43 @@
+module Sqlite
+  class Dataset
+    attr_reader :header, :rows
+
+    def initialize(data)
+      rows = data.split(/\n+/i)
+      @header = rows.shift.split(/\|/)
+      @rows   = rows.map { |row| row.split(/\|/) }
+    end
+
+    def compare(other)
+      same_header = same_header other.header
+      same_rows   = same_rows other.rows
+
+      if same_header & same_rows
+        :equals
+      elsif !same_header
+        :distinct_columns
+      else
+        :distinct_rows
+      end
+    end
+
+    protected
+
+    def same_header(other_header)
+      @header.eql? other_header
+    end
+
+    def same_rows(other_rows)
+      same_amount(other_rows) && same_content(other_rows)
+    end
+
+    def same_amount(other_rows)
+      @rows.length == other_rows.length
+    end
+
+    def same_content(other_rows)
+      @rows.zip(other_rows).all? { |tuple| tuple[0] == tuple[1] }
+    end
+
+  end
+end

data/lib/html_renderer.rb

@@ -0,0 +1,36 @@
+require 'active_support/inflector'
+
+module Sqlite
+  class HtmlRenderer
+
+    def render_success(result)
+      @header = result[:dataset].header
+      @rows   = result[:dataset].rows
+      template_file_success.result binding
+    end
+
+    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
+      }
+      template_file_error.result binding
+    end
+
+    protected
+
+    def template_file_success
+      ERB.new File.read("#{__dir__}/view/rows_success.html.erb")
+    end
+
+    def template_file_error
+      ERB.new File.read("#{__dir__}/view/rows_error.html.erb")
+    end
+
+  end
+end

data/lib/locales/en.yml

@@ -0,0 +1,6 @@
+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>"

data/lib/locales/es.yml

@@ -0,0 +1,6 @@
+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>"

data/lib/metadata_hook.rb

@@ -0,0 +1,18 @@
+class SqliteMetadataHook < Mumukit::Hook
+  def metadata
+    {
+      language: {
+        name: 'sqlite',
+        icon: { type: 'devicon', name: 'sqlite' },
+        version: 'v0.2.2',
+        extension: 'sql',
+        ace_mode: 'assembly_x86',
+        graphic: true
+      },
+      test_framework: {
+        name: 'metatest',
+        test_extension: 'yml'
+      }
+    }
+  end
+end

data/lib/multiple_executions_runner.rb

@@ -0,0 +1,10 @@
+module Sqlite
+  class MultipleExecutionsRunner
+    def run(output, example)
+      result = output.find { |it| it[:id] == example[:id] }
+
+      raise Mumukit::Metatest::Errored, result[:error] if result[:error]
+      result
+    end
+  end
+end

data/lib/sqlite_runner.rb

@@ -0,0 +1,18 @@
+require 'mumukit'
+require 'erb'
+
+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.structured = true
+end
+
+require_relative './test_hook'
+require_relative './metadata_hook'
+require_relative './checker'
+require_relative './multiple_executions_runner'
+require_relative './html_renderer'
+require_relative './dataset'

data/lib/test_hook.rb

@@ -0,0 +1,99 @@
+require 'json'
+
+##
+# This Hook allow to run Sqlite Worker from an adhoc program that receives .sql files.
+
+class SqliteTestHook < Mumukit::Templates::FileHook
+
+  # Define that worker runs on a freshly-cleaned environment
+  isolated
+
+  # 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
+
+  # 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
+  # }
+  #
+  def compile_file_content(request)
+    solution, datasets = parse_test request.test.strip
+
+    content = {
+        init: request.extra.strip,
+        solution: solution,
+        student: request.content.strip,
+        datasets: datasets
+    }
+
+    content.to_json
+  end
+
+  # Define how output results
+  # Expected:
+  # {
+  #     "solutions": [
+  #         "name\nTest 1.1\nTest 1.2\nTest 1.3\n",
+  #         "name\nTest 2.1\nTest 2.2\nTest 2.3\n"
+  #     ],
+  #     "results": [
+  #         "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"
+  #     ]
+  # }
+  def post_process_file(_file, result, status)
+    output = JSON.parse(result)
+
+    case status
+      when :passed
+        results   = post_process_datasets(output['results'])
+        solutions = post_process_datasets(output['solutions'])
+        framework.test solutions, results
+      when :failed
+        [output['output'], status]
+      else
+        [output, status]
+    end
+  end
+
+  # Transforms array datasets into hash with :id & :rows
+  def post_process_datasets(datasets)
+    datasets.map.with_index do |dataset, i|
+      {
+          id: i + 1,
+          dataset: Sqlite::Dataset.new(dataset)
+      }
+    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
+  end
+
+  # Initialize Metatest Framework with Checker & Runner
+  def framework
+    Mumukit::Metatest::Framework.new checker: Sqlite::Checker.new,
+                                     runner: Sqlite::MultipleExecutionsRunner.new
+  end
+
+end

data/lib/view/rows_error.html.erb

@@ -0,0 +1,81 @@
+<style>
+  table.sqlite_error {
+    width: auto;
+  }
+  table.sqlite_result {
+    border: 3px solid #0B465D;
+  }
+  table.sqlite_solution {
+    border: 3px solid darkred;
+  }
+  table.sqlite_error tr:nth-child(even) {
+    background-color: #DDDDDD;
+  }
+  table.sqlite_error tr:nth-child(odd) {
+    background-color: #FFFFFF;
+  }
+  table.sqlite_error th {
+    color: white;
+    font-weight: bold;
+    background-color: #2E2F30;
+  }
+  table.sqlite_error td {
+    width: auto;
+    text-align: left;
+  }
+</style>
+
+<h5><%= @error %></h5>
+
+<div class="row">
+
+  <!-- Result -->
+  <div class="col-md-6">
+    <h6>Se esperaba:</h6>
+    <table class="table table-bordered sqlite_error sqlite_result">
+      <thead>
+      <tr>
+        <% @result[:header].each do |field| %>
+            <th><%= field %></th>
+        <% end %>
+      </tr>
+      </thead>
+
+      <tbody>
+      <% @result[:rows].each do |row| %>
+          <tr>
+            <% row.each do |field| %>
+                <td><%= field %></td>
+            <% end %>
+          </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+
+  <!-- Solution -->
+  <div class="col-md-6">
+    <h6>Se obtuvo:</h6>
+    <table class="table table-bordered sqlite_error sqlite_solution">
+      <thead>
+      <tr>
+        <% @solution[:header].each do |field| %>
+            <th><%= field %></th>
+        <% end %>
+      </tr>
+      </thead>
+
+      <tbody>
+      <% @solution[:rows].each do |row| %>
+          <tr>
+            <% row.each do |field| %>
+                <td><%= field %></td>
+            <% end %>
+          </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+

data/lib/view/rows_success.html.erb

@@ -0,0 +1,42 @@
+<style>
+  table.sqlite_success {
+    width: auto;
+    border: none;
+  }
+  table.sqlite_success tr:nth-child(even) {
+    background-color: #DDDDDD;
+  }
+  table.sqlite_success tr:nth-child(odd) {
+    background-color: #FFFFFF;
+  }
+  table.sqlite_success th {
+    color: white;
+    font-weight: bold;
+    background-color: #BBBBBB;
+  }
+  table.sqlite_success td {
+    width: auto;
+    text-align: left;
+  }
+</style>
+
+<h5>Consulta correcta!</h5>
+<table class="table table-bordered sqlite_success">
+  <thead>
+  <tr>
+  <% @header.each do |field| %>
+    <th><%= field %></th>
+  <% end %>
+  </tr>
+  </thead>
+
+  <tbody>
+  <% @rows.each do |row| %>
+      <tr>
+      <% row.each do |field| %>
+        <td><%= field %></td>
+      <% end %>
+      </tr>
+  <% end %>
+  </tbody>
+</table>

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: mumuki-sqlite-runner
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Leandro Di Lorenzo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mumukit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: 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: mumukit-bridge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- leandro.jdl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/checker.rb
+- lib/dataset.rb
+- lib/html_renderer.rb
+- lib/locales/en.yml
+- lib/locales/es.yml
+- lib/metadata_hook.rb
+- lib/multiple_executions_runner.rb
+- lib/sqlite_runner.rb
+- lib/test_hook.rb
+- lib/view/rows_error.html.erb
+- lib/view/rows_success.html.erb
+homepage: http://github.com/leandrojdl/mumuki-sqlite-runner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: SQLite Runner for Mumuki
+test_files: []