kameleon-builder 2.9.4 → 2.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77bd099db84f2bcda3b7a494e19055fc1d16158f8e6cb52d3be3abad4ce61fe8
-  data.tar.gz: 9cab43b3a49e340aab7e051659c3e51e6dccdf71dffa8df18e5257dae9353ffc
+  metadata.gz: 40bafaeccf66d6d3149f1af122656d69ca563488fc51cb358e67a607f813d407
+  data.tar.gz: 93d6c6c995fa330626a823c06026e9a3733c0dc72ee1cdc7feefc1d6f0db0362
 SHA512:
-  metadata.gz: a343c26b0723fbc92015ea796eaf1846270013cbe07344c7c27ec24e15960fd461b8bcd66adf4743cadaa3173a2bc2adba2fbccf3630126c16ecca8d1fb4d155
-  data.tar.gz: c7b7c1392ab8d9459a8aba07b9c3580e6ea7a3c46cb2d56b9befb194784c6268c7370f04316a77864c6951c0f8011fd36176f75744d83e55856025fdf92195a4
+  metadata.gz: 4ff5b417aced3f8736f9d5d7dbe1f45092310667fbb352903fa9075844222d6e667e86881dca443367d1088d9dee7269d8f185c715ad9615957cda60985b7d07
+  data.tar.gz: e69e617c0ee0eddf3d65dc2c2cef1b878222afbd9d0c7f392d57a93f164e84dd5cd217e8c4ac6f8b7673ad7ceb8355c7c0d60c57e555ba2141ed3211a6c2ca25

data/.bumpversion.cfg

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

data/CHANGES

@@ -1,10 +1,33 @@
 Kameleon CHANGELOG
 ==================
 
-Version 2.9.3.dev
------------------
+Version 2.10.1
+-------------
+
+Released on March 21th 2020
+
+- Fix regression in 2.10.0 with the build directory creation
+
+Version 2.10.0
+-------------
+
+Released on March 21th 2020
+
+- Rework usage (cosmetic fixes)
+- Drop the `kameleon template repository` action (same as `kameleon repository`)
+- Make `kameleon dag` and `kameleon dryrun` standalone actions instead of `kameleon info` options
+- Add the `kamelon dag --recipes-only`
+- Make `kameleon dag` show distincly the extended recipe among the ancestors
+- Add the `kameleon export` action
+
+Version 2.9.4
+-------------
+
+Released on December 12th 2018
+
+- Minor fixes
+- NB: the 2.9.3 version was lost in space...
 
-**unreleased**
 
 Version 2.9.2
 -------------

data/lib/kameleon/cli.rb

@@ -11,10 +11,10 @@ module Kameleon
     class Repository < Thor
       include Thor::Actions
 
-      desc "add [NAME] [URL]", "Adds a new named <name> repository at <url>."
+      desc "add <NAME> <GIT_URL>", "Adds a new repository named <NAME> cloned from at <GIT_URL>."
       method_option :branch, :type => :string ,
                     :default => nil,
-                    :desc => "checkout <branch>",
+                    :desc => "checkout <BRANCH>",
                     :aliases => "-b"
       def add(name, url)
         Kameleon::Repository.add(name, url, options)
@@ -25,7 +25,7 @@ module Kameleon
         Kameleon::Repository.list
       end
 
-      desc "update [NAME]", "Updates a named <name> repository"
+      desc "update <NAME>", "Updates repository named <NAME> repository"
       def update(name)
         Kameleon::Repository.update(name)
       end
@@ -37,7 +37,7 @@ module Kameleon
     class Template < Thor
       include Thor::Actions
 
-      register CLI::Repository, 'repository', 'repository', 'Manages set of remote git repositories'
+#      register CLI::Repository, 'repository', 'repository', 'Manages set of remote git repositories'
 
       def self.source_root
         Kameleon.env.repositories_path
@@ -50,7 +50,7 @@ module Kameleon
         Utils.list_recipes(Kameleon.env.repositories_path)
       end
 
