kameleon-builder 2.10.9 → 2.10.11

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 <GIT_URL>."
+      desc "add <NAME> <GIT_URL>", "Add a new repository named <NAME> cloned from <GIT_URL>"
       method_option :branch, :type => :string,
                     :default => nil,
                     :desc => "checkout <BRANCH>",
@@ -20,7 +20,7 @@ module Kameleon
         Kameleon::Repository.add(name, url, options)
       end
 
-      desc "list", "Lists available repositories."
+      desc "list", "List available repositories"
       method_option :git, :type => :boolean,
                     :default => true,
                     :desc => "show the git repository and branch each repository comes from"
@@ -28,7 +28,7 @@ module Kameleon
         Kameleon::Repository.list(options)
       end
 
-      desc "update <NAME>", "Updates repository named <NAME> from git"
+      desc "update <NAME>", "Update repository named <NAME> from git"
       def update(name)
         Kameleon::Repository.update(name)
       end
@@ -38,7 +38,7 @@ module Kameleon
         Kameleon::Repository.remove(name)
       end
 
-      desc "commands", "Lists all available commands", :hide => true
+      desc "commands", "List all available commands", :hide => true
       def commands
         puts Repository.all_commands.keys - ["commands"]
       end
@@ -56,7 +56,7 @@ module Kameleon
         Kameleon.env.repositories_path
       end
 
-      desc "list", "Lists all available templates"
+      desc "list", "List all available templates"
       method_option :progress, :type => :boolean, :default => true,
                     :desc => "Show progress bar while resolving templates",
                     :aliases => "-p"
@@ -69,10 +69,10 @@ module Kameleon
         Utils.list_recipes(Kameleon.env.repositories_path, options[:filter], options[:progress], true)
       end
 
-      desc "import <TEMPLATE_NAME>", "Imports the given template"
+      desc "import <TEMPLATE_NAME>", "Import the given template"
       method_option :global, :type => :hash,
                     :default => {},  :aliases => "-g",
-                    :desc => "Set custom global variables."
+                    :desc => "Set custom global variables"
       def import(template_name)
         Kameleon.env.root_dir = Kameleon.env.repositories_path
         template_path = File.join(Kameleon.env.repositories_path, template_name)
@@ -104,7 +104,7 @@ module Kameleon
       desc "info <TEMPLATE_NAME>", "Display detailed information about a template"
       method_option :global, :type => :hash,
                     :default => {},  :aliases => "-g",
-                    :desc => "Set custom global variables."
+                    :desc => "Set custom global variables"
       def info(template_name)
         Kameleon.env.root_dir = Kameleon.env.repositories_path
         template_path = File.join(Kameleon.env.repositories_path, template_name)
@@ -133,7 +133,7 @@ module Kameleon
         copy_file(Pathname.new(Kameleon.erb_dirpath).join("extend.yaml.erb"), erb_file)
       end
 
-      desc "commands", "Lists all available commands", :hide => true
+      desc "commands", "List all available commands", :hide => true
       def commands
         puts Template.all_commands.keys - ["commands"]
       end
@@ -147,22 +147,22 @@ module Kameleon
   class Main < Thor
     include Thor::Actions
 
-    desc 'repository <SUBCOMMAND>', 'Manages repositories of recipes'
+    desc 'repository <SUBCOMMAND>', 'Manage repositories of recipes'
     subcommand 'repository', CLI::Repository
-    desc 'template <SUBCOMMAND>', 'Lists and imports templates'
+    desc 'template <SUBCOMMAND>', 'List and import templates'
     subcommand 'template', CLI::Template
 
     class_option :color, :type => :boolean, :default => Kameleon.default_values[:color],
-                 :desc => "Enables colorization in output"
+                 :desc => "Enable colorization in output"
     class_option :verbose, :type => :boolean, :default => Kameleon.default_values[:verbose],
-                 :desc => "Enables verbose output for kameleon users"
+                 :desc => "Enable verbose output for kameleon users"
     class_option :debug, :type => :boolean, :default => Kameleon.default_values[:debug],
-                 :desc => "Enables debug output for kameleon developpers"
+                 :desc => "Enable debug output for kameleon developpers"
     class_option :script, :type => :boolean, :default => Kameleon.default_values[:script],
-                 :desc => "Never prompts for user intervention",
+                 :desc => "Never prompt for user intervention",
                  :aliases => "-s"
 
