oneview-sdk 2.2.1 → 3.0.0

data/lib/oneview-sdk/client.rb

@@ -17,8 +17,6 @@ require_relative 'ssl_helper'
 module OneviewSDK
   # The client defines the connection to the OneView server and handles communication with it.
   class Client
-    DEFAULT_API_VERSION = 200
-
     attr_reader :url, :user, :token, :password, :max_api_version
     attr_accessor :ssl_enabled, :api_version, :logger, :log_level, :cert_store, :print_wait_dots, :timeout
 
@@ -40,22 +38,25 @@ module OneviewSDK
     # @option options [Integer] :timeout (nil) Override the default request timeout value
     def initialize(options = {})
       options = Hash[options.map { |k, v| [k.to_sym, v] }] # Convert string hash keys to symbols
+      STDOUT.sync = true
       @logger = options[:logger] || Logger.new(STDOUT)
-      [:debug, :info, :warn, :error, :level=].each { |m| fail InvalidClient, "Logger must respond to #{m} method " unless @logger.respond_to?(m) }
+      [:debug, :info, :warn, :error, :level=].each { |m| raise InvalidClient, "Logger must respond to #{m} method " unless @logger.respond_to?(m) }
       @log_level = options[:log_level] || :info
       @logger.level = @logger.class.const_get(@log_level.upcase) rescue @log_level
       @print_wait_dots = options.fetch(:print_wait_dots, false)
       @url = options[:url] || ENV['ONEVIEWSDK_URL']
-      fail InvalidClient, 'Must set the url option' unless @url
+      raise InvalidClient, 'Must set the url option' unless @url
       @max_api_version = appliance_api_version
       if options[:api_version] && options[:api_version].to_i > @max_api_version
         logger.warn "API version #{options[:api_version]} is greater than the appliance API version (#{@max_api_version})"
       end
-      @api_version = options[:api_version] || [DEFAULT_API_VERSION, @max_api_version].min
+      @api_version = options[:api_version] || [OneviewSDK::DEFAULT_API_VERSION, @max_api_version].min
+      # Set the default OneviewSDK module API version
+      OneviewSDK.api_version = @api_version unless OneviewSDK.api_version_updated? || !OneviewSDK::SUPPORTED_API_VERSIONS.include?(@api_version)
       @ssl_enabled = true
       if ENV.key?('ONEVIEWSDK_SSL_ENABLED')
         if %w(true false 1 0).include?(ENV['ONEVIEWSDK_SSL_ENABLED'])
-          @ssl_enabled = ! %w(false 0).include?(ENV['ONEVIEWSDK_SSL_ENABLED'])
+          @ssl_enabled = !%w(false 0).include?(ENV['ONEVIEWSDK_SSL_ENABLED'])
         else
           @logger.warn "Unrecognized ssl_enabled value '#{ENV['ONEVIEWSDK_SSL_ENABLED']}'. Valid options are 'true' & 'false'"
         end
@@ -68,7 +69,7 @@ module OneviewSDK
       @logger.warn 'User option not set. Using default (Administrator)' unless options[:user] || ENV['ONEVIEWSDK_USER']
       @user = options[:user] || ENV['ONEVIEWSDK_USER'] || 'Administrator'
       @password = options[:password] || ENV['ONEVIEWSDK_PASSWORD']
-      fail InvalidClient, 'Must set user & password options or token option' unless @password
+      raise InvalidClient, 'Must set user & password options or token option' unless @password
       @token = login
     end
 
@@ -102,13 +103,15 @@ module OneviewSDK
 
     # Get array of all resources of a specified type
     # @param [String] type Resource type
+    # @param [Integer] api_ver API module version to fetch resources from
     # @return [Array<Resource>] Results
     # @example Get all Ethernet Networks
     #   networks = @client.get_all('EthernetNetworks')
