kameleon-builder 2.2.5 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 713bfaf539e81472b72965b0c4d4639543b1d616
-  data.tar.gz: 425144e158dddbf29447ac5f082e546c2f2a304e
+  metadata.gz: c6a3d7e9962e22c223344369a554019b3ecdef6a
+  data.tar.gz: 25c90de017ffdb6e7f82dcdaa64a5ed7f2d621e1
 SHA512:
-  metadata.gz: da5f852444818504e73b889c62683696b9bf7c8a077109a80bc881dbd26848c602b693b834e7d26220cd6aa50a4660d4d4dc1ed65fd1184c23bf3c0f71eb5c57
-  data.tar.gz: 8d56cfb832300b771fd43832f46655c4e8504db47b9f1b1f7e5260ac244249d16f4e1077d7a30aec78090de70486a206e1a525f41d20f787208ea50e7f0e649a
+  metadata.gz: f9846ad8bd70649a76ec8c8408228eb44a172030127361e117672d0076211680c3ee07dcf6829529d73cde1b81d28051b494d92794a23062c7907a28bde4399e
+  data.tar.gz: 5143fe65f730c5b2cefd5ded3c0b412c88cd6a0b8dfa85fe5bc30417deec36e650605c9c82e0b066637cd23a4b388d0f1a3d49416eb3ff986b66a2cbca8de51c

data/.gitignore

