Class: Chef::Provider::Package::Powershell

Inherits:
Chef::Provider::Package show all
Includes:
Mixin::PowershellExec
Defined in:
lib/chef/provider/package/powershell.rb

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #after_resource, #current_resource, #logger, #new_resource, #run_context

Instance Method Summary collapse

Methods included from Mixin::PowershellExec

#powershell_exec, #powershell_exec!

Methods inherited from Chef::Provider::Package

#as_array, #expand_options, #have_any_matching_version?, #initialize, #lock_package, #multipackage_api_adapter, #options, #package_locked, #prepare_for_installation, #preseed_package, #purge_package, #reconfig_package, #removing_package?, #target_version_already_installed?, #unlock_package, #upgrade_package, #version_compare, #version_equals?, #version_requirement_satisfied?

Methods included from Mixin::SubclassDirective

#subclass_directive

Methods inherited from Chef::Provider

action, action_description, action_descriptions, #action_nothing, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #cookbook_name, #description, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #introduced, #load_after_resource, #node, #process_resource_requirements, provides, provides?, #recipe_name, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use, use_inline_resources, #validate_required_properties!, #whyrun_mode?, #whyrun_supported?

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

Methods included from Mixin::DescendantsTracker

#descendants, descendants, #direct_descendants, direct_descendants, #find_descendants_by_name, find_descendants_by_name, #inherited, store_inherited

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::Secret

#secret

Methods included from DSL::RenderHelpers

#render_json, #render_toml, #render_yaml

Methods included from DSL::ReaderHelpers

#parse_file, #parse_json, #parse_toml, #parse_yaml

Methods included from DSL::Powershell

#ps_credential

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::ChefVault

#chef_vault, #chef_vault_item, #chef_vault_item_for_environment

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search, #tagged?

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::PlatformIntrospection

#older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from DSL::Recipe

#exec, #have_resource_class_for?, #resource_class_for

Methods included from DSL::Definitions

add_definition, #evaluate_resource_definition, #has_resource_definition?

Methods included from DSL::Resources

add_resource_dsl, remove_resource_dsl

Methods included from DSL::Cheffish

load_cheffish

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::IncludeRecipe

#include_recipe, #load_recipe

Methods included from Mixin::NotifyingBlock

#notifying_block, #subcontext_block

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #resources, #with_run_context

Methods included from DSL::Compliance

#include_input, #include_profile, #include_waiver

Constructor Details

This class inherits a constructor from Chef::Provider::Package

Instance Method Details

#build_candidate_versionsObject

Returns array of available available online


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/chef/provider/package/powershell.rb', line 82

def build_candidate_versions
  versions = []
  new_resource.package_name.each_with_index do |name, index|
    version = if new_resource.version && !new_resource.version[index].nil?
                powershell_exec(build_powershell_package_command("Find-Package '#{name}'", new_resource.version[index]), timeout: new_resource.timeout).result
              else
                powershell_exec(build_powershell_package_command("Find-Package '#{name}'"), timeout: new_resource.timeout).result
              end
    if version.empty?
      version = nil
    end
    version = version.strip if version.respond_to?(:strip)
    versions.push(version)
  end
  versions
end

#build_current_versionsObject

Returns version array of installed version on the system


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/chef/provider/package/powershell.rb', line 100

def build_current_versions
  version_list = []
  new_resource.package_name.each_with_index do |name, index|
    version = if new_resource.version && !new_resource.version[index].nil?
                powershell_exec(build_powershell_package_command("Get-Package '#{name}'", new_resource.version[index]), timeout: new_resource.timeout).result
              else
                powershell_exec(build_powershell_package_command("Get-Package '#{name}'"), timeout: new_resource.timeout).result
              end
    if version.empty?
      version = nil
    end
    version = version.strip if version.respond_to?(:strip)
    version_list.push(version)
  end
  version_list
end

