RHELMISC-4745: Add ability to bring up previous session

Author: Jedoku

lib/all.rb

@@ -59,6 +59,7 @@ module AutoHCK
   autoload_relative :PhysHCK, 'setupmanagers/physhck/physhck'
   autoload_relative :Playlist, 'engines/hcktest/playlist'
   autoload_relative :Project, 'project'
+  autoload_relative :Session, 'session'
   autoload_relative :QemuHCK, 'setupmanagers/qemuhck/qemuhck'
   autoload_relative :QemuHCKError, 'setupmanagers/qemuhck/exceptions'
   autoload_relative :QemuMachine, 'setupmanagers/qemuhck/qemu_machine'

lib/cli.rb

@@ -4,7 +4,8 @@
 module AutoHCK
   # class CLI
   class CLI
-    attr_reader :common, :install, :test, :mode
+    attr_reader :install, :mode
+    attr_accessor :common, :test
 
     def initialize
       @common = CommonOptions.new
@@ -20,8 +21,15 @@ def initialize
     end
 
     # class CommonOptions
-    class CommonOptions
-      attr_accessor :verbose, :config, :client_world_net, :id, :share_on_host_path, :workspace_path
+    class CommonOptions < T::Struct
+      include T::Sig
+
+      prop :verbose, T::Boolean, default: false
+      prop :config, T.nilable(String)
+      prop :client_world_net, T::Boolean, default: false
+      prop :id, T.nilable(Integer), default: 2
+      prop :share_on_host_path, T.nilable(String)
+      prop :workspace_path, T.nilable(String)
 
       def create_parser(sub_parser)
         OptionParser.new do |parser|
@@ -40,12 +48,6 @@ def create_parser(sub_parser)
 
       # rubocop:disable Metrics/MethodLength
       def define_options(parser)
-        @verbose = false
-        @config = nil
-        @client_world_net = false
-        @id = 2
-        @share_on_host_path = nil
-
         parser.on('--share-on-host-path <path>', String,
                   'For using Transfer Network specify the directory to share on host machine') do |share_on_host_path|
           @share_on_host_path = share_on_host_path
@@ -77,15 +79,30 @@ def define_options(parser)
                   'Internal use only',
                   &method(:workspace_path=))
       end
-      # rubocop:enable Metrics/MethodLength
     end
 
     # class TestOptions
-    class TestOptions
-      attr_accessor :platform, :drivers, :driver_path, :commit, :svvp, :dump,
-                    :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
+    class TestOptions < T::Struct
+      include T::Sig
+
+      prop :platform, T.nilable(String)
+      prop :drivers, T.nilable(T::Array[String])
+      prop :driver_path, T.nilable(String)
+      prop :commit, T.nilable(String)
+      prop :svvp, T.nilable(T::Boolean)
+      prop :dump, T.nilable(T::Boolean)
+      prop :gthb_context_prefix, T.nilable(String)
+      prop :gthb_context_suffix, T.nilable(String)
+      prop :playlist, T.nilable(String)
+      prop :select_test_names, T.nilable(String)
+      prop :reject_test_names, T.nilable(String)
+      prop :reject_report_sections, T.nilable(T::Array[String]), default: []
+      prop :boot_device, T.nilable(String)
+      prop :allow_test_duplication, T.nilable(T::Boolean)
+      prop :manual, T.nilable(T::Boolean)
+      prop :package_with_playlist, T.nilable(T::Boolean)
+      prop :session, T.nilable(String)
+      prop :latest_session, T.nilable(T::Boolean)
 
       def create_parser
         OptionParser.new do |parser|
