mumuki-qsim-runner 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 930559ecdb6bedad199c06203e02f499a6a73126
-  data.tar.gz: 3900757dd30409efb6adf45dbd7c959d9938bec7
+SHA256:
+  metadata.gz: 8344af1b99d0efa137e744b790bac1c493ef67b257a4058db638ed8935ad4606
+  data.tar.gz: 1ae990e1197ffabdc7269893730067d67062ae748c5aa537d01fc266499615a4
 SHA512:
-  metadata.gz: 2f79d3713b02bc46a90fe0b1d242d7bd09fdf8e84bf89c4b65b53b48d31ac9c666dbda66c2e9cd31e728c0b0bae7601f2547d79cc44a9403e22784df726c1182
-  data.tar.gz: 9e4221841ff15a2f7a979be3721fbd4500e45a09efbeaa4cf5003525a6fe1bef40a1017dbd6d2117a9a69d2e9e863b06907f2a38a16f57c1617c975eaf22834c
+  metadata.gz: d7156538f1ede88f2edce45fd6f09ef0c99bf3d79bde43f0a36fc467317f94f269399d9dc7e5e575d9db15e8ab8f590dda220c67f50355090789116244163951
+  data.tar.gz: 99d427cdd46eab7d8a90923a06d06712e127f585ee9dff967e559574c44260f14a169019621c7ed64e8b9b7acfba3d3b8c037650c4b45dfacfba5adf2173a97c

data/lib/checker.rb

@@ -1,18 +1,23 @@
 module Qsim
   class Checker < Mumukit::Metatest::Checker
+    def check(result, example)
+      @output_options = example[:output]
+      super
+    end
+
     def check_equal(result, records)
       records.each do |record, expected|
         actual = result[:records][record]
-        fail I18n.t :check_equal_failure, {record: record, expected: expected, actual: actual} unless actual == expected
+        fail I18n.t(:check_equal_failure, record: record, expected: expected, actual: actual) unless actual == expected
       end
     end
 
     def render_success_output(result)
-      renderer.render result
+      renderer.render(result, @output_options)
     end
 
     def render_error_output(result, error)
-      "#{error}\n#{renderer.render result}"
+      "#{error}\n#{renderer.render(result, @output_options)}"
     end
 
     private
@@ -21,4 +26,4 @@ module Qsim
       @renderer ||= Qsim::HtmlRenderer.new
     end
   end
-end
+end

data/lib/extensions/string_extension.rb

@@ -0,0 +1,5 @@
+class String
+  def to_hex
+    to_i(16)
+  end
+end

data/lib/html_renderer.rb

@@ -1,14 +1,67 @@
+require 'active_support/inflector'
+
 module Qsim
   class HtmlRenderer
-    def render(result)
-      @result = result
+    def render(result, output)
+      @output = output
+      @result = {}
+      output.keys.each do |output_key|
+        fields = range(output_key, output)
+                   .map { |key| [key_for(output_key, key), '0000'] }
+                   .to_h
+                   .merge(result[output_key])
+                   .sort
+        @result[output_key] = fields
+      end
       template_file.result binding
     end
 
     private
 
     def template_file
-      ERB.new File.read("#{__dir__}/records.html.erb")
+      ERB.new File.read("#{__dir__}/view/records.html.erb")
+    end
+
+    def to_memory(number)
+      number.to_s(16).rjust(4, '0').upcase.to_sym
+    end
+
+    def to_record(number)
+      "R#{number}".to_sym
+    end
+
+    def to_flag(number)
+      number.to_sym
+    end
+
+    def to_special_record(record)
+      record.to_sym
+    end
+
+    def memory_range(options)
+      from = options[:memory][:from].to_hex
+      to = options[:memory][:to].to_hex
+      (from..to)
+    end
+
+    def range(output_key, output)
+      send("#{output_key}_range", output)
+    end
+
+    def key_for(output_key, key)
+      send("to_#{output_key}".singularize, key)
+    end
+
+    def records_range(_)
+      (0..7)
+    end
+
+    def flags_range(_)
+      %w(N Z V C).map(&:to_sym)
+    end
+
+    def special_records_range(_)
+      %w(SP PC IR).map(&:to_sym)
     end
   end
