Module: ModuleSync

Includes:
Constants
Defined in:
lib/modulesync.rb,
lib/modulesync/cli.rb,
lib/modulesync/git.rb,
lib/modulesync/hook.rb,
lib/modulesync/util.rb,
lib/modulesync/renderer.rb,
lib/modulesync/settings.rb,
lib/modulesync/constants.rb

Overview

rubocop:disable Metrics/ModuleLength

Defined Under Namespace

Modules: Constants, Git, Renderer, Util Classes: CLI, Hook, Settings

Constant Summary

Constants included from Constants

Constants::CONF_FILE, Constants::GLOBAL_DEFAULTS_KEY, Constants::HOOK_FILE, Constants::MODULESYNC_CONF_FILE, Constants::MODULE_CONF_FILE, Constants::MODULE_FILES_DIR

Class Method Summary collapse

Class Method Details

.config_defaults ⇒ Object 



22
23
24
25
26
27
28
29
 
# File 'lib/modulesync.rb', line 22

def self.config_defaults
  {
    :project_root         => 'modules/',
    :managed_modules_conf => 'managed_modules.yml',
    :configs              => '.',
    :tag_pattern          => '%s'
  }
end

.find_template_files(local_template_dir) ⇒ Object

List all template files.

Only select *.erb files, and strip the extension. This way all the code will only have to handle bare paths, except when reading the actual ERB text



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/modulesync.rb', line 43

def self.find_template_files(local_template_dir)
  if File.exist?(local_template_dir)
    Find.find(local_template_dir).find_all { |p| p =~ /.erb$/ && !File.directory?(p) }
        .collect { |p| p.chomp('.erb') }
        .to_a
  else
    $stdout.puts "#{local_template_dir} does not exist." \
      ' Check that you are working in your module configs directory or' \
      ' that you have passed in the correct directory with -c.'
    exit
  end
end

.hook(options) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/modulesync.rb', line 77

def self.hook(options)
  hook = Hook.new(HOOK_FILE, options)

  case options[:hook]
  when 'activate'
    hook.activate
  when 'deactivate'
    hook.deactivate
  end
end

.local_file(config_path, file) ⇒ Object 



31
32
33
 
# File 'lib/modulesync.rb', line 31

def self.local_file(config_path, file)
  File.join(config_path, MODULE_FILES_DIR, file)
end

.manage_file(filename, settings, options) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/modulesync.rb', line 88

def self.manage_file(filename, settings, options)
  namespace = settings.additional_settings[:namespace]
  module_name = settings.additional_settings[:puppet_module]
  configs = settings.build_file_configs(filename)
  target_file = module_file(options[:project_root], namespace, module_name, filename)
  if configs['delete']
    Renderer.remove(target_file)
  else
    templatename = local_file(options[:configs], filename)
    begin
      erb = Renderer.build(templatename)
      # Meta data passed to the template as @metadata[:name]
      metadata = {
        :module_name => module_name,
        :workdir     => module_file(options[:project_root], namespace, module_name),
        :target_file => target_file,
      }
      template = Renderer.render(erb, configs, metadata)
      Renderer.sync(template, target_file)
    rescue # rubocop:disable Lint/RescueWithoutErrorClass
      $stderr.puts "Error while rendering #{filename}"
      raise
    end
  end
end

.manage_module(puppet_module, module_files, module_options, defaults, options) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/modulesync.rb', line 114

def self.manage_module(puppet_module, module_files, module_options, defaults, options)
  namespace, module_name = module_name(puppet_module, options[:namespace])
  git_repo = File.join(namespace, module_name)
  unless options[:offline]
    Git.pull(options[:git_base], git_repo, options[:branch], options[:project_root], module_options || {})
  end

  module_configs = Util.parse_config(module_file(options[:project_root], namespace, module_name, MODULE_CONF_FILE))
  settings = Settings.new(defaults[GLOBAL_DEFAULTS_KEY] || {},
                          defaults,
                          module_configs[GLOBAL_DEFAULTS_KEY] || {},
                          module_configs,
                          :puppet_module => module_name,
                          :git_base => options[:git_base],
                          :namespace => namespace)
  settings.unmanaged_files(module_files).each do |filename|
    $stdout.puts "Not managing #{filename} in #{module_name}"
  end

  files_to_manage = settings.managed_files(module_files)
  files_to_manage.each { |filename| manage_file(filename, settings, options) }

  if options[:noop]
    Git.update_noop(git_repo, options)
  elsif !options[:offline]
    # Git.update() returns a boolean: true if files were pushed, false if not.
    pushed = Git.update(git_repo, files_to_manage, options)
    return nil unless pushed && options[:pr]

    manage_pr(namespace, module_name, options)
  end