-    def get_all(type)
-      OneviewSDK.resource_named(type).get_all(self)
-    rescue StandardError
-      raise TypeError, "Invalid resource type '#{type}'"
+    # @raise [TypeError] if the type is invalid
+    def get_all(type, api_ver = @api_version)
+      klass = OneviewSDK.resource_named(type, api_ver)
+      raise TypeError, "Invalid resource type '#{type}'. OneviewSDK::API#{api_ver} does not contain a class like it." unless klass
+      klass.get_all(self)
     end
 
     # Wait for a task to complete
@@ -116,9 +119,9 @@ module OneviewSDK
     # @raise [OneviewSDK::TaskError] if the task resulted in an error or early termination.
     # @return [Hash] if the task completed successfully, return the task details
     def wait_for(task_uri)
-      fail ArgumentError, 'Must specify a task_uri!' if task_uri.nil? || task_uri.empty?
+      raise ArgumentError, 'Must specify a task_uri!' if task_uri.nil? || task_uri.empty?
       loop do
-        task_uri.gsub!(%r{/https:(.*)\/rest/}, '/rest')
+        task_uri.gsub!(%r{https:(.*)\/rest}, '/rest')
         task = rest_get(task_uri)
         body = JSON.parse(task.body)
         case body['taskState'].downcase
@@ -130,7 +133,7 @@ module OneviewSDK
         when 'error', 'killed', 'terminated'
           msg = "Task ended with bad state: '#{body['taskState']}'.\nResponse: "
           msg += body['taskErrors'] ? JSON.pretty_generate(body['taskErrors']) : JSON.pretty_generate(body)
-          fail TaskError, msg
+          raise TaskError, msg
         else
           print '.' if @print_wait_dots
           sleep 10
@@ -146,12 +149,12 @@ module OneviewSDK
       options = { 'Content-Type' => :none, 'X-API-Version' => :none, 'auth' => :none }
       response = rest_api(:get, '/rest/version', options)
       version = response_handler(response)['currentVersion']
-      fail ConnectionError, "Couldn't get API version" unless version
+      raise ConnectionError, "Couldn't get API version" unless version
       version = version.to_i if version.class != Fixnum
       version
     rescue ConnectionError
-      @logger.warn "Failed to get OneView max api version. Using default (#{DEFAULT_API_VERSION})"
-      DEFAULT_API_VERSION
+      @logger.warn "Failed to get OneView max api version. Using default (#{OneviewSDK::DEFAULT_API_VERSION})"
+      OneviewSDK::DEFAULT_API_VERSION
     end
 
     # Log in to OneView appliance and set max_api_version
@@ -166,7 +169,7 @@ module OneviewSDK
       response = rest_post('/rest/login-sessions', options)
       body = response_handler(response)
       return body['sessionID'] if body['sessionID']
-      fail ConnectionError, "\nERROR! Couldn't log into OneView server at #{@url}. Response: #{response}\n#{response.body}"
+      raise ConnectionError, "\nERROR! Couldn't log into OneView server at #{@url}. Response: #{response}\n#{response.body}"
     rescue StandardError => e
       raise e unless retries > 0
       @logger.debug 'Failed to log in to OneView. Retrying...'

data/lib/oneview-sdk/config_loader.rb

@@ -25,7 +25,7 @@ module OneviewSDK
       JSON.parse(IO.read(expanded_path))
     rescue
       data = YAML.load_file(expanded_path)
-      Hash[data.map { |k, v| [k.to_s, v] }]
+      JSON.parse(data.to_json) # Convert to and from JSON to ensure compatibility
     end
   end
 end

data/lib/oneview-sdk/resource.rb

@@ -16,6 +16,7 @@ module OneviewSDK
   # Resource base class that defines all common resource functionality.
   class Resource
     BASE_URI = '/rest'.freeze
+    UNIQUE_IDENTIFIERS = %w(name uri).freeze # Ordered list of unique attributes to search by
 
     attr_accessor \
       :client,
@@ -29,37 +30,43 @@ module OneviewSDK
     # @param [Integer] api_ver The api version to use when interracting with this resource.
     #   Defaults to the client.api_version if it exists, or the OneviewSDK::Client::DEFAULT_API_VERSION.
     def initialize(client, params = {}, api_ver = nil)