@@ -21,3 +21,4 @@ coverage
 .vagrant
 *.log
 bin/*
+build

data/CHANGELOG.rst

@@ -2,6 +2,27 @@ Kameleon CHANGELOG
 ==================
 
 
+version 2.3.0
+-------------
+
+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)
+- Renamed ``--cache`` option to ``--enable-cache``
+- Renamed ``--checkpoint`` option to ``--enable-checkpoint``
+- Removed ``kameleon import`` command
+- Removed ``kameleon templates`` command
+- Added ``kameleon info`` to display detailed information about a recipe
+- Added ``kameleon list`` to list all defined recipes in the current directory
+- Added ``kameleon template info`` to display detailed information about a template
+- Added ``kameleon template import`` to import a template
+- Added ``kameleon template list`` to list all available templates
+- Added ``kameleon template repository`` to manage external git recipes repositories
+
+
 version 2.2.5
 -------------
 

data/{templates → contrib}/steps/bootstrap/debian/debootstrap_arm.yaml

@@ -6,7 +6,7 @@
   - check_cmd_out: qemu-arm-static
   - exec_out:|
         mkdir -p $$rootfs
-        debootstrap --no-check-gpg --foreign --variant=minbase --arch=$$arch --include="$$include_pkg" $$release $$rootfs $$repository
+        debootstrap --no-check-gpg --foreign --arch=$$arch --include="$$include_pkg" $$release $$rootfs $$repository
         QEMU_USER_PATH=$(which qemu-arm-static)
         cp $QEMU_USER_PATH $$rootfs/usr/bin/qemu-arm-static
         chroot $$rootfs /usr/bin/qemu-arm-static -cpu cortex-a9 /bin/sh /debootstrap/debootstrap --second-stage

data/{templates → erb}/extend.erb

@@ -7,10 +7,10 @@
 #==============================================================================
 
 ---
-extend: <%= tpl.relative_path %>
+extend: <%= tpl.relative_path_from_recipe(recipe_path) %>
 
 global:
-    # You can see the base template `<%= tpl.relative_path %>.yaml` to know the
+    # You can see the base template `<%= tpl.relative_path_from_recipe(recipe_path) %>.yaml` to know the
     # variables that you can override
 
 bootstrap:

data/erb/userconf.erb

@@ -0,0 +1,5 @@
+---
+repositories_path: <%= Kameleon.default_values[:repositories_path] %>
+script: <%= Kameleon.default_values[:script] %>
+color: <%= Kameleon.default_values[:color] %>
+debug: <%= Kameleon.default_values[:debug] %>

data/kameleon-builder.gemspec

@@ -6,17 +6,20 @@ require 'kameleon/version'
 Gem::Specification.new do |s|
   s.name          = 'kameleon-builder'
   s.version       = Kameleon::VERSION
+  s.date          = Time.now.strftime('%Y-%m-%d')
   s.authors       = ['Salem Harrache',
                      'Michael Mercier',
                      'Cristan Ruiz',
+                     'Pierre Neyron',
                      'Bruno Bzeznik']
   s.email         = ['salem.harrache@inria.fr',
                      'michael.mercier@inria.fr',
                      'cristian.ruiz@imag.fr',
+                     '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.homepage      = 'http://kameleon.readthedocs.org/'
+  s.homepage      = 'http://kameleon.imag.fr/'
   s.license       = 'GPL-2'
 
   s.files         = `git ls-files`.split($/)
@@ -28,4 +31,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'childprocess', '~> 0.5.3', '>= 0.3.0'
   s.add_dependency 'thor', '~> 0.19', '>= 0.15.0'
   s.add_dependency 'table_print', '~> 1.5.2'
+
+  s.requirements = ['polipo 1.0.3, or greater']
 end

data/lib/kameleon.rb

@@ -10,20 +10,70 @@ require 'pathname'
 require 'table_print'
 require 'yaml'
 
+require 'kameleon/ui'
+
 module Kameleon
   class << self
     attr_writer :env
     attr_writer :ui
     attr_writer :source_root
     attr_writer :log_on_progress
+    attr_writer :userdir
+    attr_writer :userconf_path
+    attr_writer :repositories_path
+    attr_writer :default_values
 
     # The source root is the path to the root directory of the kameleon gem.
     def source_root
       @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
     end
 
-    def default_templates_path
-      File.join(Kameleon.source_root, 'templates')
+    def erb_dirpath
+      File.join(Kameleon.source_root, 'erb')
+    end
+
+    def userdir
+      @userdir ||= Pathname.new(File.join('~', '.kameleon.d'))
+      Dir.mkdir(File.expand_path(@userdir.to_path)) unless File.exists?(File.expand_path(@userdir.to_path))
+      @userdir
+    end
+
+    def userconf_path
+      @userconf_path ||= Pathname.new(File.join(File.expand_path(userdir.to_path), 'config'))
+    end
+
+    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")
+          erb = ERB.new(File.open(userconf_erb, 'rb') { |f| f.read })
+          result = erb.result(binding)
+          file.write(result)
+        end
+      end
+    end
+
+    def load_userconf
+      if File.exists?(Kameleon.userconf_path) and not File.zero?(Kameleon.userconf_path)
+        yaml_conf = YAML.load_file Kameleon.userconf_path
+        unless yaml_conf.kind_of? Hash
+          yaml_conf = {}
+        end
+      else
+        yaml_conf = {}
+      end
+      return yaml_conf
+    end
+
+    def default_values
+      userconf = load_userconf
+      @default_values ||= {
+        :color => userconf.fetch("color", true),
+        :debug => userconf.fetch("debug", false),
+        :script => userconf.fetch("script", false),
+        :repositories_path =>  userconf.fetch("repositories_path",
+                                          File.join(userdir.to_path, 'repos')),
+      }
     end
 
     def env
@@ -44,7 +94,7 @@ end
 require 'kameleon/compat'
 require 'kameleon/utils'
 require 'kameleon/error'
+require 'kameleon/repository'
 require 'kameleon/cli'
 require 'kameleon/environment'
 require 'kameleon/version'
-require 'kameleon/ui'

data/lib/kameleon/cli.rb

@@ -3,53 +3,138 @@ require 'kameleon/recipe'
 require 'kameleon/utils'
 
 module Kameleon
-  class CLI < Thor
+
+  module CLI
+
+    class Repository < Thor
+      include Thor::Actions
+
+      desc "add [NAME] [URL]", "Adds a new named <name> repository at <url>."
+      method_option :branch, :type => :string ,
+                    :default => nil,
+                    :desc => "checkout <branch>",
+                    :aliases => "-b"
+      def add(name, url)
+        Kameleon::Repository.add(name, url, options)
+      end
+
+      desc "list", "Lists available repositories."
+      def list
+        Kameleon::Repository.list
+      end
+
+      desc "update [NAME]", "Updates a named <name> repository"
+      def update(name)
+        Kameleon::Repository.update(name)
+      end
+      map %w(-h --help) => :help
+      map %w(ls) => :list
+    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"
+      def list
+        Kameleon.ui.info "The following templates are available in " \
+                         "#{ Kameleon.env.repositories_path }:"
+        Utils.list_recipes(Kameleon.env.repositories_path)
+      end
+
+      desc "import [TEMPLATE_NAME]", "Imports the given template"
+      def import(template_name)
+        template_path = File.join(Kameleon.env.repositories_path, template_name)
+        unless template_name.end_with? '.yaml'
+          template_path = template_path + '.yaml'
+        end
+        begin
+          tpl = RecipeTemplate.new(template_path)
+        rescue
+          raise TemplateNotFound, "Template '#{template_name}' not found. " \
+                                  "To see all templates, run the command "\
+                                  "`kameleon template ls`"
+        else
+          files2copy = tpl.base_recipes_files + tpl.files
+          files2copy.each do |path|
+            relative_path = path.relative_path_from(Kameleon.env.repositories_path)
+            dst = File.join(Kameleon.env.workspace, relative_path)
+            copy_file(path, dst)
+          end
+        end
+      end
+
+      desc "info [TEMPLATE_NAME]", "Display detailed information about a template"
+      def info(template_name)
+        template_path = File.join(Kameleon.env.repositories_path, template_name)
+        unless template_name.end_with? '.yaml'
+          template_path = template_path + '.yaml'
+        end
+        tpl = RecipeTemplate.new(template_path)
+        tpl.display_info
+      end
+      map %w(-h --help) => :help
+      map %w(ls) => :list
+    end
+  end
+
+
+  class Main < Thor
     include Thor::Actions
 
-    class_option :color, :type => :boolean, :default => true,
-                 :desc => "Enable colorization in output"
-    class_option :debug, :type => :boolean, :default => false,
-                 :desc => "Enable debug output"
-    class_option :script, :type => :boolean, :default => false,
-                 :desc => "never prompts for user intervention",
+    # register CLI::Recipe, 'recipe', 'recipe', 'Manages the local recipes'
+    register CLI::Template, 'template', 'template', 'Lists and imports templates'
+
+    class_option :color, :type => :boolean, :default => Kameleon.default_values[:color],
+                 :desc => "Enables colorization in output"
+    class_option :debug, :type => :boolean, :default => Kameleon.default_values[:debug],
+                 :desc => "Enables debug output"
+    class_option :script, :type => :boolean, :default => Kameleon.default_values[:script],
+                 :desc => "Never prompts for user intervention",
                  :aliases => "-s"
     map %w(-h --help) => :help
 
-    desc "import [TEMPLATE_NAME]", "Imports the given template"
-    method_option :templates_path, :type => :string ,
-                  :default => Kameleon.default_templates_path, :aliases => "-t",
-                  :desc => "Using another templates directory"
-    def import(template_name)
-      templates_path = Kameleon.env.templates_path
-      template_path = File.join(templates_path, template_name) + '.yaml'
-      begin
-        tpl = RecipeTemplate.new(template_path)
-      rescue
-        raise TemplateNotFound, "Template '#{template_name}' not found. " \
-                                "To see all templates, run the command "\
-                                "`kameleon templates`"
-      else
-        files2copy = tpl.base_recipes_files + tpl.files
-        files2copy.each do |path|
-          relative_path = path.relative_path_from(Kameleon.env.templates_path)
-          dst = File.join(Kameleon.env.workspace, relative_path)
-          copy_file(path, dst)
-        end
-      end
+    desc "version", "Prints the Kameleon's version information"
+    def version
+      puts "Kameleon version #{Kameleon::VERSION}"
     end
+    map %w(-v --version) => :version
 
-    desc "new [RECIPE_NAME] [TEMPLATE_NAME]", "Creates a new recipe"
-    method_option :templates_path, :type => :string ,
-                  :default => Kameleon.default_templates_path, :aliases => "-t",
-                  :desc => "Using another templates directory"
-    def new(recipe_name, template_name)
-      if recipe_name == template_name
-        fail RecipeError, "Recipe name should be different from template name"
+    def self.source_root
+      Kameleon.env.repositories_path
+    end
+
+    desc "list", "Lists all defined recipes in the current directory"
+    def list
+      Utils.list_recipes(Kameleon.env.workspace)
+    end
+    map %w(ls) => :list
+
+    desc "new [RECIPE_PATH] [TEMPLATE_NAME]", "Creates a new recipe"
+    def new(recipe_path, template_name)
+      unless template_name.end_with? '.yaml'
+        template_name = template_name + '.yaml'
       end
-      templates_path = Kameleon.env.templates_path
-      template_path = File.join(templates_path, template_name) + '.yaml'
+
+      unless recipe_path.end_with? '.yaml'
+        recipe_path = recipe_path + '.yaml'
+      end
+
+      if recipe_path == template_name
+        fail RecipeError, "Recipe path should be different from template name"
+      end
+
+      template_path = File.join(Kameleon.env.repositories_path, template_name)
+
+      recipe_path = Pathname.new(Kameleon.env.workspace).join(recipe_path).to_path
+
       begin
-        tpl = RecipeTemplate.new(template_path)
+        tpl = Kameleon::RecipeTemplate.new(template_path)
       rescue
         raise TemplateNotFound, "Template '#{template_name}' not found. " \
                                 "To see all templates, run the command "\
@@ -57,87 +142,53 @@ module Kameleon
       else
         files2copy = tpl.base_recipes_files + tpl.files
         files2copy.each do |path|
-          relative_path = path.relative_path_from(Kameleon.env.templates_path)
+          relative_path = path.relative_path_from(Kameleon.env.repositories_path)
           dst = File.join(Kameleon.env.workspace, relative_path)
           copy_file(path, dst)
         end
         Dir::mktmpdir do |tmp_dir|
-          recipe_path = File.join(tmp_dir, recipe_name + '.yaml')
+          recipe_temp = File.join(tmp_dir, File.basename(recipe_path))
           ## copying recipe
-          File.open(recipe_path, 'w+') do |file|
-            extend_erb_tpl = File.join(Kameleon.default_templates_path, "extend.erb")
+          File.open(recipe_temp, 'w+') do |file|
+            extend_erb_tpl = File.join(Kameleon.erb_dirpath, "extend.erb")
             erb = ERB.new(File.open(extend_erb_tpl, 'rb') { |f| f.read })
             result = erb.result(binding)
             file.write(result)
           end
-          recipe_dst = File.join(Kameleon.env.workspace, recipe_name + '.yaml')
-          copy_file(recipe_path, Pathname.new(recipe_dst))
+          copy_file(recipe_temp, recipe_path)
         end
       end
     end
 
-    desc "templates", "Lists all defined templates"
-    method_option :templates_path, :type => :string ,
-                  :default => Kameleon.default_templates_path, :aliases => "-t",
-                  :desc => "Using another templates directory"
-    def templates
-      puts "The following templates are available in " \
-                 "#{ Kameleon.env.templates_path }:"
-      templates_hash = []
-      templates_path = File.join(Kameleon.env.templates_path, "/")
-      all_yaml_files = Dir["#{templates_path}**/*.yaml"]
-      steps_files = Dir["#{templates_path}steps/**/*.yaml"]
-      templates_files = all_yaml_files - steps_files
-      templates_files.each do |f|
-        begin
-        recipe = RecipeTemplate.new(f)
-        templates_hash.push({
-          "name" => f.gsub(templates_path, "").chomp(".yaml"),
-          "description" => recipe.metainfo['description'],
-        })
-        rescue => e
-          raise e if Kameleon.env.debug
-        end
-      end
-      unless templates_hash.empty?
-      templates_hash = templates_hash.sort_by{ |k| k["name"] }
-      name_width = templates_hash.map { |k| k['name'].size }.max
-      desc_width = Kameleon.ui.shell.terminal_width - name_width - 3
-      end
-      tp(templates_hash,
-        {"name" => {:width => name_width}},
-        { "description" => {:width => desc_width}})
-    end
-
-    desc "version", "Prints the Kameleon's version information"
-    def version
-      puts "Kameleon version #{Kameleon::VERSION}"
+    desc "info [RECIPE_PATH]", "Display detailed information about a recipe"
+    def info(recipe_path)
+      recipe = Kameleon::Recipe.new(recipe_path)
+      recipe.display_info
     end
