oneview-sdk 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33d01d70d21a357c6e0c4f9295f039d874aea7b1
-  data.tar.gz: f5bd6ddea83a0124bf87c034b2107b7949a1004b
+  metadata.gz: 91b49f3734a5341886b50994724e02c367a85572
+  data.tar.gz: 504c62c8c43728d41c60230661d24f44ff79f5ba
 SHA512:
-  metadata.gz: 81644b00704bc889c5f62fbeb98fc2ef00fd7c0ba2a66631016aa867a298207bfc109eb904a8f404768779447f34b9f40a1cc17c3fb1efea46f2be3bd64811ae
-  data.tar.gz: d469232c518d22bc5ec52d828b929093a5bdac8a7d8ac12bbf647d4c1ca7f6be6f60ac817638e805d2d47dad578649e3ca7d4a310e9251a2bbdb34ab2c3304eb
+  metadata.gz: 9193b1927608fbacde28cfeb0d1699a050e12f1741c8d57610e20a704f837918f5f80e9cd1122cf2c55f6f0492be8b17fceaf3cee768da892b44278c6c1016d7
+  data.tar.gz: 19ed880cd4bc058178872b0df2f0bad6623b8c4978495a449fcdda37f0985bde7184241d00b8696b10890964992f39152b2cab4b577d1def2eb45a4267b645d5

data/CHANGELOG.md