-end
+end

data/lib/locales/en.yml

@@ -1,3 +1,6 @@
 en:
   records: 'Records'
-  check_equal_failure: "<b>%{record}</b> should be <b>%{expected}</b>, but was <b>%{actual}</b>"
+  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

@@ -1,3 +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

@@ -3,7 +3,7 @@ class QsimMetadataHook < Mumukit::Hook
     {
       language: {
         name: 'qsim',
-        icon: {type: 'devicon', name: 'qsim'},
+        icon: { type: 'devicon', name: 'qsim' },
         version: 'v0.2.2',
         extension: 'qsim',
         ace_mode: 'assembly_x86',
@@ -11,8 +11,20 @@ class QsimMetadataHook < Mumukit::Hook
       },
       test_framework: {
         name: 'metatest',
-        test_extension: 'yml'
+        test_extension: 'yml',
+        template: <<qsim
+examples:
+- name: '{{ test_template_group_description }}'
+  preconditions:
+    records:
+      R0: '0001'
+      R1: '000A'
+  postconditions:
+    equal:
+      R0: '0001'
+      R1: '000A'
+qsim
       }
     }
   end
-end
+end

data/lib/multiple_executions_runner.rb

@@ -7,4 +7,4 @@ module Qsim
       result
     end
   end
-end
+end

data/lib/qsim_runner.rb

@@ -10,8 +10,10 @@ Mumukit.configure do |config|
   config.structured = true
 end
 
+require_relative './extensions/string_extension'
 require_relative './test_hook'
 require_relative './metadata_hook'
 require_relative './checker'
 require_relative './multiple_executions_runner'
-require_relative './html_renderer'
+require_relative './html_renderer'
+require_relative './subject'

data/lib/subject/program_subject.rb

@@ -0,0 +1,15 @@
+module Qsim
+  class ProgramSubject < Subject
+    def extra_code
+      @request.extra
+    end
+
+    def main_code
+      "#{skip_command}\n#{@request.content}"
+    end
+
+    def skip_command
+      'MOV R0, R0'
+    end
+  end
+end

data/lib/subject/routine_subject.rb

@@ -0,0 +1,11 @@
+module Qsim
+  class RoutineSubject < Subject
+    def extra_code
+      "#{@request.extra}\n#{@request.content}"
+    end
+
+    def main_code
+      "CALL #{@subject}"
+    end
+  end
+end

data/lib/subject/subject.rb

@@ -0,0 +1,27 @@
+module Qsim
+  class Subject
+    def self.from_test(test, request)
+      subject = test[:subject]
+      clazz = subject ? RoutineSubject : ProgramSubject
+      clazz.new(subject, request)
+    end
+
+    def initialize(subject, request)
+      @subject = subject
+      @request = request
+    end
+
+    def compile_code(input_file_separator, initial_state_file)
+      <<~QSIM
+        JMP main
+
+        #{extra_code}
+
+        main:
+        #{main_code}
+        #{input_file_separator}
+        #{initial_state_file}
+      QSIM
+    end
+  end
+end

data/lib/subject.rb

@@ -0,0 +1,3 @@
+require_relative './subject/subject'
+require_relative './subject/program_subject'
+require_relative './subject/routine_subject'

data/lib/test_hook.rb

@@ -2,7 +2,7 @@ class QsimTestHook < Mumukit::Templates::FileHook
   include Mumukit::WithTempfile
   attr_reader :examples
 
-  isolated true
+  isolated
 
   def tempfile_extension
     '.qsim'
@@ -13,27 +13,21 @@ class QsimTestHook < Mumukit::Templates::FileHook
   end
 
   def compile_file_content(request)
