kameleon-builder 2.10.12 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756d8f2585c156772b7fff190366543ed56ea250de8ecf0a9b08fa2a10ab9291
-  data.tar.gz: c0d8a7a73a6eeb8d436711811744c674f71c76fb71d1f2f724476a0aa1f441a8
+  metadata.gz: 8a474581cf9237053d9e97441871d3cfec86a5670aec656c05dfd93d699b6098
+  data.tar.gz: 4636916224c68d8637a71dd427975698669d11f7ca6ec9511ece3931853d33a8
 SHA512:
-  metadata.gz: 28dba475cc7f55acfe066a245cfc62e14962dacb933541b4df5c90bf78ae9c505f11561b0ec094feaf586cc6b2b85ce8b7c04da9a43ec0eee06652cb38507769
-  data.tar.gz: 5584616d421ffb8586ed25bbd1a20d4784077802231efba67d6777eef1f1a8a9b808b132a3093682979dc3f7b58c835515c1705ca084d8f8bc3eab7c02ca03da
+  metadata.gz: 27159883626026bdb00254119ea6428eba91c1cf0bc0dd30dbb3af3ded154aee855ef4d4b780a901f84e7c2563874446f0a2ca4951d5b12eedb416c5085cac67
+  data.tar.gz: ab15e8247297ece98afa80cfe50ba9b8d53da227ca120a8613e729fbc03749b1e22a5a095d10b130023eb837fb582741e4a6f7c04f3d7cc0406e833ce1ad0a43

data/CHANGES

@@ -1,6 +1,30 @@
 Kameleon CHANGELOG
 ==================
 
+Version 2.10.14 → 2.11.0
+------------------------
+
+Released on May 4th 2025
+
+- Enable command aliases in the definition of checkpoint actions.
+- Enable command aliases with no args.
+- Fix dependencies to progressbar and ruby-graphviz (the "ruby-" prefix matters!).
+- Fix terminal width issue with latest Thor.
+- Fix graphviz and progress bar dependencies.
+- Rework README.rst and the documentation front page.
+- Some other minor changes.
+
+Version 2.10.13
+---------------
+
+Released on March 26th 2025
+
+- Drop useless contrib directory.
+- Rework gem summary and description.
+- Update gem dependencies for gem install on Debian 11 and 13.
+- Adapt sources to Ruby 3.1 - Psych's YAML: explicitly use YAML.unsafe_load.
+- Add git to requirements, need for kameleon repo commands.
+
 Version 2.10.12
 ---------------
 

data/COPYING

@@ -55,7 +55,7 @@ patent must be licensed for everyone's free use or not licensed at all.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
-
+
 		    GNU GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
@@ -110,7 +110,7 @@ above, provided that you also meet all of these conditions:
     License.  (Exception: if the Program itself is interactive but
     does not normally print such an announcement, your work based on
     the Program is not required to print an announcement.)
-
+
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
@@ -168,7 +168,7 @@ access to copy from a designated place, then offering equivalent
 access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
-
+
   4. You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
@@ -225,7 +225,7 @@ impose that choice.
 
 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
-
+
   8. If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
@@ -278,7 +278,7 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
 		     END OF TERMS AND CONDITIONS
-
+
 	    How to Apply These Terms to Your New Programs
 
   If you develop a new program, and you want it to be of the greatest

data/README.rst

@@ -1,11 +1,26 @@
 Kameleon appliance builder
 ==========================
 
-Kameleon is a simple but powerful tool to generate customized appliances. With
-Kameleon, you make your recipe that describes how to create step by step your
-own distribution. At start Kameleon is used to create custom kvm, LXC,
-VirtualBox, iso images, ..., but as it is designed to be very generic you can
-probably do a lot more than that.
+Kameleon is a simple but powerful tool to generate customized operating system
+images, based on traceable recipes.
+
+Thanks to Kameleon, one can write recipes that describe how to create, step by
+step, customized operating systems in any desired target format, and then cook
+them (build them), just like GNU make cooks sources using a Makefile to build
+binary programs.
+
+For instance, Kameleon can create custom operating system images for QEMU/KVM,
+VirtualBox, docker, LXC or bootable ISO. It can support creating such images
+for any machine architecture (x86, ARM64, PPC64, ... ).
+
+In fact, since the Kameleon engine by itself is very generic by design, a lot
+more can be done, because most of the specialization happens in the recipes,
+written in Kameleon's powerful recipe language (YAML based DSL).
+
+Kameleon was initially developed to improve reproducibility in computer science
+and engineering, providing a tool that achieves complete *reconstructability*
+of system images with cache, checkpointing and interactive breakpoint
+mechanisms.
 
 * Latest documentation: http://kameleon.imag.fr/getting_started.html
 * Source code and issue tracker: https://github.com/oar-team/kameleon

