Class: Chef::Provider::Package::Cab

Inherits:
Chef::Provider::Package show all
Includes:
Mixin::Checksum, Mixin::ShellOut, Mixin::Uris
Defined in:
lib/chef/provider/package/cab.rb

Instance Attribute Summary

Attributes inherited from Chef::Provider::Package

#candidate_version

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods included from Mixin::Checksum

#checksum, #short_cksum

Methods included from Mixin::Uris

#as_uri, #uri_scheme?

Methods included from Mixin::ShellOut

#a_to_s, #clean_array, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_compact_timeout, #shell_out_compact_timeout!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Methods inherited from Chef::Provider::Package

#action_lock, #action_unlock, #as_array, #check_resource_semantics!, #define_resource_requirements, #expand_options, #get_preseed_file, #have_any_matching_version?, #initialize, #lock_package, #multipackage_api_adapter, #options, #package_locked, #preseed_package, #preseed_resource, #purge_package, #reconfig_package, #removing_package?, #target_version_already_installed?, #unlock_package, #upgrade_package, #version_requirement_satisfied?

Methods included from Mixin::SubclassDirective

#subclass_directive

Methods inherited from Chef::Provider

action, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #define_resource_requirements, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #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::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!, #with_run_context

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::PlatformIntrospection

#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Constructor Details

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

Instance Method Details

#cab_file_sourceObject


43
44
45
# File 'lib/chef/provider/package/cab.rb', line 43

def cab_file_source
  @cab_file_source ||= uri_scheme?(new_resource.source) ? download_source_file : new_resource.source
end

#cab_identity_from_cab_fileObject


104
105
106
107
108
# File 'lib/chef/provider/package/cab.rb', line 104

def cab_identity_from_cab_file
  stdout = dism_command("/Get-PackageInfo /PackagePath:\"#{cab_file_source}\"").stdout
  package_info = parse_dism_get_package_info(stdout)
  split_package_identity(package_info["package_information"]["package_identity"])
end

#default_download_cache_pathObject


61
62
63
64
65
66
# File 'lib/chef/provider/package/cab.rb', line 61

def default_download_cache_path
  uri = ::URI.parse(new_resource.source)
  filename = ::File.basename(::URI.unescape(uri.path))
  file_cache_dir = Chef::FileCache.create_cache_path("package/")
  Chef::Util::PathHelper.cleanpath("#{file_cache_dir}/#{filename}")
end

#dism_command(command) ⇒ Object


76
77
78
79
80
81
# File 'lib/chef/provider/package/cab.rb', line 76

def dism_command(command)
  shellout = Mixlib::ShellOut.new("dism.exe /Online /English #{command} /NoRestart", timeout: new_resource.timeout)
  with_os_architecture(nil) do
    shellout.run_command
  end
end

#download_source_fileObject


47
48
49
50
51
# File 'lib/chef/provider/package/cab.rb', line 47

def download_source_file
  source_resource.run_action(:create)
  Chef::Log.debug("#{new_resource} fetched source file to #{source_resource.path}")
  source_resource.path
end

#install_package(name, version) ⇒ Object


68
69
70
# File 'lib/chef/provider/package/cab.rb', line 68

def install_package(name, version)
  dism_command("/Add-Package /PackagePath:\"#{cab_file_source}\"")
end

#installed_packagesObject


173
174
175
176
177
178
179
# File 'lib/chef/provider/package/cab.rb', line 173

def installed_packages
  @packages ||= begin
    output = dism_command("/Get-Packages").stdout
    packages = parse_dism_get_packages(output)
    packages
  end
end

#installed_versionObject


83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/chef/provider/package/cab.rb', line 83

