crowbar-client 2.4.1 → 2.4.2

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

@@ -17,12 +17,22 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI entry point which resolves the sub-commands
+      #
       class Entry < Base
+        check_unknown_options!
+
         map [
           "--version",
           "-v"
         ] => :version
 
+        map [
+          "--help",
+          "-h"
+        ] => :help
+
         class_option :alias,
           type: :string,
           default: Config.defaults[:alias],
@@ -56,7 +66,7 @@ module Crowbar
         class_option :anonymous,
           type: :boolean,
           default: Config.defaults[:anonymous],
-          aliases: ["-a"],
+          aliases: ["-A"],
           desc: "Skip API user authentication"
 
         class_option :debug,
@@ -65,6 +75,18 @@ module Crowbar
           aliases: ["-d"],
           desc: "Output more debug information"
 
+        # TODO(should): Prevent a --no-help alternative flag
+        # class_option :help,
+        #   type: :boolean,
+        #   aliases: ["-h"],
+        #   desc: "Print this help information"
+
+        # TODO(should): Prevent a --no-version alternative flag
+        # class_option :version,
+        #   type: :boolean,
+        #   aliases: ["-v"],
+        #   desc: "Print the current version of the CLI"
+
         desc "version",
           "Display the current version of the client"
 
@@ -74,6 +96,9 @@ module Crowbar
           to debug some issue with the current implementation.
         LONGDESC
 
+        #
+        # Command to print the version of Crowbar CLI
+        #
         def version
           say "crowbar-client v#{Crowbar::Client::Version}"
         end

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for host IP commands
+      #
       class HostIP < Base
         namespace "network hostip"
 
@@ -28,6 +31,18 @@ module Crowbar
           try to allocate a host IP address for the specified node.
         LONGDESC
 