data/RELEASING.md

@@ -11,21 +11,23 @@ Assuming work is done in the devel branch.
 For stable releases:
 --------------------
 
-## Merge devel into master:
+## Switch and update the master branch
 ```
-git checkout master
-git merge devel
+git switch master
+git pull -r
 ```
+Do whatever changes needed in the code (possibly merging a branch or a pull request).
+Commit.
 
-## Fix anything needed
-Should be no conflict but...
-Make sure changelog is up to date.
+## Update changelog
+Edit the `CHANGES` file.
+Commit.
 
 ## Bump version
-***Warning*** Make sure that there is no dirty file (not committed) before the following.
+Edit the `lib/kameleon/version.rb` file and bump the version.
+Commit:
 ```
-./scripts/bumpversion.py release  # will do 2.7.0.dev -> 2.7.0 + git tag + changelog
-git push
+git commit -m "v2.10.16 → v.2.10.17" lib/kameleon/version.rb
 ```
 
 ## Build gem
@@ -33,9 +35,28 @@ git push
 gem build kameleon-builder.gemspec
 ```
 
+## Test
+Manually install:
+```
+gem install --user ./kameleon-builder-2.10.17.gem
+```
+Test, test, test.
+
+## Tag
+If everything is ok, tag:
+```
+git tag -s 'v2.10.17' -m 'v2.10.17'
+```
+
+## Push git push
+```
+git push
+```
+
+
 ## Push to Ruby gem repository
 ```
-  gem push kameleon-builder-2.7.0.gem
+gem push kameleon-builder-2.10.17.gem
 ```
 
 Note: You need a rubygem account and the owner has to give you permissions so that you can push.
@@ -43,27 +64,23 @@ To do so, create an account on https://rubygems.org/ and ask an owner to do
 the following command::
 
 ```
-  gem owner kameleon-builder -a your@email.com
+gem owner kameleon-builder -a your@email.com
 ```
 
 That's all :)
 
-For devel releases:
--------------------
-
-## Move to the devel branch and rebase on master
+## In case a release is buggy
+Yank it to remove it from the rubygems index.
 ```
-git checkout devel
-git rebase master
+gem yank kameleon-builder -v 2.10.16
 ```
 
-## Prepare the new version 
-Create the new devel version (e.g. 2.7.0 dev)
+For developments:
+-----------------
+
+Changes can be tested by locally installing the gem after building it:
 ```
-  ./scripts/bumpversion.py newversion patch  # 2.6.7 -> 2.7.0.dev
+gem build kameleon-builder.gemspec && gem install --user ./kameleon-builder-2.10.17.gem
 ```
 
-At this point, do work, commit, and so on.
-And same as above to build "devel" gem and use them locally, or push them if really wanted.
-
-Up to the time to build a new stable version.
+Using git branches, github pull requests, aso, is of course good.

data/completion/kameleon.bash

@@ -1,5 +1,3 @@
-#!/usr/bin/env bash
-
 _kameleon() {
     COMPREPLY=()
     local i=1

data/erb/extend.yaml.erb

@@ -6,7 +6,7 @@
 #
 #==============================================================================
 # This recipe extends another. To look at the step involed, run:
-#   kameleon dryrun <%= recipe_name %>
+#   kameleon build --dryrun <%= recipe_name %>
 # To see the variables that you can override, use the following command:
 #   kameleon info <%= recipe_name %>
 ---

data/kameleon-builder.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'kameleon/version'
 
@@ -17,8 +18,8 @@ Gem::Specification.new do |s|
                      'camilo1729@gmail.com',
                      'pierre.neyron@imag.fr',
                      'bruno.bzeznik@imag.fr']
-  s.description   = %q{The mindful appliance builder}
-  s.summary       = %q{Kameleon is a tool to build system appliances from scratch}
+  s.summary       = 'The mindful appliance builder'
+  s.description   = 'Kameleon is a tool to build system appliances, possibly from scratch'
   s.homepage      = 'http://kameleon.imag.fr/'
   s.license       = 'GPL-2.0-or-later'
 
@@ -28,12 +29,13 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(tests|s|features)/})
   s.require_paths = ['lib']
 
-  s.add_dependency 'childprocess', '~> 0.5.3', '>= 0.3.0'
-  s.add_dependency 'thor', '~> 1'
-  s.add_dependency 'table_print', '~> 1.5'
-  s.add_dependency 'psych', '~> 2.0'
+  s.add_dependency 'childprocess', '~> 4.0'
+  s.add_dependency 'progressbar', '~> 1.10'
+  s.add_dependency 'psych', '~> 5.0'
   s.add_dependency 'ruby-graphviz', '~> 1.2'
-  s.add_dependency 'progressbar', '~> 1'
+  s.add_dependency 'table_print', '~> 1.5'
+  s.add_dependency 'thor', '~> 1.0'
 
-  s.requirements = ['polipo 1.0.3, or greater', 'graphviz 2.38.0 or greater']
+  s.requirements << 'git'
+  s.requirements << 'graphviz'
 end

data/lib/kameleon/cli.rb

@@ -2,7 +2,7 @@ require 'kameleon/engine'
 require 'kameleon/recipe'
 require 'kameleon/utils'
 require 'tempfile'
-require 'graphviz'
+require 'graphviz' # ruby-graphviz gem (GraphViz class), not the graphviz gem (Graphviz module)
 
 module Kameleon
 
@@ -157,7 +157,7 @@ module Kameleon
     class_option :verbose, :type => :boolean, :default => Kameleon.default_values[:verbose],
                  :desc => "Enable verbose output for kameleon users"
     class_option :debug, :type => :boolean, :default => Kameleon.default_values[:debug],
-                 :desc => "Enable debug output for kameleon developpers"
+                 :desc => "Enable debug output for kameleon developers"
     class_option :script, :type => :boolean, :default => Kameleon.default_values[:script],
                  :desc => "Never prompt for user intervention",
                  :aliases => "-s"

data/lib/kameleon/engine.rb

@@ -675,7 +675,7 @@ module Kameleon
 
     def load_build_recipe
       if File.file?(@build_recipe_path)
-        result = YAML.load_file(@build_recipe_path)
+        result = YAML.unsafe_load_file(@build_recipe_path)
         return result if result
       end
       return nil

data/lib/kameleon/persistent_cache.rb

@@ -258,7 +258,7 @@ module Kameleon
         end
         ## We have to load the file
         metadata_dir = File.join(@cache_dir,"metadata")
-        @cmd_cached = YAML.load(File.read("#{metadata_dir}/cache_cmd_index"))
+        @cmd_cached = YAML.unsafe_load(File.read("#{metadata_dir}/cache_cmd_index"))
       end
       @activated = true
       #@cached_recipe_dir = @cache_dir

data/lib/kameleon/recipe.rb

@@ -93,7 +93,7 @@ module Kameleon
       Kameleon.ui.verbose("Loading #{@path}")
       fail RecipeError, "Could not find this following recipe: #{@path}" \
          unless File.file? @path
-      yaml_recipe = YAML.load_file @path
+      yaml_recipe = YAML.unsafe_load_file @path
       unless yaml_recipe.kind_of? Hash
         fail RecipeError, "Invalid yaml: #{@path}"
       end
@@ -137,7 +137,7 @@ module Kameleon
 
       # Resolve dynamically-defined variables !!
       resolved_global = Utils.resolve_vars(@global.to_yaml, @path, @global, self, kwargs)
-      resolved_global = @global.merge YAML.load(resolved_global)
+      resolved_global = @global.merge YAML.unsafe_load(resolved_global)
       Kameleon.ui.debug("Resolved_global: #{resolved_global}")
       # Loads aliases
       load_aliases(yaml_recipe)
@@ -242,7 +242,7 @@ module Kameleon
       base_recipe_path << ".yaml" unless base_recipe_path.end_with? ".yaml"
       fail RecipeError, "Could not find this following recipe: #{@recipe_path}" \
          unless File.file? path
-      base_yaml_recipe = YAML.load_file base_recipe_path
+      base_yaml_recipe = YAML.unsafe_load_file base_recipe_path
       unless yaml_recipe.kind_of? Hash
         fail RecipeError, "Invalid yaml: #{base_yaml_recipe}"
       end
@@ -298,7 +298,7 @@ module Kameleon
       def load_global_file(global_file, recipe_path)
         def try_to_load(absolute_path)
           if File.file?(absolute_path)
-            global_to_include = YAML.load_file(absolute_path)
+            global_to_include = YAML.unsafe_load_file(absolute_path)
             if global_to_include.kind_of? Hash
               @step_files.push(absolute_path)
               return global_to_include
@@ -376,7 +376,7 @@ module Kameleon
           path = Pathname.new(File.join(dir_path, aliases_file))
           if File.file?(path)
             Kameleon.ui.verbose("Loading aliases #{path}")
-            @aliases.merge!(YAML.load_file(path))
+            @aliases.merge!(YAML.unsafe_load_file(path))
             @step_files.push(path)
             return path
           end
@@ -439,7 +439,7 @@ module Kameleon
             path = Pathname.new(File.join(dir_path, checkpoint))
             if File.file?(path)
               Kameleon.ui.verbose("Loading checkpoint configuration #{path}")
-              @checkpoint = YAML.load_file(path)
+              @checkpoint = YAML.unsafe_load_file(path)
               @checkpoint["path"] = path.to_s
               @step_files.push(path)
               break
@@ -461,7 +461,7 @@ module Kameleon
         macrostep_yaml = args
         step_path = @path
       else
-        macrostep_yaml = YAML.load_file(step_path)
+        macrostep_yaml = YAML.unsafe_load_file(step_path)
         # Basic macrostep syntax check
         if not macrostep_yaml.kind_of? Array
           fail RecipeError, "The macrostep #{step_path} is not valid "
@@ -550,7 +550,7 @@ module Kameleon
       end
       # Resolve dynamically-defined variables !!
       resolved_global = Utils.resolve_vars(@global.to_yaml, @path, @global, self, kwargs)
-      @global.merge! YAML.load(resolved_global)
+      @global.merge! YAML.unsafe_load(resolved_global)
 
       consistency_check
       resolve_checkpoint unless @checkpoint.nil?
@@ -637,6 +637,9 @@ module Kameleon
 
     def resolve_checkpoint()
       (@checkpoint.keys - ["path"]).each do |key|
+        @checkpoint[key].map! do |cmd|
+          resolve_alias(cmd)
+        end.flatten!
         @checkpoint[key].each do |cmd|
           cmd.string_cmd = Utils.resolve_vars(cmd.string_cmd,
                                               @checkpoint["path"],
@@ -648,32 +651,34 @@ module Kameleon
 
     def resolve_alias(cmd)
       name = cmd.key
-      if @aliases.keys.include?(name) 
+      if @aliases.keys.include?(name)
         Kameleon.ui.debug("Resolving alias '#{name}'")
         aliases_cmd = @aliases.fetch(name).clone
         aliases_cmd_str = aliases_cmd.to_yaml
-        args = YAML.load(cmd.string_cmd)[name]
-        args = [].push(args).flatten  # convert args to array
+        yaml = YAML.unsafe_load(cmd.string_cmd)
+        args = []
+        if yaml.is_a?(Hash) # if cmd is an alias with no args, yaml is a String
+          args.push(yaml[name]).flatten! # convert args to array
+        end
         expected_args_number = aliases_cmd_str.scan(/@\d+/).uniq.count
         if expected_args_number != args.count
-          if args.length == 0
-            msg = "#{name} takes no arguments (#{args.count} given)"
-          else
-            msg = "#{name} takes exactly #{expected_args_number} arguments"
-                  " (#{args.count} given)"
-          end
+          msg = if expected_args_number.zero?
+                  "#{name} takes no arguments (#{args.count} given)"
+                else
+                  "#{name} takes exactly #{expected_args_number} arguments (#{args.count} given)"
+                end
           raise RecipeError, msg
         end
         aliases_cmd.map do |c|
           nc = Command.new(c, cmd.microstep_name)
           args.each_with_index do |arg, i|
-            nc.gsub!("@#{i+1}", arg)
+            nc.gsub!("@#{i + 1}", arg)
           end
           resolve_alias(nc)
-        end 
-      elsif cmd.value.kind_of?(Array)
+        end
+      elsif cmd.value.is_a?(Array)
         Kameleon.ui.debug("Search for aliases in the sub-commands of '#{name}'")
-        cmd.value.map!{ |cmd| resolve_alias(cmd) }.flatten!
+        cmd.value.map! { |c| resolve_alias(c) }.flatten!
         cmd.remaster_string_cmd_from_value!
       else
         Kameleon.ui.debug("Leaf command '#{name}' is not an alias")

data/lib/kameleon/step.rb

@@ -23,7 +23,7 @@ module Kameleon
 
     def key
       if @key.nil?
-        object = YAML.load(@string_cmd)
+        object = YAML.unsafe_load(@string_cmd)
         if object.kind_of? String
           @key = object
         else
@@ -40,7 +40,7 @@ module Kameleon
     def value
       if @value.nil?
         Kameleon.ui.debug("Parsed string = #{@string_cmd}")
-        object = YAML.load(@string_cmd)
+        object = YAML.unsafe_load(@string_cmd)
         if object.kind_of? Command
           @value = object
         elsif object.kind_of? String
@@ -192,7 +192,7 @@ module Kameleon
                                            @path,
                                            tmp_resolved_vars.merge(global),
                                            recipe)
-        tmp_resolved_vars.merge! YAML.load(yaml_resolved.chomp)
+        tmp_resolved_vars.merge! YAML.unsafe_load(yaml_resolved.chomp)
       end
       @variables.merge! tmp_resolved_vars
       @microsteps.each do |m|

data/lib/kameleon/ui.rb

@@ -139,7 +139,7 @@ module Kameleon
         spaces ? text.gsub(/#{spaces}/, '') : text
       end
 
-      def word_wrap(text, line_width = @shell.terminal_width)
+      def word_wrap(text, line_width = Thor::Shell::Terminal.terminal_width)
         strip_leading_spaces(text).split("\n").collect do |line|
           line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
         end * "\n"

data/lib/kameleon/utils.rb

@@ -1,3 +1,8 @@
+# The progressbar and ruby-progressbar gems are the same code from
+# https://github.com/jfelchner/ruby-progressbar/tree/master
+# Only the lib head file is named progressbar.rb vs. ruby-progressbar.rb.
+# The progressbar gem is the one packaged as ruby-progressbar in Debian.
+# Using that one (see gemspec) and require "progressbar" not "ruby-progessbar".
 require 'progressbar'
 
 module Kameleon
@@ -158,7 +163,7 @@ module Kameleon
       end
       unless recipes_hash.empty?
         name_width = recipes_hash.map { |k| k['name'].size }.max
-        desc_width = Kameleon.ui.shell.terminal_width - name_width - 3
+        desc_width = Thor::Shell::Terminal.terminal_width - name_width - 3
         desc_width = (80 - name_width - 3) if desc_width < 0
       end
       repo_str_old = nil
@@ -180,7 +185,7 @@ module Kameleon
         if r["description"].to_s.length > desc_width - 4
           r["description"] = r["description"][0..(desc_width - 4)] + "..."
         end
-        Kameleon.ui.shell.say sprintf("%-#{desc_width}s", r["description"]), :blue
+        Kameleon.ui.shell.say r["description"], :blue
       end
     end
 

data/lib/kameleon/version.rb

@@ -1,3 +1,3 @@
 module Kameleon
-  VERSION = '2.10.12'
+  VERSION = '2.11.0'
 end

data/lib/kameleon.rb

@@ -61,7 +61,7 @@ module Kameleon
 
     def load_userconf
       if File.exist?(Kameleon.userconf_path) and not File.zero?(Kameleon.userconf_path)
-        yaml_conf = YAML.load_file Kameleon.userconf_path
+        yaml_conf = YAML.unsafe_load_file Kameleon.userconf_path
         unless yaml_conf.kind_of? Hash
           yaml_conf = {}
         end