Implement extensions mechanism and add HCKTrace

docs/Test-config-behavior.md

@@ -67,3 +67,5 @@ Guest run command can use the following replacements:
 - `@client_name@` - Client name
 - `@run_number@` - The current run number of a test that is executed multiple times
 - `@<driver_short_name>.driver_dir@` - Path to uploaded driver binary
+- `@driver_short_name@` - Short name of driver (defined only in case of one driver is in test)
+- `@driver_dir@` - Path to uploaded driver binary (defined only in case of one driver is in test)

lib/cli.rb

@@ -96,7 +96,7 @@ class TestOptions
                     :gthb_context_prefix, :gthb_context_suffix, :playlist, :select_test_names,
                     :reject_test_names, :reject_report_sections, :boot_device,
                     :allow_test_duplication, :manual, :package_with_playlist, :enable_vbs, :tag_suffix,
-                    :fs_test_image_format
+                    :fs_test_image_format, :extensions
 
       def create_parser
         OptionParser.new do |parser|
@@ -113,6 +113,7 @@ def create_parser
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def define_options(parser)
         @reject_report_sections = []
+        @extensions = []
         @svvp = false
         @enable_vbs = false
 
@@ -205,6 +206,10 @@ def define_options(parser)
                   'Filesystem test image format (qcow2/raw). Default is qcow2.',
                   'Has effect only when testing storage drivers.',
                   &method(:fs_test_image_format=))
+
+        parser.on('--extensions <extensions_list>', Array,
+                  'List of extensions for run test',
+                  &method(:extensions=))
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
     end

lib/engines/hckinstall/hckinstall.rb

@@ -241,16 +241,7 @@ def run_second(client:)
       end
     end
 
-    def prepare_setup_scripts_config
-      kit_type, kit_version = parse_kit_info
-
-      config = {
-        kit_type:,
-        hlk_kit_ver: kit_version,
-        debug: @project.options.install.debug,
-        no_reboot_after_bugcheck: @project.options.install.no_reboot_after_bugcheck
-      }
-
+    def prepare_kit_installer(kit_type, kit_version)
       @kit_path = find_kit(kit_type, kit_version)
 
       if @kit_path.nil?
@@ -267,7 +258,20 @@ def prepare_setup_scripts_config
       @kit_is_iso = @kit_path.end_with?('.iso')
 
       @logger.info("HLK installer #{kit_type}#{kit_version} was found at #{@kit_path}")
+    end
+
+    def prepare_setup_scripts_config
+      kit_type, kit_version = parse_kit_info
+
+      options_install = @project.options.install
+      config = {
+        kit_type:,
+        hlk_kit_ver: kit_version,
+        debug: options_install.debug,
+        no_reboot_after_bugcheck: options_install.no_reboot_after_bugcheck
+      }
 
+      prepare_kit_installer(kit_type, kit_version)
       create_setup_scripts_config(@hck_setup_scripts_path, config)
     end
 

lib/engines/hcktest/extensions/hcktrace.json

@@ -0,0 +1,39 @@
+{
+  "extra_software": [
+    "hcktrace"
+  ],
+  "post_start_commands": [
+    {
+      "desc": "Configure HCKTrace service for driver tracing",
+      "guest_run": "Start-Process -Wait -FilePath hcktrace.exe -ArgumentList driver,@driver_short_name@,@driver_dir@,4"
+    }
+  ],
+  "tests_config": [
+    {
+      "tests": [
+        ".*"
+      ],
+      "pre_test_commands": [
+        {
+          "desc": "Start HCKTrace recording",
+          "guest_run": "Start-Process -Wait -FilePath hcktrace.exe -ArgumentList test,@safe_test_name@"
+        }
+      ],
+      "post_test_commands": [
+        {
+          "desc": "Stop HCKTrace recording",
+          "guest_run": "Start-Process -Wait -FilePath hcktrace.exe -ArgumentList test,end",
+          "files_action": [
+            {
+              "remote_path": "C:/hcktrace/zip",
+              "local_path": "@workspace@/trace-@safe_test_name@-@client_name@-@run_number@",
+              "direction": "remote-to-local",
+              "move": true,
+              "allow_missing": true
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

lib/engines/hcktest/hcktest.rb

@@ -8,11 +8,12 @@ class HCKTest
     extend T::Sig
     include Helper
 
-    attr_reader :config, :drivers, :platform
+    attr_reader :config, :drivers, :platform, :extensions
 
     PLATFORMS_JSON_DIR = 'lib/engines/hcktest/platforms'
     CONFIG_JSON = 'lib/engines/hcktest/hcktest.json'
     DRIVERS_JSON_DIR = 'lib/engines/hcktest/drivers'
+    EXTENSIONS_JSON_DIR = 'lib/engines/hcktest/extensions'
     SVVP_JSON = 'svvp.json'
     ENGINE_MODE = 'test'
     AUTOHCK_RETRIES = 5
@@ -24,6 +25,7 @@ def initialize(project)
       @config = Models::HCKTestConfig.from_json_file(CONFIG_JSON, @logger)
       @driver_path = @project.options.test.driver_path
       @drivers = find_drivers
+      @extensions = find_extensions
       prepare_extra_sw
       validate_paths unless @driver_path.nil?
     end
@@ -33,18 +35,13 @@ def test_steps
     end
 
     def prepare_extra_sw
-      @drivers.each do |driver|
-        next if driver.extra_software.nil?
-
-        @project.extra_sw_manager.prepare_software_packages(
-          driver.extra_software, @project.engine_platform['kit'], ENGINE_MODE
-        )
-      end
-
-      return if @project.engine_platform['extra_software'].nil?
+      extra_softwares = []
+      extra_softwares += @drivers.flat_map(&:extra_software)
+      extra_softwares += @extensions.flat_map(&:extra_software)
+      extra_softwares += @project.engine_platform['extra_software'] || []
 
       @project.extra_sw_manager.prepare_software_packages(
-        @platform['extra_software'], @platform['kit'], ENGINE_MODE
+        extra_softwares, @project.engine_platform['kit'], ENGINE_MODE
       )
     end
 
@@ -105,6 +102,14 @@ def find_drivers
       end
     end
 
+    sig { returns(T::Array[Models::Extension]) }
+    def find_extensions
+      @project.options.test.extensions.map do |ext_name|
+        @logger.info("Loading extension: #{ext_name}")
+        Models::Extension.from_json_file("#{EXTENSIONS_JSON_DIR}/#{ext_name}.json", @logger)
+      end
+    end
+
     def target
       if @project.options.test.svvp
         {
@@ -159,6 +164,7 @@ def run_clients(scope, run_opts = {})
 
     def post_start_commands
       (@drivers.flat_map(&:post_start_commands) +
+       @extensions.flat_map(&:post_start_commands) +
         @project.setup_manager.client_post_start_commands).select(&:host_run)
     end
 
@@ -305,7 +311,9 @@ def run_tests_with_config
     def group_tests_by_config
       grouped_tests = { secure: [] }
 
-      tests_config = @config.tests_config + @drivers.flat_map(&:tests_config)
+      tests_config = @config.tests_config +
+                     @drivers.flat_map(&:tests_config) +
+                     @extensions.flat_map(&:tests_config)
 
       tests_config.each do |test_group|
         selected_tests = @test_list.select { |test| test_group.tests.include?(test.name) }

lib/engines/hcktest/tests.rb

@@ -167,10 +167,14 @@ def wait_queued_test(id)
       end
     end
 
-    def select_test_config(test_name, config)
-      tests_config = @project.engine.config.tests_config + @project.engine.drivers.flat_map(&:tests_config)
+    def all_tests_configs
+      @project.engine.config.tests_config +
+        @project.engine.drivers.flat_map(&:tests_config) +
+        @project.engine.extensions.flat_map(&:tests_config)
+    end
 
-      tests_config
+    def select_test_config(test_name, config)
+      all_tests_configs
         .select { |test_config| Regexp.union(test_config.tests.map { Regexp.new(_1) }).match?(test_name) }
         .flat_map(&config)
     end

lib/models.rb

@@ -7,6 +7,7 @@ module Models
     autoload_relative :CommandInfo, 'models/command_info'
     autoload_relative :DriverInstallMethods, 'models/driver_install_methods'
     autoload_relative :Driver, 'models/driver'
+    autoload_relative :Extension, 'models/extension'
     autoload_relative :Kit, 'models/kit'
     autoload_relative :TestConfig, 'models/test_config'
     autoload_relative :HCKTestConfig, 'models/hcktest_config'

lib/models/driver.rb

@@ -27,7 +27,7 @@ class Driver < T::Struct
       const :enlightenments_state, T.nilable(T::Boolean)
 
       const :post_start_commands, T::Array[CommandInfo], default: []
-      const :extra_software, T.nilable(T::Array[String])
+      const :extra_software, T::Array[String], default: []
       const :reject_test_names, T.nilable(T::Array[String])
       const :select_test_names, T.nilable(T::Array[String])
       const :tests_config, T::Array[TestConfig], default: []

lib/models/extension.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+module AutoHCK
+  module Models
+    class Extension < T::Struct
+      extend T::Sig
+      extend JsonHelper
+
+      prop :short, T.nilable(String)
+
+      const :extra_software, T::Array[String], default: []
+      const :post_start_commands, T::Array[CommandInfo], default: []
+      const :tests_config, T::Array[TestConfig], default: []
+    end
+  end
+end

lib/setupmanagers/hckclient.rb

@@ -76,6 +76,7 @@ def set_machine_ready
 
     def post_start_commands
       (@project.engine.drivers.flat_map(&:post_start_commands) +
+       @project.engine.extensions.flat_map(&:post_start_commands) +
         @setup_manager.client_post_start_commands).select(&:guest_run)
     end
 
@@ -107,16 +108,26 @@ def install_driver(driver)
                                             force_install_cert: driver.install_cert)
     end
 
+    def insert_driver_replacement(driver, one_driver, replacement)
+      client_replacement = replacement.transform_keys { |k| k.dup.insert(1, "#{driver.short}.") }
+      @replacement_map.merge!(client_replacement)
+      @replacement_map.merge!({ '@driver_short_name@' => driver.short })
+
+      # If there is only one driver, we can use generic keys without driver short name.
+      @replacement_map.merge!(replacement) if one_driver
+    end
+
     def install_drivers
+      one_driver = @project.engine.drivers.one?
+
       @project.engine.drivers&.each do |driver|
         if driver.install_method == AutoHCK::Models::DriverInstallMethods::NoDrviver
           @project.logger.info("Driver installation skipped for #{driver.name} in #{@name}")
           next
         end
 
         driver_replacement = install_driver(driver)
-        client_replacement = driver_replacement.transform_keys { |k| k.dup.insert(1, "#{driver.short}.") }
-        @replacement_map.merge!(client_replacement)
+        insert_driver_replacement(driver, one_driver, driver_replacement)
       end
 
       @logger.debug("Driver replacement list: #{@replacement_map.dump_string}")