-    @examples = to_examples(parse_test(request)[:examples])
+    test = parse_test(request)
+    @examples = to_examples(test[:examples])
+    @subject = test[:subject]
 
-    <<EOF
-JMP main
-
-#{request.extra}
-
-main:
-#{skip_command}
-#{request.content}
-#{input_file_separator}
-#{initial_state_file}
-EOF
+    Qsim::Subject
+      .from_test(test, request)
+      .compile_code(input_file_separator, initial_state_file)
   end
 
   def execute!(request)
-    result, _ = run_file! compile request
+    result, = run_file! compile request
     parse_json result
   end
 
-  def post_process_file(file, result, status)
+  def post_process_file(_file, result, status)
     output = parse_json result
 
     case status
@@ -49,8 +43,48 @@ EOF
   private
 
   def to_examples(examples)
-    defaults = { preconditions: {} }
-    examples.each_with_index.map { |example, index| defaults.merge(example).merge(id: index) }
+    examples.each_with_index.map do |example, index|
+      example[:preconditions] = classify(example.fetch(:preconditions, {}))
+      example.merge(id: index, output: @output)
+    end
+  end
+
+  def classify(fields)
+    classified_fields = {}
+    fields.each do |key, value|
+      kind = category(key)
+      unless kind == :unknown
+        classified_fields.deep_merge!(kind => { key => value })
+      end
+    end
+    classified_fields
+  end
+
+  def category(key)
+    field = key.to_s
+    return :records if record?(field)
+    return :flags if flag?(field)
+    return :memory if memory?(field)
+    return :special_records if special_record?(field)
+    :unknown
+  end
+
+  def record?(key)
+    (0..7)
+      .map { |number| "R#{number}" }
+      .include?(key)
+  end
+
+  def flag?(key)
+    %w(N C V Z).include? key
+  end
+
+  def memory?(key)
+    /^[A-F0-9]{4}/.matches?(key)
+  end
+
+  def special_record?(key)
+    %w(SP PC IR).include? key
   end
 
   def framework
@@ -63,9 +97,41 @@ EOF
   end
 
   def parse_test(request)
+    load_tests(request).tap do |tests|
+      @output = define_output(tests)
+    end
+  end
+
+  def load_tests(request)
     YAML.load(request.test).deep_symbolize_keys
   end
 