-      fail InvalidClient, 'Must specify a valid client' unless client.is_a?(OneviewSDK::Client)
+      raise InvalidClient, 'Must specify a valid client' unless client.is_a?(OneviewSDK::Client)
       @client = client
       @logger = @client.logger
       @api_version = api_ver || @client.api_version
       if @api_version > @client.max_api_version
-        fail UnsupportedVersion,
-             "#{self.class.name} api_version '#{@api_version}' is greater than the client's max_api_version '#{@client.max_api_version}'"
+        raise UnsupportedVersion,
+              "#{self.class.name} api_version '#{@api_version}' is greater than the client's max_api_version '#{@client.max_api_version}'"
       end
       @data ||= {}
       set_all(params)
     end
 
     # Retrieve resource details based on this resource's name or URI.
-    # @note Name or URI must be specified inside the resource
+    # @note one of the UNIQUE_IDENTIFIERS, e.g. name or uri, must be specified in the resource
     # @return [Boolean] Whether or not retrieve was successful
     def retrieve!
-      fail IncompleteResource, 'Must set resource name or uri before trying to retrieve!' unless @data['name'] || @data['uri']
-      results = self.class.find_by(@client, name: @data['name']) if @data['name']
-      results = self.class.find_by(@client, uri:  @data['uri'])  if @data['uri'] && (!results || results.empty?)
-      return false unless results.size == 1
-      set_all(results[0].data)
-      true
+      retrieval_keys = self.class::UNIQUE_IDENTIFIERS.select { |k| !@data[k].nil? }
+      raise IncompleteResource, "Must set resource #{self.class::UNIQUE_IDENTIFIERS.join(' or ')} before trying to retrieve!" if retrieval_keys.empty?
+      retrieval_keys.each do |k|
+        results = self.class.find_by(@client, k => @data[k])
+        next if results.size != 1
+        set_all(results[0].data)
+        return true
+      end
+      false
     end
 
     # Check if a resource exists
-    # @note name or uri must be specified inside resource
+    # @note one of the UNIQUE_IDENTIFIERS, e.g. name or uri, must be specified in the resource
     # @return [Boolean] Whether or not resource exists
     def exists?
-      fail IncompleteResource, 'Must set resource name or uri before trying to retrieve!' unless @data['name'] || @data['uri']
-      return true if @data['name'] && self.class.find_by(@client, name: @data['name']).size == 1
-      return true if @data['uri']  && self.class.find_by(@client, uri:  @data['uri']).size == 1
+      retrieval_keys = self.class::UNIQUE_IDENTIFIERS.select { |k| !@data[k].nil? }
+      raise IncompleteResource, "Must set resource #{self.class::UNIQUE_IDENTIFIERS.join(' or ')} before trying to retrieve!" if retrieval_keys.empty?
+      retrieval_keys.each do |k|
+        results = self.class.find_by(@client, k => @data[k])
+        return true if results.size == 1
+      end
       false
     end
 
@@ -206,7 +213,7 @@ module OneviewSDK
       when :yml, :yaml
         File.open(file_path, 'w') { |f| f.write(temp_data.to_yaml) }
       else
-        fail InvalidFormat, "Invalid format: #{format}"
+        raise InvalidFormat, "Invalid format: #{format}"
       end
       true
     end
@@ -235,7 +242,16 @@ module OneviewSDK
     # @return [Resource] New resource created from the file contents
     def self.from_file(client, file_path)
       resource = OneviewSDK::Config.load(file_path)
-      new(client, resource['data'], resource['api_version'])
+      klass = self
+      if klass == OneviewSDK::Resource && resource['type'] # Use correct resource class by parsing type
+        klass = OneviewSDK # Secondary/temp class/module reference
+        resource['type'].split('::').each do |id|
+          c = klass.const_get(id) rescue nil
+          klass = c if c.is_a?(Class) || c.is_a?(Module)
+        end
+        klass = OneviewSDK::Resource unless klass <= OneviewSDK::Resource
+      end
+      klass.new(client, resource['data'], resource['api_version'])
     end
 
     # Make a GET request to the resource uri, and returns an array with results matching the search