#build_powershell_package_command(command, version = nil) ⇒ Object


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/chef/provider/package/powershell.rb', line 117

def build_powershell_package_command(command, version = nil)
  command = [command] unless command.is_a?(Array)
  cmdlet_name = command.first
  command.unshift("(")
  # PowerShell Gallery requires tls 1.2
  command.unshift("if ([Net.ServicePointManager]::SecurityProtocol -lt [Net.SecurityProtocolType]::Tls12) { [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 };")
  # -WarningAction SilentlyContinue is used to suppress the warnings from stdout
  %w{-Force -ForceBootstrap -WarningAction SilentlyContinue}.each do |arg|
    command.push(arg)
  end
  command.push("-RequiredVersion #{version}") if version
  command.push("-Source #{new_resource.source}") if new_resource.source && cmdlet_name =~ Regexp.union(/Install-Package/, /Find-Package/)
  command.push("-SkipPublisherCheck") if new_resource.skip_publisher_check && cmdlet_name !~ /Find-Package/
  if new_resource.options && cmdlet_name !~ Regexp.union(/Get-Package/, /Find-Package/)
    new_resource.options.each do |arg|
      command.push(arg) unless command.include?(arg)
    end
  end
  command.push(").Version")
  command.join(" ")
end

#candidate_versionObject


50
51
52
# File 'lib/chef/provider/package/powershell.rb', line 50

def candidate_version
  @candidate_version ||= build_candidate_versions
end

#check_resource_semantics!Object


139
140
141
# File 'lib/chef/provider/package/powershell.rb', line 139

def check_resource_semantics!
  # This validation method from Chef::Provider::Package does not apply here, so no-op it.
end

#define_resource_requirementsObject


37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/chef/provider/package/powershell.rb', line 37

def define_resource_requirements
  super
  if powershell_version < 5
    raise "Minimum installed PowerShell Version required is 5"
  end

  requirements.assert(:install) do |a|
    a.assertion { candidates_exist_for_all_uninstalled? }
    a.failure_message(Chef::Exceptions::Package, "No candidate version available for #{packages_missing_candidates.join(", ")}")
    a.whyrun("Assuming a repository that offers #{packages_missing_candidates.join(", ")} would have been configured")
  end
end

#install_package(names, versions) ⇒ Object

Installs the package specified with the version passed else latest version will be installed


55
56
57
58
59
60
61
# File 'lib/chef/provider/package/powershell.rb', line 55

def install_package(names, versions)
  names.each_with_index do |name, index|
    cmd = powershell_exec(build_powershell_package_command("Install-Package '#{name}'", versions[index]), timeout: new_resource.timeout)
    next if cmd.nil?
    raise Chef::Exceptions::PowershellCmdletException, "Failed to install package due to catalog signing error, use skip_publisher_check to force install" if /SkipPublisherCheck/.match?(cmd.error)
  end
end

#load_current_resourceObject


30
31
32
33
34
35
# File 'lib/chef/provider/package/powershell.rb', line 30

def load_current_resource
  @current_resource = Chef::Resource::PowershellPackage.new(new_resource.name)
  current_resource.package_name(new_resource.package_name)
  current_resource.version(build_current_versions)
  current_resource
end

#remove_package(names, versions) ⇒ Object

Removes the package for the version passed and if no version is passed, then all installed versions of the package are removed


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/chef/provider/package/powershell.rb', line 64

def remove_package(names, versions)
  names.each_with_index do |name, index|
    if versions && !versions[index].nil?
      powershell_exec(build_powershell_package_command("Uninstall-Package '#{name}'", versions[index]), timeout: new_resource.timeout)
    else
      version = "0"
      until version.empty?
        version = powershell_exec(build_powershell_package_command("Uninstall-Package '#{name}'"), timeout: new_resource.timeout).result
        version = version.strip if version.respond_to?(:strip)
        unless version.empty?
          logger.info("Removed package '#{name}' with version #{version}")
        end
      end
    end
  end
end