kameleon-builder 2.10.13 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98949549d6db81a6e1f992d047d98cb1996422a1fafd974395983511f1a0fac0
-  data.tar.gz: 238e4bacb28a1061fb8ea65477949013357619501b40ceb28784e44feea51b26
+  metadata.gz: 8a474581cf9237053d9e97441871d3cfec86a5670aec656c05dfd93d699b6098
+  data.tar.gz: 4636916224c68d8637a71dd427975698669d11f7ca6ec9511ece3931853d33a8
 SHA512:
-  metadata.gz: 9d44ab789cd681b54a6db3b7377e52e6ba66acc76391a02397f87df1d1b33f66492a454eb3902bbf76aba8a07041000803001ca1cff7448b0d0d8a7260780671
-  data.tar.gz: 448f0ebb4d031e99f11edbf8608628c24698a17f1da187557c6695fef21c8038d3b83ba9bb6727e30fd2fef568236d4d51efffbc7a121db7b4368ca7eafa4db4
+  metadata.gz: 27159883626026bdb00254119ea6428eba91c1cf0bc0dd30dbb3af3ded154aee855ef4d4b780a901f84e7c2563874446f0a2ca4951d5b12eedb416c5085cac67
+  data.tar.gz: ab15e8247297ece98afa80cfe50ba9b8d53da227ca120a8613e729fbc03749b1e22a5a095d10b130023eb837fb582741e4a6f7c04f3d7cc0406e833ce1ad0a43

data/CHANGES

@@ -1,6 +1,19 @@
 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
 ---------------
 

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/kameleon-builder.gemspec

@@ -30,9 +30,9 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   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 'ruby-progressbar', '~> 1.10'
   s.add_dependency 'table_print', '~> 1.5'
   s.add_dependency 'thor', '~> 1.0'
 

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/recipe.rb

@@ -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.unsafe_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/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.13'
+  VERSION = '2.11.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kameleon-builder
 version: !ruby/object:Gem::Version
-  version: 2.10.13
+  version: 2.11.0
 platform: ruby
 authors:
 - Salem Harrache
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -29,47 +29,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: psych
+  name: progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: ruby-graphviz
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: ruby-progressbar
+  name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: table_print
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".bumpversion.cfg"
 - ".editorconfig"
 - ".env"
 - ".gitignore"
@@ -148,7 +147,6 @@ files:
 - lib/kameleon/utils.rb
 - lib/kameleon/version.rb
 - lib64
-- scripts/bumpversion.py
 - tests/helper.rb
 - tests/issue76/fail.stdout
 - tests/issue76/fail.yaml

data/.bumpversion.cfg

@@ -1,16 +0,0 @@
-[bumpversion]
-commit = True
-tag = True
-current_version = 2.10.13
-parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+))?
-serialize = 
-	{major}.{minor}.{patch}.{release}
-	{major}.{minor}.{patch}
-
-[bumpversion:file:lib/kameleon/version.rb]
-
-[bumpversion:part:release]
-optional_value = gamma
-values = 
-	dev
-	gamma

data/scripts/bumpversion.py

