modulesync 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16cd854b2ba5a64f73b1051081fbf1e3bdbe39bbec2b7dacf5de3a3f37750625
-  data.tar.gz: d45c398dd5e7fc20d4bbf257ca0303bda0faa91ea49d3b6804d34fdbb25e1175
+  metadata.gz: 139a0b0b011d17ff31b014560eb02ce6a57e62f2e45ffaa06c9acf778240b047
+  data.tar.gz: f1696a42bcf9cf44719ea8f7c5f5580481672e9c3dd920463f77f2f72d54a82a
 SHA512:
-  metadata.gz: 38ae3613c9b28a0d679445350dcf6d625ad0db7156db8e26df7b4a4703a79713b471ce786d20d879a4bcdf8cd23830ac8277f259435f6fb191eede8a5a49ac9f
-  data.tar.gz: 62cacbdc9b002371957bc732727774c79d3b5783280469e3a2a34379265b784a8b6c0a6bccf1ce47ceb4bccea27cdb0273933b86381a37d57fd39e011b382d49
+  metadata.gz: 22bf21a62e3c6e3c8df65bed7b1356af3dc656ba85ae885338b0f35b501c1217c5159918d2c21fcbe3c92c52d14ab2f561b876004eabec99ecaa81521c875c88
+  data.tar.gz: 751fdcd7d6ee62611f90659e21eb94a103ac6473c98b6907342441675232e1c946dc69ed925dff5e1f708dd4e5f8dca68e039b38600d7c73c9f919dc837a9aee

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
     - 'tmp/**/*'
     - 'pkg/**/*'
     - 'lib/monkey_patches.rb'
+    - 'spec/**/*'
 
 Style/HashSyntax:
   Enabled: false

data/.travis.yml

@@ -6,10 +6,13 @@ dist: trusty
 script: 'bundle exec rake test'
 rvm:
   - 2.0
-  - 2.1.9
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
 notifications:
   email: false
 deploy:
@@ -18,7 +21,7 @@ deploy:
     secure: "Tbf1EbLEobIIox+fftJZADZsfQQ6kl0urcMNetK7NJzFo/negD/WyJIUj3kro/B7buyYADEjTui/JR4o8EPbugfM3ie5vYOd5k3AesSzbdr4BSwGe/cGbGOB7/PZuGfFLkb94/FiCU2mIwibkbh1rHWGlBoPj7ntL0+5ZtdvsM4="
   gem: modulesync
   on:
-    rvm: 2.4.0
+    rvm: 2.7
     tags: true
     all_branches: true
     repo: voxpupuli/modulesync

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2020-05-01 - 1.1.0
+
+This release provides metadata in the ERB template scope which makes it easy to read files from inside the module. A possible application is reading metadata.json and generating CI configs based on that.
+
+* Add metadata to ERB template scope - [#168](https://github.com/voxpupuli/modulesync/pull/168)
+* Skip issuing a PR if one already exists for -b option - [#171](https://github.com/voxpupuli/modulesync/pull/171)
+* Correct the type on the pr-labels option to prevent a deprecation warning - [#173](https://github.com/voxpupuli/modulesync/pull/173)
+
 ## 2019-09-19 - 1.0.0
 
 This is the first stable release! 🎉

data/Gemfile

@@ -3,4 +3,4 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 gemspec
 
 gem 'cucumber', '< 3.0' if RUBY_VERSION < '2.1'
-gem 'octokit', '~> 4.0'
+gem 'octokit', '~> 4.9'

data/README.md

@@ -389,6 +389,23 @@ As mentioned, files in the moduleroot directory must be ERB templates (they must
 <%= @configs[:puppet_module] %>
 ```
 
+Alternatively some meta data is passed to the template. This will allow you to add custom Ruby extensions inside the
+template, reading other files from the module, to make the template system more adaptive.
+
+```erb
+module: <%= @metadata[:module_name] %>
+target: <%= @metadata[:target_file] %>
+workdir: <%= @metadata[:workdir] %>
+```
+
+Will result in something like:
+
+```
+module: puppet-test
+target: modules/github-org/puppet-test/test
+workdir: modules/github-org/puppet-test
+```
+
 The Templates
 -------------
 

data/Rakefile

@@ -19,3 +19,4 @@ Cucumber::Rake::Task.new do |t|
 end
 
 task :test => %i[clean spec cucumber rubocop]
+task :default => %i[test]

data/features/update.feature

@@ -922,3 +922,36 @@ Feature: update
     When I run `msync update -m "Update Gemfile"`
     Then the exit status should be 0
     Then the output should contain "Using repository's default branch: develop"
+
+  Scenario: Adding a new file from a template using meta data
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      """
+    Given a file named "managed_modules.yml" with:
+      """
+      ---
+        - puppet-test
+      """
+    And a file named "modulesync.yml" with:
+      """
+      ---
+        namespace: maestrodev
+        git_base: https://github.com/
+      """
+    And a directory named "moduleroot"
+    And a file named "moduleroot/test.erb" with:
+      """
+      module: <%= @metadata[:module_name] %>
+      target: <%= @metadata[:target_file] %>
+      workdir: <%= @metadata[:workdir] %>
+      """
+    When I run `msync update --noop`
+    Then the exit status should be 0
+    Given I run `cat modules/maestrodev/puppet-test/test`
+    Then the output should contain:
+      """
+      module: puppet-test
+      target: modules/maestrodev/puppet-test/test
+      workdir: modules/maestrodev/puppet-test
+      """

data/lib/modulesync.rb

@@ -16,7 +16,7 @@ Octokit.configure do |c|
   c.api_endpoint = ENV.fetch('GITHUB_BASE_URL', 'https://api.github.com')
 end
 
-module ModuleSync
+module ModuleSync # rubocop:disable Metrics/ModuleLength
   include Constants
 
   def self.config_defaults
@@ -32,8 +32,8 @@ module ModuleSync
     File.join(config_path, MODULE_FILES_DIR, file)
   end
 
-  def self.module_file(project_root, namespace, puppet_module, file)
-    File.join(project_root, namespace, puppet_module, file)
+  def self.module_file(project_root, namespace, puppet_module, *parts)
+    File.join(project_root, namespace, puppet_module, *parts)
   end
 
   # List all template files.
@@ -46,7 +46,7 @@ module ModuleSync
           .collect { |p| p.chomp('.erb') }
           .to_a
     else
-      puts "#{local_template_dir} does not exist." \
+      $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
@@ -60,7 +60,7 @@ module ModuleSync
   def self.managed_modules(config_file, filter, negative_filter)
     managed_modules = Util.parse_config(config_file)
     if managed_modules.empty?
-      puts "No modules found in #{config_file}." \
+      $stdout.puts "No modules found in #{config_file}." \
         ' Check that you specified the right :configs directory and :managed_modules_conf file.'
       exit
     end
@@ -89,27 +89,29 @@ module ModuleSync
     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(module_file(options[:project_root], namespace, module_name, filename))
+      Renderer.remove(target_file)
     else
       templatename = local_file(options[:configs], filename)
       begin
         erb = Renderer.build(templatename)
-        template = Renderer.render(erb, configs)
-        Renderer.sync(template, module_file(options[:project_root], namespace, module_name, filename))
+        # 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}"
+        $stderr.puts "Error while rendering #{filename}"
         raise
       end
     end
   end
 
   def self.manage_module(puppet_module, module_files, module_options, defaults, options)
-    if options[:pr] && !GITHUB_TOKEN
-      STDERR.puts 'Environment variable GITHUB_TOKEN must be set to use --pr!'
-      raise unless options[:skip_broken]
-    end
-
     namespace, module_name = module_name(puppet_module, options[:namespace])
     git_repo = File.join(namespace, module_name)
     unless options[:offline]
@@ -125,7 +127,7 @@ module ModuleSync
                             :git_base => options[:git_base],
                             :namespace => namespace)
     settings.unmanaged_files(module_files).each do |filename|
-      puts "Not managing #{filename} in #{module_name}"
+      $stdout.puts "Not managing #{filename} in #{module_name}"
     end
 
     files_to_manage = settings.managed_files(module_files)
@@ -138,24 +140,39 @@ module ModuleSync
       pushed = Git.update(git_repo, files_to_manage, options)
       return nil unless pushed && options[:pr]
 
-      # We only do GitHub PR work if the GITHUB_TOKEN variable is set in the environment.
-      repo_path = File.join(namespace, module_name)
-      puts "Submitting PR '#{options[:pr_title]}' on GitHub to #{repo_path} - merges #{options[:branch]} into master"
-      github = Octokit::Client.new(:access_token => GITHUB_TOKEN)
-      pr = github.create_pull_request(repo_path, 'master', options[:branch], options[:pr_title], options[:message])
-      puts "PR created at #{pr['html_url']}"
+      manage_pr(namespace, module_name, options)
+    end
+  end
+
+  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
 
-      # 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 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)
 
-      # 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.
-      unless pr_labels.empty?
-        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
+    # 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
 
   def self.update(options)
@@ -176,10 +193,10 @@ module ModuleSync
       begin
         manage_module(puppet_module, module_files, module_options, defaults, options)
       rescue # rubocop:disable Lint/RescueWithoutErrorClass
-        STDERR.puts "Error while updating #{puppet_module}"
+        $stderr.puts "Error while updating #{puppet_module}"
         raise unless options[:skip_broken]
         errors = true
-        puts "Skipping #{puppet_module} as update process failed"
+        $stdout.puts "Skipping #{puppet_module} as update process failed"
       end
     end
     exit 1 if errors && options[:fail_on_warnings]

data/lib/modulesync/cli.rb

@@ -96,6 +96,7 @@ module ModuleSync
              :desc => 'Title of GitHub PR',
              :default => CLI.defaults[:pr_title] || 'Update to module template files'
       option :pr_labels,
+             :type => :array,
              :desc => 'Labels to add to the GitHub PR',
              :default => CLI.defaults[:pr_labels] || []
       option :offline,

data/lib/modulesync/renderer.rb

@@ -4,8 +4,9 @@ require 'find'
 module ModuleSync
   module Renderer
     class ForgeModuleFile
-      def initialize(configs = {})
+      def initialize(configs = {}, metadata = {})
         @configs = configs
+        @metadata = metadata
       end
     end
 
@@ -26,8 +27,8 @@ module ModuleSync
       File.delete(file) if File.exist?(file)
     end
 
-    def self.render(_template, configs = {})
-      ForgeModuleFile.new(configs).render
+    def self.render(_template, configs = {}, metadata = {})
+      ForgeModuleFile.new(configs, metadata).render
     end
 
     def self.sync(template, target_name)

data/modulesync.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'modulesync'
-  spec.version               = '1.0.0'
+  spec.version               = '1.1.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'aruba', '~> 0.14'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

data/spec/unit/modulesync_spec.rb

@@ -11,4 +11,59 @@ describe ModuleSync do
       ModuleSync.update(options)
     end
   end
+
+  context '::manage_pr' do
+    before(:each) do
+      stub_const('GITHUB_TOKEN', 'test')
+      @git_repo = 'test/modulesync'
+      @namespace, @repo_name = @git_repo.split('/')
+      @options = {
+        :pr => true,
+        :pr_title => 'Test PR is submitted',
+        :branch => 'test',
+        :message => 'Hello world',
+        :pr_auto_merge => false,
+      }
+
+      @client = double()
+    end
+
+    it 'rasies an error when GITHUB_TOKEN not set for PRs' do
+      stub_const('GITHUB_TOKEN', '')
+      options = {:pr => true, :skip_broken => false}
+
+      expect { ModuleSync.manage_pr(@namespace, @repo_name, options) }.to raise_error(RuntimeError).and output(/GITHUB_TOKEN/).to_stderr
+    end
+
+    it 'submits PR when --pr is set' do
+      allow(Octokit::Client).to receive(:new).and_return(@client)
+      allow(@client).to receive(:pull_requests).with(@git_repo, :state => 'open', :base => 'master', :head => "#{@namespace}:#{@options[:branch]}").and_return([])
+      expect(@client).to receive(:create_pull_request).with(@git_repo, 'master', @options[:branch], @options[:pr_title], @options[:message]).and_return({"html_url" => "http://example.com/pulls/22"})
+      expect { ModuleSync.manage_pr(@namespace, @repo_name, @options) }.to output(/Submitted PR/).to_stdout
+    end
+
+    it 'skips submitting PR if one has already been issued' do
+      allow(Octokit::Client).to receive(:new).and_return(@client)
+
+      pr = {
+        "title" => "Test title",
+        "html_url" => "https://example.com/pulls/44",
+        "number" => "44"
+      }
+
+      expect(@client).to receive(:pull_requests).with(@git_repo, :state => 'open', :base => 'master', :head => "#{@namespace}:#{@options[:branch]}").and_return([pr])
+      expect { ModuleSync.manage_pr(@namespace, @repo_name, @options) }.to output(/Skipped! 1 PRs found for branch test/).to_stdout
+    end
+
+    it 'adds labels to PR when --pr-labels is set' do
+      @options[:pr_labels] = "HELLO,WORLD"
+
+      allow(Octokit::Client).to receive(:new).and_return(@client)
+      allow(@client).to receive(:create_pull_request).and_return({"html_url" => "http://example.com/pulls/22", "number" => "44"})
+      allow(@client).to receive(:pull_requests).with(@git_repo, :state => 'open', :base => 'master', :head => "#{@namespace}:#{@options[:branch]}").and_return([])
+
+      expect(@client).to receive(:add_labels_to_an_issue).with(@git_repo, "44", ["HELLO", "WORLD"])
+      expect { ModuleSync.manage_pr(@namespace, @repo_name, @options) }.to output(/Attaching the following labels to PR 44: HELLO, WORLD/).to_stdout
+    end
+  end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2020-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer