test-oneview 5.18.0

data/lib/oneview-sdk/client.rb

@@ -0,0 +1,220 @@
+# (c) Copyright 2016-2017 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 'logger'
+require_relative 'config_loader'
+require_relative 'rest'
+require_relative 'ssl_helper'
+
+module OneviewSDK
+  # The client defines the connection to the OneView server and handles communication with it.
+  class Client
+    attr_reader :max_api_version, :log_level
+    attr_accessor :url, :user, :token, :password, :domain, :ssl_enabled, :api_version, \
+                  :logger, :cert_store, :print_wait_dots, :timeout
+
+    include Rest
+
+    # Creates client object, establish connection, and set up logging and api version.
+    # @param [Hash] options the options to configure the client
+    # @option options [Logger] :logger (Logger.new(STDOUT)) Logger object to use.
+    #   Must implement debug(String), info(String), warn(String), error(String), & level=
+    # @option options [Symbol] :log_level (:info) Log level. Logger must define a constant with this name. ie Logger::INFO
+    # @option options [Boolean] :print_wait_dots (false) When true, prints status dots while waiting on the tasks to complete.
+    # @option options [String] :url URL of OneView appliance
+    # @option options [String] :user ('Administrator') The username to use for authentication with the OneView appliance
+    # @option options [String] :password (ENV['ONEVIEWSDK_PASSWORD']) The password to use for authentication with OneView appliance
+    # @option options [String] :domain ('LOCAL') The name of the domain directory used for authentication
+    # @option options [String] :token (ENV['ONEVIEWSDK_TOKEN']) The token to use for authentication with OneView appliance
+    #   Use the token or the username and password (not both). The token has precedence.
+    # @option options [Integer] :api_version (1800) Appliance's max API version to be used by default for requests
+    # @option options [Boolean] :ssl_enabled (true) Use ssl for requests? Respects ENV['ONEVIEWSDK_SSL_ENABLED']
+    # @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)
+      %i[debug info warn error level=].each { |m| raise InvalidClient, "Logger must respond to #{m} method " unless @logger.respond_to?(m) }
+      self.log_level = options[:log_level] || :info
+      @print_wait_dots = options.fetch(:print_wait_dots, false)
+      @url = options[:url] || ENV['ONEVIEWSDK_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] || @max_api_version
+      # 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'])
+        else
+          @logger.warn "Unrecognized ssl_enabled value '#{ENV['ONEVIEWSDK_SSL_ENABLED']}'. Valid options are 'true' & 'false'"
+        end
+      end
+      @ssl_enabled = options[:ssl_enabled] unless options[:ssl_enabled].nil?
+      @timeout = options[:timeout] unless options[:timeout].nil?
+      @cert_store = OneviewSDK::SSLHelper.load_trusted_certs if @ssl_enabled
+      @token = options[:token] || ENV['ONEVIEWSDK_TOKEN']
+      @logger.warn 'User option not set. Using default (Administrator)' unless @token || options[:user] || ENV['ONEVIEWSDK_USER']
+      @user = options[:user] || ENV['ONEVIEWSDK_USER'] || 'Administrator'
+      @password = options[:password] || ENV['ONEVIEWSDK_PASSWORD']
+      raise InvalidClient, 'Must set user & password options or token option' unless @token || @password
+      @domain = options[:domain] || ENV['ONEVIEWSDK_DOMAIN'] || 'LOCAL'
+      @token ||= login
+    end
+
+    def log_level=(level)
+      @logger.level = @logger.class.const_get(level.upcase) rescue level
+      @log_level = level
+    end
+
+    # Tells OneView to create the resource using the current attribute data
+    # @param [Resource] resource the object to create
+    def create(resource)
+      resource.client = self
+      resource.create
+    end
+
+    # Sets the attribute data, and then saves to OneView
+    # @param [Resource] resource the object to update
+    def update(resource, attributes = {})
+      resource.client = self
+      resource.update(attributes)
+    end
+
+    # Updates this object using the data that exists on OneView
+    # @param [Resource] resource the object to refresh
+    def refresh(resource)
+      resource.client = self
+      resource.refresh
+    end
+
+    # Deletes this object from OneView
+    # @param [Resource] resource the object to delete
+    def delete(resource)
+      resource.client = self
+      resource.delete
+    end
+
+    # 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
+    # @param [String] variant API module variant to fetch resource from
+    # @return [Array<Resource>] Results
+    # @example Get all Ethernet Networks
+    #   networks = @client.get_all('EthernetNetworks')
+    #   synergy_networks = @client.get_all('EthernetNetworks', 300, 'Synergy')
+    # @raise [TypeError] if the type is invalid
+    def get_all(type, api_ver = @api_version, variant = nil)
+      klass = OneviewSDK.resource_named(type, api_ver, variant)
+      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
+    # @param [String] task_uri
+    # @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)
+      raise ArgumentError, 'Must specify a task_uri!' if task_uri.nil? || task_uri.empty?
+      loop do
+        task_uri.gsub!(%r{https:(.*)\/rest}, '/rest')
+        task = rest_get(task_uri)
+        body = JSON.parse(task.body)
+        case body['taskState'].downcase
+        when 'completed'
+          return body
+        when 'warning'
+          @logger.warn "Task ended with warning status. Details: #{JSON.pretty_generate(body['taskErrors']) rescue body}"
+          return body
+        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)
+          raise TaskError, msg
+        else
+          print '.' if @print_wait_dots
+          sleep 10
+        end
+      end
+    end
+
+    # Refresh the client's session token & max_api_version.
+    # Call this after a token expires or the user and/or password is updated on the client object.
+    # @return [OneviewSDK::Client] self
+    def refresh_login
+      @max_api_version = appliance_api_version
+      @token = login
+      self
+    end
+
+    # Delete the session on the appliance, invalidating the client's token.
+    # To generate a new token after calling this method, use the refresh_login method.
+    # Call this after a token expires or the user and/or password is updated on the client object.
+    # @return [OneviewSDK::Client] self
+    def destroy_session
+      response_handler(rest_delete('/rest/login-sessions'))
+      self
+    end
+
+    # Creates the image streamer client object.
+    # @param [Hash] options the options to configure the client
+    # @option options [Logger] :logger (Logger.new(STDOUT)) Logger object to use.
+    #   Must implement debug(String), info(String), warn(String), error(String), & level=
+    # @option options [Symbol] :log_level (:info) Log level. Logger must define a constant with this name. ie Logger::INFO
+    # @option options [Boolean] :print_wait_dots (false) When true, prints status dots while waiting on the tasks to complete.
+    # @option options [String] :url URL of Image Streamer
+    # @option options [Integer] :api_version (300) This is the API version to use by default for requests
+    # @option options [Boolean] :ssl_enabled (true) Use ssl for requests? Respects ENV['I3S_SSL_ENABLED']
+    # @option options [Integer] :timeout (nil) Override the default request timeout value
+    # @return [OneviewSDK::ImageStreamer::Client] New instance of image streamer client
+    def new_i3s_client(options = {})
+      OneviewSDK::ImageStreamer::Client.new(options.merge(token: @token))
+    end
+
+
+    private
+
+    # Get current api version from the OneView appliance
+    def appliance_api_version
+      options = { 'Content-Type' => :none, 'X-API-Version' => :none, 'auth' => :none }
+      response = rest_api(:get, '/rest/version', options)
+      version = response_handler(response)['currentVersion']
+      raise ConnectionError, "Couldn't get API version" unless version
+      version = version.to_i if version.class != Integer
+      version
+    rescue ConnectionError
+      @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 return the session token
+    def login(retries = 2)
+      options = {
+        'body' => {
+          'userName' => @user,
+          'password' => @password,
+          'authLoginDomain' => @domain
+        }
+      }
+      response = rest_post('/rest/login-sessions', options)
+      body = response_handler(response)
+      return body['sessionID'] if body['sessionID']
+      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...'
+      return login(retries - 1)
+    end
+  end
+end