-      desc "import [TEMPLATE_NAME]", "Imports the given template"
+      desc "import <TEMPLATE_NAME>", "Imports the given template"
       method_option :global, :type => :hash ,
                     :default => {},  :aliases => "-g",
                     :desc => "Set custom global variables."
@@ -81,7 +81,7 @@ module Kameleon
         end
       end
 
-      desc "info [TEMPLATE_NAME]", "Display detailed information about a template"
+      desc "info <TEMPLATE_NAME>", "Display detailed information about a template"
       method_option :global, :type => :hash ,
                     :default => {},  :aliases => "-g",
                     :desc => "Set custom global variables."
@@ -108,7 +108,7 @@ module Kameleon
   class Main < Thor
     include Thor::Actions
 
-    register CLI::Repository, 'repository', 'repository', 'Manages set of remote git repositories'
+    register CLI::Repository, 'repository', 'repository', 'Manages repositories of recipes'
     # register CLI::Recipe, 'recipe', 'recipe', 'Manages the local recipes'
     register CLI::Template, 'template', 'template', 'Lists and imports templates'
 
@@ -139,7 +139,7 @@ module Kameleon
     end
     map %w(ls) => :list
 
-    desc "new [RECIPE_PATH] [TEMPLATE_NAME]", "Creates a new recipe"
+    desc "new <RECIPE_PATH> <TEMPLATE_NAME>", "Creates a new recipe from template <TEMPLATE_NAME>"
     method_option :global, :type => :hash ,
                   :default => {},  :aliases => "-g",
                   :desc => "Set custom global variables."
@@ -190,7 +190,7 @@ module Kameleon
       end
     end
 
-    desc "info [RECIPE_PATH]", "Display detailed information about a recipe"
+    desc "info <RECIPE_PATH>", "Display detailed information about a recipe"
     method_option :global, :type => :hash ,
                   :default => {},  :aliases => "-g",
                   :desc => "Set custom global variables."
@@ -200,9 +200,35 @@ module Kameleon
     method_option :dryrun, :type => :boolean ,
                   :default => false,
                   :desc => "Show the build sequence but do not actually build"
-    method_option :dag, :type => :boolean ,
+    method_option :relative, :type => :boolean ,
                   :default => false,
-                  :desc => "Show a DAG of the build sequence"
+                  :desc => "Make pathnames relative to the current working directory"
+    def info(*recipe_paths)
+      if recipe_paths.empty?
+        if options[:from_cache].nil?
+          raise ArgumentError
+        else
+          unless File.file?(options[:from_cache])
+            raise CacheError, "The specified cache file "\
+                              "\"#{options[:from_cache]}\" do not exists"
+          end
+          Kameleon.ui.info("Using the cached recipe")
+          @cache = Kameleon::Persistent_cache.instance
+          @cache.cache_path = options[:from_cache]
+        end
+      else
+        recipe_paths.each do |path|
+          recipe = Kameleon::Recipe.new(path)
+          recipe.resolve!
+          recipe.display_info(options[:relative])
+        end
+      end
+    end
+
+    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."
     method_option :file, :type => :string ,
                   :default => "/tmp/kameleon.dag",
                   :desc => "DAG output filename"
@@ -211,52 +237,95 @@ module Kameleon
     method_option :relative, :type => :boolean ,
                   :default => false,
                   :desc => "Make pathnames relative to the current working directory"
-
-    def info(*recipe_paths)
-      if recipe_paths.length == 0 && !options[:from_cache].nil?
-        unless File.file?(options[:from_cache])
-          raise CacheError, "The specified cache file "\
-                            "\"#{options[:from_cache]}\" do not exists"
-        end
-        Kameleon.ui.info("Using the cached recipe")
-        @cache = Kameleon::Persistent_cache.instance
-        @cache.cache_path = options[:from_cache]
-      end
-      dag = nil
+    method_option :recipes_only, :type => :boolean ,
+                  :default => false,
+                  :desc => "Show recipes only (mostly useful to display multiple recipes inheritance)"
+    def dag(*recipe_paths)
+      raise ArgumentError if recipe_paths.empty?
       color = 0
