crowbar-client 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 196e25c8ac9b8112656985164751b9a51b732178
-  data.tar.gz: 3d281cb6d8561bc51f78d9aae02517b714761d0f
+  metadata.gz: ad1e74fd43f734f1de83365be861088e5fe578f3
+  data.tar.gz: 7227247e2f6d0650fbaaa3a4ee94e3560f16324b
 SHA512:
-  metadata.gz: ba6e3e297bd4a9d22c6c737c040101af78dbf2b1c70b9ee70eddb377f72e844b3759e098dcbd646998ebababb04d9c6070d666048b95eb6bdcfa58387c99fefe
-  data.tar.gz: 8572d1bb1472e8a57133bd94731205783011803fb5902ef8f0947591350f6197b2bd19fc1237defeec06c6a455d6352e58a2c4d9f2c85976a9b20424d0b8dfd6
+  metadata.gz: 48598a6ec995593fc838e7a5dfa08a476605445fb7fc0d2d6f643e1ab88b73d812b1c8e07ebc546305d72db39cdbfbeeabf2019f4c87ea38ed432b3c6079cf0d
+  data.tar.gz: 0deaf315129041b3fdd4209734324170476de4a6bb9b21324d6c525f957d781d7c37a2cbaa81d539e3555674b7f781e224d391ae41714343596b09e1e39bf34e

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [2.4.0](https://github.com/crowbar/crowbar-client/releases/tag/v2.4.0) - 2015-01-27
+
+* BUGFIX
+  * Fixed backup commands by name (@tboerger)
+  * Fixed help output for nested commands (@tboerger)
+* ENHANCEMENT
+  * Added subcommand to trigger a backup restore (@tboerger)
+  * Added subcommand for batch build and export (@tboerger)
+
 ## [2.3.0](https://github.com/crowbar/crowbar-client/releases/tag/v2.3.0) - 2015-01-15
 
 * BREAKING

data/lib/crowbar/client/app/backup.rb

@@ -22,9 +22,9 @@ module Crowbar
           "List existing backups"
 
         long_desc <<-LONGDESC
-          `list` will print out a list of existing backups on the admin
-          node. You can display the list in different output
-          formats and you can filter the list by any search criteria.
+          `list` will print out a list of existing backups on the server.
+          You can display the list in different output formats and you
+          can filter the list by any search criteria.
 
           With --format <format> option you can choose an output format
           with the available options table, json or plain. You can also
@@ -73,34 +73,71 @@ module Crowbar
           catch_errors(e)
         end
 
+        desc "restore NAME",
+          "Restore from a backup"
+
+        long_desc <<-LONGDESC
+          `restore NAME` will trigger the restore process based on the
+          specified backup name. This command will override the proposals
+          of your server.
+
+          With --yes option you can force the restore without any further
+          question, this skips the otherwise required confirmation.
+        LONGDESC
+
+        method_option :yes,
+          type: :boolean,
+          default: false,
+          aliases: [],
+          desc: "Force the restore without any confirmation message"
+
+        def restore(name)
+          unless accepts_restore?
+            say "Canceled restore"
+            return
+          end
+
+          Command::Backup::Restore.new(
+            *command_params(
+              name: name
+            )
+          ).execute
+        rescue => e
+          catch_errors(e)
+        end
+
         desc "create",
           "Create a new backup"
 
         long_desc <<-LONGDESC
-          `create NAME` will create a new backup on the Administration Server.
+          `create NAME` will trigger the creation of a new backup on the
+          server, to download the backup after processing you can use the
+            download command.
         LONGDESC
 
         def create(name)
           Command::Backup::Create.new(
             *command_params(
-              backup: name
+              name: name
             )
           ).execute
         rescue => e
           catch_errors(e)
         end
 
-        desc "download",
-          "Download a backup"
+        desc "delete",
+          "Delete a backup"
 
         long_desc <<-LONGDESC
-          `download ID` will download a backup from the Administration Server.
+          `delete NAME` will delete a backup from the server. Be careful
+          with that command, you are not able to restore this file after
+          deletion.
         LONGDESC
 
-        def download(id)
-          Command::Backup::Download.new(
+        def delete(name)
+          Command::Backup::Delete.new(
             *command_params(
-              id: id
+              name: name
             )
           ).execute
         rescue => e
@@ -111,37 +148,66 @@ module Crowbar
           "Upload a backup"
 
         long_desc <<-LONGDESC
-          `upload FILE` will upload a backup to the Administration Server.
+          `upload FILE` will upload a backup to the server. You can use
+          this backup later to trigger a restore.
         LONGDESC
 
         def upload(file)
           Command::Backup::Upload.new(
             *command_params(
-              file: File.new(
-                file
-              )
+              file: file
             )
           ).execute
         rescue => e
           catch_errors(e)
         end
 
-        desc "delete",
-          "Delete a backup"
+        desc "download",
+          "Download a backup"
 
         long_desc <<-LONGDESC
-          `delete ID` will delete a backup from the Administration Server.
+          `download NAME [FILE]` will download a backup from the server. If
+          you specify a `file` the download gets written to that file,
+          otherwise it gets saved to the current working directory with an
+          automatically generated filename. You can directly provide a path
+          to a file or just pipe the content to stdout. To pipe the content
+          to stdout you should just write a `-` instead of a specific
+          filename.
         LONGDESC
 
-        def delete(id)
-          Command::Backup::Delete.new(
+        def download(name, file = nil)
+          Command::Backup::Download.new(
             *command_params(
-              id: id
+              name: name,
+              file: file
             )
           ).execute
         rescue => e
           catch_errors(e)
         end
+
+        no_commands do
+          def accepts_restore?
+            return true if options[:yes]
+
+            question = <<-QUESTION.strip_heredoc
+              Usage of this command is dangerous as it overwrites the
+              current state of the server and the proposals. Are you
+              sure you want to proceed?
+            QUESTION
+
+            answer = ask(
+              question,
+              :red,
+              limited_to: [
+                "yes",
+                "no"
+              ]
+            )
+
+            answer == "yes"
+          end
+        end
       end
     end
   end

data/lib/crowbar/client/app/base.rb

@@ -80,6 +80,26 @@ module Crowbar
             end
           end
         end
+
+        class << self
+          def handle_argument_error(command, error, args, arity)
+            $stderr.puts("Usage: #{banner(command)}")
+            exit(2)
+          end
+
+          def banner(command, namespace = nil, subcommand = true)
+            addition = command.formatted_usage(
+              self,
+              false,
+              subcommand
+            )
+
+            [
+              basename,
+              addition
+            ].compact.join(" ")
+          end
+        end
       end
     end
   end

data/lib/crowbar/client/app/batch.rb

@@ -28,24 +28,29 @@ module Crowbar
           stdin you should just write a `-` instead of a specific
           filename.
 
-          With --include <barclamp[.proposal]> option you can process
-          only a specific part from the provided YAML file structure.
+          With --includes BARCLAMP[.PROPOSAL] option you can process
+          only a specific part from the provided YAML file structure,
+          the `default` proposal will be taken if you don't provide a
+          proposal name. This option allows multiple values, separated
+          by a `,` from each other.
 
-          With --exclude <barclamp[.proposal]> option you exclude
+          With --excludes BARCLAMP[.PROPOSAL] option you exclude
           specific parts from the provided YAML file structure to be
-          processed.
+          processed, the `default` proposal will be taken if you don't
+          provide a proposal name. This option allows multiple values,
+          separated by a `,` from each other.
         LONGDESC
 
-        method_option :include,
-          type: :string,
-          default: nil,
-          banner: "<barclamp[.proposal]>",
+        method_option :includes,
+          type: :array,
+          default: [],
+          banner: "BARCLAMP[.PROPOSAL]",
           desc: "Include a specific barclamp or proposal for processing"
 
-        method_option :exclude,
-          type: :string,
-          default: nil,
-          banner: "<barclamp[.proposal]>",
+        method_option :excludes,
+          type: :array,
+          default: [],
+          banner: "BARCLAMP[.PROPOSAL]",
           desc: "Exclude a specific barclamp or proposal for processing"
 
         def build(file)
@@ -58,37 +63,45 @@ module Crowbar
           catch_errors(e)
         end
 
-        desc "export PROPOSAL [PROPOSAL]",
-          "Export proposals to stdout"
+        desc "export FILE",
+          "Export proposals to file or stdout"
 
         long_desc <<-LONGDESC
-          `export PROPOSAL [PROPOSAL]` will collect the informations
-          for the provided proposals and print it out to stdout in a
-          YAML format that can be used to build again.
+          `export FILE` will collect the informations of the proposals
+          in a YAML format. You can directly provide a path to a file or
+          just pipe the content into stdout. To pipe the content to
+          stdout you should just write a `-` instead of a specific
+          filename.
 
-          With --include <barclamp[.proposal]> option you can export
-          only a specific part from the existing proposals.
+          With --includes BARCLAMP[.PROPOSAL] option you can export
+          only a specific part from the existing proposals, the `default`
+          proposal will be taken if you don't provide a proposal name.
+          This option allows multiple values, separated by a `,` from
+          each other.
 
-          With --exclude <barclamp[.proposal]> option you exclude
-          specific parts from the existing proposals to be exported.
+          With --excludes BARCLAMP[.PROPOSAL] option you exclude specific
+          parts from the existing proposals to be exported, the `default`
+          proposal will be taken if you don't provide a proposal name.
+          This option allows multiple values, separated by a `,` from
+          each other.
         LONGDESC
 
-        method_option :include,
-          type: :string,
-          default: nil,
-          banner: "<barclamp[.proposal]>",
+        method_option :includes,
+          type: :array,
+          default: [],
+          banner: "BARCLAMP[.PROPOSAL]",
           desc: "Include a specific barclamp or proposal for export"
 
-        method_option :exclude,
-          type: :string,
-          default: nil,
-          banner: "<barclamp[.proposal]>",
+        method_option :excludes,
+          type: :array,
+          default: [],
+          banner: "BARCLAMP[.PROPOSAL]",
           desc: "Exclude a specific barclamp or proposal for export"
 
-        def export(*proposals)
+        def export(file)
           Command::Batch::Export.new(
             *command_params(
-              proposals: proposals
+              file: file
             )
           ).execute
         rescue => e

data/lib/crowbar/client/app/host_ip.rb

@@ -18,6 +18,8 @@ module Crowbar
   module Client
     module App
       class HostIP < Base
+        namespace "network hostip"
+
         desc "allocate PROPOSAL NODE NETWORK RANGE [SUGGESTION]",
           "Allocate a host IP address"
 

data/lib/crowbar/client/app/interface.rb

@@ -18,6 +18,8 @@ module Crowbar
   module Client
     module App
       class Interface < Base
+        namespace "network interface"
+
         desc "enable PROPOSAL NODE NETWORK",
           "Enable a network interface"
 

data/lib/crowbar/client/app/virtual_ip.rb

@@ -18,6 +18,8 @@ module Crowbar
   module Client
     module App
       class VirtualIP < Base
+        namespace "network virtualip"
+
         desc "allocate PROPOSAL SERVICE NETWORK RANGE [SUGGESTION]",
           "Allocate a virtual IP address"
 

data/lib/crowbar/client/command/backup.rb

@@ -30,6 +30,9 @@ module Crowbar
         autoload :List,
           File.expand_path("../backup/list", __FILE__)
 
+        autoload :Restore,
+          File.expand_path("../backup/restore", __FILE__)
+
         autoload :Upload,
           File.expand_path("../backup/upload", __FILE__)
       end

data/lib/crowbar/client/command/backup/delete.rb

@@ -30,6 +30,8 @@ module Crowbar
               case request.code
               when 200
                 say "Successfully deleted the backup"
+              when 404
+                err "Backup does not exist"
               else
                 err request.parsed_response["error"]
               end

data/lib/crowbar/client/command/backup/download.rb

@@ -14,8 +14,6 @@
 # limitations under the License.
 #
 
-require "httparty"
-
 module Crowbar
   module Client
     module Command
@@ -32,12 +30,14 @@ module Crowbar
               case request.code
               when 200
                 if write(request.body)
-                  say "Successfully downloaded backup to #{path}"
+                  say "Successfully downloaded backup"
                 else
-                  say "Failed to download backup to #{path}"
+                  err "Failed to download backup"
                 end
+              when 404
+                err "Backup does not exist"
               else
-                err request.parsed_response["error"]
+                err request.body
               end
             end
           end
@@ -45,21 +45,28 @@ module Crowbar
           protected
 
           def write(body)
-            path.open("wb") do |f|
-              f.binmode
-              f.write body
+            path.binmode
+            path.write body
 
-              true
-            end
+            true
           rescue
+            path.unlink if path.file?
             false
           end
 
           def path
-            filename = Request::Backup::List.new.process do |p|
-              p.parsed_response.select { |s| s["id"] == args.id.to_i }
-            end.first["name"]
-            Pathname.new("#{filename}.tar.gz")
+            @path ||=
+              case args.file
+              when "-"
+                stdout.to_io
+              when File
+                args.file
+              else
+                File.new(
+                  args.file || "#{args.name}.tar.gz",
+                  File::CREAT | File::TRUNC | File::RDWR
+                )
+              end
           end
         end
       end

data/lib/crowbar/client/command/backup/list.rb

@@ -55,18 +55,21 @@ module Crowbar
           protected
 
           def headings
-            ["Id", "Name", "Created", "Size", "Version"]
+            ["Name", "Created", "Size", "Version"]
           end
 
           def content_from(request)
             request.parsed_response.map do |row|
               row.slice(
-                "id",
                 "name",
                 "created_at",
                 "size",
                 "version"
-              )
+              ).tap do |values|
+                values["size"] = number_to_human_size(
+                  values["size"]
+                )
+              end
             end
           end
         end