data/lib/oneview-sdk/config_loader.rb

@@ -0,0 +1,31 @@
+# (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 'yaml'
+require 'json'
+
+module OneviewSDK
+  # Configuration helper class to allow .yaml and .json files to be easily used to specify OneView Configuration
+  class Config
+
+    # Load config from .yaml or .json file
+    # @param [String] path The full path to the configuration file
+    # @return [Hash] hash of the configuration
+    def self.load(path)
+      path = File.join(Dir.pwd, path) unless Pathname.new(path).absolute?
+      expanded_path = File.expand_path(path)
+      JSON.parse(IO.read(expanded_path))
+    rescue
+      data = YAML.load_file(expanded_path)
+      JSON.parse(data.to_json) # Convert to and from JSON to ensure compatibility
+    end
+  end
+end

data/lib/oneview-sdk/exceptions.rb

@@ -0,0 +1,91 @@
+# (c) Copyright 2016-2017 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.
+
+# Contains all the custom Exception classes
+module OneviewSDK
+  # Error class allowing storage of a data attribute
+  class OneViewError < ::StandardError
+    attr_accessor :data
+    MESSAGE = '(No message)'.freeze
+
+    def initialize(msg = self.class::MESSAGE, data = nil)
+      @data = data
+      super(msg)
+    end
+
+    # Shorthand method to raise an error.
+    # @example
+    #   OneviewSDK::OneViewError.raise! 'Message', { data: 'stuff' }
+    def self.raise!(msg = self::MESSAGE, data = nil)
+      raise new(msg, data)
+    end
+  end
+
+  class ConnectionError < OneViewError # Cannot connect to client/resource
+    MESSAGE = 'Cannot connect to client/resource'.freeze
+  end
+
+  class InvalidURL < OneViewError # URL is invalid
+    MESSAGE = 'URL is invalid'.freeze
+  end
+
+  class InvalidClient < OneViewError # Client configuration is invalid
+    MESSAGE = 'Client configuration is invalid'.freeze
+  end
+
+  class InvalidResource < OneViewError # Failed resource validations
+    MESSAGE = 'Failed resource validations'.freeze
+  end
+
+  class IncompleteResource < OneViewError # Missing required resource data to complete action
+    MESSAGE = 'Missing required resource data to complete action'.freeze
+  end
+
+  class MethodUnavailable < OneViewError # Resource does not support this method
+    MESSAGE = 'Resource does not support this method'.freeze
+  end
+
+  class UnsupportedVariant < OneViewError # Variant is not supported
+    MESSAGE = 'Variant is not supported'.freeze
+  end
+
+  class UnsupportedVersion < OneViewError # Resource not supported on this API version
+    MESSAGE = 'Resource not supported on this API version'.freeze
+  end
+
+  class InvalidRequest < OneViewError # Could not make request
+    MESSAGE = 'Could not make request'.freeze
+  end
+
+  class BadRequest < OneViewError # 400
+    MESSAGE = '400'.freeze
+  end
+
+  class Unauthorized < OneViewError # 401
+    MESSAGE = '401'.freeze
+  end
+
+  class NotFound < OneViewError # 404
+    MESSAGE = '404'.freeze
+  end
+
+  class RequestError < OneViewError # Other bad response codes
+    MESSAGE = 'Bad response code'.freeze
+  end
+
+  class TaskError < OneViewError # Task ended in a bad state
+    MESSAGE = 'Task ended in a bad state'.freeze
+  end
+
+  class InvalidFormat < OneViewError # File format is invalid
+    MESSAGE = 'File format is invalid'.freeze
+  end
+end

