modsvaskr 0.1.11 → 0.2.0

data/lib/modsvaskr/tests_suite.rb

@@ -1,69 +1,70 @@
-require 'fileutils'
-require 'json'
-require 'modsvaskr/logger'
-require 'modsvaskr/run_cmd'
-
-module Modsvaskr
-
-  # Common functionality for any tests suite
-  class TestsSuite
-
-    include Logger, RunCmd
-
-    # Constructor
-    #
-    # Parameters::
-    # * *tests_suite* (Symbol): The tests suite name
-    # * *game* (Game): The game for which this test type is instantiated
-    def initialize(tests_suite, game)
-      @tests_suite = tests_suite
-      @game = game
-    end
-
-    # Get test statuses
-    #
-    # Result::
-    # * Array<[String, String]>: Ordered list of [test name, test status]
-    def statuses
-      File.exist?(json_statuses_file) ? JSON.parse(File.read(json_statuses_file)) : []
-    end
-
-    # Set test statuses.
-    # Add new ones and overwrites existing ones.
-    #
-    # Parameters::
-    # * *statuses* (Array<[String, String]>): Ordered list of [test name, test status]
-    def set_statuses(statuses)
-      current_statuses = self.statuses
-      statuses.each do |(test_name, test_status)|
-        test_status_info = current_statuses.find { |(search_test_name, _search_test_status)| search_test_name == test_name }
-        if test_status_info.nil?
-          # New one. Add it to the end.
-          current_statuses << [test_name, test_status]
-        else
-          # Already existing. Just change its status.
-          test_status_info[1] = test_status
-        end
-      end
-      FileUtils.mkdir_p File.dirname(json_statuses_file)
-      File.write(json_statuses_file, JSON.pretty_generate(current_statuses))
-    end
-
-    # Remove all tests from this suite
-    def clear_tests
-      File.unlink(json_statuses_file) if File.exist?(json_statuses_file)
-    end
-
-    private
-
-    # Get the JSON statuses file name
-    #
-    # Result::
-    # * String: The JSON statuses file name
-    def json_statuses_file
-      "#{@game.path}/Data/Modsvaskr/Tests/Statuses_#{@tests_suite}.json"
-    end
-
-  end
-
-end
+require 'fileutils'
+require 'json'
+require 'modsvaskr/logger'
+require 'modsvaskr/run_cmd'
+
+module Modsvaskr
+
+  # Common functionality for any tests suite
+  class TestsSuite
+
+    include RunCmd
+    include Logger
+
+    # Constructor
+    #
+    # Parameters::
+    # * *tests_suite* (Symbol): The tests suite name
+    # * *game* (Game): The game for which this test type is instantiated
+    def initialize(tests_suite, game)
+      @tests_suite = tests_suite
+      @game = game
+    end
+
+    # Get test statuses
+    #
+    # Result::
+    # * Array<[String, String]>: Ordered list of [test name, test status]
+    def statuses
+      File.exist?(json_statuses_file) ? JSON.parse(File.read(json_statuses_file)) : []
+    end
+
+    # Set test statuses.
+    # Add new ones and overwrites existing ones.
+    #
+    # Parameters::
+    # * *statuses* (Array<[String, String]>): Ordered list of [test name, test status]
+    def statuses=(statuses)
+      current_statuses = self.statuses
+      statuses.each do |(test_name, test_status)|
+        test_status_info = current_statuses.find { |(search_test_name, _search_test_status)| search_test_name == test_name }
+        if test_status_info.nil?
+          # New one. Add it to the end.
+          current_statuses << [test_name, test_status]
+        else
+          # Already existing. Just change its status.
+          test_status_info[1] = test_status
+        end
+      end
+      FileUtils.mkdir_p File.dirname(json_statuses_file)
+      File.write(json_statuses_file, JSON.pretty_generate(current_statuses))
+    end
+
+    # Remove all tests from this suite
+    def clear_tests
+      FileUtils.rm_f(json_statuses_file)
+    end
+
+    private
+
+    # Get the JSON statuses file name
+    #
+    # Result::
+    # * String: The JSON statuses file name
+    def json_statuses_file
+      "#{@game.path}/Data/Modsvaskr/Tests/Statuses_#{@tests_suite}.json"
+    end
+
+  end
+
+end

