kameleon-builder 2.10.2 → 2.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ba36ddda8ead18d06bc94412de565662a2cbed76a2ce71e4994e4f5ee665477
-  data.tar.gz: 8a1e67a68923b413654682b87e14e6c91102b57dc9fd4ed45164f0827b1483cb
+  metadata.gz: c3e726c2e8f9ca4aa09d3e5c6ef46ddc96f76f815ed8d740c431deb7e46f9433
+  data.tar.gz: 2fc324e1b1f507886d628ff27c6daa94ec50ef7e04f57f30af6614f8db7d3f1d
 SHA512:
-  metadata.gz: 6993ca5f73661525c8a44133eb715d383144b75d5e4c9cc66f73aab1896643d9db09165ddc9af46e1474c2a82b856f1dc8a894582fb398f8d25ec472019878f1
-  data.tar.gz: 205ac5b41d50af596f7428196bfc1c1c6633e6408d5643e3d4e71f323f5117755e863e98432febcca98f0461b421d40a6a3ec08634da50a66f1afe101c38eba8
+  metadata.gz: 83abce13fbf9368ed09392794a572065fc6959ff3071a61d2a4f1231288f2d4ad176d1003d57027320728042de7b8c5a5abf0e068c52c7b203faaae4d29faff7
+  data.tar.gz: c6f6f3bb93d99b960fd1650fb1247d21a5e306c5f334e19bc969a6d2195d3c93fe931de68640c84d87f2e6afc75c36b938c3b490a0aef482e5d66af31ce8cb0e

data/.bumpversion.cfg

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

data/CHANGES

@@ -1,6 +1,16 @@
 Kameleon CHANGELOG
 ==================
 
+Version 2.10.3
+--------------
+
+Released on April 10th 2020
+
+- Rework kameleon template list: add color add progress bar
+- Make bash completion understand the subcommands
+- Fix the command help ->  `kameleon <command> -h`
+- Add support for custom extend erb templates
+
 Version 2.10.2
 --------------
 

data/completion/kameleon.bash

@@ -2,12 +2,23 @@
 
 _kameleon() {
     COMPREPLY=()
-    local word="${COMP_WORDS[COMP_CWORD]}"
-
-    if [ "$COMP_CWORD" -eq 1 ]; then
-        local commands="$(compgen -W "$(kameleon commands)" -- "$word")"
+    local i=1
+    while [ $i -le "$COMP_CWORD" -a  "${COMP_WORDS[$i]:0:1}" == "-" ]; do
+        ((i++))
+    done
+    if [ "$COMP_CWORD" -eq $i ]; then
+        local commands="$(compgen -W "$(kameleon commands)" -- "${COMP_WORDS[$i]}")"
         COMPREPLY=( $commands $projects )
     fi
+    while [ $i -le "$COMP_CWORD" -a  "${COMP_WORDS[$i]:0:1}" == "-" ]; do
+        ((i++))
+    done
+    if [ "$COMP_CWORD" -eq $((i+1)) ] && kameleon commands | grep -q "${COMP_WORDS[$i]}" ; then
+        if wordlist=$(kameleon ${COMP_WORDS[$i]} commands); then
+            local commands="$(compgen -W "$wordlist" -- "${COMP_WORDS[$((i+1))]}")"
+            COMPREPLY=( $commands $projects )
+        fi
+    fi
 }
 
 complete -o default -F _kameleon kameleon

data/erb/extend.yaml.erb

@@ -0,0 +1,24 @@
+#==============================================================================
+# vim: softtabstop=2 shiftwidth=2 expandtab fenc=utf-8 cc=81 tw=80
+#==============================================================================
+#
+# DESCRIPTION: <MY RECIPE DESCRIPTION>
+#
+#==============================================================================
+# This recipe extends another. To look at the step involed, run:
+#   kameleon dryrun <%= recipe_name %>
+# To see the variables that you can override, use the following command:
+#   kameleon info <%= recipe_name %>
+---
+extend: <%= tpl.relative_path_from_recipe(recipe_path) %>
+
+global:
+
+bootstrap:
+  - "@base"
+
+setup:
+  - "@base"
+
+export:
+  - "@base"

data/kameleon-builder.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
                      'pierre.neyron@imag.fr',
                      'bruno.bzeznik@imag.fr']
   s.description   = %q{The mindful appliance builder}
-  s.summary       = %q{Kameleon is a tool to build virtual machines from scratch}
+  s.summary       = %q{Kameleon is a tool to build system appliances from scratch}
   s.homepage      = 'http://kameleon.imag.fr/'
   s.license       = 'GPL-2.0'
 
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'table_print', '~> 1.5'
   s.add_dependency 'psych', '~> 2.0'
   s.add_dependency 'ruby-graphviz', '~> 1.2'