data/lib/oneview-sdk/image-streamer/client.rb

@@ -0,0 +1,99 @@
+# (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 '../client'
+
+module OneviewSDK
+  module ImageStreamer
+    # The client defines the connection to the Image Streamer server and handles communication with it.
+    class Client < OneviewSDK::Client
+      undef :user
+      undef :user=
+      undef :password
+      undef :password=
+      undef :domain
+      undef :domain=
+      undef :refresh_login
+      undef :destroy_session
+
+      # Creates client object, establish connection, and set up logging and api version.
+      # @param [Hash] options the options to configure the client
+      # @option options [Logger] :logger (Logger.new(STDOUT)) Logger object to use.
+      #   Must implement debug(String), info(String), warn(String), error(String), & level=
+      # @option options [Symbol] :log_level (:info) Log level. Logger must define a constant with this name. ie Logger::INFO
+      # @option options [Boolean] :print_wait_dots (false) When true, prints status dots while waiting on the tasks to complete.
+      # @option options [String] :url URL of Image Streamer
+      # @option options [String] :token (ENV['ONEVIEWSDK_TOKEN']) The token to use for authentication
+      # @option options [Integer] :api_version (300) This is the API version to use by default for requests
+      # @option options [Boolean] :ssl_enabled (true) Use ssl for requests? Respects ENV['I3S_SSL_ENABLED']
+      # @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)
+        %i[debug info warn error level=].each { |m| raise InvalidClient, "Logger must respond to #{m} method " unless @logger.respond_to?(m) }
+        self.log_level = options[:log_level] || :info
+        @print_wait_dots = options.fetch(:print_wait_dots, false)
+        @url = options[:url] || ENV['I3S_URL']
+        raise InvalidClient, 'Must set the url option' unless @url
+        @max_api_version = appliance_i3s_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 Image Streamer API version (#{@max_api_version})"
+        end
+        @api_version = options[:api_version] || [OneviewSDK::ImageStreamer::DEFAULT_API_VERSION, @max_api_version].min
+        # Set the default Image Streamer module API version
+        OneviewSDK::ImageStreamer.api_version = @api_version unless
+          OneviewSDK::ImageStreamer.api_version_updated? || !OneviewSDK::ImageStreamer::SUPPORTED_API_VERSIONS.include?(@api_version)
+        @ssl_enabled = true
+        if ENV.key?('I3S_SSL_ENABLED')
+          if %w[true false 1 0].include?(ENV['I3S_SSL_ENABLED'])
+            @ssl_enabled = !%w[false 0].include?(ENV['I3S_SSL_ENABLED'])
+          else
+            @logger.warn "Unrecognized ssl_enabled value '#{ENV['I3S_SSL_ENABLED']}'. Valid options are 'true' & 'false'"
+          end
+        end
+        @ssl_enabled = options[:ssl_enabled] unless options[:ssl_enabled].nil?
+        @timeout = options[:timeout] unless options[:timeout].nil?
+        @cert_store = OneviewSDK::SSLHelper.load_trusted_certs if @ssl_enabled
+        raise InvalidClient, 'Must set token option' unless options[:token] || ENV['ONEVIEWSDK_TOKEN']
+        @token = options[:token] || ENV['ONEVIEWSDK_TOKEN']
+      end
+
+      # 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 Deployment Plans
+      #   deployment_plans = @client.get_all('DeploymentPlans')
+      # @raise [TypeError] if the type is invalid
+      def get_all(type, api_ver = @api_version)
+        klass = OneviewSDK::ImageStreamer.resource_named(type, api_ver)
+        raise TypeError, "Invalid resource type '#{type}'. OneviewSDK::ImageStreamer::API#{api_ver} does not contain a class like it." unless klass
+        klass.get_all(self)
+      end
+
+      private
+
+      # Get current api version from the Image Streamer
+      def appliance_i3s_api_version
+        options = { 'Content-Type' => :none, 'X-API-Version' => :none, 'auth' => :none }
+        response = rest_api(:get, '/rest/version', options)
+        version = response_handler(response)['currentVersion']
+        raise ConnectionError, "Couldn't get API version" unless version
+        version = version.to_i if version.class != Integer
+        version
+      rescue ConnectionError
+        @logger.warn "Failed to get Image Streamer max api version. Using default (#{OneviewSDK::ImageStreamer::DEFAULT_API_VERSION})"
+        OneviewSDK::ImageStreamer::DEFAULT_API_VERSION
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api1000.rb

@@ -0,0 +1,39 @@
+# (c) Copyright 2020 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 Image Streamer
+  module ImageStreamer
+    # Module API 1000
+    module API1000
+      # 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
+end
+
+# Load all API-specific resources:
+Dir[File.dirname(__FILE__) + '/api1000/*.rb'].each { |file| require file }