end

.manage_pr(namespace, module_name, options) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/modulesync.rb', line 147

def self.manage_pr(namespace, module_name, options)
  if options[:pr] && GITHUB_TOKEN.empty?
    $stderr.puts 'Environment variable GITHUB_TOKEN must be set to use --pr!'
    raise unless options[:skip_broken]
  end

  # We only do GitHub PR work if the GITHUB_TOKEN variable is set in the environment.
  repo_path = File.join(namespace, module_name)
  github = Octokit::Client.new(:access_token => GITHUB_TOKEN)

  # Skip creating the PR if it exists already.
  head = "#{namespace}:#{options[:branch]}"
  pull_requests = github.pull_requests(repo_path, :state => 'open', :base => 'master', :head => head)
  if pull_requests.empty?
    pr = github.create_pull_request(repo_path, 'master', options[:branch], options[:pr_title], options[:message])
    $stdout.puts "Submitted PR '#{options[:pr_title]}' to #{repo_path} - merges #{options[:branch]} into master"
  else
    $stdout.puts "Skipped! #{pull_requests.length} PRs found for branch #{options[:branch]}"
  end

  # PR labels can either be a list in the YAML file or they can pass in a comma
  # separated list via the command line argument.
  pr_labels = Util.parse_list(options[:pr_labels])

  # We only assign labels to the PR if we've discovered a list > 1. The labels MUST
  # already exist. We DO NOT create missing labels.
  return if pr_labels.empty?
  $stdout.puts "Attaching the following labels to PR #{pr['number']}: #{pr_labels.join(', ')}"
  github.add_labels_to_an_issue(repo_path, pr['number'], pr_labels)
end

.managed_modules(config_file, filter, negative_filter) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/modulesync.rb', line 60

def self.managed_modules(config_file, filter, negative_filter)
  managed_modules = Util.parse_config(config_file)
  if managed_modules.empty?
    $stdout.puts "No modules found in #{config_file}." \
      ' Check that you specified the right :configs directory and :managed_modules_conf file.'
    exit
  end
  managed_modules.select! { |m| m =~ Regexp.new(filter) } unless filter.nil?
  managed_modules.reject! { |m| m =~ Regexp.new(negative_filter) } unless negative_filter.nil?
  managed_modules
end

.module_file(project_root, namespace, puppet_module, *parts) ⇒ Object 



35
36
37
 
# File 'lib/modulesync.rb', line 35

def self.module_file(project_root, namespace, puppet_module, *parts)
  File.join(project_root, namespace, puppet_module, *parts)
end

.module_name(module_name, default_namespace) ⇒ Object 



72
73
74
75
 
# File 'lib/modulesync.rb', line 72

def self.module_name(module_name, default_namespace)
  return [default_namespace, module_name] unless module_name.include?('/')
  ns, mod = module_name.split('/')
end

.relative_names(file_list, path) ⇒ Object 



56
57
58
 
# File 'lib/modulesync.rb', line 56

def self.relative_names(file_list, path)
  file_list.map { |file| file.sub(/#{path}/, '') }
end

.update(options) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/modulesync.rb', line 178

def self.update(options)
  options = config_defaults.merge(options)
  defaults = Util.parse_config(File.join(options[:configs], CONF_FILE))

  local_template_dir = File.join(options[:configs], MODULE_FILES_DIR)
  local_files = find_template_files(local_template_dir)
  module_files = relative_names(local_files, local_template_dir)

  managed_modules = self.managed_modules(File.join(options[:configs], options[:managed_modules_conf]),
                                         options[:filter],
                                         options[:negative_filter])

  errors = false
  # managed_modules is either an array or a hash
  managed_modules.each do |puppet_module, module_options|
    begin
      manage_module(puppet_module, module_files, module_options, defaults, options)
    rescue # rubocop:disable Lint/RescueWithoutErrorClass
      $stderr.puts "Error while updating #{puppet_module}"
      raise unless options[:skip_broken]
      errors = true
      $stdout.puts "Skipping #{puppet_module} as update process failed"
    end
  end
  exit 1 if errors && options[:fail_on_warnings]
end