+      recipes_dag = nil
       recipe_paths.each do |path|
         recipe = Kameleon::Recipe.new(path)
-        if options[:dryrun]
-          Kameleon::Engine.new(recipe, options).dryrun
-        elsif options[:dag]
-          dag = Kameleon::Engine.new(recipe, options).dag(dag, color)
-          color += 1
+        recipes_dag = Kameleon::Engine.new(recipe, options.dup.merge({no_create_build_dir: true}).freeze).dag(recipes_dag, color, options[:recipes_only])
+        color += 1
+      end
+      format = "canon"
+      if options[:format]
+        if GraphViz::Constants::FORMATS.include?(options[:format])
+          format = options[:format]
         else
-          recipe.resolve!
-          recipe.display_info(options[:relative])
+          Kameleon.ui.warn("Unknown GraphViz format #{options[:format]}, fall back to #{format}")
         end
-      end
-      if options[:dag]
-        format = "canon"
-        if options[:format]
-          if GraphViz::Constants::FORMATS.include?(options[:format])
-            format = options[:format]
-          else
-            Kameleon.ui.warn("Unknown GraphViz format #{options[:format]}, fall back to #{format}")
+      else
+        options[:file].match(/^.+\.([^\.]+)$/) do |f|
+          if GraphViz::Constants::FORMATS.include?(f[1])
+            format = f[1]
           end
-        else
-          options[:file].match(/^.+\.([^\.]+)$/) do |f|
-            if GraphViz::Constants::FORMATS.include?(f[1])
-              format = f[1]
-            end
+        end
+      end
+      recipes_dag.output( :"#{format}" => options[:file] )
+      Kameleon.ui.info("Generated GraphViz #{format} file: #{options[:file]}")
+    end
+
+    desc "dryrun <RECIPE_PATH>", "Show the steps the build would process"
+    method_option :global, :type => :hash ,
+                  :default => {},  :aliases => "-g",
+                  :desc => "Set custom global variables."
+    method_option :relative, :type => :boolean ,
+                  :default => false,
+                  :desc => "Make pathnames relative to the current working directory"
+    def dryrun(*recipe_paths)
+      raise ArgumentError if recipe_paths.empty?
+      recipe_paths.each do |path|
+        recipe = Kameleon::Recipe.new(path)
+        Kameleon::Engine.new(recipe, options.dup.merge({no_create_build_dir: true}).freeze).dryrun
+      end
+    end
+
+    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."
+    method_option :add, :type => :boolean ,
+                  :default => false,  :aliases => "-A",
+                  :desc => "export recipe and steps to an existing directory (this may overwrite some existing files)"
+    def export(recipe_path,dest_path)
+      unless recipe_path.end_with? '.yaml'
+        recipe_path = recipe_path + '.yaml'
+      end
+      # Manage global as it is not passed to env by default
+      if options[:global]
+         Kameleon.env.global.merge!(options[:global])
+      end
+      recipe = Recipe.new(recipe_path)
+      recipe.resolve! :strict => false
+      recipe.all_files.uniq.each do |path|
+        relative_path = path.relative_path_from(Kameleon.env.workspace)
+          if relative_path.fnmatch("../*")
+            raise if Kameleon.ui.level("verbose")
+            raise ExportError, "Recipe '#{recipe_path}' depends on a file" \
+                " outside of the current directory: '#{relative_path.to_s}'"
           end
+      end
+      Kameleon.ui.info("Export recipe #{recipe_path} to directory: #{dest_path}")
+      if File.exists?(dest_path)
+        unless options[:add]
+          raise if Kameleon.ui.level("verbose")
+          raise ExportError, "Target export directory '#{dest_path}' already "\
+              "exists, use the --add option if you really want to export the "\
+              "recipe files to it (this may overwrite some existing files)"
         end