-    map %w(-v --version) => :version
 
-    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 => "Set the build directory path"
+                  :desc => "Sets the build directory path"
     method_option :clean, :type => :boolean ,
                   :default => false,
-                  :desc => "Run the command `kameleon clean` first"
+                  :desc => "Runs the command `kameleon clean` first"
     method_option :from_checkpoint, :type => :string ,
                   :default => nil,
-                  :desc => "Using specific checkpoint to build the image. " \
+                  :desc => "Uses specific checkpoint to build the image. " \
                            "Default value is the last checkpoint."
-    method_option :checkpoint, :type => :boolean ,
+    method_option :enable_checkpoint, :type => :boolean ,
                   :default => false,
-                  :desc => "Enable checkpoint"
-    method_option :cache, :type => :boolean,
+                  :desc => "Enables checkpoint [experimental]"
+    method_option :enable_cache, :type => :boolean,
                   :default => false,
-                  :desc => "Generate a persistent cache for the appliance."
+                  :desc => "Generates a persistent cache for the appliance."
     method_option :cache_path, :type => :string ,
                   :default => nil,
-                  :desc => "Set the cache directory path"
+                  :desc => "Sets the cache directory path"
     method_option :from_cache, :type => :string ,
                   :default => nil,
-                  :desc => "Using a persistent cache tar file to build the image."
+                  :desc => "Uses a persistent cache tar file to build the image."
     method_option :proxy_path, :type => :string ,
                   :default => nil,
                   :desc => "Full path of the proxy binary to use for the persistent cache."
