kameleon-builder 2.10.9 → 2.10.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0090f004c5c7501866feada95e6f0a402bd02b6eb3bfbbe1f3252bcc6e399f8f'
-  data.tar.gz: 6ff09a19773c76287ab9e0ef9c6aa4b49675be9e030ef195b3b53a636208add6
+  metadata.gz: 2492ad18812484a81bd0aa54360137ee497d43fcea554cd60f2d68eec3c951c7
+  data.tar.gz: 36c9ab6b6757a0930e8c3e0aec1dd69eef915d48aa1ef1f9d953fdd9b036c1d8
 SHA512:
-  metadata.gz: b075dc8cb7cb14dc4576cca16ea8f3d785d9d44e3dd75028d84b285e9c07e02e2bb40467a504801634b6bd7d315115411643288f052ca4220cfb047d0cc7b7d2
-  data.tar.gz: f3444f8b1b0b5b8ea942debad0625ff22ae890a13355131dfb41c1e3a1cd6694577b31e2598bf04aaea7041f14b97d69d8f24e7d90f2860afc803dedc7cadf27
+  metadata.gz: 703c0d4a6d43d24a3c6d455049f661a8d8eabcaad4d07168a4233acd5044f213fbc80abb4ef4074200afe98999f68a48e2ff52c07b27e6dfd40590609e08d6df
+  data.tar.gz: cc7c30c503c3e8c59c1b188adeddb63a0286367959428126b1dbcd10bd996abbe80c34e42abebb525ad6a06f107d9e4f4e1ae23ac5bc7e74645795b026dde32a

data/.bumpversion.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
 commit = True
 tag = True
-current_version = 2.10.9
+current_version = 2.10.10
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+))?
 serialize = 
 	{major}.{minor}.{patch}.{release}

data/CHANGES

@@ -1,6 +1,21 @@
 Kameleon CHANGELOG
 ==================
 
+Version 2.10.10
+--------------
+
+Released on June 13 2023
+
+- Set kameleon build --microstep-checkpoint option to "all" by default.
+- Rework the kameleon checkpoint documentation and more.
+- Rework the kameleon build options.
+- Add the on_checkpoint=only keyword, allowing a step to be run only when checkpoint is activated.
+- Add the on_checkpoint=disabled keyword, allowing a step to be never be checkpointed.
+- Add the $${checkpointing_enabled} global variable, value is "true" or "false" whether checkpointing is enabled or not.
+- Fix error in kameleon info: variable not found $${checkpointing_enabled} / $${persistent_cache}.
+- Make the context_reload command less verbose by default, and some other commands by side effects.
+- Other cosmetic fixes.
+
 Version 2.10.9
 --------------
 
