crowbar-client 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4b636e56d83e9730ca3c0673c16bf3b224da00b
-  data.tar.gz: c0890e422cedfaae4323992edbbddecea89227da
+  metadata.gz: c1c168edc28fee98083d4a8fa4e2241956b79cec
+  data.tar.gz: cbb8ea40deeb4a95c12ca7113fdcde04878631a7
 SHA512:
-  metadata.gz: ff7ebe7f47b711872f134a1741a4219469efbb88eab2dd6935ce76ab13bf5f05061693e540312aab02f1fee700ca23e5ab6e88c8d6f5eccaa462c9dab897c13f
-  data.tar.gz: 38d95910370053dc116d07355c75c30bd8b66e7d6f55af623115983d5bc91ca02db27408a11967046f44b8fe3d588ed1717850c893fc4ebc4e7d8d7b0dcbea2b
+  metadata.gz: 3ba3640b9f7d4828acde6300d6324b5856f818eee8b99859b9827b5f25a4caa90929882a4b2cf4e5287ae7b3a9f5f2e09df13a17a7bcb887e20442a0810a1735
+  data.tar.gz: 1243a8524c37791076b30e09d15e36dc7a60f13558a99ca9e407acc3f656c59ed2d424919550cea4ac46842d99a81229df4405cb458a907be452dca939fa18b2

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [2.4.2](https://github.com/crowbar/crowbar-client/releases/tag/v2.4.2) - 2015-05-04
+
+* BUGFIX
+  * Fixed duplicate option, renamed --anonymous shorthand from -a to -A (@tboerger)
+  * Raised timeout default value to prevent timeouts on requests (@MaximilianMeister)
+  * Pin development dependency listen to ruby 2.1 compatible version (@tboerger)
+* ENHANCEMENT
+  * Properly handle 502, 503 and 504 responses (@tboerger)
+  * Map -h and --help options properly to help subcommand (@tboerger)
+  * Extended the test suite (@MaximilianMeister)
+  * Enhanched the inline documentation (@tboerger)
+  * Added subcommand to check server sanity (@MaximilianMeister)
+
 ## [2.4.1](https://github.com/crowbar/crowbar-client/releases/tag/v2.4.1) - 2015-02-08
 
 * BUGFIX

data/README.md

@@ -1,9 +1,9 @@
 # Crowbar: Client
 
-This is an experimental implementation to replace the current CLI scripts of
-the crowbar barclamps. This tool is intended to be installable standalone,
-that way everybody who got access to the Crowbar admin network should be able
-to manage Crowbar from remote.
+This tool is a complete reimplementation of the old CLI scripts of Crowbar.
+It is intended to be installable standalone on any machine with access to
+the Crowbar admin network. It is the **recommended command line interface** to manage
+Crowbar from remote or locally on the Crowbar server itself.
 
 The [Crowbar Framework](https://github.com/crowbar/crowbar) is currently
 maintained by [SUSE](http://www.suse.com/) as an [OpenStack](http://openstack.org)
@@ -16,18 +16,30 @@ was originally developed by the [Dell CloudEdge Solutions Team](http://dell.com/
 [![Code Climate](https://codeclimate.com/github/crowbar/crowbar-client.svg)](https://codeclimate.com/github/crowbar/crowbar-client)
 [![Test Coverage](https://codeclimate.com/github/crowbar/crowbar-client/badges/coverage.svg)](https://codeclimate.com/github/crowbar/crowbar-client)
 [![Dependency Status](https://gemnasium.com/crowbar/crowbar-client.svg)](https://gemnasium.com/crowbar/crowbar-client)
+[![Inline Docs](http://inch-ci.org/github/crowbar/crowbar-client.svg?branch=master)](http://inch-ci.org/github/crowbar/crowbar-client)
 [![Join the chat at https://gitter.im/crowbar/crowbar](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/crowbar/crowbar)
 
 ## Install
 
-To install this simple rubygem you can check your package manager if it is
-available for you, alternativly you can just install the ruby gem if you have a
+To install this simple ruby gem you can check your package manager if it is
+available for you, alternatively you can just install the ruby gem if you have a
 running ruby stack on your machine with this command:
 
 ```
 gem install crowbar-client
 ```
 
+## Configuration
+
+`crowbar-client` can be configured by placing a `.crowbarrc` file in your `$HOME` directory.
+For details about the options see the [default configuration file](config/crowbarrc).
+
+## Usage
+
+```
+crowbarctl help
+```
+
 ## Contributing
 
 Fork -> Patch -> Spec -> Push -> Pull Request

data/lib/crowbar/client.rb

@@ -24,37 +24,91 @@ end
 require "active_support/all"
 
 module Crowbar
+  #
+  # Client for the Crowbar API
+  #
   module Client
+    #
+    # Error class that always gets caught by the client
+    #
     class SimpleCatchableError < StandardError
     end
 
+    #
+    # Error class to catch invalid options
+    #
     class BadOptionsError < SimpleCatchableError
     end
 
+    #
+    # Error class to catch unsupported formatters
+    #
     class BadFormatterError < SimpleCatchableError
     end
 
+    #
+    # Error class to catch unsupported filters
+    #
     class BadFilterError < SimpleCatchableError
     end
 
+    #
+    # Error class to catch invalid formats
+    #
     class InvalidFormatError < SimpleCatchableError
     end
 
+    #
+    # Error class to catch a closed editor exception
+    #
     class EditorAbortError < SimpleCatchableError
     end
 
+    #
+    # Error class to catch a editor startup exception
+    #
     class EditorStartupError < SimpleCatchableError
     end
 
+    #
+    # Error class to catch JSON parsing errors
+    #
     class InvalidJsonError < SimpleCatchableError
     end
 
+    #
+    # Error class to catch internal server errors
+    #
     class InternalServerError < SimpleCatchableError
     end
 
+    #
+    # Error class to catch bad gateway responses
+    #
+    class BadGatewayError < SimpleCatchableError
+    end
+
+    #
+    # Error class to catch service unavailable responses
+    #
+    class ServiceUnavailableError < SimpleCatchableError
+    end
+
+    #
+    # Error class to catch gateway timeout responses
+    #
+    class GatewayTimeoutError < SimpleCatchableError
+    end
+
+    #
+    # Error class to catch unauthorized responses
+    #
     class NotAuthorizedError < SimpleCatchableError
     end
 
+    #
+    # Error class to catch unavailable barclamps
+    #
     class UnavailableBarclampError < SimpleCatchableError
       def initialize(barclamp)
         super("Barclamp #{barclamp} is not available")

data/lib/crowbar/client/app.rb

@@ -16,6 +16,9 @@
 
 module Crowbar
   module Client
+    #
+    # Module for the Thor based CLI wrapper
+    #
     module App
       autoload :Backup,
         File.expand_path("../app/backup", __FILE__)

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for backup commands
+      #
       class Backup < Base
         desc "list",
           "List existing backups"
@@ -65,6 +68,13 @@ module Crowbar
           banner: "<filter>",
           desc: "Filter by criteria, display only data that contains filter"
 
+        #
+        # Backup list command
+        #
+        # It 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.
+        #
         def list
           Command::Backup::List.new(
             *command_params
@@ -91,6 +101,14 @@ module Crowbar
           aliases: [],
           desc: "Force the restore without any confirmation message"
 
+        #
+        # Backup restore command
+        #
+        # It will trigger the restore process based on the specified backup
+        # name. This command will override the proposals of your server.
+        #
+        # @param name [String] the name of the backup
+        #
         def restore(name)
           unless accepts_restore?
             say "Canceled restore"
@@ -112,9 +130,18 @@ module Crowbar
         long_desc <<-LONGDESC
           `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.
+          download command.
         LONGDESC
 
+        #
+        # Backup create command
+        #
+        # It will trigger the creation of a new backup on the server, to
+        # download the backup after processing you can use the download
+        # command.
+        #
+        # @param name [String] the name of the backup
+        #
         def create(name)
           Command::Backup::Create.new(
             *command_params(
@@ -134,6 +161,14 @@ module Crowbar
           deletion.
         LONGDESC
 
+        #
+        # Backup delete command
+        #
+        # It will delete a backup from the server. Be careful with that
+        # command, you are not able to restore this file after deletion.
+        #
+        # @param name [String] the name of the backup
+        #
         def delete(name)
           Command::Backup::Delete.new(
             *command_params(
@@ -152,6 +187,14 @@ module Crowbar
           this backup later to trigger a restore.
         LONGDESC
 
+        #
+        # Backup upload command
+        #
+        # It will upload a backup to the server. You can use this backup
+        # later to trigger a restore.
+        #
+        # @param file [String] the path to the file
+        #
         def upload(file)
           Command::Backup::Upload.new(
             *command_params(
@@ -175,6 +218,19 @@ module Crowbar
           filename.
         LONGDESC
 
+        #
+        # Backup download command
+        #
+        # It 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.
+        #
+        # @param name [String] the name of the backup
+        # @param file [String] the path of the file
+        #
         def download(name, file = nil)
           Command::Backup::Download.new(
             *command_params(
@@ -187,6 +243,11 @@ module Crowbar
         end
 
         no_commands do
+          #
+          # Ask if the restore should be really down
+          #
+          # @return [Bool] allow or disallow a restore
+          #
           def accepts_restore?
             return true if options[:yes]
 

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for barclamp commands
+      #
       class Barclamp < Base
         desc "list",
           "List available barclamps"
@@ -65,6 +68,13 @@ module Crowbar
           banner: "<filter>",
           desc: "Filter by criteria, display only data that contains filter"
 
+        #
+        # Barclamp list command
+        #
+        # It will print out a list of the available barclamps on the target
+        # cloud. You can display the list in different output formats and
+        # you can filter the list by any search criteria.
+        #
         def list
           Command::Barclamp::List.new(
             *command_params

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

@@ -20,7 +20,18 @@ require "easy_diff"
 module Crowbar
   module Client
     module App
+      #
+      # A base class that provides helper for the wrappers
+      #
       class Base < Thor
+        #
+        # Initialize the Thor command
+        #
+        # @param args [Array] the arguments
+        # @param local_options [Hash] the local options
+        # @param config [Hash] the configuration
+        # @return [Crowbar::Client::App::Base]
+        #
         def initialize(args = [], local_options = {}, config = {})
           super
 
@@ -40,10 +51,21 @@ module Crowbar
         no_commands do
           include Mixin::Format
 
+          #
+          # Print a message to STDOUT
+          #
+          # @param message [String] the message to print
+          #
           def say(message)
             $stdout.puts message
           end
 
+          #
+          # Print a message to STDERR
+          #
+          # @param message [String] the message to print
+          # @param exit_code [Integer] the exit code to use
+          #
           def err(message, exit_code = nil)
             case provide_format
             when :json
@@ -57,6 +79,12 @@ module Crowbar
             exit(exit_code) unless exit_code.nil?
           end
 
+          #
+          # Standard parameters for commands
+          #
+          # @param args [Hash] the arguments to inject
+          # @return [Array]
+          #
           def command_params(args = {})
             [
               $stdin,
@@ -67,6 +95,12 @@ module Crowbar
             ]
           end
 
+          #
+          # General errors to catch properly
+          #
+          # @param error [StandardError] the error to catch
+          # @raise [StandardError] only raised if uncatchable
+          #
           def catch_errors(error)
             case error
             when SimpleCatchableError
@@ -82,11 +116,27 @@ module Crowbar
         end
 
         class << self
+          #
+          # Properly print an error on invalid command
+          #
+          # @param command [String] the command that failed
+          # @param error [StandardError] the error class
+          # @param args [Array] the arguments that failed
+          # @param arity [Integer] the number of arguments
+          #
           def handle_argument_error(command, error, args, arity)
             $stderr.puts("Usage: #{banner(command)}")
             exit(2)
           end
 
+          #
+          # A banner that gets displayed on help and error
+          #
+          # @param command [String] the command for help output
+          # @param namespace [String] the namespace for help
+          # @param subcommand [Bool] the flag if it's a subcommand
+          # @return [String]
+          #
           def banner(command, namespace = nil, subcommand = true)
             addition = command.formatted_usage(
               self,

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for batch commands
+      #
       class Batch < Base
         desc "build FILE",
           "Build proposals from file or stdin"
@@ -53,6 +56,17 @@ module Crowbar
           banner: "BARCLAMP[.PROPOSAL]",
           desc: "Exclude a specific barclamp or proposal for processing"
 
+        #
+        # Batch build command
+        #
+        # It will create/edit/commit proposals defined in an YAML format. You
+        # can directly provide a path to a file or just pipe the content
+        # from stdin. To pipe the content from stdin you should just write
+        # a `-` instead of a specific filename.
+        #
+        # @param file [String] the path to the file
+        # @return [String] a formatted response from the server
+        #
         def build(file)
           Command::Batch::Build.new(
             *command_params(
@@ -98,6 +112,17 @@ module Crowbar
           banner: "BARCLAMP[.PROPOSAL]",
           desc: "Exclude a specific barclamp or proposal for export"
 
+        #
+        # Batch export command
+        #
+        # It will collect the information 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.
+        #
+        # @param file [String] the path of the file
+        # @return [String] a formatted response from the server
+        #
         def export(file = nil)
           Command::Batch::Export.new(
             *command_params(