fog-hyperv 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccbf3e9eda759ea102435d2964c19386543882388faf665cef30f1799ec53ae1
-  data.tar.gz: 45decf89ada52daa7b99e4fbba5f638c115835f03c6cc298a812c4028f7057d0
+  metadata.gz: 967724a9fd59c0978858d86ff438fe64a8eefc884cdeb11d0e6c7e372c28b725
+  data.tar.gz: f845028078a57dd1aec509aa7357ac3c58e5aab5d301b833ac00ab01fc8ee726
 SHA512:
-  metadata.gz: 5f5840914ddd70af716c7695a65afe481315b9fee527106b08dd0ac3668b1ec6303a4bddbc30eae15be77c7d77e0f75cb2f0594abd55e65caa84381a0cf504b3
-  data.tar.gz: 07cddab77c89dd6ead6c54b168eed4ea74a56f96070b9d8305811083cc410d940bdc47783576df1100ba6cf72c9a24599a98a46882eaac5744ab10e59f3eaab5
+  metadata.gz: e4f71c7887ef726c2281be088d048fa56ceb71b4bd0b1684846bd1accd922a245ea2227e4f562b3acdbb9d57c90f72a930011f63c051b30937187cd1e13bc012
+  data.tar.gz: 2ea917dfb9a6fc294ea7ced844661dc3c5772e9775d2e01d77eb3eb2592d742b8a96e5a57ca4ecd9ca527bee1e467d40256cb218f897164e223a7de4b874e5e4

data/lib/fog/hyperv/compute/models/firmware.rb

@@ -55,6 +55,8 @@ class Fog::Hyperv::Compute
           computer_name: computer_name,
           vm_id: vm_id,
 
+          **changes,
+
           _return_fields: self.class.attributes
         )
       )

data/lib/fog/hyperv/compute/models/hard_drive.rb

@@ -67,7 +67,7 @@ class Fog::Hyperv::Compute
       return associations[:vhd] if associations[:vhd]
       return unless path
 
-      associations[:vhd] = service.vhds.get(path, computer_name: computer_name)
+      associations[:vhd] = (vm || service).vhds.get(path, computer_name: computer_name)
     end
 
     def vhd=(new_vhd)

data/lib/fog/hyperv/compute/models/integration_service.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  class IntegrationService < Fog::Hyperv::Model
+    # rubocop:disable Layout/HashAlignment
+
+    # Integration service statuses
+    # @note Defined by Microsoft.HyperV.PowerShell.VMIntegrationComponentOperationalStatus
+    INTEGRATION_SERVICE_STATUS_ENUM_VALUES = {
+      Ok:                    2,
+      Degraded:              3,
+      Error:                 6,
+      NonRecoverableError:   7,
+      NoContact:             12,
+      LostCommunication:     13,
+      Disabled:              32_896,
+      ProtocolMismatch:      32_775,
+      ApplicationCritical:   32_782,
+      CommunicationTimedOut: 32_783,
+      CommunicationFailed:   32_784
+    }.freeze
+    # rubocop:enable Layout/HashAlignment
+
+    # @!attribute [r] name
+    #   @return [String] the name of the integration service
+    identity :name
+
+    # @!attribute [r] computer_name
+    #   @return [String] the name of the computer running the VM that this integration service is attached to
+    attribute :computer_name
+    # @!attribute [r] vm_id
+    #   @return [String] the GUID of the VM this integration service is attached to
+    attribute :vm_id
+
+    # @!attribute enabled
+    #   @return [Boolean] if the integration service is enabled or not
+    attribute :enabled, type: :boolean
+    # @!attribute [r] operational_status
+    #   @return [Symbol] the statuses of the integration service
+    #   @see INTEGRATION_SERVICE_STATUS_ENUM_VALUES
+    attribute :operational_status, type: :hypervenumarray, values: INTEGRATION_SERVICE_STATUS_ENUM_VALUES
+
+    def update
+      requires :name, :vm_id
+
+      return self unless changed? :enabled
+
+      method = enabled ? :enable : :disable
+      service.send(:"#{method}_vm_integration_service", computer_name: computer_name, vm_id: vm_id, name: name)
+
+      old.enabled = attributes[:enabled]
+      self
+    end
+
+    def reload
+      requires :name, :vm_id
+
+      data = service.get_vm_integration_service computer_name: computer_name, vm_id: vm_id, name: name
+      return unless data
+
+      merge_attributes(data)
+    end
+
+    protected
+
+    def merge_attributes(new_attributes = {})
+      new_attributes[:operational_status] = [] if new_attributes[:operational_status] == ''
+
+      super
+    end
+  end
+end