+  s.add_dependency 'progressbar', '~> 1'
 
   s.requirements = ['polipo 1.0.3, or greater', 'graphviz 2.38.0 or greater']
 end

data/lib/kameleon.rb

@@ -46,7 +46,7 @@ module Kameleon
     def init_userconf()
       if not File.exists?(Kameleon.userconf_path) or File.zero?(Kameleon.userconf_path)
         File.open(Kameleon.userconf_path, 'w+') do |file|
-          userconf_erb = File.join(Kameleon.erb_dirpath, "userconf.erb")
+          userconf_erb = File.join(Kameleon.erb_dirpath, "userconf.yaml.erb")
           erb = ERB.new(File.open(userconf_erb, 'rb') { |f| f.read })
           result = erb.result(binding)
           file.write(result)

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 at <GIT_URL>."
+      desc "add <NAME> <GIT_URL>", "Adds a new repository named <NAME> cloned from <GIT_URL>."
       method_option :branch, :type => :string ,
                     :default => nil,
                     :desc => "checkout <BRANCH>",
@@ -32,33 +32,38 @@ module Kameleon
       def update(name)
         Kameleon::Repository.update(name)
       end
-      map %w(-h --help) => :help
-      map %w(ls) => :list
 
       desc "remove <NAME>", "Remove repository named <NAME>"
       def remove(name)
         Kameleon::Repository.remove(name)
       end
-      map %w(-h --help) => :help
+
+      desc "commands", "Lists all available commands", :hide => true
+      def commands
+        puts Repository.all_commands.keys - ["commands"]
+      end
+
       map %w(ls) => :list
       map %w(rm) => :remove
+      map %w(completions) => :commands
     end
 
 
     class Template < Thor
       include Thor::Actions
 
-#      register CLI::Repository, 'repository', 'repository', 'Manages set of remote git repositories'
-
       def self.source_root
         Kameleon.env.repositories_path
       end
 
       desc "list", "Lists all available templates"
+      method_option :progress, :type => :boolean, :default => true,
+                    :desc => "Show progress bar while resolving templates",
+                    :aliases => "-p"
       def list
-        Kameleon.ui.info "The following templates are available in " \
-                         "#{ Kameleon.env.repositories_path }:"
-        Utils.list_recipes(Kameleon.env.repositories_path)
+        Kameleon.ui.shell.say "Recipe templates available in: ", :red, false
+        Kameleon.ui.shell.say Kameleon.env.repositories_path.to_s, :yellow
+        Utils.list_recipes(Kameleon.env.repositories_path, options[:progress], true)
       end
 
       desc "import <TEMPLATE_NAME>", "Imports the given template"
@@ -110,8 +115,14 @@ module Kameleon
         tpl.resolve! :strict => false
         tpl.display_info(false)
       end
-      map %w(-h --help) => :help
+
+      desc "commands", "Lists all available commands", :hide => true
+      def commands
+        puts Template.all_commands.keys - ["commands"]
+      end
+
       map %w(ls) => :list
+      map %w(completions) => :commands
     end
   end
 
@@ -133,23 +144,24 @@ module Kameleon
     class_option :script, :type => :boolean, :default => Kameleon.default_values[:script],
                  :desc => "Never prompts for user intervention",
                  :aliases => "-s"
-    map %w(-h --help) => :help
 
     desc "version", "Prints the Kameleon's version information"
     def version
       puts "Kameleon version #{Kameleon::VERSION}"
     end
-    map %w(-v --version) => :version
 
     def self.source_root
       Kameleon.env.repositories_path
     end
 
     desc "list", "Lists all defined recipes in the current directory"
+    method_option :progress, :type => :boolean, :default => false,
+                  :desc => "Show progress bar while resolving templates",
+                  :aliases => "-p"
     def list
-      Utils.list_recipes(Kameleon.env.workspace)
+      Kameleon.ui.shell.say "Workspace recipes:", :red
+      Utils.list_recipes(Kameleon.env.workspace, options[:progress])
     end
-    map %w(ls) => :list
 
     desc "new <RECIPE_PATH> <TEMPLATE_NAME>", "Creates a new recipe from template <TEMPLATE_NAME>"
     method_option :global, :type => :hash ,
@@ -192,7 +204,18 @@ module Kameleon
           recipe_temp = File.join(tmp_dir, File.basename(recipe_path))
           ## copying recipe
           File.open(recipe_temp, 'w+') do |file|