@@ -372,7 +387,7 @@ Released on Oct 16th 2014
 - Handled Ctrl-C to make a breakpoint instead of quitting. (Fixed #29)
 - Stored kameleon user configuration file in ``~/.kameleon.d/config`` (Fixed #24)
 - Fixed ``kameleon new`` to take an absolute or relative path and place the recipe in a subdir (Fixed #22)
-- Moved builtin recipes to an external repository : See [http://kameleon.imag.fr/repository.html](Docs) (Fixed #24)
+- Moved builtin recipes to an external repository: See [http://kameleon.imag.fr/repository.html](Docs) (Fixed #24)
 - Renamed ``--cache`` option to ``--enable-cache``
 - Renamed ``--checkpoint`` option to ``--enable-checkpoint``
 - Removed ``kameleon import`` command
@@ -482,7 +497,7 @@ Released on July 20th 2014
 - [template] Do not run qemu with nohup (Use ``-daemonize`` instead)
 - [template] Improved context_out/in log readability
 - [template] Removed fedora-rawhide templates
-- [template] Added new templates :
+- [template] Added new templates:
 
   - qemu/archlinux-desktop-i686
   - qemu/archlinux-i686
@@ -547,7 +562,7 @@ Released on June 12th 2014
 - [core] Set the variable ``KAMELEON_WORKDIR`` for all contexts
 - [core] Used ``KAMELEON_WORKDIR`` when working with PIPE
 - [core] Added persistent cache feature to Kameleon, So far it is caching just packages comming from the network using Polipo
-- [template] Added new templates :
+- [template] Added new templates:
 
   - archlinux
   - archlinux-desktop

data/lib/kameleon/cli.rb

@@ -11,7 +11,7 @@ module Kameleon
     class Repository < Thor
       include Thor::Actions
 
-      desc "add <NAME> <GIT_URL>", "Adds a new repository named <NAME> cloned from <GIT_URL>."
+      desc "add <NAME> <GIT_URL>", "Add a new repository named <NAME> cloned from <GIT_URL>"
       method_option :branch, :type => :string,
                     :default => nil,
                     :desc => "checkout <BRANCH>",
@@ -20,7 +20,7 @@ module Kameleon
         Kameleon::Repository.add(name, url, options)
       end
 
-      desc "list", "Lists available repositories."
+      desc "list", "List available repositories"
       method_option :git, :type => :boolean,
                     :default => true,
                     :desc => "show the git repository and branch each repository comes from"
@@ -28,7 +28,7 @@ module Kameleon
         Kameleon::Repository.list(options)
       end
 
-      desc "update <NAME>", "Updates repository named <NAME> from git"
+      desc "update <NAME>", "Update repository named <NAME> from git"
       def update(name)
         Kameleon::Repository.update(name)
       end
@@ -38,7 +38,7 @@ module Kameleon
         Kameleon::Repository.remove(name)
       end
 
-      desc "commands", "Lists all available commands", :hide => true
+      desc "commands", "List all available commands", :hide => true
       def commands
         puts Repository.all_commands.keys - ["commands"]
       end
@@ -56,7 +56,7 @@ module Kameleon
         Kameleon.env.repositories_path
       end
 
-      desc "list", "Lists all available templates"
+      desc "list", "List all available templates"
       method_option :progress, :type => :boolean, :default => true,
                     :desc => "Show progress bar while resolving templates",
                     :aliases => "-p"
@@ -69,10 +69,10 @@ module Kameleon
         Utils.list_recipes(Kameleon.env.repositories_path, options[:filter], options[:progress], true)
       end
 
-      desc "import <TEMPLATE_NAME>", "Imports the given template"
+      desc "import <TEMPLATE_NAME>", "Import the given template"
       method_option :global, :type => :hash,
                     :default => {},  :aliases => "-g",
-                    :desc => "Set custom global variables."
+                    :desc => "Set custom global variables"
       def import(template_name)
         Kameleon.env.root_dir = Kameleon.env.repositories_path
         template_path = File.join(Kameleon.env.repositories_path, template_name)
@@ -104,7 +104,7 @@ module Kameleon
       desc "info <TEMPLATE_NAME>", "Display detailed information about a template"
       method_option :global, :type => :hash,
                     :default => {},  :aliases => "-g",
-                    :desc => "Set custom global variables."
+                    :desc => "Set custom global variables"
       def info(template_name)
         Kameleon.env.root_dir = Kameleon.env.repositories_path
         template_path = File.join(Kameleon.env.repositories_path, template_name)
@@ -133,7 +133,7 @@ module Kameleon
         copy_file(Pathname.new(Kameleon.erb_dirpath).join("extend.yaml.erb"), erb_file)
       end
 
-      desc "commands", "Lists all available commands", :hide => true
+      desc "commands", "List all available commands", :hide => true
       def commands
         puts Template.all_commands.keys - ["commands"]
       end
@@ -147,22 +147,22 @@ module Kameleon
   class Main < Thor
     include Thor::Actions
 
-    desc 'repository <SUBCOMMAND>', 'Manages repositories of recipes'
+    desc 'repository <SUBCOMMAND>', 'Manage repositories of recipes'
     subcommand 'repository', CLI::Repository
-    desc 'template <SUBCOMMAND>', 'Lists and imports templates'
+    desc 'template <SUBCOMMAND>', 'List and import templates'
     subcommand 'template', CLI::Template
 
     class_option :color, :type => :boolean, :default => Kameleon.default_values[:color],
-                 :desc => "Enables colorization in output"
+                 :desc => "Enable colorization in output"
     class_option :verbose, :type => :boolean, :default => Kameleon.default_values[:verbose],
-                 :desc => "Enables verbose output for kameleon users"
+                 :desc => "Enable verbose output for kameleon users"
     class_option :debug, :type => :boolean, :default => Kameleon.default_values[:debug],
-                 :desc => "Enables debug output for kameleon developpers"
+                 :desc => "Enable debug output for kameleon developpers"
     class_option :script, :type => :boolean, :default => Kameleon.default_values[:script],
-                 :desc => "Never prompts for user intervention",
+                 :desc => "Never prompt for user intervention",
                  :aliases => "-s"
 
-    desc "version", "Prints the Kameleon's version information"
+    desc "version", "Print the Kameleon's version information"
     def version
       puts "Kameleon version #{Kameleon::VERSION}"
     end
@@ -171,7 +171,7 @@ module Kameleon
       Kameleon.env.repositories_path
     end
 
-    desc "list", "Lists all defined recipes in the current directory"
+    desc "list", "List all defined recipes in the current directory"
     method_option :progress, :type => :boolean, :default => false,
                   :desc => "Show progress bar while resolving recipes",
                   :aliases => "-p"
@@ -183,10 +183,10 @@ module Kameleon
       Utils.list_recipes(Kameleon.env.workspace, options[:filter], options[:progress])
     end
 
-    desc "new <RECIPE_PATH> <TEMPLATE_NAME>", "Creates a new recipe from template <TEMPLATE_NAME>"
+    desc "new <RECIPE_PATH> <TEMPLATE_NAME>", "Create a new recipe from template <TEMPLATE_NAME>"
     method_option :global, :type => :hash,
                   :default => {},  :aliases => "-g",
-                  :desc => "Set custom global variables."
+                  :desc => "Set custom global variables"
     def new(recipe_name, template_name)
       Kameleon.env.root_dir = Kameleon.env.repositories_path
       unless template_name.end_with? '.yaml'
@@ -248,7 +248,7 @@ module Kameleon
     desc "info <RECIPE_PATH>", "Display detailed information about a recipe"
     method_option :global, :type => :hash,
                   :default => {},  :aliases => "-g",
-                  :desc => "Set custom global variables."
+                  :desc => "Set custom global variables"
     method_option :from_cache, :type => :string,
                   :default => nil,
                   :desc => "Get info from a persistent cache tar file (ignore recipe path)"
@@ -280,7 +280,7 @@ module Kameleon
     desc "dag <RECIPE_PATH> [<RECIPE_PATH> [<...>]]", "Draw a DAG of the steps to build one or more recipes"
     method_option :global, :type => :hash,
                   :default => {},  :aliases => "-g",
-                  :desc => "Set custom global variables."
+                  :desc => "Set custom global variables"
     method_option :file, :type => :string,
                   :default => "/tmp/kameleon.dag",
                   :desc => "DAG output filename"
@@ -322,7 +322,7 @@ module Kameleon
     desc "dryrun <RECIPE_PATH>", "Show the steps the build would process"
     method_option :global, :type => :hash,
                   :default => {},  :aliases => "-g",
-                  :desc => "Set custom global variables."
+                  :desc => "Set custom global variables"
     method_option :relative, :type => :boolean,
                   :default => false,
                   :desc => "Make pathnames relative to the current working directory"
@@ -337,7 +337,7 @@ module Kameleon
     desc "export <RECIPE_PATH> <EXPORT_PATH>", "Export the given recipe with its steps and data to a given directory"
     method_option :global, :type => :hash,
                   :default => {},  :aliases => "-g",
-                  :desc => "Set custom global variables."
+                  :desc => "Set custom global variables"
     method_option :add, :type => :boolean,
                   :default => false,  :aliases => "-A",
                   :desc => "export recipe and steps to an existing directory (this may overwrite some existing files)"
@@ -377,56 +377,52 @@ module Kameleon
       end
     end
 
-    desc "build <RECIPE_PATH>", "Builds the appliance from the given recipe"
+    desc "build <RECIPE_PATH>", "Build the appliance from the given recipe"
     method_option :build_path, :type => :string,
                   :default => nil, :aliases => "-b",
-                  :desc => "Sets the build directory path"
+                  :desc => "Set the build directory path"
     method_option :clean, :type => :boolean,
                   :default => false,
-                  :desc => "Runs the command `kameleon clean` first"
+                  :desc => "Run the command `kameleon clean` first"
     method_option :from_checkpoint, :type => :string,
                   :default => nil,
-                  :desc => "Uses specific checkpoint to build the image. " \
-                           "Default value is the last checkpoint."
-    method_option :enable_checkpoint, :type => :boolean,
+                  :desc => "Restart a build from a specific checkpoint, instead of the latest one"
+    method_option :enable_checkpointing, :type => :boolean, :aliases => "-c",
                   :default => false,
-                  :desc => "Enables checkpointing"
-    method_option :microstep_checkpoint, :type => :string,
+                  :desc => "Enable creating and using checkpoints"
+    method_option :microstep_checkpoints, :type => :string,
                   :enum => ["first", "all"],
-                  :default => "first",
+                  :default => "all",
                   :desc => "Create checkpoint of the first microstep only, or all"
-    method_option :list_checkpoints, :type => :boolean, :aliases => "--checkpoints",
+    method_option :list_checkpoints, :type => :boolean, :aliases => "-l",
                   :default => false,
-                  :desc => "Lists all availables checkpoints"
-    method_option :enable_cache, :type => :boolean,
+                  :desc => "List all availables checkpoints"
+    method_option :enable_cache, :type => :boolean, :aliases => "-C",
                   :default => false,
-                  :desc => "Generates a persistent cache for the appliance."
+                  :desc => "Generate a persistent cache for the appliance"
     method_option :cache_path, :type => :string,
                   :default => nil,
-                  :desc => "Sets the cache directory path"
+                  :desc => "Set the cache directory path"
     method_option :from_cache, :type => :string,
                   :default => nil,
-                  :desc => "Uses a persistent cache tar file to build the image."
+                  :desc => "Use a persistent cache tar file to build the image"
     method_option :cache_archive_compression, :type => :string,
                   :enum => ["none", "gzip", "bz2", "xz"],
                   :default => "gzip",
-                  :desc => "Set the persistent cache tar file compression."
+                  :desc => "Set the persistent cache tar file compression"
     method_option :polipo_path, :type => :string,
                   :default => nil,
-                  :desc => "Full path of the polipo binary to use for the persistent cache."
+                  :desc => "Full path of the polipo binary to use for the persistent cache"
     method_option :proxy, :type => :string, :default => "",
-                  :desc => "Specifies the hostname and port number of an HTTP " \
-                           "proxy; it should have the form 'host:port'"
+                  :desc => "HTTP proxy address and port (expected format is hostname:port)"
     method_option :proxy_credentials, :type => :string, :default => "",
-                  :desc => "Specifies the username and password if the parent "\
-                           "proxy requires authorisation it should have the "\
-                           "form 'username:password'"
+                  :desc => "Username and password if required by the parent proxy (expected format is username:password)"
     method_option :proxy_offline, :type => :boolean,
-                  :default => false, :aliases => "--offline",
-                  :desc => "Prevents Polipo from contacting remote servers"
+                  :default => false,
+                  :desc => "Prevent Polipo from contacting remote servers"
     method_option :global, :type => :hash,
                   :default => {}, :aliases => "-g",
-                  :desc => "Set custom global variables."
+                  :desc => "Set custom global variables"
     def build(recipe_path=nil)
       if recipe_path.nil? && !options[:from_cache].nil?
         unless File.file?(options[:from_cache])
@@ -458,11 +454,11 @@ module Kameleon
         total_time = Time.now.to_i - start_time
         Kameleon.ui.info("")
         Kameleon.ui.info("Successfully built '#{recipe_path}'")
-        Kameleon.ui.info("Total duration : #{total_time} secs")
+        Kameleon.ui.info("Total duration: #{total_time} secs")
       end
     end
 
-    desc "commands", "Lists all available commands", :hide => true
+    desc "commands", "List all available commands", :hide => true
     def commands(context="main")
       Kameleon.ui.debug("Commands for '#{context}':")
       case context
@@ -475,7 +471,7 @@ module Kameleon
       end
     end
 
-    desc "source_root", "Prints the kameleon directory path", :hide => true
+    desc "source_root", "Print the kameleon directory path", :hide => true
     def source_root
       puts Kameleon.source_root
     end

data/lib/kameleon/context.rb

@@ -79,7 +79,7 @@ module Kameleon
         do_log(out, log_level) unless out.nil?
         do_log(err, "error") unless err.nil?
       end
-      Kameleon.ui.verbose("Exit status : #{exit_status}")
+      Kameleon.ui.verbose("Exit status: #{exit_status}")
       fail ExecError unless exit_status.eql? 0
     rescue ShellError, Errno::EPIPE  => e
       Kameleon.ui.verbose("Shell cmd failed to launch: #{@shell.shell_cmd}")

data/lib/kameleon/engine.rb

@@ -17,6 +17,7 @@ module Kameleon
       @cwd = @recipe.global["kameleon_cwd"]
       @build_recipe_path = File.join(@cwd, ".build_recipe")
 
+      @recipe.global["checkpointing_enabled"] = @options[:enable_checkpointing] ? "true" : "false"
       @recipe.global["persistent_cache"] = @options[:enable_cache] ? "true" : "false"
 
       build_recipe = load_build_recipe
@@ -26,11 +27,11 @@ module Kameleon
           @recipe.global[key] = build_recipe["global"][key]
         end
       end
-      @enable_checkpoint = @options[:enable_checkpoint]
-      @enable_checkpoint = true unless @options[:from_checkpoint].nil?
-      @microstep_checkpoint = @options[:microstep_checkpoint]
+      @checkpointing = @options[:enable_checkpointing]
+      @checkpointing = true unless @options[:from_checkpoint].nil?
+      @microstep_checkpoint = @options[:microstep_checkpoints]
       # Check if the recipe have checkpoint entry
-      if @enable_checkpoint && @recipe.checkpoint.nil?
+      if @checkpointing && @recipe.checkpoint.nil?
         fail BuildError, "Checkpoint is unavailable for this recipe"
       end
 
@@ -78,7 +79,7 @@ module Kameleon
       end
       unless @options[:no_create_build_dir]
         begin
-          Kameleon.ui.info("Creating kameleon build directory : #{@cwd}")
+          Kameleon.ui.info("Creating kameleon build directory: #{@cwd}")
           FileUtils.mkdir_p @cwd
         rescue
           raise BuildError, "Failed to create build directory #{@cwd}"
@@ -145,7 +146,7 @@ module Kameleon
 
     def create_checkpoint(microstep_id)
       @recipe.checkpoint["create"].each do |cmd|
-        safe_exec_cmd(cmd.dup.gsub!("@microstep_id", microstep_id))
+        safe_exec_cmd(cmd.dup.gsub!("@microstep_id", microstep_id), :log_level => "warn")
       end
     end
 
@@ -202,15 +203,15 @@ module Kameleon
         macrostep.sequence do |microstep|
           microstep_time = Time.now.to_i
           microstep_checkpoint_duration = 0
-          step_prefix = "Step #{ microstep.order } : "
+          step_prefix = "Step #{ microstep.order }: "
           Kameleon.ui.info("#{step_prefix}#{ microstep.slug }")
-          if @enable_checkpoint
+          if @checkpointing
             if microstep.on_checkpoint == "skip"
-              Kameleon.ui.msg("--> Skipped")
+              Kameleon.ui.msg("--> Skipped because checkpointing is enabled")
               next
             end
-            if microstep.in_cache && microstep.on_checkpoint == "use_cache"
-              Kameleon.ui.msg("--> Using checkpoint")
+            if microstep.in_cache and microstep.on_checkpoint != "redo"
+              Kameleon.ui.msg("--> Checkpoint ahead, do nothing")
             else
               begin
               Kameleon.ui.msg("--> Running the step...")
@@ -221,29 +222,38 @@ module Kameleon
                 reload_contexts
                 breakpoint(nil)
               end
-              unless microstep.on_checkpoint == "redo"
-                unless checkpointed and @microstep_checkpoint == "first"
-                  if checkpoint_enabled?
-                    microstep_checkpoint_time = Time.now.to_i
-                    Kameleon.ui.msg("--> Creating checkpoint : #{ microstep.identifier }")
-                    create_checkpoint(microstep.identifier)
-                    checkpointed = true
-                    microstep_checkpoint_duration = Time.now.to_i - microstep_checkpoint_time
-                    macrostep_checkpoint_duration += microstep_checkpoint_duration
-                    Kameleon.ui.verbose("Checkpoint creation for MicroStep #{microstep.name} took: #{microstep_checkpoint_duration} secs")
-                  end
+              if checkpoint_enabled?
+                if (@microstep_checkpoint == "first" and checkpointed)
+                  Kameleon.ui.msg("--> Do not create a checkpoint for this microstep: macrostep was already checkpointed once")
+                elsif microstep.on_checkpoint == "redo"
+                  Kameleon.ui.msg("--> Do not create a checkpoint for this microstep: it must be redone everytime")
+                elsif microstep.on_checkpoint == "disabled"
+                  Kameleon.ui.msg("--> Do not create a checkpoint for this microstep: it is disabled")
+                else
+                  microstep_checkpoint_time = Time.now.to_i
+                  Kameleon.ui.msg("--> Creating checkpoint: #{ microstep.identifier }")
+                  create_checkpoint(microstep.identifier)
+                  checkpointed = true
+                  microstep_checkpoint_duration = Time.now.to_i - microstep_checkpoint_time
+                  macrostep_checkpoint_duration += microstep_checkpoint_duration
+                  Kameleon.ui.verbose("Checkpoint creation for MicroStep #{microstep.name} took: #{microstep_checkpoint_duration} secs")
                 end
               end
             end
           else
-            begin
-            Kameleon.ui.msg("--> Running the step...")
-            microstep.commands.each do |cmd|
-              safe_exec_cmd(cmd)
-            end
-            rescue SystemExit, Interrupt
-              reload_contexts
-              breakpoint(nil)
+            if microstep.on_checkpoint == "only"
+              Kameleon.ui.msg("--> Skipped because checkpointing is not enabled")
+              next
+            else
+              begin
+              Kameleon.ui.msg("--> Running the step...")
+              microstep.commands.each do |cmd|
+                safe_exec_cmd(cmd)
+              end
+              rescue SystemExit, Interrupt
+                reload_contexts
+                breakpoint(nil)
+              end
             end
           end
           Kameleon.ui.verbose("MicroStep #{microstep.name} took: #{Time.now.to_i - microstep_time - microstep_checkpoint_duration} secs")
@@ -278,7 +288,7 @@ module Kameleon
         context = "exec_" + cmd.value
         expected_names = map.keys.map { |k| k.gsub "exec_", "" }
         unless map.keys.include? context
-          Kameleon.ui.error("Invalid context name arguments. Expected : "\
+          Kameleon.ui.error("Invalid context name arguments. Expected: "\
                            "#{expected_names}")
           fail ExecError
         else
@@ -296,7 +306,7 @@ module Kameleon
         execute = true
         [first_cmd.key, second_cmd.key].each do |key|
           unless expected_cmds.include?(key)
-            Kameleon.ui.error("Invalid pipe arguments. Expected : "\
+            Kameleon.ui.error("Invalid pipe arguments. Expected: "\
                               "#{expected_cmds}")
             fail ExecError
           end
@@ -349,7 +359,7 @@ module Kameleon
            exec_cmd(cmd, kwargs)
          end
       else
-        Kameleon.ui.warn("Unknown command : #{cmd.key}")
+        Kameleon.ui.warn("Unknown command: #{cmd.key}")
       end
     end
 
@@ -407,7 +417,7 @@ module Kameleon
     end
 
     def rescue_exec_error(cmd)
-      message = "Error occured when executing the following command :\n"
+      message = "Error occured when executing the following command:\n"
       cmd.string_cmd.split( /\r?\n/ ).each {|m| message << "\n> #{m}" }
       if Kameleon.env.script?
         raise ExecError, message
@@ -423,7 +433,7 @@ module Kameleon
           begin
             exec_cmd(cmd, kwargs)
           rescue
-            Kameleon.ui.warn("An error occurred while executing : #{cmd.value}")
+            Kameleon.ui.warn("An error occurred while executing: #{cmd.value}")
           end
         end
       end
@@ -431,16 +441,20 @@ module Kameleon
         next if @cleaned_sections.include?(section.name)
         Kameleon.ui.info("Cleaning #{section.name} section")
         section.clean_macrostep.sequence do |microstep|
-          if @enable_checkpoint
+          if @checkpointing
             if microstep.on_checkpoint == "skip"
               next
             end
+          else
+            if microstep.on_checkpoint == "only"
+              next
+            end
           end
           microstep.commands.each do |cmd|
             begin
               exec_cmd(cmd, kwargs)
             rescue
-              Kameleon.ui.warn("An error occurred while executing : #{cmd.value}")
+              Kameleon.ui.warn("An error occurred while executing: #{cmd.value}")
             end
           end
         end
@@ -555,19 +569,19 @@ module Kameleon
     end
 
     def build
-      if @enable_checkpoint
+      if @checkpointing
         @from_checkpoint = @options[:from_checkpoint]
         if @from_checkpoint.nil? || @from_checkpoint == "last"
           @from_checkpoint = list_checkpoints.last
         else
           unless list_checkpoints.include?@from_checkpoint
-            fail BuildError, "Unknown checkpoint hash : #{@from_checkpoint}." \
+            fail BuildError, "Unknown checkpoint hash: #{@from_checkpoint}." \
                              " Use checkpoints command to find a valid" \
                              " checkpoint"
           end
         end
         unless @from_checkpoint.nil?
-          Kameleon.ui.info("Restoring last build from step : #{@from_checkpoint}")
+          Kameleon.ui.info("Restoring last build from step: #{@from_checkpoint}")
           apply_checkpoint @from_checkpoint
           @recipe.microsteps.each do |microstep|
             microstep.in_cache = true

data/lib/kameleon/recipe.rb

@@ -46,6 +46,8 @@ module Kameleon
         "proxy_local" => "",
         "proxy_out" => "",
         "proxy_in" => "",
+        "checkpointing_enabled" => "false",
+        "persistent_cache" => "false",
       }
       @aliases = {}
       @checkpoint = nil
@@ -89,7 +91,7 @@ module Kameleon
     def load!(kwargs = {})
       # Find recipe path
       Kameleon.ui.verbose("Loading #{@path}")
-      fail RecipeError, "Could not find this following recipe : #{@path}" \
+      fail RecipeError, "Could not find this following recipe: #{@path}" \
          unless File.file? @path
       yaml_recipe = YAML.load_file @path
       unless yaml_recipe.kind_of? Hash
@@ -238,7 +240,7 @@ module Kameleon
       update_steps_dirs()
 
       base_recipe_path << ".yaml" unless base_recipe_path.end_with? ".yaml"
-      fail RecipeError, "Could not find this following recipe : #{@recipe_path}" \
+      fail RecipeError, "Could not find this following recipe: #{@recipe_path}" \
          unless File.file? path
       base_yaml_recipe = YAML.load_file base_recipe_path
       unless yaml_recipe.kind_of? Hash
@@ -556,7 +558,7 @@ module Kameleon
       Kameleon.ui.verbose("Resolving aliases")
       @sections.values.each do |section|
         section.macrosteps.each do |macrostep|
-          # First pass : resolve aliases
+          # First pass: resolve aliases
           Kameleon.ui.debug("Resolving aliases for macrostep '#{macrostep.name}'")
           macrostep.microsteps.each do |microstep|
             microstep.commands.map! do |cmd|
@@ -577,7 +579,7 @@ module Kameleon
 
       @sections.values.each do |section|
         section.macrosteps.each do |macrostep|
-          # Second pass : resolve variables + clean/init hooks
+          # Second pass: resolve variables + clean/init hooks
           macrostep.microsteps.each do |microstep|
             microstep.commands.map! do |cmd|
               resolve_hooks(cmd, macrostep, microstep)
@@ -730,7 +732,7 @@ module Kameleon
             end
           end
         end
-        fail RecipeError, "Invalid command : '#{cmd.key}'"
+        fail RecipeError, "Invalid command: '#{cmd.key}'"
       else
         return cmd
       end

data/lib/kameleon/shell.rb

@@ -296,10 +296,10 @@ SCRIPT
     def fork(io)
       if io.eql? "interactive"
         command = ["bash", "-c", @interactive_shell_cmd]
-        Kameleon.ui.info("Starting interactive command: #{@interactive_shell_cmd.inspect}")
+        Kameleon.ui.verbose("Starting interactive command: #{@interactive_shell_cmd.inspect}")
       else
         command = ["bash", "-c", @shell_cmd]
-        Kameleon.ui.info("Starting command: #{@cmd.inspect}")
+        Kameleon.ui.verbose("Starting command: #{@cmd.inspect}")
       end
       Kameleon.ui.debug("Starting shell process: #{ command.inspect}")
       ChildProcess.posix_spawn = true

data/lib/kameleon/step.rb

@@ -33,7 +33,7 @@ module Kameleon
       @key
     rescue
       lines = @string_cmd.split( /\r?\n/ ).map {|l| "> #{l}" }
-      fail RecipeError, "Syntax error for microstep #{@microstep_name} : \n"\
+      fail RecipeError, "Syntax error for microstep #{@microstep_name}: \n"\
                         "#{ lines.join "\n"}"
     end
 

data/lib/kameleon/utils.rb

@@ -6,7 +6,7 @@ module Kameleon
     @@warned_vars = Array.new
     def self.warn_var(var)
       if ! @@warned_vars.include?(var)
-        Kameleon.ui.warn("Warning : variable $$#{var[0]} is not enclosed with braces, which may cause errors. Please prefer using $${#{var[0]}}.")
+        Kameleon.ui.warn("Warning: variable $$#{var[0]} is not enclosed with braces, which may cause errors. Please prefer using $${#{var[0]}}.")
         @@warned_vars.push(var)
       end
     end

data/lib/kameleon/version.rb

@@ -1,3 +1,3 @@
 module Kameleon
-  VERSION = '2.10.9'
+  VERSION = '2.10.10'
 end

data/tests/recipes/test_recipe_checkpoints.yaml

@@ -0,0 +1,75 @@
+#===============================================================================
+# vim: softtabstop=2 shiftwidth=2 expandtab fenc=utf-8 cc=81 tw=80
+#===============================================================================
+#
+# DESCRIPTION: This is a test recipe made for unit testing
+#
+#===============================================================================
+---
+# Loads some helpful aliases
+extend: ../test2/test2.yaml
+aliases: defaults.yaml
+checkpoint: test.yaml
+#== Global variables use by Kameleon engine and the steps
+global:
+
+  include_steps:
+    - $${distrib}
+
+  ## User varibales : used by the recipe
+  user_name: kameleon_user
+  user_password: $${user_name}
+
+  # test overload
+  toto: $${toto} tata
+
+  # Distribution
+  distrib: linux
+
+  ## System variables. Required by kameleon engine
+  # Include specific steps
+  include_steps:
+    - $${distrib}
+
+  bootstrap_packages: >
+    less vim python
+    sl sudo
+
+  version: 12.2
+  variant: toto-tata
+
+  uuid: $${kameleon_uuid}
+
+  appliance_filename: $${kameleon_recipe_name}_$${kameleon_short_uuid}
+
+#== Bootstrap the new system and create the 'in_context'
+bootstrap:
+
+setup:
+  - MA:
+    - MA1:
+      - on_checkpoint: redo
+      - exec_local: echo "MicroStepA1 ($${checkpointing_enabled}, $${persistent_cache})"
+  - MB:
+    - MB1:
+      - exec_local: echo MicroStepB1; cp; echo coucou
+    - MB2:
+      - on_checkpoint: skip
+      - exec_local: echo MicroStepB2
+    - MB3:
+      - exec_local: echo MicroStepB3
+  - MC:
+    - MC1:
+      - exec_local: echo MicroStepC1
+    - MC2:
+      - on_checkpoint: only
+      - exec_local: echo MicroStepC2
+    - MC3:
+      - exec_local: echo MicroStepC3
+  - MD:
+    - MD1:
+      - on_checkpoint: use_cache
+      - exec_local: echo MicroStepD1
+
+
+export:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kameleon-builder
 version: !ruby/object:Gem::Version
-  version: 2.10.9
+  version: 2.10.10
 platform: ruby
 authors:
 - Salem Harrache
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -207,6 +207,7 @@ files:
 - tests/recipes/steps/setup/linux/software_install.yaml
 - tests/recipes/steps/test_uuid_step.yaml
 - tests/recipes/test_recipe.yaml
+- tests/recipes/test_recipe_checkpoints.yaml
 - tests/recipes/test_recipe_child.yaml
 - tests/test2/steps/data/mydata.txt
 - tests/test2/test2.yaml
@@ -257,6 +258,7 @@ test_files:
 - tests/recipes/steps/setup/linux/software_install.yaml
 - tests/recipes/steps/test_uuid_step.yaml
 - tests/recipes/test_recipe.yaml
+- tests/recipes/test_recipe_checkpoints.yaml
 - tests/recipes/test_recipe_child.yaml
 - tests/test2/steps/data/mydata.txt
 - tests/test2/test2.yaml