data/lib/fog/hyperv/compute/models/integration_services.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # A collection of integration services available for a VM
+  #
+  # @note Requires a vm_id to be specified, as integration services are not retrievable as loose objects
+  class IntegrationServices < Fog::Hyperv::Collection
+    model Fog::Hyperv::Compute::IntegrationService
+
+    get_method :get_vm_integration_service
+
+    # @!attribute vm_id
+    #   @return [String] the GUID of the VM containing the COM ports
+    attribute :vm_id
+    # @!attribute computer_name
+    #   @return [String] the name of the computer running the VM that these COM ports are attached to
+    attribute :computer_name
+
+    requires :vm_id
+
+    # Get an integration service by name
+    # @param id [String] the name of the integration service to retrieve
+    def get(name, **filters)
+      raise ArgumentError, 'Must provide a name' if name.nil? || name.empty?
+
+      super(name: name, **filters)
+    end
+  end
+end

data/lib/fog/hyperv/compute/models/security.rb

@@ -36,10 +36,14 @@ class Fog::Hyperv::Compute
     def key_protector
       requires :vm
 
-      @key_protector ||= service.get_vm_key_protector(
-        computer_name: vm.computer_name,
-        vm_id: vm.id
-      )[:value]
+      @key_protector ||= begin
+        value = service.get_vm_key_protector(
+          computer_name: vm.computer_name,
+          vm_id: vm.id
+        )[:value]
+        value = nil if value == [0, 0, 0, 4]
+        value
+      end
     end
 
     # Change the key protector for a VM

data/lib/fog/hyperv/compute/models/server.rb

@@ -141,6 +141,9 @@ class Fog::Hyperv::Compute
     # @!attribute notes
     #   @return [String] user-specified notes for the VM
     attribute :notes, type: :string
+    # @!attribute path
+    #   @return [String] the path on disk where the VM configuration is stored
+    attribute :path, type: :string
     # @!attribute processor_count
     #   @return [Integer] the number of processors in the VM
     attribute :processor_count, type: :integer, default: 1
@@ -161,6 +164,9 @@ class Fog::Hyperv::Compute
     # @!attribute hard_drives
     #   @return [Array<HardDrive>] the hard drives on the VM
     collection :hard_drives
+    # @!attribute integration_services
+    #   @return [Array<IntegrationService>] the integration services on the VM
+    collection :integration_services
     # @!attribute network_adapters
     #   @return [Array<NetworkAdapter>] the network adapters on the VM
     collection :network_adapters
@@ -212,16 +218,21 @@ class Fog::Hyperv::Compute
     # @!attribute [r] security
     # @return [Security] UEFI security configuration, if #generation is +:UEFI+
     def security
-      requires :generation, :id
-      return nil unless generation == :UEFI
+      return unless persisted?
 