@@ -1,5 +1,20 @@
-# Unreleased Changes
-(none)
+# v4.2.0
+
+#### New Resources:
+   - OS Deployment Plan
+
+#### Bug fixes & Enhancements:
+- [#89](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/89) Fix like? method for Logical Interconnect Groups
+- [#119](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/112) VolumeAttachment::remove_extra_unmanaged_volume throw Unexpected Http Error
+- [#125](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/125) References to resources C7000 in Synergy integration tests
+- [#189](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/189) Use helper methods of Rest module for upload and download file
+- [#201](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/201) Code to search the collection of resources (paginated search) is repeated in some resources
+- [#202](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/202) The method #get_default_settings in LogicalInterconnectGroup is used on integration test
+- [#212](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/212) Unable to create a Server Profile with Deployment Plan settings
+- [#219](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/219) Fix like? method for Server Profile
+
+#### Design changes:
+   - Architecture for future API500 support. Features for API500 are not yet supported.
 
 # v4.1.0
 

data/Gemfile

@@ -1,2 +1,13 @@
 source 'https://rubygems.org'
 gemspec
+
+begin
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.2.6')
+    group :development do
+      gem 'guard-rspec'
+      gem 'guard-rubocop'
+    end
+  end
+rescue StandardError
+  "no big deal; just don't use guard"
+end

data/Guardfile

@@ -0,0 +1,26 @@
+# (c) Copyright 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.
+
+guard :rubocop, cmd: 'bundle exec rubocop', cli: ['-D'] do
+  watch('.rubocop.yml')
+  watch(/(.+\.rb)$/)
+  watch(/^(Gemfile|Rakefile)$/)
+end
+
+guard :rspec, cmd: 'bundle exec rspec --color -t ~integration', first_match: true do
+  watch(%r{^spec\/(\w+)\.rb$}) { 'spec/unit' }
+  watch(%r{^(spec\/unit\/.+_spec\.rb)$})
+  watch('lib/oneview-sdk/cli.rb') { 'spec/unit/cli' }
+  watch(%r{^lib\/oneview-sdk\/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch(%r{^(spec\/support\/\w+\.rb)$}) { 'spec/unit' }
+  watch(%r{^spec\/support\/fixtures\/unit\/(\w+)\/.+$}) { |m| "spec/unit/#{m[1]}" }
+  watch(%r{^lib\/(.+)\.rb$}) { 'spec/unit' } # Everything else
+end

data/README.md

@@ -12,7 +12,7 @@ The OneView SDK provides a Ruby library to easily interact with HPE OneView and
 - Require the gem in your Gemfile:
 
   ```ruby
-  gem 'oneview-sdk', '~> 4.1'
+  gem 'oneview-sdk', '~> 4.2'
   ```
 
   Then run `$ bundle install`
@@ -162,7 +162,7 @@ You may notice resource classes being accessed in a few different ways; for exam
 require 'oneview-sdk'
 
 # Show defaults:
-OneviewSDK::SUPPORTED_API_VERSIONS      # [200, 300]
+OneviewSDK::SUPPORTED_API_VERSIONS      # [200, 300, 500]
 OneviewSDK::DEFAULT_API_VERSION         # 200
 OneviewSDK.api_version                  # 200
 OneviewSDK.api_version_updated?         # false
@@ -178,12 +178,17 @@ OneviewSDK.api_version = 300
 OneviewSDK.api_version                  # 300
 OneviewSDK.api_version_updated?         # true
 
-# The API200 module has no variants, but API300 has 2 (C7000 & Synergy):
+# The API200 module has no variants, but API300 and API500 has 2 (C7000 & Synergy):
 OneviewSDK::API300::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
 OneviewSDK::API300::DEFAULT_VARIANT     # 'C7000'
 OneviewSDK::API300.variant              # 'C7000'
 OneviewSDK::API300.variant_updated?     # false
 
+OneviewSDK::API500::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API500::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API500.variant              # 'C7000'
+OneviewSDK::API500.variant_updated?     # false
+
 # Therefore, there is 1 more namespace level to the real resource class name
 OneviewSDK::EthernetNetwork             # OneviewSDK::API300::C7000::EthernetNetwork
 OneviewSDK::API300::EthernetNetwork     # OneviewSDK::API300::C7000::EthernetNetwork
@@ -425,6 +430,7 @@ First run `$ bundle` (requires the bundler gem), then...
 ### Testing
  - RuboCop: `$ rake rubocop`
  - Unit: `$ rake spec`
+ - Optional: Start guard to run unit tests & rubocop automatically on file changes: `$ bundle exec guard`
  - Integration: See the [spec/integration](spec/integration/) README
  - All: Run `$ rake test:all` to run RuboCop, unit, & integration tests.
  - Examples: See the [examples](examples/) README

data/lib/oneview-sdk.rb

@@ -24,7 +24,7 @@ module OneviewSDK
   env_i3s = %w(I3S_URL I3S_SSL_ENABLED)
   ENV_VARS = env_sdk.concat(env_i3s).freeze
 
-  SUPPORTED_API_VERSIONS = [200, 300].freeze
+  SUPPORTED_API_VERSIONS = [200, 300, 500].freeze
   DEFAULT_API_VERSION = 200
   @api_version = DEFAULT_API_VERSION
   @api_version_updated = false # Whether or not the API version has been set by the user

data/lib/oneview-sdk/image-streamer/resource/api300/artifact_bundle.rb

@@ -50,8 +50,7 @@ module OneviewSDK
             file_name = File.basename(file_path)
           end
 
-          params = { 'name' => file_name }
-          body = client.upload_file(file_path, BASE_URI, params, timeout)
+          body = client.upload_file(file_path, BASE_URI, { 'file_name' => file_name }, timeout)
           ArtifactBundle.new(client, body)
         end
 
@@ -76,22 +75,21 @@ module OneviewSDK
         #   If there are any artifacts existing, they will be removed before the extract operation.
         # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer appliance
         # @param [String] file_path The file path with file extension
-        # @param [String] artifact_name The name for the artifact that will be created
+        # @param [String] artifact_name The name for the artifact that will be created. Default is the file name.
         # @param [Integer] timeout The number of seconds to wait for completing the request. Default is 300.
         # @return [Hash] The result hash with DeploymentGroup data
-        def self.create_backup_from_file!(client, deployment_group, file_path, artifact_name, timeout = OneviewSDK::Rest::READ_TIMEOUT)
+        def self.create_backup_from_file!(client, deployment_group, file_path, artifact_name = nil, timeout = OneviewSDK::Rest::READ_TIMEOUT)
           ensure_resource!(deployment_group)
           ensure_file_path_extension!(file_path)
 
-          file_name = artifact_name.dup
-          if file_name && !file_name.empty?
-            file_name += File.extname(file_path)
-          else
-            file_name = File.basename(file_path)
-          end
+          file_name = if artifact_name && !artifact_name.empty?
+                        artifact_name + File.extname(file_path)
+                      else
+                        File.basename(file_path)
+                      end
 
-          params = { 'name' => file_name, 'deploymentGrpUri' => deployment_group['uri'] }
-          client.upload_file(file_path, BACKUPS_ARCHIVE_URI, params, timeout)
+          params = { 'deploymentGrpUri' => deployment_group['uri'] }
+          client.upload_file(file_path, BACKUPS_ARCHIVE_URI, { 'file_name' => file_name, 'body' => params }, timeout)
         end
 
         # Download the backup bundle

data/lib/oneview-sdk/image-streamer/resource/api300/golden_image.rb

@@ -10,7 +10,6 @@
 # language governing permissions and limitations under the License.
 
 require_relative 'resource'
-require 'net/http/post/multipart'
 
 module OneviewSDK
   module ImageStreamer
@@ -18,7 +17,6 @@ module OneviewSDK
       # Golden Image resource implementation for Image Streamer
       class GoldenImage < Resource
         BASE_URI = '/rest/golden-images'.freeze
-        READ_TIMEOUT = 300 # in seconds (5 minutes)
         ACCEPTED_FORMATS = %w(.zip .ZIP).freeze # Supported upload extensions
 
         # Create a resource object, associate it with a client, and set its properties.
@@ -44,36 +42,10 @@ module OneviewSDK
         # Downloads the content of the selected golden image to the specified file path.
         # @param [String] file_path
         # @param [Integer] timeout The number of seconds to wait for the request to complete
-        # @return [True] When was saved successfully
-        def download(file_path, timeout = READ_TIMEOUT)
+        # @return [True] When it was saved successfully
+        def download(file_path)
           ensure_client && ensure_uri
-          uri = URI.parse(URI.escape("#{client.url}#{BASE_URI}/download/#{@data['uri'].split('/').last}"))
-          req = Net::HTTP::Get.new(uri.request_uri)
-
-          options = {}
-          options['Content-Type'] = 'application/json'
-          options['X-Api-Version'] = @client.api_version.to_s
-          options['auth'] = @client.token
-          options.each do |key, val|
-            req[key] = val
-          end
-
-          http_request = Net::HTTP.new(uri.host, uri.port)
-          http_request.use_ssl = true
-          http_request.verify_mode = OpenSSL::SSL::VERIFY_NONE
-          http_request.read_timeout = timeout
-
-          http_request.start do |http|
-            http.request(req) do |res|
-              client.response_handler(res) unless res.code.to_i.between?(200, 204)
-              File.open(file_path, 'wb') do |file|
-                res.read_body do |segment|
-                  file.write(segment)
-                end
-              end
-            end
-          end
-          true
+          client.download_file("#{BASE_URI}/download/#{@data['uri'].split('/').last}", file_path)
         end
 
         # Upload a golden image from the specified local file path.
@@ -85,40 +57,13 @@ module OneviewSDK
         # @option data_options [String] :description The description of the Golden Image (required)
         # @param [Integer] timeout The number of seconds to wait for the request to complete
         # @return [OneviewSDK::ImageStreamer::API300::GoldenImage] if the upload was successful, return a GoldenImage object
-        def self.add(client, file_path, data_options, timeout = READ_TIMEOUT)
+        def self.add(client, file_path, data_options, timeout = OneviewSDK::Rest::READ_TIMEOUT)
           data_options = Hash[data_options.map { |k, v| [k.to_s, v] }] # Convert symbols hash keys to string
-          raise NotFound, "ERROR: File '#{file_path}' not found!" unless File.file?(file_path)
           raise InvalidFormat, 'ERROR: File with extension not supported!' unless ACCEPTED_FORMATS.include? File.extname(file_path)
           raise IncompleteResource, 'Please set the name of the golden image!' unless data_options['name']
           raise IncompleteResource, 'Please set the description of the golden image!' unless data_options['description']
-          options = {}
-          options['Content-Type'] = 'multipart/form-data'
-          options['X-Api-Version'] = client.api_version.to_s
-          options['auth'] = client.token
-          options['file'] = File.basename(file_path)
-          url = URI.parse(URI.escape("#{client.url}#{BASE_URI}"))
-
-          File.open(file_path) do |file|
-            req = Net::HTTP::Post::Multipart.new(
-              url.path,
-              { 'file' => UploadIO.new(file, 'application/octet-stream', File.basename(file_path)) }.merge(data_options),
-              options
-            )
-
-            http_request = Net::HTTP.new(url.host, url.port)
-            http_request.use_ssl = true if url.scheme == 'https'
-            if client.ssl_enabled
-              http_request.cert_store = client.cert_store if client.cert_store
-            else http_request.verify_mode = OpenSSL::SSL::VERIFY_NONE
-            end
-            http_request.read_timeout = timeout
-
-            http_request.start do |http|
-              response = http.request(req)
-              data = client.response_handler(response)
-              return OneviewSDK::ImageStreamer::API300::GoldenImage.new(client, data)
-            end
-          end
+          data = client.upload_file(file_path, BASE_URI, { 'body' => data_options }, timeout)
+          GoldenImage.new(client, data)
         end
 
         # Sets the OS volume

data/lib/oneview-sdk/resource.rb

@@ -262,20 +262,31 @@ module OneviewSDK
     # @param [String] uri URI of the endpoint
     # @return [Array<Resource>] Results matching the search
     def self.find_by(client, attributes, uri = self::BASE_URI)
+      all = find_with_pagination(client, uri)
       results = []
+      all.each do |member|
+        temp = new(client, member)
+        results.push(temp) if temp.like?(attributes)
+      end
+      results
+    end
+
+    # Make a GET request to the uri, and returns an array with all results (search using resource pagination)
+    # @param [OneviewSDK::Client] client The client object for the OneView appliance
+    # @param [String] uri URI of the endpoint
+    # @return [Array<Hash>] Results
+    def self.find_with_pagination(client, uri)
+      all = []
       loop do
         response = client.rest_get(uri)
         body = client.response_handler(response)
         members = body['members']
         break unless members
-        members.each do |member|
-          temp = new(client, member)
-          results.push(temp) if temp.like?(attributes)
-        end
+        all.concat(members)
         break unless body['nextPageUri'] && (body['nextPageUri'] != body['uri'])
         uri = body['nextPageUri']
       end
-      results
+      all
     end
 
     # Make a GET request to the resource base uri, and returns an array with all objects of this type
@@ -350,7 +361,13 @@ module OneviewSDK
         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] && val != data[key.to_sym]
+        elsif val.is_a?(Array) && val.first.is_a?(Hash)
+          data_array = data[key.to_s] || data[key.to_sym]
+          return false unless data_array.is_a?(Array)
+          val.each do |other_item|
+            return false unless data_array.find { |data_item| recursive_like?(other_item, data_item) }
+          end
+        elsif val.to_s != data[key.to_s].to_s && val.to_s != data[key.to_sym].to_s
           return false
         end
       end

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

@@ -9,54 +9,21 @@
 # CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require 'net/http/post/multipart'
-
 module OneviewSDK
   module API200
     # Firmware bundle resource implementation
     class FirmwareBundle
       BASE_URI = '/rest/firmware-bundles'.freeze
-      READ_TIMEOUT = 300 # in seconds, 5 minutes
 
       # Uploads a firmware bundle file
       # @param [OneviewSDK::Client] client The client object for the OneView appliance
       # @param [String] file_path
       # @param [Integer] timeout The number of seconds to wait for completing the request
       # @return [OneviewSDK::FirmwareDriver] if the upload was successful, return a FirmwareDriver object
-      def self.add(client, file_path, timeout = READ_TIMEOUT)
-        raise NotFound, "ERROR: File '#{file_path}' not found!" unless File.file?(file_path)
-        options = {}
-        options['Content-Type'] = 'multipart/form-data'
-        options['X-Api-Version'] = client.api_version.to_s
-        options['auth'] = client.token
-        options['uploadfilename'] = File.basename(file_path)
-        url = URI.parse(URI.escape("#{client.url}#{BASE_URI}"))
-
-        File.open(file_path) do |file|
-          req = Net::HTTP::Post::Multipart.new(
-            url.path,
-            { 'file' => UploadIO.new(file, 'application/octet-stream', File.basename(file_path)) },
-            options
-          )
-
-          http_request = Net::HTTP.new(url.host, url.port)
-          http_request.use_ssl = true
-          http_request.verify_mode = OpenSSL::SSL::VERIFY_NONE
-          http_request.read_timeout = timeout
-
-          http_request.start do |http|
-            begin
-              response = http.request(req)
-              data = client.response_handler(response)
-              return OneviewSDK::FirmwareDriver.new(client, data)
-            rescue Net::ReadTimeout
-              raise "The connection was closed because the timeout of #{timeout} seconds has expired."\
-                'You can specify the timeout in seconds by passing the timeout on the method call.'\
-                'Interrupted firmware uploads may result in corrupted firmware remaining in the appliance.'\
-                'HPE recommends checking the appliance for corrupted firmware and removing it.'
-            end
-          end
-        end
+      def self.add(client, file_path, timeout = OneviewSDK::Rest::READ_TIMEOUT)
+        options = { 'header' => { 'uploadfilename' => File.basename(file_path) } }
+        result = client.upload_file(file_path, BASE_URI, options, timeout)
+        OneviewSDK::FirmwareDriver.new(client, result)
       end
     end
   end

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

@@ -25,7 +25,7 @@ module OneviewSDK
         super
         # Default values:
         @data['logicalPortConfigInfos'] ||= []
-        @data['lacpTimer'] ||= 'Short'
+        @data['lacpTimer'] ||= 'Short' unless @data['networkType'] == 'FibreChannel' # FibreChannel does not need set up lacpTimer
         @data['mode'] ||= 'Auto'
         @data['networkUris'] ||= []
       end

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

@@ -32,12 +32,6 @@ module OneviewSDK
         @data['type'] ||= 'logical-interconnect-groupV3'
         @data['interconnectMapTemplate'] ||= {}
         @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] ||= []
-
-        # User friendly values:
-        @bay_count = 8
-
-        # Create all entries if empty
-        parse_interconnect_map_template if @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] == []
       end
 
       # Get the logical interconnect group default settings
@@ -51,18 +45,28 @@ module OneviewSDK
       # Adds an interconnect
       # @param [Fixnum] bay Bay number
       # @param [String] type Interconnect type
-      # @raise [StandardError] if a invalid type is given then raises an error
+      # @raise [OneviewSDK::NotFound] if an invalid type is given
       def add_interconnect(bay, type)
+        interconnect_type = OneviewSDK::Interconnect.get_type(@client, type)
+        unless interconnect_type
+          list = OneviewSDK::Interconnect.get_types(@client).map { |t| t['name'] }
+          raise OneviewSDK::NotFound, "Interconnect type #{type} not found! Supported types: #{list}"
+        end
+
+        entry_already_present = false
         @data['interconnectMapTemplate']['interconnectMapEntryTemplates'].each do |entry|
           entry['logicalLocation']['locationEntries'].each do |location|
             if location['type'] == 'Bay' && location['relativeValue'] == bay
-              entry['permittedInterconnectTypeUri'] = OneviewSDK::Interconnect.get_type(@client, type)['uri']
+              entry['permittedInterconnectTypeUri'] = interconnect_type['uri']
+              entry_already_present = true
             end
           end
         end
-      rescue StandardError
-        list = OneviewSDK::Interconnect.get_types(@client).map { |t| t['name'] }
-        raise "Interconnect type #{type} not found! Supported types: #{list}"
+
+        unless entry_already_present
+          new_entry = new_interconnect_entry_template(bay, interconnect_type['uri'])
+          @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] << new_entry
+        end
       end
 
       # Adds an uplink set
@@ -79,11 +83,25 @@ module OneviewSDK
         @client.response_handler(response)
       end
 
-      # Saves the current data attributes to the Logical Interconnect Group
-      # @param [Hash] attributes attributes to be updated
-      # @return Updated instance of the Logical Interconnect Group
+      # Create 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 [Resource] self
+      def create
+        verify_interconnects_before_save!
+        super
+      end
+
+      # Set data and save to OneView
+      # @param [Hash] attributes The attributes to add/change for this resource (key-value pairs)
+      # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+      # @raise [StandardError] if the resource save fails
+      # @return [Resource] self
       def update(attributes = {})
         set_all(attributes)
+        ensure_client && ensure_uri
+        verify_interconnects_before_save!
         update_options = {
           'If-Match' =>  @data.delete('eTag'),
           'Body' => @data
@@ -95,21 +113,21 @@ module OneviewSDK
 
       private
 
-      # Parse interconnect map template structure
-      def parse_interconnect_map_template
-        1.upto(@bay_count) do |bay_number|
-          entry = {
-            'logicalDownlinkUri' => nil,
-            'logicalLocation' => {
-              'locationEntries' => [
-                { 'relativeValue' => bay_number, 'type' => 'Bay' },
-                { 'relativeValue' => 1, 'type' => 'Enclosure' }
-              ]
-            },
-            'permittedInterconnectTypeUri' => nil
-          }
-          @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] << entry
-        end
+      def verify_interconnects_before_save!
+        return unless @data['interconnectMapTemplate']['interconnectMapEntryTemplates'].empty?
+        @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] << new_interconnect_entry_template
+      end
+
+      def new_interconnect_entry_template(bay = 1, interconnect_type_uri = nil)
+        {
+          'logicalLocation' => {
+            'locationEntries' => [
+              { 'relativeValue' => bay, 'type' => 'Bay' },
+              { 'relativeValue' => 1, 'type' => 'Enclosure' }
+            ]
+          },
+          'permittedInterconnectTypeUri' => interconnect_type_uri
+        }
       end
     end
   end