@@ -1,184 +0,0 @@
-#!/usr/bin/env python
-# coding: utf-8
-from __future__ import unicode_literals, print_function
-import os
-import re
-
-from io import open
-import datetime
-import subprocess
-
-from argparse import RawTextHelpFormatter, ArgumentParser, FileType
-
-
-def generate_changelog_title(version):
-    version_title = "Version %s" % version
-    return version_title + "\n" + "-" * len(version_title)
-
-
-def get_release_date():
-    dt = datetime.date.today()
-    if 4 <= dt.day <= 20 or 24 <= dt.day <= 30:
-        suffix = "th"
-    else:
-        suffix = ["st", "nd", "rd"][dt.day % 10 - 1]
-    return dt.strftime("%%B %%d%s %%Y" % suffix)
-
-
-def bump_release_version(args):
-    """Automated software release workflow
-
-  * Bumps the release version number (with .bumpversion.cfg)
-  * Preloads the correct changelog template for editing
-  * Builds a source distribution
-  * Sets release date
-  * Tags the release
-
-You can run it like::
-
-    $ python bumpversion.py
-
-which will create a 'release' version (Eg. 0.7.2-dev => 0.7.2).
-
-    """
-    # Dry run 'bumpversion' to find out what the new version number
-    # would be. Useful side effect: exits if the working directory is not
-    # clean.
-    changelog = args.changelog.name
-    bumpver = subprocess.check_output(
-        ['bumpversion', 'release', '--dry-run', '--verbose'],
-        stderr=subprocess.STDOUT)
-    m = re.search(r'Parsing version \'(\d+\.\d+\.\d+)\.dev\'', bumpver)
-    current_version = m.groups(0)[0] + ".dev"
-    m = re.search(r'New version will be \'(\d+\.\d+\.\d+)\'', bumpver)
-    release_version = m.groups(0)[0]
-
-    date = get_release_date()
-
-    current_version_title = generate_changelog_title(current_version)
-    release_version_title = generate_changelog_title(release_version)
-    changes = ""
-    with open(changelog) as fd:
-        changes += fd.read()
-
-    changes = changes.replace(current_version_title, release_version_title)\
-                     .replace("**unreleased**", "Released on %s" % date)
-
-    with open(changelog, "w") as fd:
-            fd.write(changes)
-
-    # Tries to load the EDITOR environment variable, else falls back to vim
-    editor = os.environ.get('EDITOR', 'vim')
-    os.system("{} {}".format(editor, changelog))
-
-    subprocess.check_output(['gem', 'build', 'kameleon-builder.gemspec'])
-
-    # Have to add it so it will be part of the commit
-    subprocess.check_output(['git', 'add', changelog])
-    subprocess.check_output(
-        ['git', 'commit', '-m', 'Changelog for {}'.format(release_version)])
-
-    # Really run bumpver to set the new release and tag
-    bv_args = ['bumpversion', 'release']
-
-    bv_args += ['--new-version', release_version]
-
-    subprocess.check_output(bv_args)
-
-
-def bump_new_version(args):
-    """Increment the version number to the next development version
-
-  * Bumps the development version number (with .bumpversion.cfg)
-  * Preloads the correct changelog template for editing
-
-You can run it like::
-
-    $ python bumpversion.py newversion
-
-which, by default, will create a 'patch' dev version (0.0.1 => 0.0.2-dev).
-
-You can also specify a patch level (patch, minor, major) to change to::
-
-    $ python bumpversion.py newversion major
-
-which will create a 'major' release (0.0.2 => 1.0.0-dev)."""
-    pass
-    # Dry run 'bumpversion' to find out what the new version number
-    # would be. Useful side effect: exits if the working directory is not
-    # clean.
-    changelog = args.changelog.name
-    part = args.part
-    bumpver = subprocess.check_output(
-        ['bumpversion', part, '--dry-run', '--verbose'],
-        stderr=subprocess.STDOUT)
-    m = re.search(r'Parsing version \'(\d+\.\d+\.\d+)\'', bumpver)
-    current_version = m.groups(0)[0]
-    m = re.search(r'New version will be \'(\d+\.\d+\.\d+)\.dev\'', bumpver)
-    next_version = m.groups(0)[0] + ".dev"
-
-    current_version_title = generate_changelog_title(current_version)
-    next_version_title = generate_changelog_title(next_version)
-
-    next_release_template = "%s\n\n**unreleased**\n\n" % next_version_title
-
-    changes = ""
-    with open(changelog) as fd:
-        changes += fd.read()
-
-    changes = changes.replace(current_version_title,
-                              next_release_template + current_version_title)
-
-    with open(changelog, "w") as fd:
-            fd.write(changes)
-
-    # Tries to load the EDITOR environment variable, else falls back to vim
-    editor = os.environ.get('EDITOR', 'vim')
-    os.system("{} {}".format(editor, changelog))
-
-    # Have to add it so it will be part of the commit
-    subprocess.check_output(['git', 'add', changelog])
-    subprocess.check_output(
-        ['git', 'commit', '-m', 'Changelog for {}'.format(next_version)])
-
-    # Really run bumpver to set the new release and tag
-    bv_args = ['bumpversion', part, '--no-tag', '--new-version', next_version]
-
-    subprocess.check_output(bv_args)
-
-
-def main():
-    '''Parse command-line arguments and execute bumpversion command.'''
-
-    parser = ArgumentParser(prog='bumpversion',
-                            description='Bumpversion wrapper')
-
-    default_changelog = os.path.join(os.getcwd(), 'CHANGES')
-
-    subparsers = parser.add_subparsers(title='bumpversion wrapper commands')
-    # release command
-    release_doc = bump_release_version.__doc__
-    subparser = subparsers.add_parser("release",
-                                      description=release_doc,
-                                      formatter_class=RawTextHelpFormatter)
-    subparser.add_argument('--changelog', help='Project changelog',
-                           type=FileType(),
-                           default=default_changelog)
-    subparser.set_defaults(func=bump_release_version)
-    # newversion command
-    newversion_doc = bump_new_version.__doc__
-    subparser = subparsers.add_parser("newversion",
-                                      description=newversion_doc,
-                                      formatter_class=RawTextHelpFormatter)
-    subparser.add_argument('--changelog', help='Project changelog',
-                           type=FileType(),
-                           default=default_changelog)
-    subparser.add_argument('part', help='Part of the version to be bumped',
-                           choices=['patch', 'minor', 'major'])
-    subparser.set_defaults(func=bump_new_version)
-    # Parse argv arguments
-    args = parser.parse_args()
-    args.func(args)
-
-if __name__ == '__main__':
-    main()