HewlettPackard/oneview-sdk-ruby

# (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
    # Storage system resource implementation
    class StorageSystem < Resource
      BASE_URI = '/rest/storage-systems'.freeze
      UNIQUE_IDENTIFIERS = %w[name uri serialNumber wwn].freeze # credentials['ip_hostname'] is supported too

      # 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['type'] ||= 'StorageSystemV3'
      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 create!(*)
        unavailable_method
      end

      # Method is not available
      # @raise [OneviewSDK::MethodUnavailable] method is not available
      def delete(*)
        unavailable_method
      end

      # Adds the resource to OneView using the current data
      # @note Calls the refresh method to set additional data
      # @return [OneviewSDK::StorageSystem] self
      def add
        ensure_client
        task = @client.rest_post(self.class::BASE_URI, { 'body' => self['credentials'] }, @api_version)
        temp = @data.clone
        task = @client.wait_for(task['uri'] || task['location'])
        @data['uri'] = task['associatedResource']['resourceUri']
        refresh
        temp.delete('credentials')
        update(temp)
        self
      end

      # Checks if the resource already exists
      # @note one of the UNIQUE_IDENTIFIERS or credentials['ip_hostname'] must be specified in the resource
      # @return [Boolean] Whether or not resource exists
      # @raise [OneviewSDK::IncompleteResource] if required attributes are not filled
      def exists?
        ip_hostname = self['credentials'][:ip_hostname] || self['credentials']['ip_hostname'] rescue nil
        return true if ip_hostname && self.class.find_by(@client, credentials: { ip_hostname: ip_hostname }).size == 1
        super
      rescue IncompleteResource => e
        raise e unless ip_hostname
        false
      end

      # Retrieves the resource details based on this resource's name or URI.
      # @note one of the UNIQUE_IDENTIFIERS or credentials['ip_hostname'] must be specified in the resource
      # @return [Boolean] Whether or not retrieve was successful
      # @raise [OneviewSDK::IncompleteResource] if required attributes are not filled
      def retrieve!
        ip_hostname = self['credentials'][:ip_hostname] || self['credentials']['ip_hostname'] rescue nil
        if ip_hostname
          results = self.class.find_by(@client, credentials: { ip_hostname: ip_hostname })
          if results.size == 1
            set_all(results[0].data)
            return true
          end
        end
        super
      rescue IncompleteResource => e
        raise e unless ip_hostname
        false
      end

      # Check the equality of the data for the other resource with this resource.
      # @note Does not check the client, logger, or api_version if another resource is passed in
      # @param [Hash, Resource] other resource or hash to compare the key-value pairs with
      # @example Compare to hash
      # @note Does not check the password in credentials
      # @example myResource.like?(credentials: { username: 'admin', password: 'secret' })
      #   myResource = OneviewSDK::Resource.new(client, { name: 'res1', description: 'example'}, 200)
      #   myResource.like?(description: '') # returns false
      #   myResource.like?(name: 'res1') # returns true
      # @return [Boolean] Whether or not the two objects are alike
      def like?(other)
        if other.is_a? Hash
          other_copy = Marshal.load(Marshal.dump(other))
        else
          other_copy = other.dup
          other_copy.data = Marshal.load(Marshal.dump(other.data))
        end

        if other_copy['credentials']
          other_copy['credentials'].delete('password') rescue nil
          other_copy['credentials'].delete(:password) rescue nil
        elsif other_copy[:credentials]
          other_copy[:credentials].delete('password') rescue nil
          other_copy[:credentials].delete(:password) rescue nil
        end

        super(other_copy)
      end

      # Gets the host types for the storage system resource
      # @param [OneviewSDK::Client] client The client object for the OneView appliance
      # @return [String] response body
      def self.get_host_types(client)
        response = client.rest_get(BASE_URI + '/host-types')
        client.response_handler(response)
      end

      # Lists the storage pools
      def get_storage_pools
        self.class.find_with_pagination(@client, @data['uri'] + '/storage-pools')
      end

      # Lists all managed target ports for the specified storage system,
      # or only the one specified
      # @param [String] port Target port
      def get_managed_ports(port = nil)
        uri = @data['uri']
        uri += port.nil? ? '/managedPorts' : "/managedPorts/#{port}"
        self.class.find_with_pagination(@client, uri)
      end

      # Refreshes a storage system
      # @param [String] state NotRefreshing, RefreshFailed, RefreshPending, Refreshing
      def set_refresh_state(state)
        @data['refreshState'] = state
        update
      end
    end
  end
end