def installed_version
  # e.g. Package_for_KB2975719~31bf3856ad364e35~amd64~~6.3.1.8
  package = new_cab_identity
  # Search for just the package name to catch a different version being installed
  Chef::Log.debug("#{new_resource} searching for installed package #{package['name']}")
  existing_package_identities = installed_packages.map do |p|
    split_package_identity(p["package_identity"])
  end
  found_packages = existing_package_identities.select do |existing_package_ident|
    existing_package_ident["name"] == package["name"]
  end
  if found_packages.empty?
    nil
  elsif found_packages.length == 1
    found_packages.first["version"]
  else
    # Presuming this won't happen, otherwise we need to handle it
    raise Chef::Exceptions::Package, "Found multiple packages installed matching name #{package['name']}, found: #{found_packages.length} matches"
  end
end

#load_current_resourceObject


35
36
37
38
39
40
41
# File 'lib/chef/provider/package/cab.rb', line 35

def load_current_resource
  @current_resource = Chef::Resource::CabPackage.new(new_resource.name)
  current_resource.source(cab_file_source)
  new_resource.version(package_version)
  current_resource.version(installed_version)
  current_resource
end

#new_cab_identityObject


110
111
112
113
# File 'lib/chef/provider/package/cab.rb', line 110

def new_cab_identity
  Chef::Log.debug("#{new_resource} getting product version for package at #{cab_file_source}")
  @new_cab_identity ||= cab_identity_from_cab_file
end

#package_versionObject


115
116
117
# File 'lib/chef/provider/package/cab.rb', line 115

def package_version
  new_cab_identity["version"].chomp
end

#parse_dism_get_package_info(text) ⇒ Object

returns a hash of package information given the output of dism /get-packageinfo


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/chef/provider/package/cab.rb', line 134

def parse_dism_get_package_info(text)
  package_data = {}
  errors = []
  in_section = false
  section_headers = [ "Package information", "Custom Properties", "Features" ]
  text.each_line do |line|
    if line =~ /Error: (.*)/
      errors << $1.strip
    elsif section_headers.any? { |header| line =~ /^(#{header})/ }
      in_section = $1.downcase.tr(" ", "_")
    elsif line =~ /(.*) ?: (.*)/
      v = $2 # has to be first or the gsub below replaces this variable
      k = $1.downcase.strip.tr(" ", "_")
      if in_section
        package_data[in_section] = {} unless package_data[in_section]
        package_data[in_section][k] = v
      else
        package_data[k] = v
      end
    end
  end
  unless errors.empty?
    if errors.include?("0x80070003") || errors.include?("0x80070002")
      raise Chef::Exceptions::Package, "DISM: The system cannot find the path or file specified."
    elsif errors.include?("740")
      raise Chef::Exceptions::Package, "DISM: Error 740: Elevated permissions are required to run DISM."
    else
      raise Chef::Exceptions::Package, "Unknown errors encountered parsing DISM output: #{errors}"
    end
  end
  package_data
end

#parse_dism_get_packages(text) ⇒ Object

returns a hash of package state information given the output of dism /get-packages expected keys: package_identity


121
122
123
124
125
126
127
128
129
130
131
# File 'lib/chef/provider/package/cab.rb', line 121

def parse_dism_get_packages(text)
  packages = []
  text.each_line do |line|
    key, value = line.split(":") if line.start_with?("Package Identity")
    next if key.nil? || value.nil?
    package = {}
    package[key.downcase.strip.tr(" ", "_")] = value.strip.chomp
    packages << package
  end
  packages
end

#remove_package(name, version) ⇒ Object


72
73
74
# File 'lib/chef/provider/package/cab.rb', line 72

def remove_package(name, version)
  dism_command("/Remove-Package /PackagePath:\"#{cab_file_source}\"")
end

#source_resourceObject


53
54
55
56
57
58
59
# File 'lib/chef/provider/package/cab.rb', line 53

def source_resource
  @source_resource ||= declare_resource(:remote_file, new_resource.name) do
    path default_download_cache_path
    source new_resource.source
    backup false
  end
end

#split_package_identity(identity) ⇒ Object


167
168
169
170
171
# File 'lib/chef/provider/package/cab.rb', line 167

def split_package_identity(identity)
  data = {}
  data["name"], data["publisher"], data["arch"], data["resource_id"], data["version"] = identity.split("~")
  data
end