+  def define_output(parsed_tests)
+    output = { records: true }
+    output.merge!(parsed_tests[:output] || {})
+    check_memory_range(output) if output[:memory].is_a? Hash
+    output.tap do |hash|
+      hash
+        .delete_if { |_, value| !value }
+        .slice!(:records, :flags, :special_records, :memory)
+    end
+  end
+
+  def check_memory_range(config)
+    memory_settings = config[:memory]
+    from = memory_settings[:from].to_hex
+    to = memory_settings[:to].to_hex
+    config[:memory] = false unless to > from && in_memory_range?(from, to)
+  end
+
+  def in_memory_range?(*addresses)
+    addresses.all? { |address| memory_range.include?(address) }
+  end
+
+  def memory_range
+    0..0xFFFF
+  end
+
   def default_initial_state
     {
       special_records: {
@@ -94,19 +160,19 @@ EOF
   end
 
   def initial_state_file
-    initial_states = @examples.map { |example| default_initial_state.merge(id: example[:id]).deep_merge(example[:preconditions]) }
-    JSON.generate initial_states
-  end
-
-  def input_file_separator
-    '!!!BEGIN_EXAMPLES!!!'
+    initial_states = @examples.map do |example|
+      default_initial_state
+        .merge(id: example[:id])
+        .deep_merge(example[:preconditions])
+    end
+    JSON.generate(initial_states)
   end
 
   def q_architecture
     6
   end
 
-  def skip_command
-    'MOV R0, R0'
+  def input_file_separator
+    '!!!BEGIN_EXAMPLES!!!'
   end
-end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module QsimVersionHook
+  VERSION = '1.2.0'
+end

data/lib/view/records.html.erb

@@ -0,0 +1,67 @@
+<style>
+  table.qsim-fields {
+    display: inline-block;
+    border: none;
+  }
+
+  td.qsim-field-name {
+    background-color: #ecf0f1;
+    font-weight: bold;
+    white-space: nowrap;
+  }
+
+  td {
+    text-align: center;
+    width: 60px;
+  }
+</style>
+
+<% if @output.key?(:memory) %>
+    <h5><%= I18n.t :memory %></h5>
+    <table class="table table-bordered qsim-fields">
+      <tbody>
+      <% @result[:memory].each_slice(10) do |group| %>
+          <tr>
+            <% group.each.with_index do |record, index| %>
+                <% if index.zero? %>
+                    <td class="qsim-field-name"> <%= record[0] %> </td>
+                <% end %>
+                <td> <%= record[1] %> </td>
+            <% end %>
+          </tr>
+      <% end %>
+      </tbody>
+    </table>
+<% end %>
+
+<% if @output.key?(:records) %>
+    <h5><%= I18n.t :records %></h5>
+    <table class="table table-bordered qsim-fields">
+      <tbody>
+      <% @result[:records].each_slice(4) do |group| %>
+          <tr>
+            <% group.each do |address, value| %>
+                <td class="qsim-field-name"> <%= address %> </td>
+                <td> <%= value %> </td>
+            <% end %>
+          </tr>
+      <% end %>
+      </tbody>
+    </table>
+<% end %>
+
+<% [:flags, :special_records].each do |key| %>
+    <% if @result.key?(key) %>
+        <h5><%= I18n.t key %></h5>
+        <table class="table table-bordered qsim-fields">
+          <tbody>
+          <tr>
+            <% @result[key].each do |address, value| %>
+                <td class="qsim-field-name"><%= address %></td>
+                <td><%= value %></td>
+            <% end %>
+          </tr>
+          </tbody>
+        </table>
+    <% end %>
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-qsim-runner
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Federico Aloi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2019-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mumukit
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !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
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !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
@@ -86,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.0'
 description: 
 email:
 - fede@mumuki.org
@@ -102,15 +130,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/checker.rb
+- lib/extensions/string_extension.rb
 - lib/html_renderer.rb
 - lib/locales/en.yml
 - lib/locales/es.yml
 - lib/metadata_hook.rb
 - lib/multiple_executions_runner.rb
 - lib/qsim_runner.rb
-- lib/records.html.erb
+- lib/subject.rb
+- lib/subject/program_subject.rb
+- lib/subject/routine_subject.rb
+- lib/subject/subject.rb
 - lib/test_hook.rb
-homepage: http://github.com/mumuki/mumuki-qsim-server
+- lib/version.rb
+- lib/view/records.html.erb
+homepage: http://github.com/mumuki/mumuki-qsim-runner
 licenses:
 - MIT
 metadata: {}
@@ -129,8 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Qsim Runner for Mumuki

data/lib/records.html.erb

@@ -1,28 +0,0 @@
-<style>
-  	table.qsim-records {
-		max-width: 10%;
-		display: inline-block;
-		border: none;
-	}
-
-	td.qsim-record-name {
-		background-color: #ecf0f1;
-		font-weight: bold;
-		width: 1%;
-		white-space: nowrap;
-	}
-</style>
-
-<h5><%=I18n.t :records %></h5>
-<% @result[:records].each_slice(4) do |group| %>
-	<table class="table table-bordered qsim-records">
-		<tbody>
-	  		<% group.each do |name, value| %>
-				<tr>
-			  		<td class="qsim-record-name"><%= name %></td>
-			  		<td class="text-center"><%= value %></td>
-				</tr>
-			<% end %>
-		</tbody>
-	</table>
-<% end %>