data/lib/modsvaskr/tests_suites/exterior_cell.rb

@@ -1,117 +1,120 @@
-require 'modsvaskr/in_game_tests_suite'
-
-module Modsvaskr
-
-  module TestsSuites
-
-    class ExteriorCell < TestsSuite
-
-      include InGameTestsSuite
-
-      # Return the in-game tests suite to which we forward the tests to be run
-      #
-      # Result::
-      # * Symbol: In-game tests suite
-      def in_game_tests_suite
-        :locations
-      end
-
-      # Discover the list of tests information that could be run.
-      # [API] - This method is mandatory
-      #
-      # Result::
-      # * Hash< String, Hash<Symbol,Object> >: Ordered hash of test information, per test name
-      def discover_tests
-        # List of exterior cells coordinates, per worldspace name, per plugin name
-        # Hash< String, Hash< String, Array<[Integer, Integer]> > >
-        exterior_cells = {}
-        @game.xedit.run_script('DumpInfo', only_once: true)
-        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
-          esp_name, record_type = row[0..1]
-          if record_type.downcase == 'cell'
-            cell_type, cell_name, cell_x, cell_y = row[3..6]
-            if cell_type == 'cow'
-              if cell_x.nil?
-                log "!!! Invalid record: #{row}"
-              else
-                esp_name.downcase!
-                exterior_cells[esp_name] = {} unless exterior_cells.key?(esp_name)
-                exterior_cells[esp_name][cell_name] = [] unless exterior_cells[esp_name].key?(cell_name)
-                exterior_cells[esp_name][cell_name] << [Integer(cell_x), Integer(cell_y)]
-              end
-            end
-          end
-        end
-        # Test only exterior cells that have been changed by mods, and make sure we test the minimum, knowing that each cell loaded in game tests 5x5 cells around
-        vanilla_esps = @game.game_esps
-        vanilla_exterior_cells = vanilla_esps.inject({}) do |merged_worldspaces, esp_name|
-          merged_worldspaces.merge(exterior_cells[esp_name] || {}) do |worldspace, ext_cells1, ext_cells2|
-            (ext_cells1 + ext_cells2).sort.uniq
-          end
-        end
-        changed_exterior_cells = {}
-        exterior_cells.each do |esp_name, esp_exterior_cells|
-          unless vanilla_esps.include?(esp_name)
-            esp_exterior_cells.each do |worldspace, worldspace_exterior_cells|
-              if vanilla_exterior_cells.key?(worldspace)
-                changed_exterior_cells[worldspace] = [] unless changed_exterior_cells.key?(worldspace)
-                changed_exterior_cells[worldspace].concat(vanilla_exterior_cells[worldspace] & worldspace_exterior_cells)
-              end
-            end
-          end
-        end
-        tests = {}
-        # Value taken from the ini file
-        # TODO: Read it from there (uiGrid)
-        loaded_grid = 5
-        delta_cells = loaded_grid / 2
-        changed_exterior_cells.each do |worldspace, worldspace_exterior_cells|
-          # Make sure we select the minimum cells
-          # Use a Hash of Hashes for the coordinates to speed-up their lookup.
-          remaining_cells = {}
-          worldspace_exterior_cells.each do |(cell_x, cell_y)|
-            remaining_cells[cell_x] = {} unless remaining_cells.key?(cell_x)
-            remaining_cells[cell_x][cell_y] = nil
-          end
-          while !remaining_cells.empty?
-            cell_x, cell_ys = remaining_cells.first
-            cell_y, _nil = cell_ys.first
-            # We want to test cell_x, cell_y.
-            # Knowing that we can test it by loading any cell in the range ((cell_x - delta_cells..cell_x + delta_cells), (cell_y - delta_cells..cell_y + delta_cells)),
-            # check which cell would test the most wanted cells from our list
-            best_cell_x, best_cell_y, best_cell_score = nil, nil, nil
-            (cell_x - delta_cells..cell_x + delta_cells).each do |candidate_cell_x|
-              (cell_y - delta_cells..cell_y + delta_cells).each do |candidate_cell_y|
-                # Check the number of cells that would be tested if we were to test (candidate_cell_x, candidate_cell_y)
-                nbr_tested_cells = remaining_cells.
-                  slice(*(candidate_cell_x - delta_cells..candidate_cell_x + delta_cells)).
-                  inject(0) { |sum_cells, (_cur_cell_x, cur_cell_ys)| sum_cells + cur_cell_ys.slice(*(candidate_cell_y - delta_cells..candidate_cell_y + delta_cells)).size }
-                if best_cell_score.nil? || nbr_tested_cells > best_cell_score
-                  best_cell_score = nbr_tested_cells
-                  best_cell_x = candidate_cell_x
-                  best_cell_y = candidate_cell_y
-                end
-              end
-            end
-            # Remove the tested cells from the remaining ones
-            (best_cell_x - delta_cells..best_cell_x + delta_cells).each do |cur_cell_x|
-              if remaining_cells.key?(cur_cell_x)
-                (best_cell_y - delta_cells..best_cell_y + delta_cells).each do |cur_cell_y|
-                  remaining_cells[cur_cell_x].delete(cur_cell_y)
-                end
-                remaining_cells.delete(cur_cell_x) if remaining_cells[cur_cell_x].empty?
-              end
-            end
-            tests["#{worldspace}/#{best_cell_x}/#{best_cell_y}"] = {
-              name: "Load #{worldspace} cell #{best_cell_x}, #{best_cell_y}"
-            }
-          end
-        end
-        tests
-      end
-
-    end
-
-  end
-
-end
+require 'modsvaskr/in_game_tests_suite'
+
+module Modsvaskr
+
+  module TestsSuites
+
+    # Test exterior cells by using cow and camera spanning
+    class ExteriorCell < TestsSuite
+
+      include InGameTestsSuite
+
+      # Return the in-game tests suite to which we forward the tests to be run
+      #
+      # Result::
+      # * Symbol: In-game tests suite
+      def in_game_tests_suite
+        :locations
+      end
+
+      # Discover the list of tests information that could be run.
+      # [API] - This method is mandatory
+      #
+      # Result::
+      # * Hash< String, Hash<Symbol,Object> >: Ordered hash of test information, per test name
+      def discover_tests
+        # List of exterior cells coordinates, per worldspace name, per plugin name
+        # Hash< String, Hash< String, Array<[Integer, Integer]> > >
+        exterior_cells = {}
+        @game.xedit.run_script('DumpInfo', only_once: true)
+        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
+          esp_name, record_type = row[0..1]
+          if record_type.downcase == 'cell'
+            cell_type, cell_name, cell_x, cell_y = row[3..6]
+            if cell_type == 'cow'
+              if cell_x.nil?
+                log "!!! Invalid record: #{row}"
+              else
+                esp_name.downcase!
+                exterior_cells[esp_name] = {} unless exterior_cells.key?(esp_name)
+                exterior_cells[esp_name][cell_name] = [] unless exterior_cells[esp_name].key?(cell_name)
+                exterior_cells[esp_name][cell_name] << [Integer(cell_x), Integer(cell_y)]
+              end
+            end
+          end
+        end
+        # Test only exterior cells that have been changed by mods, and make sure we test the minimum, knowing that each cell loaded in game tests 5x5 cells around
+        vanilla_esps = @game.game_esps
+        vanilla_exterior_cells = vanilla_esps.inject({}) do |merged_worldspaces, esp_name|
+          merged_worldspaces.merge(exterior_cells[esp_name] || {}) do |_worldspace, ext_cells_1, ext_cells_2|
+            (ext_cells_1 + ext_cells_2).sort.uniq
+          end
+        end
+        changed_exterior_cells = {}
+        exterior_cells.each do |esp_name, esp_exterior_cells|
+          next if vanilla_esps.include?(esp_name)
+
+          esp_exterior_cells.each do |worldspace, worldspace_exterior_cells|
+            if vanilla_exterior_cells.key?(worldspace)
+              changed_exterior_cells[worldspace] = [] unless changed_exterior_cells.key?(worldspace)
+              changed_exterior_cells[worldspace].concat(vanilla_exterior_cells[worldspace] & worldspace_exterior_cells)
+            end
+          end
+        end
+        tests = {}
+        # Value taken from the ini file
+        # TODO: Read it from there (uiGrid)
+        loaded_grid = 5
+        delta_cells = loaded_grid / 2
+        changed_exterior_cells.each do |worldspace, worldspace_exterior_cells|
+          # Make sure we select the minimum cells
+          # Use a Hash of Hashes for the coordinates to speed-up their lookup.
+          remaining_cells = {}
+          worldspace_exterior_cells.each do |(cell_x, cell_y)|
+            remaining_cells[cell_x] = {} unless remaining_cells.key?(cell_x)
+            remaining_cells[cell_x][cell_y] = nil
+          end
+          until remaining_cells.empty?
+            cell_x, cell_ys = remaining_cells.first
+            cell_y, _nil = cell_ys.first
+            # We want to test cell_x, cell_y.
+            # Knowing that we can test it by loading any cell in the range ((cell_x - delta_cells..cell_x + delta_cells), (cell_y - delta_cells..cell_y + delta_cells)),
+            # check which cell would test the most wanted cells from our list
+            best_cell_x = nil
+            best_cell_y = nil
+            best_cell_score = nil
+            (cell_x - delta_cells..cell_x + delta_cells).each do |candidate_cell_x|
+              (cell_y - delta_cells..cell_y + delta_cells).each do |candidate_cell_y|
+                # Check the number of cells that would be tested if we were to test (candidate_cell_x, candidate_cell_y)
+                nbr_tested_cells = remaining_cells.
+                  slice(*(candidate_cell_x - delta_cells..candidate_cell_x + delta_cells)).
+                  inject(0) { |sum_cells, (_cur_cell_x, cur_cell_ys)| sum_cells + cur_cell_ys.slice(*(candidate_cell_y - delta_cells..candidate_cell_y + delta_cells)).size }
+                next unless best_cell_score.nil? || nbr_tested_cells > best_cell_score
+
+                best_cell_score = nbr_tested_cells
+                best_cell_x = candidate_cell_x
+                best_cell_y = candidate_cell_y
+              end
+            end
+            # Remove the tested cells from the remaining ones
+            (best_cell_x - delta_cells..best_cell_x + delta_cells).each do |cur_cell_x|
+              next unless remaining_cells.key?(cur_cell_x)
+
+              (best_cell_y - delta_cells..best_cell_y + delta_cells).each do |cur_cell_y|
+                remaining_cells[cur_cell_x].delete(cur_cell_y)
+              end
+              remaining_cells.delete(cur_cell_x) if remaining_cells[cur_cell_x].empty?
+            end
+            tests["#{worldspace}/#{best_cell_x}/#{best_cell_y}"] = {
+              name: "Load #{worldspace} cell #{best_cell_x}, #{best_cell_y}"
+            }
+          end
+        end
+        tests
+      end
+
+    end
+
+  end
+
+end