-    desc "version", "Prints the Kameleon's version information"
+    desc "version", "Print the Kameleon's version information"
     def version
       puts "Kameleon version #{Kameleon::VERSION}"
     end
@@ -171,7 +171,7 @@ module Kameleon
       Kameleon.env.repositories_path
     end
 
-    desc "list", "Lists all defined recipes in the current directory"
+    desc "list", "List all defined recipes in the current directory"
     method_option :progress, :type => :boolean, :default => false,
                   :desc => "Show progress bar while resolving recipes",
                   :aliases => "-p"
@@ -183,10 +183,10 @@ module Kameleon
       Utils.list_recipes(Kameleon.env.workspace, options[:filter], options[:progress])
     end
 
-    desc "new <RECIPE_PATH> <TEMPLATE_NAME>", "Creates a new recipe from template <TEMPLATE_NAME>"
+    desc "new <RECIPE_PATH> <TEMPLATE_NAME>", "Create a new recipe from template <TEMPLATE_NAME>"
     method_option :global, :type => :hash,
                   :default => {},  :aliases => "-g",
-                  :desc => "Set custom global variables."
+                  :desc => "Set custom global variables"
     def new(recipe_name, template_name)
       Kameleon.env.root_dir = Kameleon.env.repositories_path
       unless template_name.end_with? '.yaml'
@@ -248,7 +248,7 @@ module Kameleon
     desc "info <RECIPE_PATH>", "Display detailed information about a recipe"
     method_option :global, :type => :hash,
                   :default => {},  :aliases => "-g",
-                  :desc => "Set custom global variables."
+                  :desc => "Set custom global variables"
     method_option :from_cache, :type => :string,
                   :default => nil,
                   :desc => "Get info from a persistent cache tar file (ignore recipe path)"
@@ -280,7 +280,7 @@ module Kameleon
     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."
+                  :desc => "Set custom global variables"
     method_option :file, :type => :string,
                   :default => "/tmp/kameleon.dag",
                   :desc => "DAG output filename"
@@ -319,25 +319,10 @@ module Kameleon
       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."
+                  :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)"
@@ -377,56 +362,64 @@ module Kameleon
       end
     end
 
-    desc "build <RECIPE_PATH>", "Builds the appliance from the given recipe"
+    desc "build <RECIPE_PATH>", "Build the appliance from the given recipe"
     method_option :build_path, :type => :string,
                   :default => nil, :aliases => "-b",
-                  :desc => "Sets the build directory path"
+                  :desc => "Set the build directory path"
     method_option :clean, :type => :boolean,
                   :default => false,
-                  :desc => "Runs the command `kameleon clean` first"
-    method_option :from_checkpoint, :type => :string,
+                  :desc => "Run the command `kameleon clean` first"
+    method_option :dryrun, :type => :boolean, :aliases => "-d",
+                  :default => false,
+                  :desc => "Dry run, only show what would run"
+    method_option :relative, :type => :boolean,
+                  :default => false,
+                  :desc => "Make dryrun show pathnames relative to the current working directory"
+    method_option :from_checkpoint, :type => :string, :aliases => "-F",
+                  :default => nil,
+                  :desc => "Restart the build from a specific checkpointed step, instead of the latest one"
+    method_option :begin_checkpoint, :type => :string, :aliases => "-B",
                   :default => nil,
-                  :desc => "Uses specific checkpoint to build the image. " \
-                           "Default value is the last checkpoint."
-    method_option :enable_checkpoint, :type => :boolean,
+                  :desc => "Only create checkpoints after the given step"
+    method_option :end_checkpoint, :type => :string, :aliases => "-E",
+                  :default => nil,
+                  :desc => "Do not create checkpoints after the given step"
+    method_option :enable_checkpointing, :type => :boolean, :aliases => "-c",
                   :default => false,
-                  :desc => "Enables checkpointing"
-    method_option :microstep_checkpoint, :type => :string,
+                  :desc => "Enable creating and using checkpoints"
+    method_option :microstep_checkpoints, :type => :string,
                   :enum => ["first", "all"],
-                  :default => "first",
+                  :default => "all",
                   :desc => "Create checkpoint of the first microstep only, or all"