@@ -99,8 +116,7 @@ def create_parser
         end
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      def define_options(parser)
+      def define_options(parser) # rubocop:disable Metrics/AbcSize
         @reject_report_sections = []
 
         parser.on('-p', '--platform <platform_name>', String,
@@ -179,13 +195,28 @@ def define_options(parser)
         parser.on('--package-with-playlist', TrueClass,
                   'Load playlist into HLKX project package',
                   &method(:package_with_playlist=))
+
+        parser.on('--session <path>', String,
+                  'Load session from workspace',
+                  &method(:session=))
+
+        parser.on('--latest-session', TrueClass,
+                  'Load previous session',
+                  &method(:latest_session=))
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength
     end
 
     # class InstallOptions
-    class InstallOptions
-      attr_accessor :platform, :force, :skip_client, :drivers, :driver_path, :debug
+    class InstallOptions < T::Struct
+      include T::Sig
+
+      prop :platform, T.nilable(String)
+      prop :force, T::Boolean, default: false
+      prop :skip_client, T::Boolean, default: false
+      prop :drivers, T::Array[String], default: []
+      prop :driver_path, T.nilable(String)
+      prop :debug, T::Boolean, default: false
 
       def create_parser
         OptionParser.new do |parser|
@@ -199,13 +230,7 @@ def create_parser
         end
       end
 
-      # rubocop:disable Metrics/MethodLength
       def define_options(parser)
-        @force = false
-        @skip_client = false
-        @drivers = []
-        @debug = false
-
         parser.on('--debug', TrueClass, 'Enable debug mode',
                   &method(:debug=))
 
@@ -229,13 +254,18 @@ def define_options(parser)
                   'Path to the location of the driver wanted to be installed',
                   &method(:driver_path=))
       end
-      # rubocop:enable Metrics/MethodLength
     end
 
     def parse(args)
       left = @parser.order(args)
       @mode = left.shift
       @sub_parser[@mode]&.order!(left) unless @mode.nil?
+
+      restore_session if @test.latest_session || @test.session
+    end
+
+    def restore_session
+      AutoHCK::Session.load(self)
     end
   end
 end

lib/engines/hcktest/hcktest.rb

@@ -160,13 +160,13 @@ def run_clients_post_start_host_commands
     end
 
     def configure_and_synchronize_clients
-      run_only = @project.options.test.manual && @project.options.test.driver_path.nil?
+      run_only = @project.restored || (@project.options.test.manual && @project.options.test.driver_path.nil?)
 
       @clients.each_value do |client|
         client.configure(run_only:)
       end
 
-      run_clients_post_start_host_commands
+      run_clients_post_start_host_commands unless @project.restored
       @clients.each_value(&:synchronize)
     end
 
@@ -183,7 +183,7 @@ def run_clients_and_configure_setup(scope, **opts)
       retries = 0
       begin
         scope.transaction do |tmp_scope|
-          run_clients tmp_scope, keep_alive: true, **opts
+          run_clients tmp_scope, keep_alive: true, **opts, **restored_options
 
           configure_setup_and_synchronize
         end
@@ -245,9 +245,16 @@ def prepare_tests
       @test_list = @tests.list_tests(log: true)
     end
 
+    def restored_options
+      {
+        boot_from_snapshot: @project.restored,
+        restored: @project.restored
+      }
+    end
+
     def auto_run
       ResourceScope.open do |scope|
-        run_studio scope
+        run_studio(scope, create_snapshot: !@project.restored, **restored_options)
         sleep 5 until @studio.up?
 
         run_tests_without_config
@@ -274,7 +281,7 @@ def run_tests_with_config
         next if tests.empty?
 
         ResourceScope.open do |scope|
-          run_clients_and_configure_setup(scope, group => true, create_snapshot: false, boot_from_snapshot: true)
+          run_clients_and_configure_setup(scope, create_snapshot: false, group => true)
 
           @logger.info("Clients ready, running #{group} tests")
           @tests.run(tests)
@@ -295,8 +302,8 @@ def group_tests_by_config
       grouped_tests
     end
 
-    def run
-      upload_driver_package unless @driver_path.nil?
+    def run # rubocop:disable Metrics/AbcSize
+      upload_driver_package unless @driver_path.nil? || @project.restored
 
       if @project.options.test.dump
         @project.logger.info('AutoHCK started in dump only mode')

lib/models.rb

@@ -11,6 +11,7 @@ module Models
     autoload_relative :HCKTestConfig, 'models/hcktest_config'
     autoload_relative :JsonHelper, 'models/json_helper'
     autoload_relative :SVVPConfig, 'models/svvp_config'
+    autoload_relative :Session, 'models/session'
     autoload_relative :QemuHCKDevice, 'models/qemuhck_device'
   end
 end

lib/models/session.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+module AutoHCK
+  module Models
+    class Session < T::Struct
+      extend T::Sig
+      extend JsonHelper
+
+      const :test, AutoHCK::CLI::TestOptions
+      const :common, AutoHCK::CLI::CommonOptions
+    end
+  end
+end