data/lib/modsvaskr/tests_suites/interior_cell.rb

@@ -1,63 +1,63 @@
-require 'modsvaskr/in_game_tests_suite'
-
-module Modsvaskr
-
-  module TestsSuites
-
-    class InteriorCell < TestsSuite
-
-      include InGameTestsSuite
-
-      # Return the in-game tests suite to which we forward the tests to be run
-      #
-      # Result::
-      # * Symbol: In-game tests suite
-      def in_game_tests_suite
-        :locations
-      end
-
-      # Discover the list of tests information that could be run.
-      # [API] - This method is mandatory
-      #
-      # Result::
-      # * Hash< String, Hash<Symbol,Object> >: Ordered hash of test information, per test name
-      def discover_tests
-        # List of interior cells, per plugin name
-        # Hash< String, Array<String> >
-        interior_cells = {}
-        @game.xedit.run_script('DumpInfo', only_once: true)
-        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
-          esp_name, record_type = row[0..1]
-          if record_type.downcase == 'cell'
-            cell_type, cell_name = row[3..4]
-            if cell_type == 'coc'
-              esp_name.downcase!
-              interior_cells[esp_name] = [] unless interior_cells.key?(esp_name)
-              interior_cells[esp_name] << cell_name
-            end
-          end
-        end
-        # Test only interior cells that have been changed by mods
-        vanilla_esps = @game.game_esps
-        vanilla_interior_cells = vanilla_esps.map { |esp_name| interior_cells[esp_name] || [] }.flatten.sort.uniq
-        Hash[interior_cells.
-          map { |esp_name, esp_cells| vanilla_esps.include?(esp_name) ? [] : vanilla_interior_cells & esp_cells }.
-          flatten.
-          sort.
-          uniq.
-          map do |cell_name|
-            [
-              cell_name,
-              {
-                name: "Load cell #{cell_name}"
-              }
-            ]
-          end
-        ]
-      end
-
-    end
-
-  end
-
-end
+require 'modsvaskr/in_game_tests_suite'
+
+module Modsvaskr
+
+  module TestsSuites
+
+    # Test interior cells by using coc and camera spanning
+    class InteriorCell < TestsSuite
+
+      include InGameTestsSuite
+
+      # Return the in-game tests suite to which we forward the tests to be run
+      #
+      # Result::
+      # * Symbol: In-game tests suite
+      def in_game_tests_suite
+        :locations
+      end
+
+      # Discover the list of tests information that could be run.
+      # [API] - This method is mandatory
+      #
+      # Result::
+      # * Hash< String, Hash<Symbol,Object> >: Ordered hash of test information, per test name
+      def discover_tests
+        # List of interior cells, per plugin name
+        # Hash< String, Array<String> >
+        interior_cells = {}
+        @game.xedit.run_script('DumpInfo', only_once: true)
+        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
+          esp_name, record_type = row[0..1]
+          if record_type.downcase == 'cell'
+            cell_type, cell_name = row[3..4]
+            if cell_type == 'coc'
+              esp_name.downcase!
+              interior_cells[esp_name] = [] unless interior_cells.key?(esp_name)
+              interior_cells[esp_name] << cell_name
+            end
+          end
+        end
+        # Test only interior cells that have been changed by mods
+        vanilla_esps = @game.game_esps
+        vanilla_interior_cells = vanilla_esps.map { |esp_name| interior_cells[esp_name] || [] }.flatten.sort.uniq
+        interior_cells.
+          map { |esp_name, esp_cells| vanilla_esps.include?(esp_name) ? [] : vanilla_interior_cells & esp_cells }.
+          flatten.
+          sort.
+          uniq.
+          to_h do |cell_name|
+            [
+              cell_name,
+              {
+                name: "Load cell #{cell_name}"
+              }
+            ]
+          end
+      end
+
+    end
+
+  end
+
+end