@@ -296,19 +312,19 @@ module OneviewSDK
 
     # Fail unless @client is set for this resource.
     def ensure_client
-      fail IncompleteResource, 'Please set client attribute before interacting with this resource' unless @client
+      raise IncompleteResource, 'Please set client attribute before interacting with this resource' unless @client
       true
     end
 
     # Fail unless @data['uri'] is set for this resource.
     def ensure_uri
-      fail IncompleteResource, 'Please set uri attribute before interacting with this resource' unless @data['uri']
+      raise IncompleteResource, 'Please set uri attribute before interacting with this resource' unless @data['uri']
       true
     end
 
     # Fail for methods that are not available for one resource
     def unavailable_method
-      fail MethodUnavailable, "The method ##{caller[0][/`.*'/][1..-2]} is unavailable for this resource"
+      raise MethodUnavailable, "The method ##{caller[0][/`.*'/][1..-2]} is unavailable for this resource"
     end
 
     private
@@ -316,12 +332,12 @@ module OneviewSDK
     # Recursive helper method for like?
     # Allows comparison of nested hash structures
     def recursive_like?(other, data = @data)
-      fail "Can't compare with object type: #{other.class}! Must respond_to :each" unless other.respond_to?(:each)
+      raise "Can't compare with object type: #{other.class}! Must respond_to :each" unless other.respond_to?(:each)
       other.each do |key, val|
         return false unless data && data.respond_to?(:[])
         if val.is_a?(Hash)
           return false unless data.class == Hash && recursive_like?(val, data[key.to_s])
-        elsif val != data[key.to_s]
+        elsif val != data[key.to_s] && val != data[key.to_sym]
           return false
         end
       end
@@ -332,22 +348,14 @@ module OneviewSDK
 
   # Get resource class that matches the type given
   # @param [String] type Name of the desired class type
+  # @param [Fixnum] api_ver API module version to fetch resource from
+  # @param [String] variant API module variant to fetch resource from
   # @return [Class] Resource class or nil if not found
-  def self.resource_named(type)
-    classes = {}
-    orig_classes = []
-    OneviewSDK.constants.each do |c|
-      klass = OneviewSDK.const_get(c)
-      next unless klass.is_a?(Class) && klass < OneviewSDK::Resource
-      name = klass.name.split('::').last
-      orig_classes.push(name)
-      classes[name.downcase.delete('_').delete('-')] = klass
-      classes["#{name.downcase.delete('_').delete('-')}s"] = klass
+  def self.resource_named(type, api_ver = @api_version, variant = nil)
+    unless SUPPORTED_API_VERSIONS.include?(api_ver)
+      raise UnsupportedVersion, "API version #{api_ver} is not supported! Try one of: #{SUPPORTED_API_VERSIONS}"
     end
-    new_type = type.to_s.downcase.gsub(/[ -_]/, '')
-    return classes[new_type] if classes.keys.include?(new_type)
+    api_module = OneviewSDK.const_get("API#{api_ver}")
+    variant ? api_module.resource_named(type, variant) : api_module.resource_named(type)
   end
 end
-
-# Load all resources:
-Dir[File.dirname(__FILE__) + '/resource/*.rb'].each { |file| require file }

data/lib/oneview-sdk/resource/api200.rb

@@ -0,0 +1,34 @@
+# (c) Copyright 2016 Hewlett Packard Enterprise Development LP
+#
+# 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 OneviewSDK
+  # Module for API v200
+  module API200
+    # Get resource class that matches the type given
+    # @param [String] type Name of the desired class type
+    # @param [String] variant There is only 1 variant for this module, so this is not used.
+    #   It exists only so that the parameters match API modules that do have multiple variants.
+    # @return [Class] Resource class or nil if not found
+    def self.resource_named(type, _variant = nil)
+      new_type = type.to_s.downcase.gsub(/[ -_]/, '')
+      constants.each do |c|
+        klass = const_get(c)
+        next unless klass.is_a?(Class) && klass < OneviewSDK::Resource
+        name = klass.name.split('::').last.downcase.delete('_').delete('-')
+        return klass if new_type =~ /^#{name}[s]?$/
+      end
+      nil
+    end
+  end
+end
+
+# Load all API-specific resources:
+Dir[File.dirname(__FILE__) + '/api200/*.rb'].each { |file| require file }