lib/project.rb

@@ -9,7 +9,7 @@ class Project
     attr_reader :config, :logger, :timestamp, :setup_manager, :engine, :id,
                 :workspace_path, :github, :result_uploader, :engine_tag,
                 :engine_platform, :engine_type, :options, :extra_sw_manager,
-                :run_terminated
+                :run_terminated, :restored
 
     def initialize(scope, options)
       @scope = scope
@@ -146,11 +146,24 @@ def check_run_termination
     end
 
     def init_workspace
+      @restored = @options.test.session
       unless @options.common.workspace_path.nil?
         @workspace_path = @options.common.workspace_path
         return
       end
 
+      if @restored
+        restore_session
+      else
+        create_workspace
+        save_session
+        add_latest_symlink
+      end
+
+      @setup_manager_type&.enter @workspace_path
+    end
+
+    def create_workspace
       @workspace_path = File.join(@config['workspace_path'],
                                   @engine_name,
                                   @engine_tag,
@@ -161,15 +174,28 @@ def init_workspace
         @logger.warn('Workspace path already exists')
       end
       @logger.info("Workspace path: #{@workspace_path}")
+    end
+
+    def restore_session
+      @workspace_path = @options.test.session
 
+      raise AutoHCKError, 'Workspace path does not exist could not load session' unless File.directory?(@workspace_path)
+
+      @logger.info("Loading session from #{@workspace_path}")
+    end
+
+    def save_session
+      Session.save(@workspace_path, @options)
+    end
+
+    def add_latest_symlink
       begin
         File.delete("#{@config['workspace_path']}/latest")
       rescue Errno::ENOENT
         # firts run, no symlink to delete
       end
 
       File.symlink(@workspace_path, "#{@config['workspace_path']}/latest")
-      @setup_manager_type&.enter @workspace_path
     end
 
     def handle_cancel

lib/session.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/AbcSize,Lint/MissingCopEnableDirective
+
+module AutoHCK
+  class Session
+    extend T::Sig
+    include Helper
+
+    def self.save(workspace_path, options)
+      File.write("#{workspace_path}/session.json", compose_session_json(options, workspace_path))
+    end
+
+    def self.load(cli)
+      session = Models::Session.from_json_file("#{session_path(cli)}/session.json")
+
+      session.common.workspace_path = cli.common.workspace_path
+      session.test.latest_session = cli.test.latest_session
+      session.test.session = cli.test.session
+
+      cli.test = session.test
+      cli.common = session.common
+
+      cli.test.manual = true
+    end
+
+    def self.session_path(cli)
+      cli.test.latest_session ? "#{Config.read['workspace_path']}/latest" : cli.test.session
+    end
+
+    private_class_method def self.compose_session_json(options, workspace_path)
+      session = AutoHCK::Models::Session.new(
+        test: options.test,
+        common: options.common
+      )
+      session.common.workspace_path = workspace_path
+      session.serialize.to_json
+    end
+  end
+end

lib/setupmanagers/hckclient.rb

@@ -150,8 +150,8 @@ def prepare_machine
     def configure(run_only: false)
       @tools = @studio.tools
       @cooldown_thread = Thread.new do
-        unless pool == @project.engine_tag
-          return_when_client_up
+        if @project.restored || pool != @project.engine_tag
+          return_when_client_up unless @project.restored
           if run_only
             @logger.info("Preparing client skipped #{@name}...")
 

lib/setupmanagers/hckstudio.rb

@@ -80,6 +80,8 @@ def configure(clients)
       connect
       verify_tools
       update_filters
+      return if @project.restored
+
       create_pool
       create_project
     end

lib/setupmanagers/qemuhck/qemu_machine.rb

@@ -154,7 +154,8 @@ def close
       boot_from_snapshot: false,
       attach_iso_list: [],
       dump_only: false,
-      secure: false
+      secure: false,
+      restored: false
     }.freeze
 
     MACHINE_JSON = 'lib/setupmanagers/qemuhck/machine.json'
@@ -689,7 +690,7 @@ def run(scope, run_opts = nil)
         dump_commands
       else
         unless @configured
-          run_config_commands
+          run_config_commands unless @run_opts[:restored]
           @configured = true
         end