@@ -172,10 +223,10 @@ module Kameleon
       engine.pretty_checkpoints_list
     end
 
-    desc "clean [RECIPE_PATH]", "Cleaning all contexts and removing the checkpoints"
+    desc "clean [RECIPE_PATH]", "Cleans all contexts and removing the checkpoints"
     method_option :build_path, :type => :string ,
                   :default => nil, :aliases => "-b",
-                  :desc => "Set the build directory path"
+                  :desc => "Sets the build directory path"
     def clean(recipe_path)
       opts = Hash.new.merge options
       opts[:lazyload] = false
@@ -187,7 +238,7 @@ module Kameleon
 
     desc "commands", "Lists all available commands", :hide => true
     def commands
-      puts CLI.all_commands.keys - ["commands", "completions"]
+      puts Main.all_commands.keys - ["commands", "completions"]
     end
 
     desc "source_root", "Prints the kameleon directory path", :hide => true
@@ -207,7 +258,7 @@ module Kameleon
       opts = args[1]
       cmd_name = args[2][:current_command].name
       if opts.include? "--help" or opts.include? "-h"
-        CLI.command_help(Kameleon.ui.shell, cmd_name)
+        Main.command_help(Kameleon.ui.shell, cmd_name)
         raise Kameleon::Exit
       end
     end
@@ -219,10 +270,6 @@ module Kameleon
       raise e
     end
 
-    def self.source_root
-      Kameleon.source_root
-    end
-
   end
 
 end