data/lib/oneview-sdk/resource/api200/connection_template.rb

@@ -0,0 +1,52 @@
+# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+#
+# 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.
+
+require_relative 'resource'
+
+module OneviewSDK
+  module API200
+    # Connection template resource implementation
+    class ConnectionTemplate < Resource
+      BASE_URI = '/rest/connection-templates'.freeze
+
+      # Create a resource object, associate it with a client, and set its properties.
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [Hash] params The options for this resource (key-value pairs)
+      # @param [Integer] api_ver The api version to use when interracting with this resource.
+      def initialize(client, params = {}, api_ver = nil)
+        super
+        # Default values:
+        @data['bandwidth'] ||= {}
+        @data['type'] ||= 'connection-template'
+      end
+
+      # Method is not available
+      # @raise [OneviewSDK::MethodUnavailable] method is not available
+      def create
+        unavailable_method
+      end
+
+      # Method is not available
+      # @raise [OneviewSDK::MethodUnavailable] method is not available
+      def delete
+        unavailable_method
+      end
+
+      # Get the default network connection template
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @return [OneviewSDK::ConnectionTemplate] Connection template
+      def self.get_default(client)
+        response = client.rest_get(BASE_URI + '/defaultConnectionTemplate')
+        OneviewSDK::ConnectionTemplate.new(client, client.response_handler(response))
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api200/datacenter.rb

@@ -0,0 +1,81 @@
+# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+#
+# 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.
+
+require_relative 'resource'
+
+module OneviewSDK
+  module API200
+    # Datacenter resource implementation
+    class Datacenter < Resource
+      BASE_URI = '/rest/datacenters'.freeze
+
+      # Add the resource on OneView using the current data
+      # @note Calls the refresh method to set additional data
+      # @raise [OneviewSDK::IncompleteResource] if the client is not set
+      # @raise [StandardError] if the resource creation fails
+      # @return [OneviewSDK::Datacenter] self
+      alias add create
+
+      # Remove resource from OneView
+      # @return [true] if resource was removed successfully
+      alias remove delete
+
+      # Create a resource object, associate it with a client, and set its properties.
+      # @param [OneviewSDK::Client] client The client object for the OneView appliance
+      # @param [Hash] params The options for this resource (key-value pairs)
+      # @param [Integer] api_ver The api version to use when interracting with this resource.
+      def initialize(client, params = {}, api_ver = nil)
+        super
+        # Default values:
+        @data['contents'] ||= []
+      end
+
+      # Method is not available
+      # @raise [OneviewSDK::MethodUnavailable] method is not available
+      def create
+        unavailable_method
+      end
+
+      # Method is not available
+      # @raise [OneviewSDK::MethodUnavailable] method is not available
+      def delete
+        unavailable_method
+      end
+
+      # Adds an existing rack to the datacenter
+      # @param [OneviewSDK::Rack] rack rack
+      # @param [Decimal] pos_x x position
+      # @param [Decimal] pos_y y position
+      # @param [Decimal] rotation Rotation degrees (0-359) around the center of the resource
+      def add_rack(rack, pos_x, pos_y, rotation = 0)
+        @data['contents'] << {
+          'resourceUri' => rack['uri'],
+          'x' => pos_x,
+          'y' => pos_y,
+          'rotation' => rotation
+        }
+      end
+
+      # Removes a rack from the datacenter
+      # @param [OneviewSDK::Rack] rack rack
+      def remove_rack(rack)
+        @data['contents'].reject! { |resource| resource['resourceUri'] == rack['uri'] }
+      end
+
+      # Gets a list of the visual content objects
+      # @return [Hash]
+      def get_visual_content
+        response = @client.rest_get(@data['uri'] + '/visualContent')
+        @client.response_handler(response)
+      end
+    end
+  end
+end