Add unit test, using factorio-unit-test system

Author: tburrows13

scripts/remote.lua

@@ -1,10 +1,19 @@
 remote.add_interface("factory-search", {
+  ---@param player LuaPlayer
+  ---@param state SearchGuiState
+  set_search_state = function(player, state)
+    SearchGui.open(player, storage.players[player.index])
+    local player_data = storage.players[player.index]
+    local refs = player_data.refs
+    SearchGui.set_state(refs, state)
+  end,
+
   ---@param player LuaPlayer
   ---@param search_value SignalID
   search = function(player, search_value)
     SearchGui.open(player, storage.players[player.index])
     local player_data = storage.players[player.index]
     player_data.refs.item_select.elem_value = search_value
-    SearchGui.start_search(player, player_data)
+    SearchGui.start_search_immediate(player, player_data)
   end
 })

scripts/search-gui.lua

@@ -343,7 +343,7 @@ end
 function SearchGui.show_search_progress(refs, progress)
   refs.searching_label.visible = true
   refs.search_progressbar.visible = progress ~= nil
-  
+
   if progress ~= nil then
     refs.search_progressbar.value = progress
     refs.search_progressbar.tooltip = {'', math.floor(progress * 100), '%'}
@@ -758,6 +758,23 @@ local function generate_state(refs)
   }
 end
 
+---@param refs SearchGuiRefs
+---@param state SearchGuiState
+function SearchGui.set_state(refs, state)
+  refs.all_qualities.state = state.all_qualities or refs.all_qualities.state
+  refs.all_surfaces.state = state.all_surfaces or refs.all_surfaces.state
+  refs.include_consumers.state = state.consumers or refs.include_consumers.state
+  refs.include_machines.state = state.producers or refs.include_machines.state
+  refs.include_inventories.state = state.storage or refs.include_inventories.state
+  refs.include_logistics.state = state.logistics or refs.include_logistics.state
+  refs.include_modules.state = state.modules or refs.include_modules.state
+  refs.include_requesters.state = state.requesters or refs.include_requesters.state
+  refs.include_ground_items.state = state.ground_items or refs.include_ground_items.state
+  refs.include_entities.state = state.entities or refs.include_entities.state
+  refs.include_signals.state = state.signals or refs.include_signals.state
+  refs.include_map_tags.state = state.map_tags or refs.include_map_tags.state
+end
+
 ---@param state SearchGuiState
 ---@return boolean
 local function is_valid_state(state)
@@ -796,6 +813,7 @@ function SearchGui.start_search(player, player_data, _, _, immediate)
       else
         SearchGui.build_results({}, {}, refs.result_flow)
       end
+      if immediate then Search.on_tick() end
     else
       SearchGui.build_invalid_state(refs.result_flow)
       storage.current_searches[player.index] = nil

scripts/search.lua

@@ -819,7 +819,7 @@ function Search.blocking_search(force, state, target_item, surface_list, type_li
   storage.current_searches[player.index] = nil
 end
 
-function on_tick()
+function Search.on_tick()
   local player_index, search_data = next(storage.current_searches)
   if not player_index or not search_data then return end
 
@@ -1079,7 +1079,7 @@ function Search.find_machines(target_item, force, state, player, immediate)
   end
   search_data = {
     blocking = not non_blocking_search,
-    tick_triggered = game.tick - (immediate and DEBOUNCE_TICKS or 0),
+    tick_triggered = immediate and -10000 or game.tick,
     force = force,
     state = state,
     target_item = target_item,
@@ -1098,7 +1098,7 @@ function Search.find_machines(target_item, force, state, player, immediate)
 end
 
 Search.events = {
-  [defines.events.on_tick] = on_tick,
+  [defines.events.on_tick] = Search.on_tick,
 }
 
 return Search

unit-test-config.jsonnet

@@ -0,0 +1,42 @@
+{
+    defaultSettings: {},
+    configurations:
+    {
+        "Vanilla (Blocking)":
+        {
+            "runtime-global": {
+                startup: {
+                    "fs-non-blocking-search": false,
+                },
+            },
+            mods: [
+                "FactorySearch",
+            ],
+        },
+        /*"Vanilla (Non-blocking)":
+        {
+            "runtime-global": {
+                startup: {
+                    "fs-non-blocking-search": true,
+                },
+            },
+            mods: [
+                "FactorySearch",
+            ],
+        },
+        "Space Age":
+        {
+            settings: {},
+            mods: [
+                "FactorySearch",
+                "space-age",
+                "elevated-rails",
+                "quality",
+            ],
+        },*/
+    },
+    tests:
+    {
+        "test-search": {},
+    }
+}

unit-tests/test-search.lua

@@ -0,0 +1,78 @@
+local unit_test_functions = require("unit-test-functions")
+
+local LOG = unit_test_functions.print_msg
+local SUCCESS = unit_test_functions.test_successful
+local FAIL = unit_test_functions.test_failed
+local INVALID = unit_test_functions.test_invalid
+local ASSERT = unit_test_functions.assert
+local ASSERT_EQUAL = unit_test_functions.assert_equal
+
+local test_search = function(tick)
+  LOG("Unit testing mod configuration:")
+  for mod_name, mod_version in pairs(script.active_mods) do
+    LOG(mod_name .. " version " .. mod_version)
+  end
+
+  -- Setup
+  local player = game.get_player(1)  ---@cast player -?
+  player.exit_cutscene()
+
+  local surface = player.surface
+
+  --surface.clear(true)
+  local chest = surface.create_entity{
+    name = "steel-chest",
+    position = {5, 5},
+    force = player.force,
+  }  ---@cast chest -?
+
+  chest.insert({name = "iron-plate", count = 100})
+
+  -- Run test
+
+  remote.call("factory-search", "set_search_state", player,
+  ---@diagnostic disable-next-line: missing-fields
+  {
+    all_qualities = true,
+    all_surfaces = true,
+    consumers = false,
+    producers = false,
+    storage = true,
+    logistics = false,
+    modules = false,
+    requesters = false,
+    ground_items = false,
+    entities = false,
+    signals = false,
+    map_tags = false,
+  })
+  remote.call("factory-search", "search", player, {name = "iron-plate"})
+
+  -- Check result
+  local search_frame = player.gui.screen["fs_frame"]
+  local results_flow = search_frame
+    .children[2]  -- inside_shallow_frame
+      .children[2]  -- horizontal flow
+        .children[2]  -- scroll pane
+          .children[1]  -- vertical flow
+            .children[2]  -- result_flow
+
+  local surface_counts_flow = results_flow.children[1]  -- [2] when include_surface_name
+  local item_count_label = surface_counts_flow.children[1]
+  ASSERT(item_count_label.caption[5] == "100", "Item count label does not show the correct number of items.")
+
+  local results_table = results_flow
+    .children[2]  -- vertical frame (slot_button_deep_frame) ([3] when include_surface_name)
+      .children[3]  -- table (storage results)
+
+  ASSERT(#results_table.children == 1, "No results found in search table, test failed.")
+  local result_button = results_table.children[1]
+  ASSERT(result_button.sprite == "entity/steel-chest", "Result button does not have the correct sprite.")
+  ASSERT(result_button.number == 1, "Result button does not have the correct number of items.")
+  ASSERT(result_button.tags.position.x == 5.5 and result_button.tags.position.y == 5.5,
+         "Result button does not have the correct position tags.")
+  ASSERT(result_button.tags.surface == surface.name, "Result button does not have the correct surface tag.")
+  return SUCCESS
+end
+
+return {test_search = test_search}