+        #
+        # Host IP allocate command
+        #
+        # It will try to allocate a host IP address for the specified
+        # node.
+        #
+        # @param proposal [String] the proposal name
+        # @param node [String] the node name or alias
+        # @param network [String] the network name
+        # @param range [String] the network range
+        # @param suggestion [String] an optional suggestion
+        #
         def allocate(proposal, node, network, range, suggestion = nil)
           Command::HostIP::Allocate.new(
             *command_params(
@@ -50,6 +65,15 @@ module Crowbar
           a host IP address for the specified node.
         LONGDESC
 
+        #
+        # Host IP deallocate command
+        #
+        # It will try to deallocate a host IP address.
+        #
+        # @param proposal [String] the proposal name
+        # @param node [String] the node name or alias
+        # @param network [String] the network name
+        #
         def deallocate(proposal, node, network)
           Command::HostIP::Deallocate.new(
             *command_params(

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for installer commands
+      #
       class Installer < Base
         desc "status",
           "Show current installer status"
@@ -65,6 +68,13 @@ module Crowbar
           banner: "<filter>",
           desc: "Filter by criteria, display only data that contains filter"
 
+        #
+        # Installer status command
+        #
+        # It will print out information about the current status of the
+        # installer. You can display the list in different output formats
+        # and you can filter the list by any search criteria.
+        #
         def status
           Command::Installer::Status.new(
             *command_params
@@ -77,7 +87,7 @@ module Crowbar
           "Start the insallation of Crowbar"
 
         long_desc <<-LONGDESC
-          `start` will trigger the installation of the Administration Server.
+          `start` will trigger the installation of the server.
 
           With --force you can enforce a reinstallation if the installation
           has already been finished. Be careful with that option as you will
@@ -90,6 +100,11 @@ module Crowbar
           aliases: [],
           desc: "Force Administration Server installation"
 
+        #
+        # Installer start command
+        #
+        # It will trigger the installation of the server.
+        #
         def start
           Command::Installer::Start.new(
             *command_params

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for interface commands
+      #
       class Interface < Base
         namespace "network interface"
 
@@ -28,6 +31,15 @@ module Crowbar
           specified network interface on the specified node.
         LONGDESC
 
+        #
+        # Interface enable command
+        #
+        # Enable a network interface.
+        #
+        # @param proposal [String] the proposal name
+        # @param node [String] the node name or alias
+        # @param network [String] the network name
+        #
         def enable(proposal, node, network)
           Command::Interface::Enable.new(
             *command_params(
@@ -48,6 +60,15 @@ module Crowbar
           specified network interface on the specified node.
         LONGDESC
 
+        #
+        # Interface disable command
+        #
+        # Disable a network interface.
+        #
+        # @param proposal [String] the proposal name
+        # @param node [String] the node name or alias
+        # @param network [String] the network name
+        #
         def disable(proposal, node, network)
           Command::Interface::Disable.new(
             *command_params(

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for network commands
+      #
       class Network < Base
         desc "virtualip [COMMANDS]",
           "Actions for virtual IP addresses, call without params for help"

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for node commands
+      #
       class Node < Base
         desc "status",
           "Show current nodes status"

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for proposal commands
+      #
       class Proposal < Base
         desc "list BARCLAMP",
           "Show a list of available proposals"

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for repository commands
+      #
       class Repository < Base
         desc "list",
           "List all available repositories"

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for role commands
+      #
       class Role < Base
         desc "list BARCLAMP",
           "List available roles for barclamp"

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for server commands
+      #
       class Server < Base
         desc "api BARCLAMP",
           "Show the API documentation"
@@ -35,6 +38,59 @@ module Crowbar
         rescue => e
           catch_errors(e)
         end
+
+        desc "check",
+          "Perform sanity checks on the server"
+
+        long_desc <<-LONGDESC
+          `check` will perform sanity checks on the server.
+
+          With --format <format> option you can choose an output format
+          with the available options table, json or plain. You can also
+          use the shortcut options --table, --json or --plain.
+
+          With --filter <filter> option you can limit the result of
+          printed out elements. You can use any substring that is part
+          of the found elements.
+        LONGDESC
+
+        method_option :format,
+          type: :string,
+          default: "table",
+          banner: "<format>",
+          desc: "Format of the output, valid formats are table, json or plain"
+
+        method_option :table,
+          type: :boolean,
+          default: false,
+          aliases: [],
+          desc: "Format output as table, a shortcut for --format table option"
+
+        method_option :json,
+          type: :boolean,
+          default: false,
+          aliases: [],
+          desc: "Format output as table, a shortcut for --format json option"
+
+        method_option :plain,
+          type: :boolean,
+          default: false,
+          aliases: [],
+          desc: "Format output as table, a shortcut for --format plain option"
+
+        method_option :filter,
+          type: :string,
+          default: nil,
+          banner: "<filter>",
+          desc: "Filter by criteria, display only data that contains filter"
+
+        def check
+          Command::Server::Check.new(
+            *command_params
+          ).execute
+        rescue => e
+          catch_errors(e)
+        end
       end
     end
   end

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module App
+      #
+      # A Thor based CLI wrapper for virtual IP commands
+      #
       class VirtualIP < Base
         namespace "network virtualip"
 
@@ -28,6 +31,18 @@ module Crowbar
           try to allocate a virtual IP address for the specified service.
         LONGDESC
 
+        #
+        # Virtual IP allocate command
+        #
+        # It will try to allocate a virtual IP address for the specified
+        # service.
+        #
+        # @param proposal [String] the proposal name
+        # @param service [String] the service name
+        # @param network [String] the network name
+        # @param range [String] the network range
+        # @param suggestion [String] an optional suggestion
+        #
         def allocate(proposal, service, network, range, suggestion = nil)
           Command::VirtualIP::Allocate.new(
             *command_params(
@@ -50,6 +65,15 @@ module Crowbar
           a virtual IP address for the specified service.
         LONGDESC
 
+        #
+        # Virtual IP deallocate command
+        #
+        # It will try to deallocate a virtual IP address.
+        #
+        # @param proposal [String] the proposal name
+        # @param service [String] the service name
+        # @param network [String] the network name
+        #
         def deallocate(proposal, service, network)
           Command::VirtualIP::Deallocate.new(
             *command_params(

data/lib/crowbar/client/command.rb

@@ -16,6 +16,9 @@
 
 module Crowbar
   module Client
+    #
+    # Module for the command implementations
+    #
     module Command
       autoload :Backup,
         File.expand_path("../command/backup", __FILE__)

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Command
+      #
+      # Module for the backup command implementations
+      #
       module Backup
         autoload :Create,
           File.expand_path("../backup/create", __FILE__)

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

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Backup
+        #
+        # Implementation for the backup create command
+        #
         class Create < Base
           def request
             @request ||= Request::Backup::Create.new(

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

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Backup
+        #
+        # Implementation for the backup delete command
+        #
         class Delete < Base
           def request
             @request ||= Request::Backup::Delete.new(

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

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Backup
+        #
+        # Implementation for the backup download command
+        #
         class Download < Base
           def request
             @request ||= Request::Backup::Download.new(

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

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Backup
+        #
+        # Implementation for the backup list command
+        #
         class List < Base
           include Mixin::Format
           include Mixin::Filter

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

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Backup
+        #
+        # Implementation for the backup restore command
+        #
         class Restore < Base
           def request
             @request ||= Request::Backup::Restore.new(

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

@@ -17,6 +17,9 @@ module Crowbar
   module Client
     module Command
       module Backup
+        #
+        # Implementation for the backup upload command
+        #
         class Upload < Base
           def request
             args.file =

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Command
+      #
+      # Module for the barclamp command implementations
+      #
       module Barclamp
         autoload :List,
           File.expand_path("../barclamp/list", __FILE__)