data/lib/modsvaskr/tests_suites/npc.rb

@@ -1,64 +1,67 @@
-require 'modsvaskr/in_game_tests_suite'
-
-module Modsvaskr
-
-  module TestsSuites
-
-    class Npc < TestsSuite
-
-      include InGameTestsSuite
-
-      # Return the in-game tests suite to which we forward the tests to be run
-      #
-      # Result::
-      # * Symbol: In-game tests suite
-      def in_game_tests_suite
-        :npcs
-      end
-
-      # Discover the list of tests information that could be run.
-      # [API] - This method is mandatory
-      #
-      # Result::
-      # * Hash< String, Hash<Symbol,Object> >: Ordered hash of test information, per test name
-      def discover_tests
-        tests = {}
-        @game.xedit.run_script('DumpInfo', only_once: true)
-        # Keep track of masters, per plugin
-        # Hash<String, Array<String> >
-        masters = {}
-        # Keep track of NPCs
-        # Array< [String, Integer, String] >
-        # Array< [Plugin, FormID,  NPC   ] >
-        npcs = []
-        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
-          case row[1].downcase
-          when 'npc_'
-            npcs << [row[0].downcase, row[2].to_i(16), row[3]]
-          when 'tes4'
-            masters[row[0].downcase] = row[3..-1].map(&:downcase)
-          end
-        end
-        npcs.each do |(esp, form_id, npc_name)|
-          raise "Esp #{esp} declares NPC FormID #{form_id} (#{npc_name}) but its masters could not be parsed" unless masters.key?(esp)
-          # Know from which mod this ID comes from
-          mod_idx = form_id / 16_777_216
-          raise "NPC FormID #{form_id} (#{npc_name}) from #{esp} references an unknown master (known masters: #{masters[esp].join(', ')})" if mod_idx > masters[esp].size
-          test_name = "#{mod_idx == masters[esp].size ? esp : masters[esp][mod_idx]}/#{form_id % 16_777_216}"
-          if tests.key?(test_name)
-            # Add the name of the mod to the description, so that we know which mod modifies which NPC.
-            tests[test_name][:name] << "/#{esp}"
-          else
-            tests[test_name] = {
-              name: "Take screenshot of #{npc_name} - #{esp}"
-            }
-          end
-        end
-        tests
-      end
-
-    end
-
-  end
-
-end
+require 'modsvaskr/in_game_tests_suite'
+
+module Modsvaskr
+
+  module TestsSuites
+
+    # Test NPCs by taking screenshots
+    class Npc < TestsSuite
+
+      include InGameTestsSuite
+
+      # Return the in-game tests suite to which we forward the tests to be run
+      #
+      # Result::
+      # * Symbol: In-game tests suite
+      def in_game_tests_suite
+        :npcs
+      end
+
+      # Discover the list of tests information that could be run.
+      # [API] - This method is mandatory
+      #
+      # Result::
+      # * Hash< String, Hash<Symbol,Object> >: Ordered hash of test information, per test name
+      def discover_tests
+        tests = {}
+        @game.xedit.run_script('DumpInfo', only_once: true)
+        # Keep track of masters, per plugin
+        # Hash<String, Array<String> >
+        masters = {}
+        # Keep track of NPCs
+        # Array< [String, Integer, String] >
+        # Array< [Plugin, FormID,  NPC   ] >
+        npcs = []
+        @game.xedit.parse_csv('Modsvaskr_ExportedDumpInfo') do |row|
+          case row[1].downcase
+          when 'npc_'
+            npcs << [row[0].downcase, row[2].to_i(16), row[3]]
+          when 'tes4'
+            masters[row[0].downcase] = row[3..].map(&:downcase)
+          end
+        end
+        npcs.each do |(esp, form_id, npc_name)|
+          raise "Esp #{esp} declares NPC FormID #{form_id} (#{npc_name}) but its masters could not be parsed" unless masters.key?(esp)
+
+          # Know from which mod this ID comes from
+          mod_idx = form_id / 16_777_216
+          raise "NPC FormID #{form_id} (#{npc_name}) from #{esp} references an unknown master (known masters: #{masters[esp].join(', ')})" if mod_idx > masters[esp].size
+
+          test_name = "#{mod_idx == masters[esp].size ? esp : masters[esp][mod_idx]}/#{form_id % 16_777_216}"
+          if tests.key?(test_name)
+            # Add the name of the mod to the description, so that we know which mod modifies which NPC.
+            tests[test_name][:name] << "/#{esp}"
+          else
+            tests[test_name] = {
+              name: "Take screenshot of #{npc_name} - #{esp}"
+            }
+          end
+        end
+        tests
+      end
+
+    end
+
+  end
+
+end