-            extend_erb_tpl = File.join(Kameleon.erb_dirpath, "extend.erb")
+            message="Use extend ERB template: "
+            extend_erb_tpl = [
+              Kameleon.env.repositories_path.join(template_name + ".erb"),
+              Pathname.new(template_name).dirname.ascend.to_a.push(Pathname.new("")).map do |p|
+                Kameleon.env.repositories_path.join(p, ".kameleon-extend.yaml.erb")
+              end,
+              Pathname.new(Kameleon.erb_dirpath).join("extend.yaml.erb")
+            ].flatten.find do |f|
+              Kameleon.ui.verbose(message + f.to_s)
+              message = "-> Not found, fallback: "
+              File.readable?(f)
+            end 
             erb = ERB.new(File.open(extend_erb_tpl, 'rb') { |f| f.read })
             result = erb.result(binding)
             file.write(result)
@@ -209,9 +232,6 @@ module Kameleon
     method_option :from_cache, :type => :string ,
                   :default => nil,
                   :desc => "Get info from a persistent cache tar file (ignore recipe path)"
-    method_option :dryrun, :type => :boolean ,
-                  :default => false,
-                  :desc => "Show the build sequence but do not actually build"
     method_option :relative, :type => :boolean ,
                   :default => false,
                   :desc => "Make pathnames relative to the current working directory"
@@ -419,8 +439,16 @@ module Kameleon
     end
 
     desc "commands", "Lists all available commands", :hide => true
-    def commands
-      puts Main.all_commands.keys - ["commands", "completions"]
+    def commands(context="main")
+      Kameleon.ui.debug("Commands for '#{context}':")
+      case context
+      when "main"
+        puts Main.all_commands.keys - ["commands"]
+      when "repository"
+        invoke CLI::Repository, "commands", [], []
+      when "template"
+        invoke CLI::Template, "commands", [], []
+      end
     end
 
     desc "source_root", "Prints the kameleon directory path", :hide => true
@@ -428,6 +456,10 @@ module Kameleon
       puts Kameleon.source_root
     end
 
+    map %w(-v --version) => :version
+    map %w(ls) => :list
+    map %w(completions) => :commands
+
     def initialize(*args)
       super
       self.options ||= {}
@@ -445,7 +477,17 @@ module Kameleon
       Kameleon.ui.verbose("The level of output is set to #{Kameleon.ui.level}")
     end
 