-      associations[:security] ||= Fog::Hyperv::Compute::Security.new(
-        **service.get_vm_security(
-          computer_name: computer_name,
-          vm_id: vm_id,
+      requires :generation
+      return unless generation == :UEFI
+
+      security = service.get_vm_security(
+        computer_name: computer_name,
+        vm_id: vm_id,
 
-          _return_fields: Fog::Hyperv::Compute::Security.attributes
-        ),
+        _return_fields: Fog::Hyperv::Compute::Security.attributes
+      )
+      return unless security.is_a? Hash
+
+      associations[:security] ||= Fog::Hyperv::Compute::Security.new(
+        **security,
 
         vm: self,
         service: @service,
@@ -305,21 +316,31 @@ class Fog::Hyperv::Compute
     end
 
     # Remove the VM object from Hyper-V
+    # @param [Boolean] underlying remove the underlying configuration directory from disk on the Hyper-V host
     #
     # @note if the VM has VHDs, make sure to remove them first to not leave the VM data remaining on disk
-    def destroy
+    # @note underlying will remove the +full+ path of the VM, make sure this is what you want before using it
+    def destroy(underlying = nil)
+      underlying = true if underlying.nil? && attributes[:path]&.end_with?(attributes[:name])
+
       requires :id
+      requires :path if underlying
       stop turn_off: true if ready?
 
       service.remove_vm(computer_name: computer_name, id: id)
+      service.remove_item(path: path, computer_name: computer_name, recurse: true) if underlying
       true
     end
 
     # Create the VM object if it doesn't exist
     # @param [Symbol] boot_device the default boot device to configure the VM with, one of BOOT_DEVICE
     # @param [String] switch_name the name of a Switch to connect the VM to on creation
+    # @option attrs [String] :path
+    #   a custom path to store the VM configuration under - will use a subdir under the default config path if relative
     def create(boot_device: nil, switch_name: nil, **attrs)
       attrs[:no_vhd] = true unless attrs[:new_vhd_path]
+      attrs[:path] = [computer.virtual_machine_path, attrs[:path]].join('\\') \
+        if attrs[:path] && attrs[:path] !~ %r{^(\w:[\\/]|[\\/]{2}\w+[\\/])}i
 
       # Attributes that can't be set as part of the New-VM call
       post_create_attributes = {
@@ -422,10 +443,18 @@ class Fog::Hyperv::Compute
 
     # Build a path for where to store a VHD of a given name
     # @return [String] the absolute path for the VHD
-    def build_vhd_path(filename)
+    def build_vhd_path(filename = nil)
+      requires :name
+
+      [computer.virtual_hard_disk_path, name, filename].compact.join('\\')
+    end
+
+    # Build a path for where to store configuration files
+    # @return [String] the absolute path for the configuration store
+    def build_config_path(subdir = nil)
       requires :name
 
-      [computer.virtual_hard_disk_path, '\\', name, '\\', filename].join
+      [computer.virtual_machine_path, name, subdir].compact.join('\\')
     end
 
     # Get the username of the main system account

data/lib/fog/hyperv/compute/models/vhd.rb

@@ -171,8 +171,21 @@ class Fog::Hyperv::Compute
 
       service.remove_item(
         computer_name: computer_name,
-        path: path
+        path: [path, "#{path}.*"],
       )
+      components = path.split('\\')
+      if components[-2] == vm.name
+        # if (!Test-Path -Path ...\*) { Remove-Item -Path ... -Recurse -Force }
+        vmpath = components[0..-2].join '\\'
+        service.run_cmdlist(
+          [
+            ["$anyFiles = Test-Path", { path: [vmpath, '*'].join('\\') }],
+            ['if (-not $anyFiles) { Remove-Item @Args }', { path: vmpath, recurse: true, force: true }]
+          ],
+          skip_json: true,
+          target_computer: computer_name,
+        )
+      end
       true
     end
 

data/lib/fog/hyperv/compute/requests/disable_vm_integration_service.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  class Real
+    def disable_vm_integration_service(name:, vm_id:, computer_name: nil, **options)
+      run_cmdlist(
+        [
+          ['$VM = Get-VM', { id: vm_id }],
+          ['$VM | Disable-VMIntegrationService', { name: name, **options }]
+        ],
+        skip_json: true,
+        target_computer: computer_name
+      )
+    end
+  end
+end

data/lib/fog/hyperv/compute/requests/enable_vm_integration_service.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  class Real
+    def enable_vm_integration_service(name:, vm_id:, computer_name: nil, **options)
+      run_cmdlist(
+        [
+          ['$VM = Get-VM', { id: vm_id }],
+          ['$VM | Enable-VMIntegrationService', { name: name, **options }]
+        ],
+        skip_json: true,
+        target_computer: computer_name
+      )
+    end
+  end
+end

data/lib/fog/hyperv/compute/requests/get_vhd.rb

@@ -4,6 +4,8 @@ class Fog::Hyperv::Compute
   class Real
     def get_vhd(computer_name: nil, **options)
       requires_one options, :path, :disk_number unless options[:vm_id]
+      options.delete :vm_id if options[:path] || options[:disk_number]
+
       run_cmd 'Get-VHD', _target_computer: computer_name, **options
     end
   end

data/lib/fog/hyperv/compute/requests/get_vm_integration_service.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  class Real
+    def get_vm_integration_service(vm_id:, computer_name: nil, **options)
+      run_cmdlist(
+        [
+          ['$VM = Get-VM', { id: vm_id }],
+          ['$VM | Get-VMIntegrationService', options]
+        ],
+        target_computer: computer_name
+      )
+    end
+  end
+end

data/lib/fog/hyperv/compute.rb

@@ -25,6 +25,8 @@ module Fog::Hyperv
     collection :hard_drives
     model :host
     collection :hosts
+    model :integration_service
+    collection :integration_services
     model :network_adapter
     model :network_adapter_vlan
     collection :network_adapters
@@ -41,8 +43,10 @@ module Fog::Hyperv
     request :add_vm_hard_disk_drive
     request :add_vm_network_adapter
     request :connect_vm_network_adapter
+    request :disable_vm_integration_service
     request :disable_vm_tpm
     request :disconnect_vm_network_adapter
+    request :enable_vm_integration_service
     request :enable_vm_tpm
     request :get_cluster
     request :get_cluster_node
@@ -58,6 +62,7 @@ module Fog::Hyperv
     request :get_vm_host
     request :get_vm_host_cluster
     request :get_vm_host_sbt
+    request :get_vm_integration_service
     request :get_vm_key_protector
     request :get_vm_network_adapter
     request :get_vm_network_adapter_vlan

data/lib/fog/hyperv/version.rb

@@ -3,6 +3,6 @@
 module Fog
   module Hyperv
     # The Fog Hyper-V version
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fog-hyperv
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Olofsson
@@ -176,6 +176,8 @@ files:
 - lib/fog/hyperv/compute/models/hard_drives.rb
 - lib/fog/hyperv/compute/models/host.rb
 - lib/fog/hyperv/compute/models/hosts.rb
+- lib/fog/hyperv/compute/models/integration_service.rb
+- lib/fog/hyperv/compute/models/integration_services.rb
 - lib/fog/hyperv/compute/models/network_adapter.rb
 - lib/fog/hyperv/compute/models/network_adapter_vlan.rb
 - lib/fog/hyperv/compute/models/network_adapters.rb
@@ -190,8 +192,10 @@ files:
 - lib/fog/hyperv/compute/requests/add_vm_hard_disk_drive.rb
 - lib/fog/hyperv/compute/requests/add_vm_network_adapter.rb
 - lib/fog/hyperv/compute/requests/connect_vm_network_adapter.rb
+- lib/fog/hyperv/compute/requests/disable_vm_integration_service.rb
 - lib/fog/hyperv/compute/requests/disable_vm_tpm.rb
 - lib/fog/hyperv/compute/requests/disconnect_vm_network_adapter.rb
+- lib/fog/hyperv/compute/requests/enable_vm_integration_service.rb
 - lib/fog/hyperv/compute/requests/enable_vm_tpm.rb
 - lib/fog/hyperv/compute/requests/get_cluster.rb
 - lib/fog/hyperv/compute/requests/get_cluster_node.rb
@@ -207,6 +211,7 @@ files:
 - lib/fog/hyperv/compute/requests/get_vm_host.rb
 - lib/fog/hyperv/compute/requests/get_vm_host_cluster.rb
 - lib/fog/hyperv/compute/requests/get_vm_host_sbt.rb
+- lib/fog/hyperv/compute/requests/get_vm_integration_service.rb
 - lib/fog/hyperv/compute/requests/get_vm_key_protector.rb
 - lib/fog/hyperv/compute/requests/get_vm_network_adapter.rb
 - lib/fog/hyperv/compute/requests/get_vm_network_adapter_vlan.rb