-    method_option :list_checkpoints, :type => :boolean, :aliases => "--checkpoints",
+    method_option :list_checkpoints, :type => :boolean, :aliases => "-l",
                   :default => false,
-                  :desc => "Lists all availables checkpoints"
-    method_option :enable_cache, :type => :boolean,
+                  :desc => "List availables checkpoints"
+    method_option :enable_cache, :type => :boolean, :aliases => "-C",
                   :default => false,
-                  :desc => "Generates a persistent cache for the appliance."
+                  :desc => "Generate a persistent cache for the appliance"
     method_option :cache_path, :type => :string,
                   :default => nil,
-                  :desc => "Sets the cache directory path"
+                  :desc => "Set the cache directory path"
     method_option :from_cache, :type => :string,
                   :default => nil,
-                  :desc => "Uses a persistent cache tar file to build the image."
+                  :desc => "Use a persistent cache tar file to build the image"
     method_option :cache_archive_compression, :type => :string,
                   :enum => ["none", "gzip", "bz2", "xz"],
                   :default => "gzip",
-                  :desc => "Set the persistent cache tar file compression."
+                  :desc => "Set the persistent cache tar file compression"
     method_option :polipo_path, :type => :string,
                   :default => nil,
-                  :desc => "Full path of the polipo binary to use for the persistent cache."
+                  :desc => "Full path of the polipo binary to use for the persistent cache"
     method_option :proxy, :type => :string, :default => "",
-                  :desc => "Specifies the hostname and port number of an HTTP " \
-                           "proxy; it should have the form 'host:port'"
+                  :desc => "HTTP proxy address and port (expected format is hostname:port)"
     method_option :proxy_credentials, :type => :string, :default => "",
-                  :desc => "Specifies the username and password if the parent "\
-                           "proxy requires authorisation it should have the "\
-                           "form 'username:password'"
+                  :desc => "Username and password if required by the parent proxy (expected format is username:password)"
     method_option :proxy_offline, :type => :boolean,
-                  :default => false, :aliases => "--offline",
-                  :desc => "Prevents Polipo from contacting remote servers"
+                  :default => false,
+                  :desc => "Prevent Polipo from contacting remote servers"
     method_option :global, :type => :hash,
                   :default => {}, :aliases => "-g",
-                  :desc => "Set custom global variables."
+                  :desc => "Set custom global variables"
     def build(recipe_path=nil)
       if recipe_path.nil? && !options[:from_cache].nil?
         unless File.file?(options[:from_cache])
@@ -440,7 +433,9 @@ module Kameleon
       end
       raise BuildError, "A recipe file or a persistent cache archive " \
                         "is required to run this command." if recipe_path.nil?
-      if options[:clean]
+      if options[:dryrun]
+        Kameleon::Engine.new(Kameleon::Recipe.new(recipe_path), options.dup.merge({no_create_build_dir: true}).freeze).dryrun
+      elsif options[:clean]
         opts = Hash.new.merge options
         opts[:lazyload] = false
         opts[:fail_silently] = true
@@ -458,11 +453,11 @@ module Kameleon
         total_time = Time.now.to_i - start_time
         Kameleon.ui.info("")
         Kameleon.ui.info("Successfully built '#{recipe_path}'")
-        Kameleon.ui.info("Total duration : #{total_time} secs")
+        Kameleon.ui.info("Total duration: #{total_time} secs")
       end
     end
 
-    desc "commands", "Lists all available commands", :hide => true
+    desc "commands", "List all available commands", :hide => true
     def commands(context="main")
       Kameleon.ui.debug("Commands for '#{context}':")
       case context
@@ -475,7 +470,7 @@ module Kameleon
       end
     end
 
-    desc "source_root", "Prints the kameleon directory path", :hide => true
+    desc "source_root", "Print the kameleon directory path", :hide => true
     def source_root
       puts Kameleon.source_root
     end

data/lib/kameleon/context.rb

@@ -79,7 +79,7 @@ module Kameleon
         do_log(out, log_level) unless out.nil?
         do_log(err, "error") unless err.nil?
       end
-      Kameleon.ui.verbose("Exit status : #{exit_status}")
+      Kameleon.ui.verbose("Exit status: #{exit_status}")
       fail ExecError unless exit_status.eql? 0
     rescue ShellError, Errno::EPIPE  => e
       Kameleon.ui.verbose("Shell cmd failed to launch: #{@shell.shell_cmd}")