crowbar-client 2.4.1 → 2.4.2

data/lib/crowbar/client/command/proposal/edit.rb

@@ -21,6 +21,9 @@ module Crowbar
   module Client
     module Command
       module Proposal
+        #
+        # Implementation for the proposal edit command
+        #
         class Edit < Base
           include Mixin::Barclamp
 

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

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Proposal
+        #
+        # Implementation for the proposal list command
+        #
         class List < Base
           include Mixin::Barclamp
 

data/lib/crowbar/client/command/proposal/reset.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Proposal
+        #
+        # Implementation for the proposal reset command
+        #
         class Reset < Base
           include Mixin::Barclamp
 

data/lib/crowbar/client/command/proposal/show.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Proposal
+        #
+        # Implementation for the proposal show command
+        #
         class Show < Base
           include Mixin::Barclamp
 

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Command
+      #
+      # Module for the repository command implementations
+      #
       module Repository
         autoload :Activate,
           File.expand_path("../repository/activate", __FILE__)

data/lib/crowbar/client/command/repository/activate.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Repository
+        #
+        # Implementation for the repository activate command
+        #
         class Activate < Base
           def request
             @request ||= Request::Repository::Activate.new(

data/lib/crowbar/client/command/repository/activate_all.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Repository
+        #
+        # Implementation for the repository activate all command
+        #
         class ActivateAll < Base
           def request
             @request ||= Request::Repository::ActivateAll.new(

data/lib/crowbar/client/command/repository/deactivate.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Repository
+        #
+        # Implementation for the repository deactivate command
+        #
         class Deactivate < Base
           def request
             @request ||= Request::Repository::Deactivate.new(

data/lib/crowbar/client/command/repository/deactivate_all.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Repository
+        #
+        # Implementation for the repository deactivate all command
+        #
         class DeactivateAll < Base
           def request
             @request ||= Request::Repository::DeactivateAll.new(

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

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

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

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

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

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Role
+        #
+        # Implementation for the role list command
+        #
         class List < Base
           include Mixin::Barclamp
 

data/lib/crowbar/client/command/role/show.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Role
+        #
+        # Implementation for the role show command
+        #
         class Show < Base
           include Mixin::Barclamp
 

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

@@ -17,9 +17,14 @@
 module Crowbar
   module Client
     module Command
+      #
+      # Module for the server command implementations
+      #
       module Server
         autoload :Api,
           File.expand_path("../server/api", __FILE__)
+        autoload :Check,
+          File.expand_path("../server/check", __FILE__)
       end
     end
   end

data/lib/crowbar/client/command/server/api.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module Server
+        #
+        # Implementation for the server API command
+        #
         class Api < Base
           include Mixin::Barclamp
 

data/lib/crowbar/client/command/server/check.rb

@@ -0,0 +1,75 @@
+#
+# Copyright 2016, SUSE Linux GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Crowbar
+  module Client
+    module Command
+      module Server
+        #
+        # Implementation for the server check command
+        #
+        class Check < Base
+          include Mixin::Format
+          include Mixin::Filter
+
+          def request
+            @request ||= Request::Server::Check.new(
+              args
+            )
+          end
+
+          def execute
+            request.process do |request|
+              formatter = Formatter::Array.new(
+                format: provide_format,
+                headings: ["Errors"],
+                values: Filter::Array.new(
+                  filter: provide_filter,
+                  values: content_from(request)
+                ).result
+              )
+
+              case request.code
+              when 200
+                if formatter.empty?
+                  say "Crowbar is in a sane state"
+                else
+                  say formatter.result
+                end
+              when 409
+                err "Could not perform sanity checks: #{request.parsed_response["error"]}"
+              else
+                err request.parsed_response["error"]
+              end
+            end
+          end
+
+          protected
+
+          def content_from(request)
+            [].tap do |row|
+              request.parsed_response.each do |child|
+                row.push(
+                  child
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,6 +17,9 @@
 module Crowbar
   module Client
     module Command
+      #
+      # Module for the virtual IP command implementations
+      #
       module VirtualIP
         autoload :Allocate,
           File.expand_path("../virtual_ip/allocate", __FILE__)

data/lib/crowbar/client/command/virtual_ip/allocate.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module VirtualIP
+        #
+        # Implementation for the virtual IP allocate command
+        #
         class Allocate < Base
           def request
             @request ||= Request::VirtualIP::Allocate.new(

data/lib/crowbar/client/command/virtual_ip/deallocate.rb

@@ -18,6 +18,9 @@ module Crowbar
   module Client
     module Command
       module VirtualIP
+        #
+        # Implementation for the virtual IP deallocate command
+        #
         class Deallocate < Base
           def request
             @request ||= Request::VirtualIP::Deallocate.new(

data/lib/crowbar/client/config.rb

@@ -20,6 +20,9 @@ require "singleton"
 
 module Crowbar
   module Client
+    #
+    # General configuration for the Crowbar CLI
+    #
     class Config
       include Singleton
 
@@ -27,6 +30,11 @@ module Crowbar
       attr_writer :config
       attr_writer :values
 
+      #
+      # Define base configuration
+      #
+      # @param options [Hash] the base configuration
+      #
       def configure(options)
         self.options = Hashie::Mash.new(
           options
@@ -36,6 +44,11 @@ module Crowbar
         self.values = merge
       end
 
+      #
+      # Define default config
+      #
+      # @return [Hashie::Mash] the default config
+      #
       def defaults
         @defaults ||= Hashie::Mash.new(
           alias: default_alias,
@@ -48,44 +61,89 @@ module Crowbar
         )
       end
 
+      #
+      # Define parameter config
+      #
+      # @return [Hashie::Mash] the parameter config
+      #
       def options
         @options ||= defaults
       end
 
+      #
+      # Define file config
+      #
+      # @return [Hashie::Mash] the file config
+      #
       def config
         @config ||= Hashie::Mash.new
       end
 
+      #
+      # Define merged config
+      #
+      # @return [Hashie::Mash] the merged config
+      #
       def values
         @values ||= Hashie::Mash.new
       end
 
       protected
 
+      #
+      # Define a default alias value
+      #
+      # @return [String] the default alias value
+      #
       def default_alias
         ENV["CROWBAR_ALIAS"] || "default"
       end
 
+      #
+      # Define a default username value
+      #
+      # @return [String] the default username value
+      #
       def default_username
         ENV["CROWBAR_USERNAME"] || "crowbar"
       end
 
+      #
+      # Define a default password value
+      #
+      # @return [String] the default password value
+      #
       def default_password
         ENV["CROWBAR_PASSWORD"] || "crowbar"
       end
 
+      #
+      # Define a default server value
+      #
+      # @return [String] the default server value
+      #
       def default_server
         ENV["CROWBAR_SERVER"] || "http://127.0.0.1:80"
       end
 
+      #
+      # Define a default timeout value
+      #
+      # @return [Integer] the default timeout value
+      #
       def default_timeout
         if ENV["CROWBAR_TIMEOUT"].present?
           ENV["CROWBAR_TIMEOUT"].to_i
         else
-          60
+          180
         end
       end
 
+      #
+      # Define a default anonymous flag
+      #
+      # @return [Bool] the default anonymous flag
+      #
       def default_anonymous
         if ENV["CROWBAR_ANONYMOUS"].present?
           [
@@ -96,6 +154,11 @@ module Crowbar
         end
       end
 
+      #
+      # Define a default debug flag
+      #
+      # @return [String] the default alias flag
+      #
       def default_debug
         if ENV["CROWBAR_DEBUG"].present?
           [
@@ -106,6 +169,11 @@ module Crowbar
         end
       end
 
+      #
+      # Merge the different configs together
+      #
+      # @return [Hashie::Mash] the merged config
+      #
       def merge
         result = {}.tap do |overwrite|
           defaults.keys.each do |key|
@@ -127,6 +195,11 @@ module Crowbar
         )
       end
 
+      #
+      # Load and parse the config file
+      #
+      # @return [Hashie::Mash] the config content
+      #
       def parser
         ini = Hashie::Mash.new(
           IniFile.load(
@@ -143,12 +216,22 @@ module Crowbar
         Hashie::Mash.new
       end
 
+      #
+      # Find the first config file
+      #
+      # @return [String] the first config
+      #
       def finder
         paths.detect do |temp|
           File.exist? temp
         end
       end
 
+      #
+      # Define the available config file paths
+      #
+      # @return [Array] the available paths
+      #
       def paths
         [
           File.join(
@@ -163,26 +246,63 @@ module Crowbar
       end
 
       class << self
+        #
+        # Define base configuration
+        #
+        # @see #configure
+        # @param options [Hash] the base configuration
+        #
         def configure(options)
           instance.configure(options)
         end
 
+        #
+        # Define default config
+        #
+        # @see #defaults
+        # @return [Hashie::Mash] the default config
+        #
         def defaults
           instance.defaults
         end
 
+        #
+        # Define parameter config
+        #
+        # @see #options
+        # @return [Hashie::Mash] the parameter config
+        #
         def options
           instance.options
         end
 
+        #
+        # Define file config
+        #
+        # @see #config
+        # @return [Hashie::Mash] the file config
+        #
         def config
           instance.config
         end
 
+        #
+        # Define merged config
+        #
+        # @see #values
+        # @return [Hashie::Mash] the merged config
+        #
         def values
           instance.values
         end
 
+        #
+        # Magic to catch missing method calls
+        #
+        # @param method [Symbol] the method that is missing
+        # @param arguments [Array] the list of attributes
+        # @yield
+        #
         def method_missing(method, *arguments, &block)
           case
           when method.to_s.ends_with?("=")
@@ -200,6 +320,13 @@ module Crowbar
           end
         end
 
+        #
+        # Magic to catch missing respond_to calls
+        #
+        # @param method [Symbol] the method that is missing
+        # @param include_private [Bool] should include private methods
+        # @return [Bool] the class responds to it or not
+        #
         def respond_to?(method, include_private = false)
           case
           when method.to_s.ends_with?("=")