require 'pdk'
module PDK
module Module
class Update < Convert
GIT_DESCRIBE_PATTERN = /\A(?.+?)-(?\d+)-g(?.+)\Z/.freeze
def run
template_uri.uri_fragment = new_template_version
stage_changes!
PDK.logger.debug format('This module is already up to date with version %{version} of the template.', version: new_version) if current_version == new_version
unless update_manager.changes?
PDK::Report.default_target.puts('No changes required.')
return
end
PDK.logger.info(update_message)
print_summary
full_report('update_report.txt') unless update_manager.changes[:modified].empty?
return if noop?
unless force?
message = 'Do you want to continue and make these changes to your module?'
return unless PDK::CLI::Util.prompt_for_yes(message)
end
# Remove these files straight away as these changes are not something
# that the user needs to review.
update_manager.unlink_file('Gemfile.lock')
update_manager.unlink_file(File.join('.bundle', 'config'))
update_manager.sync_changes!
require 'pdk/util/bundler'
PDK::Util::Bundler.ensure_bundle!
print_result 'Update completed'
end
def module_metadata
@module_metadata ||= PDK::Module::Metadata.from_file(File.join(module_dir, 'metadata.json'))
rescue ArgumentError => e
raise PDK::CLI::ExitWithError, e.message
end
def template_uri
@template_uri ||= PDK::Util::TemplateURI.new(module_metadata.data['template-url'])
end
def current_version
@current_version ||= describe_ref_to_s(current_template_version)
end
def new_version
@new_version ||= fetch_remote_version(new_template_version)
end
def new_template_version
return options[:'template-ref'] if options[:'template-ref']
if template_uri.default? && PDK::Util::Git.tag?(template_uri.bare_uri, template_uri.uri_fragment) && PDK::Util.package_install?
PDK::Util::TemplateURI.default_template_ref
else
template_uri.uri_fragment
end
end
def pinned_to_puppetlabs_template_tag?
return false unless template_uri.puppetlabs_template?
return false unless PDK::Util::Git.tag?(template_uri.bare_uri, template_uri.uri_fragment)
return false if latest_template?
template_uri.uri_fragment == new_template_version
end
private
def latest_template?
[PDK::TEMPLATE_REF, 'master', 'main'].include?(template_uri.uri_fragment)
end
def current_template_version
@current_template_version ||= module_metadata.data['template-ref']
end
def describe_ref_to_s(describe_ref)
data = GIT_DESCRIBE_PATTERN.match(describe_ref)
return data if data.nil?
if %r{^(?:heads|remotes)/}.match?(data[:base])
"#{data[:base].gsub(%r{^(heads/|remotes/\w+?/)}, '')}@#{data[:sha]}"
else
data[:base]
end
end
def fetch_remote_version(template_ref)
return template_ref unless current_template_version.is_a?(String)
return template_ref if template_ref == PDK::TEMPLATE_REF
sha_length = GIT_DESCRIBE_PATTERN.match(current_template_version)[:sha].length - 1
"#{template_ref}@#{PDK::Util::Git.ls_remote(template_uri.bare_uri, template_ref)[0..sha_length]}"
end
def update_message
format_string = if template_uri.default?
'Updating %{module_name} using the default template, from %{current_version} to %{new_version}'
else
'Updating %{module_name} using the template at %{template_url}, from %{current_version} to %{new_version}'
end
format(format_string, module_name: module_metadata.data['name'], template_url: template_uri.bare_uri, current_version: current_version, new_version: new_version)
end
end
end
end