-    def self.start(*)
+    def self.start(*args)
+      # `kameleon build -h` does not work without the following, except for subcommands...
+      # Ref: https://stackoverflow.com/a/49044225/6431461
+      if (Thor::HELP_MAPPINGS & ARGV).any? and subcommands.grep(/^#{ARGV[0]}/).empty?
+        Kameleon.ui.debug("Apply workaround to handle the help command in #{ARGV}")
+        Thor::HELP_MAPPINGS.each do |cmd|
+          if match = ARGV.delete(cmd)
+            ARGV.unshift match
+          end
+        end
+      end
       super
     rescue Exception => e
       Kameleon.ui = Kameleon::UI::Shell.new

data/lib/kameleon/recipe.rb

@@ -93,7 +93,7 @@ module Kameleon
          unless File.file? @path
       yaml_recipe = YAML.load_file @path
       unless yaml_recipe.kind_of? Hash
-        fail RecipeError, "Invalid yaml error : #{@path}"
+        fail RecipeError, "Invalid yaml: #{@path}"
       end
 
       update_steps_dirs()
@@ -242,7 +242,7 @@ module Kameleon
          unless File.file? path
       base_yaml_recipe = YAML.load_file base_recipe_path
       unless yaml_recipe.kind_of? Hash
-        fail RecipeError, "Invalid yaml error : #{base_yaml_recipe}"
+        fail RecipeError, "Invalid yaml: #{base_yaml_recipe}"
       end
       base_yaml_recipe.keys.each do |key|
         if ["export", "bootstrap", "setup"].include? key

data/lib/kameleon/utils.rb

@@ -1,3 +1,5 @@
+require 'progressbar'
+
 module Kameleon
   module Utils
 
@@ -123,33 +125,63 @@ module Kameleon
       end
     end
 
-    def self.list_recipes(repository_path, kwargs = {})
-      Kameleon.env.root_dir = repository_path
+    def self.list_recipes(recipes_path, do_progressbar = false, is_repository = false, kwargs = {})
+      Kameleon.env.root_dir = recipes_path
       catch_exception = kwargs.fetch(:catch_exception, true)
       recipes_hash = []
-      recipes_files = get_recipes(repository_path)
+      recipes_files = get_recipes(recipes_path)
+      if recipes_files.empty?
+        Kameleon.ui.shell.say "  <None>", :cyan
+        return
+      end
+      if do_progressbar
+        progressbar = ProgressBar.create(:format         => '%t (%p%%) %bᗧ%i',
+                                         :title          => 'Resolving ' + if is_repository; 'templates' else  'recipes' end,
+                                         :progress_mark  => '.',
+                                         :remainder_mark => '･',
+                                         :total          => recipes_files.size + 10,
+                                         :starting_at    => 10)
+      end
       recipes_files.each do |f|
         path = f.to_s
         begin
         recipe = RecipeTemplate.new(path)
-        name = path.gsub(repository_path.to_s + '/', '').chomp('.yaml')
+        name = path.gsub(recipes_path.to_s + '/', '').chomp('.yaml')
         recipes_hash.push({
           "name" => name,
           "description" => recipe.metainfo['description'],
         })
+        progressbar.increment if do_progressbar
         rescue => e
           raise e if Kameleon.env.debug or not catch_exception
         end
       end
       unless recipes_hash.empty?
-        recipes_hash = recipes_hash.sort_by{ |k| k["name"] }
         name_width = recipes_hash.map { |k| k['name'].size }.max
         desc_width = Kameleon.ui.shell.terminal_width - name_width - 3
         desc_width = (80 - name_width - 3) if desc_width < 0
       end
-      tp(recipes_hash,
-        {"name" => {:width => name_width}},
-        { "description" => {:width => desc_width}})
+      repo_str_old = nil
+      recipes_hash.sort_by{ |k| k["name"] }.each do |r|
+        if is_repository
+          repo_str,recipe_dir_str,recipe_str = r["name"].match(%r{^([^/]+/)(.+/)?([^/]+)$}).to_a[1..3].map{|m| m.to_s}
+        else
+          repo_str,recipe_dir_str,recipe_str = r["name"].match(%r{^()(.+/)?([^/]+)$}).to_a[1..3].map{|m| m.to_s}
+        end
+        if not repo_str_old.nil? and repo_str_old != repo_str
+          Kameleon.ui.shell.say "#{'-' * name_width} | #{'-' * desc_width}"
+        end
+        repo_str_old = repo_str
+        Kameleon.ui.debug("#{r["name"]} -> repo=#{repo_str}, recipe_dir=#{recipe_dir_str}, recipee=#{recipe_str}")
+        Kameleon.ui.shell.say "#{repo_str}", :yellow, false
+        Kameleon.ui.shell.say "#{recipe_dir_str}", :cyan, false
+        Kameleon.ui.shell.say sprintf("%-#{name_width - repo_str.length - recipe_dir_str.length}s", recipe_str), :magenta, false
+        Kameleon.ui.shell.say " | ", nil, false
+        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
+      end
     end
 
     def self.get_recipes(path)

data/version.txt

@@ -1 +1 @@
-2.10.2
+2.10.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kameleon-builder
 version: !ruby/object:Gem::Version
-  version: 2.10.2
+  version: 2.10.3
 platform: ruby
 authors:
 - Salem Harrache
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -96,6 +96,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: The mindful appliance builder
 email:
 - salem.harrache@inria.fr
@@ -157,8 +171,8 @@ files:
 - contrib/steps/setup/root_ssh_config.yaml
 - contrib/steps/setup/set_user_password.yaml
 - contrib/steps/setup/system_optimization.yaml
-- erb/extend.erb
-- erb/userconf.erb
+- erb/extend.yaml.erb
+- erb/userconf.yaml.erb
 - kameleon-builder.gemspec
 - lib/kameleon.rb
 - lib/kameleon/cli.rb
@@ -226,7 +240,7 @@ rubyforge_project:
 rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
-summary: Kameleon is a tool to build virtual machines from scratch
+summary: Kameleon is a tool to build system appliances from scratch
 test_files:
 - tests/helper.rb
 - tests/issue76/fail.stdout

data/erb/extend.erb

@@ -1,33 +0,0 @@
-#==============================================================================
-# vim: softtabstop=2 shiftwidth=2 expandtab fenc=utf-8 cc=81 tw=80
-#==============================================================================
-#
-# DESCRIPTION: <MY RECIPE DESCRIPTION>
-#
-#==============================================================================
----
-extend: <%= tpl.relative_path_from_recipe(recipe_path) %>
-
-global:
-  # This is the backend you have imported to switch to an other backend BCKD do:
-  #
-  #   kameleon template import <%= tpl.relative_path_from_recipe(recipe_path) %> --global backend:BCKB
-  #
-  # Then, uncomment and update the following variable.
-<% if Kameleon.env.global["backend"] %>
-  backend: <%= Kameleon.env.global["backend"] %>
-<% else %>
-  # backend: qemu
-<% end %>
-  # To see the variables that you can override, use the following command:
-  #
-  #   kameleon info <%= recipe_name %>
-
-bootstrap:
-  - "@base"
-
-setup:
-  - "@base"
-
-export:
-  - "@base"