Class: Chef::Provider::Package::Msu

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

Instance Attribute Summary

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!, #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

#candidate_versionObject


74
75
76
# File 'lib/chef/provider/package/msu.rb', line 74

def candidate_version
  @candidate_version ||= get_candidate_versions
end

#cleanup_after_convergeObject


154
155
156
157
# File 'lib/chef/provider/package/msu.rb', line 154

def cleanup_after_converge
  # delete the temp directory where the contents of msu file are extracted
  FileUtils.rm_rf(@temp_directory) if Dir.exist?(@temp_directory)
end

#default_download_cache_pathObject


99
100
101
102
103
104
# File 'lib/chef/provider/package/msu.rb', line 99

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

#download_source_fileObject


84
85
86
87
88
# File 'lib/chef/provider/package/msu.rb', line 84

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

#extract_msu_contents(msu_file, destination) ⇒ Object


126
127
128
129
130
# File 'lib/chef/provider/package/msu.rb', line 126

def extract_msu_contents(msu_file, destination)
  with_os_architecture(nil) do
    shell_out_with_timeout!("#{ENV['SYSTEMROOT']}\\system32\\expand.exe -f:* #{msu_file} #{destination}")
  end
end

#get_cab_package(cab_file) ⇒ Object


78
79
80
81
82
# File 'lib/chef/provider/package/msu.rb', line 78

def get_cab_package(cab_file)
  cab_resource = new_resource
  cab_resource.source = cab_file
  Chef::Provider::Package::Cab.new(cab_resource, nil)
end

#get_candidate_versionsObject


67
68
69
70
71
72
# File 'lib/chef/provider/package/msu.rb', line 67

def get_candidate_versions
  @cab_files.map do |cabfile|
    cab_pkg = get_cab_package(cabfile)
    cab_pkg.package_version
  end
end

#get_current_versionsObject


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

def get_current_versions
  @cab_files.map do |cabfile|
    cab_pkg = get_cab_package(cabfile)
    cab_pkg.installed_version
  end
end

#install_package(name, version) ⇒ Object


106
107
108
109
110
111
112
113
114
# File 'lib/chef/provider/package/msu.rb', line 106

def install_package(name, version)
  # use cab_package resource to install the extracted cab packages
  @cab_files.each do |cab_file|
    declare_resource(:cab_package, new_resource.name) do
      source cab_file
      action :install
    end
  end
end

#load_current_resourceObject


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/chef/provider/package/msu.rb', line 41

def load_current_resource
  @current_resource = Chef::Resource::MsuPackage.new(new_resource.name)

  # download file if source is a url
  msu_file = uri_scheme?(new_resource.source) ? download_source_file : new_resource.source

  # temp directory where the contents of msu file get extracted
  @temp_directory = Dir.mktmpdir("chef")
  extract_msu_contents(msu_file, @temp_directory)
  @cab_files = read_cab_files_from_xml(@temp_directory)

  if @cab_files.empty?
    raise Chef::Exceptions::Package, "Corrupt MSU package: MSU package XML does not contain any cab file"
  else
    current_resource.version(get_current_versions)
  end
  current_resource
end

#read_cab_files_from_xml(msu_dir) ⇒ Object

msu package can contain multiple cab files Reading cab files from xml to ensure the order of installation in case of multiple cab files


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/chef/provider/package/msu.rb', line 134

def read_cab_files_from_xml(msu_dir)
  # get the file with .xml extension
  xml_files = Dir.glob("#{msu_dir}/*.xml")
  cab_files = []

  if xml_files.empty?
    raise Chef::Exceptions::Package, "Corrupt MSU package: MSU package doesn't contain any xml file"
  else
    # msu package contains only single xml file. So using xml_files.first is sufficient
    doc = ::File.open(xml_files.first.to_s) { |f| REXML::Document.new f }
    locations = doc.elements.each("unattend/servicing/package/source") { |element| element.attributes["location"] }
    locations.each do |loc|
      cab_files << msu_dir + "/" + loc.attribute("location").value.split("\\")[1]
    end

    cab_files
  end
  cab_files
end

#remove_package(name, version) ⇒ Object


116
117
118
119
120
121
122
123
124
# File 'lib/chef/provider/package/msu.rb', line 116

def remove_package(name, version)
  # use cab_package provider to remove the extracted cab packages
  @cab_files.each do |cab_file|
    declare_resource(:cab_package, new_resource.name) do
      source cab_file
      action :remove
    end
  end
end

#source_resourceObject


90
91
92
93
94
95
96
97
# File 'lib/chef/provider/package/msu.rb', line 90

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