-        dag.output( :"#{format}" => options[:file] )
-        Kameleon.ui.info("Generated GraphViz #{format} file: #{options[:file]}")
+      else
+        FileUtils.mkdir_p(dest_path)
+      end
+      recipe.all_files.uniq.each do |path|
+        relative_path = path.relative_path_from(Kameleon.env.workspace)
+        dst = File.join(dest_path, relative_path)
+        copy_file(path, dst)
       end
     end
 
-    desc "build [RECIPE_PATH]", "Builds the appliance from the given recipe"
+    desc "build <RECIPE_PATH>", "Builds the appliance from the given recipe"
     method_option :build_path, :type => :string ,
                   :default => nil, :aliases => "-b",
                   :desc => "Sets the build directory path"

data/lib/kameleon/engine.rb

@@ -75,7 +75,7 @@ module Kameleon
       if @options[:enable_cache] || @options[:from_cache] then
         @cache.recipe_files = @recipe.all_files
       end
-      unless @options[:dryrun] or @options[:dag]
+      unless @options[:no_create_build_dir]
         begin
           Kameleon.ui.info("Creating kameleon build directory : #{@cwd}")
           FileUtils.mkdir_p @cwd
@@ -466,7 +466,7 @@ module Kameleon
       Kameleon.ui.shell.say ""
     end
 
-    def dag(graph, color)
+    def dag(graph, color, recipes_only)
       if graph.nil?
         graph =  GraphViz::new( "G" )
       end
@@ -482,47 +482,61 @@ module Kameleon
       n_recipe['colorscheme'] = colorscheme
       n_recipe['color'] = color
       (@recipe.base_recipes_files - [@recipe.path]).uniq.each do |base_recipe_path|
-          n_base_recipe = g_recipes.add_nodes(base_recipe_path.relative_path_from(Pathname(Dir.pwd)).to_s)
-          n_base_recipe['shape'] = 'Mdiamond'
-          edge = graph.add_edges(n_base_recipe, n_recipe)
+        Kameleon.ui.debug("Dag add node #{base_recipe_path}")
+        n_base_recipe = g_recipes.add_nodes(base_recipe_path.relative_path_from(Pathname(Dir.pwd)).to_s)
+        n_base_recipe['shape'] = 'Mdiamond'
+        edge = graph.add_edges(n_base_recipe, n_recipe)
+        if base_recipe_path == @recipe.extended_recipe_file
+          Kameleon.ui.debug("This is the extended recipe")
+          edge['colorscheme'] = colorscheme
+          edge['color'] = color
+        else
           edge['style'] = 'dashed'
+        end
       end
       n_prev = n_recipe
-      ["bootstrap", "setup", "export"].each do |section_name|
-        section = @recipe.sections.fetch(section_name)
-        g_section = graph.add_graph( "cluster S:#{ section_name }" )
-        g_section['label'] = section_name.capitalize
-        section.sequence do |macrostep|
-          if macrostep.path.nil?
-              macrostep_name = macrostep.name
-          else
-              macrostep_name = macrostep.path.relative_path_from(Pathname(Dir.pwd)).to_s
-              macrostep_name.chomp!(".yaml")
-              macrostep_name.sub!(/^steps\//, "")
-          end
-          g_macrostep = g_section.add_graph( "cluster M:#{ macrostep_name }")
-          g_macrostep['label'] = macrostep_name
-          g_macrostep['style'] = 'filled'
-          g_macrostep['color'] = 'gray'
-          macrostep.sequence do |microstep|
-            n_microstep = g_macrostep.add_nodes("m:#{macrostep_name}/#{microstep.name}")
-            n_microstep['label'] = microstep.name
-            n_microstep['style'] = 'filled'
-            n_microstep['color'] = 'white'
-            edge = graph.add_edges(n_prev, n_microstep)
-            edge['colorscheme'] = colorscheme
-            edge['color'] = color
-            n_prev = n_microstep
+      if recipes_only
+        Kameleon.ui.debug("As requested, only show recipes")
+      else
+        ["bootstrap", "setup", "export"].each do |section_name|
+          Kameleon.ui.debug("Dag add section #{section_name}")
+          section = @recipe.sections.fetch(section_name)
+          g_section = graph.add_graph( "cluster S:#{ section_name }" )
+          g_section['label'] = section_name.capitalize
+          section.sequence do |macrostep|
+            Kameleon.ui.debug("Dag add macrostep #{macrostep.name}")
+            if macrostep.path.nil?
+                macrostep_name = macrostep.name
+            else
+                macrostep_name = macrostep.path.relative_path_from(Pathname(Dir.pwd)).to_s
+                macrostep_name.chomp!(".yaml")
+                macrostep_name.sub!(/^steps\//, "")
+            end
+            g_macrostep = g_section.add_graph( "cluster M:#{ macrostep_name }")
+            g_macrostep['label'] = macrostep_name
+            g_macrostep['style'] = 'filled'
+            g_macrostep['color'] = 'gray'
+            macrostep.sequence do |microstep|
+              Kameleon.ui.debug("Dag add microstep #{microstep.name}")
+              n_microstep = g_macrostep.add_nodes("m:#{macrostep_name}/#{microstep.name}")
+              n_microstep['label'] = microstep.name
+              n_microstep['style'] = 'filled'
+              n_microstep['color'] = 'white'
+              edge = graph.add_edges(n_prev, n_microstep)
+              edge['colorscheme'] = colorscheme
+              edge['color'] = color
+              n_prev = n_microstep
+            end
           end
         end
+        n_end = graph.add_nodes('end')
+        n_end['label'] = 'END'
+        n_end['shape'] = 'Msquare'
+        edge = graph.add_edges(n_prev, n_end)
+        edge['colorscheme'] = colorscheme
+        edge['color'] = color
       end
-      n_end = graph.add_nodes('end')
-      n_end['label'] = 'END'
-      n_end['shape'] = 'Msquare'
-      edge = graph.add_edges(n_prev, n_end)
-      edge['colorscheme'] = colorscheme
-      edge['color'] = color
-      Kameleon.ui.info "-> Drawn DAG for #{recipe_path}"
+      Kameleon.ui.info "-> Draw DAG for #{recipe_path}"
       return graph
     end
 

data/lib/kameleon/error.rb

@@ -26,4 +26,5 @@ module Kameleon
   class AbortError < Error; status_code(8) ; end
   class TemplateNotFound < Error; status_code(9) ; end
   class CacheError < Error; status_code(10) ; end
+  class ExportError < Error; status_code(11) ; end
 end

data/lib/kameleon/recipe.rb

@@ -14,6 +14,7 @@ module Kameleon
     attr_accessor :checkpoint_path
     attr_accessor :metainfo
     attr_accessor :files
+    attr_accessor :extended_recipe_file
     attr_accessor :base_recipes_files
     attr_accessor :data_files
     attr_accessor :env_files
@@ -97,6 +98,12 @@ module Kameleon
 
       update_steps_dirs()
 
+      extended_recipe_name = yaml_recipe.fetch("extend", "")
+      unless extended_recipe_name.nil?
+        extended_recipe_name << ".yaml" unless extended_recipe_name.end_with? ".yaml"
+        @extended_recipe_file = Pathname.new(File.expand_path(File.join(File.dirname(path), extended_recipe_name)))
+      end
+
       # Load extended recipe variables
       yaml_recipe = load_base_recipe(yaml_recipe, @path)
       yaml_recipe.delete("extend")

data/version.txt

@@ -1 +1 @@
-2.9.4
+2.10.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kameleon-builder
 version: !ruby/object:Gem::Version
-  version: 2.9.4
+  version: 2.10.1
 platform: ruby
 authors:
 - Salem Harrache
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2020-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -223,7 +223,7 @@ requirements:
 - polipo 1.0.3, or greater
 - graphviz 2.38.0 or greater
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Kameleon is a tool to build virtual machines from scratch