modulesync 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fb5357d0ecf1e4f620be302b55c9f1e88779c446021097172866c87a1e57d8f
-  data.tar.gz: be3975ae4dbe2a4e6a32cc5851bc0e9ce8ac8dd0b9560175380f492e43dabe27
+  metadata.gz: 67b9f844d9a57ed46eb75c5a9848524dee4409b78c3c1c70576f1f1c9629d24a
+  data.tar.gz: db8bbd7ca58ef57bf981c1ca49c91655d757f49920e598085e67a5e42a78b7b2
 SHA512:
-  metadata.gz: 15051bcc97f904d9d886e67abf9e6ea99818410ec3f330f7d67ed9cc86451f322b79861801218f46b534a0f3241f3aa15dc16928360c471c0742e0b8f3c120f7
-  data.tar.gz: d527c5e7eeeccfabdbd5eb328759b826873aea33f12419179a89f84a1499af784788de9ca420eab8cbc5d2d83fdf1a9a8f6bbde1c536b25aca9c35b21c77c40b
+  metadata.gz: 31d69cbe6c58f263a1bb9ba0c418d310505708bf52554d6145af1a9c3dd1ebbd06c987771fcc01c2c87d4e874f4fd918f46ca789342d802069969b196d6e5422
+  data.tar.gz: 89e4f8f54ba515b855060306d562663c1d2b6eed8ccdabc51ecec3ad5d234f3043b546d6263c24cb8086447df5544193e2ab31d90ef181f6ccaf6e5888faf77a

data/.gitignore

@@ -8,3 +8,4 @@ bin/rspec
 modules/
 tmp/
 vendor/
+.vendor/

data/.rubocop.yml

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

data/.travis.yml

@@ -2,19 +2,20 @@
 sudo: false
 language: ruby
 cache: bundler
-dist: trusty
+dist: focal
 script: 'bundle exec rake test'
+bundler_args: --without release
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
   - 2.5
   - 2.6
   - 2.7
 notifications:
   email: false
+  irc:
+    on_success: always
+    on_failure: always
+    channels:
+      - "chat.freenode.org#voxpupuli-notifications"
 deploy:
   provider: rubygems
   api_key:

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 # Changelog
 
-## 2020-07-03 - 1.3.0
+All notable changes to this project will be documented in this file.
+
+## [2.0.0](https://github.com/voxpupuli/modulesync/tree/2.0.0) (2020-08-18)
+
+[Full Changelog](https://github.com/voxpupuli/modulesync/compare/1.3.0...2.0.0)
+
+**Breaking changes:**
+
+- Drop support for Ruby 2.4 and older [\#191](https://github.com/voxpupuli/modulesync/pull/191) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Symbolize keys in managed\_modules except for module names [\#185](https://github.com/voxpupuli/modulesync/pull/185) ([raphink](https://github.com/raphink))
+
+**Fixed bugs:**
+
+- GitLab MR: undefined method `\[\]' for nil:NilClass \(NoMethodError\) [\#187](https://github.com/voxpupuli/modulesync/issues/187)
+- msync fails with nilClass error [\#172](https://github.com/voxpupuli/modulesync/issues/172)
+- Fix NoMethodError for --pr option \(caused by `module_options = nil`\) / introduce --noop [\#188](https://github.com/voxpupuli/modulesync/pull/188) ([bittner](https://github.com/bittner))
+- Allow empty module options in self.pr\(\) [\#186](https://github.com/voxpupuli/modulesync/pull/186) ([raphink](https://github.com/raphink))
+
+## [1.3.0](https://github.com/voxpupuli/modulesync/tree/1.3.0) (2020-07-03)
 
 * Expose --managed_modules_conf [#184](https://github.com/voxpupuli/modulesync/pull/184)
 * Allow absolute path for config files [#183](https://github.com/voxpupuli/modulesync/pull/183)
@@ -227,3 +248,6 @@ Also fixes the README to document the very important -m flag.
 
 This release adds support for other SSH-based git servers, which means
 gitlab is now supported.
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -4,3 +4,7 @@ gemspec
 
 gem 'cucumber', '< 3.0' if RUBY_VERSION < '2.1'
 gem 'octokit', '~> 4.9'
+
+group :release do
+  gem 'github_changelog_generator', :require => false, :git => 'https://github.com/voxpupuli/github-changelog-generator', :branch => 'voxpupuli_essential_fixes'
+end

data/HISTORY.md

@@ -0,0 +1,227 @@
+## [1.3.0](https://github.com/voxpupuli/modulesync/tree/1.3.0) (2020-07-03)
+
+* Expose --managed_modules_conf [#184](https://github.com/voxpupuli/modulesync/pull/184)
+* Allow absolute path for config files [#183](https://github.com/voxpupuli/modulesync/pull/183)
+* Add pr_target_branch option [#182](https://github.com/voxpupuli/modulesync/pull/182)
+* Allow to specify namespace in module_options [#181](https://github.com/voxpupuli/modulesync/pull/181)
+* Allow to override PR parameters per module [#178](https://github.com/voxpupuli/modulesync/pull/178)
+* Include the gitlab library (if we interact with gitlab), not github [#179](https://github.com/voxpupuli/modulesync/pull/179)
+
+## 2020-07-03 - 1.2.0
+
+* Add support for GitLab merge requests (MRs) [#175](https://github.com/voxpupuli/modulesync/pull/175)
+
+## 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! 🎉
+
+* Use namespace in directory structure when cloning repositories - [#152](https://github.com/voxpupuli/modulesync/pull/152)
+* Fix minor typo in help output - [#165](https://github.com/voxpupuli/modulesync/pull/165)
+* Small improvements and fixes - [#166](https://github.com/voxpupuli/modulesync/pull/166)
+* Fix overwriting of :global values - [#169](https://github.com/voxpupuli/modulesync/pull/169)
+
+## 2018-12-27 - 0.10.0
+
+This is another awesome release!
+
+* Add support to submit PRs to GitHub when changes are pushed - [#147](https://github.com/voxpupuli/modulesync/pull/147)
+* Fix "flat files" still mentioned in README - [#151](https://github.com/voxpupuli/modulesync/pull/151)
+
+## 2018-02-15 - 0.9.0
+
+## Summary
+
+This is an awesome release - Now honors the repo default branch[#142](https://github.com/voxpupuli/modulesync/pull/142)
+
+### Bugfixes
+
+  * Monkey patch ls_files until ruby-git/ruby-git#320 is resolved
+  * Reraise exception rather than exit so we can rescue a derived StandardError when using skip_broken option
+
+### Enhancements
+
+  * Add new option to produce a failure exit code on warnings
+  * Remove hard coding of managed_modules.yml which means that options passed to ModuleSync.update can override the filename
+
+## 2017-11-03 - 0.8.2
+
+### Summary
+
+This release fixes:
+  * Bug that caused .gitignore file handle to be left open - [#131](https://github.com/voxpupuli/modulesync/pull/131).
+  * Fixed switch_branch to use current_branch instead of master - [#130](https://github.com/voxpupuli/modulesync/pull/130).
+  * Fixed bug where failed runs wouldn't return correct exit code - [#125](https://github.com/voxpupuli/modulesync/pull/125).
+  * Fix typo in README link to Voxpupuli modulesync_config [#123](https://github.com/voxpupuli/modulesync/pull/123).
+
+## 2017-05-08 - 0.8.1
+
+### Summary
+
+This release fixes a nasty bug with CLI vs configuration file option handling: Before [#117](https://github.com/voxpupuli/modulesync/pull/117) it was not possible to override options set in `modulesync.yml` on the command line, which could cause confusion in many cases. Now the configuration file is only used to populate the default values of the options specified in the README, and setting them on the command line will properly use those new values.
+
+## 2017-05-05 - 0.8.0
+
+### Summary
+
+This release now prefers `.erb` suffixes on template files. To convert your moduleroot directory, run this command in your configs repo:
+
+        find moduleroot/ -type f -exec git mv {} {}.erb \;
+
+Note that any `.erb`-suffixed configuration keys in `config_defaults.yml`, and `.sync.yml` need to be removed by hand. (This was unreleased functionality, will not affect most users.)
+
+#### Refactoring
+
+- Prefer `.erb` suffixes on template files, issue deprecation warning for templates without the extension
+- Require Ruby 2.0 or higher
+
+#### Bugfixes
+
+- Fix dependency on `git` gem for diff functionality
+- Fix error from `git` gem when diff contained line ending changes
+
+## 2017-02-13 - 0.7.2
+
+Fixes an issue releasing 0.7.1, no functional changes.
+
+## 2017-02-13 - 0.7.1
+
+Fixes an issue releasing 0.7.0, no functional changes.
+
+## 2017-02-13 - 0.7.0
+
+### Summary
+
+This is the first release from Vox Pupuli, which has taken over maintenance of
+modulesync.
+
+#### Features
+- New `msync update` arguments:
+    - `--git-base` to override `git_base`, e.g. for read-only git clones
+    - `-s` to skip the current module and continue on error
+    - `-x` for a negative filter (blacklist) of modules not to update
+- Add `-a` argument to `msync hook` to pass additional arguments
+- Add `:git_base` and `:namespace` data to `@configs` hash
+- Allow `managed_modules.yml` to list modules with a different namespace
+- Entire directories can be listed with `unmanaged: true`
+
+#### Refactoring
+- Replace CLI optionparser with thor
+
+#### Bugfixes
+- Fix git 1.8.0 compatibility, detecting when no files are changed
+- Fix `delete: true` feature, now deletes files correctly
+- Fix handling of `:global` config entries, not interpreted as a path
+- Fix push without force to remote branch when no files have changed (#102)
+- Output template name when ERB rendering fails
+- Remove extraneous whitespace in `--noop` output
+
+## 2015-08-13 - 0.6.1
+
+### Summary
+
+This is a bugfix release to fix an issue caused by the --project-root flag.
+
+#### Bugfixes
+
+- Fix bug in git pull function (#55)
+
+##2015-08-11 - 0.6.0
+
+### Summary
+
+This release adds two new flags to help modulesync better integrate with CI tools.
+
+#### Features
+
+- Add --project-root flag
+- Create --offline flag to disable git functionality
+
+#### Bugfixes
+
+- Fix :remote option for repo
+
+#### Maintenance
+
+- Added tests
+
+## 2015-06-30 - 0.5.0
+
+### Summary
+
+This release adds the ability to sync a non-bare local git repo.
+
+#### Features
+
+- Allow one to sync non-bare local git repository
+
+## 2015-06-24 - 0.4.0
+
+### Summary
+
+This release adds a --remote-branch flag and adds a global key for template
+config.
+
+#### Features
+
+- Expose --remote-branch
+- Add a global config key
+
+#### Bugfixes
+
+- Fix markdown syntax in README
+
+## 2015-03-12 - 0.3.0
+
+### Summary
+
+This release contains a breaking change to some parameters exposed in
+modulesync.yml. In particular, it abandons the user of git_user and
+git_provider in favor of the parameter git_base to specify the base part of a
+git URL to pull from. It also adds support for gerrit by adding a remote_branch
+parameter for modulesync.yml that can differ from the local branch, plus a
+number of new flags for updating modules.
+
+#### Backwards-incompatible changes
+
+- Remove git_user and git_provider_address as parameters in favor of using
+  git_base as a whole
+
+#### Features
+
+- Expose the puppet module name in the ERB templates
+- Add support for gerrit by:
+  - Adding a --amend flag
+  - Adding a remote_branch parameter for modulesync.yml config file that can
+    differ from the local branch
+  - Adding a script to handle the pre-commit hook for adding a commit id
+  - Using git_base to specify an arbitrary git URL instead of an SCP-style one
+- Add a --force flag (usually needed with the --amend flag if not using gerrit)
+- Add --bump, --tag, --tag-pattern, and --changelog flags
+
+#### Bugfixes
+
+- Stop requiring .gitignore to exist
+- Fix non-master branch functionality
+- Add workarounds for older git versions
+
+## 2014-11-16 - 0.2.0
+
+### Summary
+
+This release adds the --filter flag to filter what modules to sync.
+Also fixes the README to document the very important -m flag.
+
+## 2014-9-29 - 0.1.0
+
+### Summary
+
+This release adds support for other SSH-based git servers, which means
+gitlab is now supported.

data/README.md

@@ -197,14 +197,14 @@ For GitHub Enterprise and self-hosted GitLab instances you also need to set the
 ```yaml
 ---
 repo1:
-  :github:
-    :token: 'EXAMPLE_TOKEN'
-    :base_url: 'https://api.github.com/'
+  github:
+    token: 'EXAMPLE_TOKEN'
+    base_url: 'https://api.github.com/'
 
 repo2:
-  :gitlab:
-    :token: 'EXAMPLE_TOKEN'
-    :base_url: 'https://git.example.com/api/v4'
+  gitlab:
+    token: 'EXAMPLE_TOKEN'
+    base_url: 'https://git.example.com/api/v4'
 ```
 
 Then:

data/Rakefile

@@ -20,3 +20,27 @@ end
 
 task :test => %i[clean spec cucumber rubocop]
 task :default => %i[test]
+
+begin
+  require 'github_changelog_generator/task'
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix modulesync skip-changelog]
+    config.user = 'voxpupuli'
+    config.project = 'modulesync'
+    config.future_release = Gem::Specification.load("#{config.project}.gemspec").version
+  end
+
+  # Workaround for https://github.com/github-changelog-generator/github-changelog-generator/issues/715
+  require 'rbconfig'
+  if RbConfig::CONFIG['host_os'] =~ /linux/
+    task :changelog do
+      puts 'Fixing line endings...'
+      changelog_file = File.join(__dir__, 'CHANGELOG.md')
+      changelog_txt = File.read(changelog_file)
+      new_contents = changelog_txt.gsub(/\r\n/, "\n")
+      File.open(changelog_file, 'w') { |file| file.puts new_contents }
+    end
+  end
+rescue LoadError
+end

data/features/update.feature

@@ -905,6 +905,28 @@ Feature: update
     Then the output should not contain "error"
     Then the output should not contain "rejected"
 
+  Scenario: Creating a GitHub PR with an update
+    Given a mocked git configuration
+    And a remote module repository
+    And a directory named "moduleroot"
+    And I set the environment variables to:
+      | variable     | value  |
+      | GITHUB_TOKEN | foobar |
+    When I run `msync update --noop --branch managed_update --pr`
+    Then the output should contain "Would submit PR "
+    And the exit status should be 0
+
+  Scenario: Creating a GitLab MR with an update
+    Given a mocked git configuration
+    And a remote module repository
+    And a directory named "moduleroot"
+    And I set the environment variables to:
+      | variable     | value  |
+      | GITLAB_TOKEN | foobar |
+    When I run `msync update --noop --branch managed_update --pr`
+    Then the output should contain "Would submit MR "
+    And the exit status should be 0
+
   Scenario: Repository with a default branch other than master
     Given a mocked git configuration
     And a remote module repository with "develop" as the default branch

data/lib/modulesync.rb

@@ -132,6 +132,7 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
 
     if options[:noop]
       Git.update_noop(git_repo, options)
+      options[:pr] && pr(module_options).manage(namespace, module_name, options)
     elsif !options[:offline]
       pushed = Git.update(git_repo, files_to_manage, options)
       pushed && options[:pr] && pr(module_options).manage(namespace, module_name, options)
@@ -171,7 +172,8 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
     # 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)
+        mod_options = module_options.nil? ? nil : Util.symbolize_keys(module_options)
+        manage_module(puppet_module, module_files, mod_options, defaults, options)
       rescue # rubocop:disable Lint/RescueWithoutErrorClass
         $stderr.puts "Error while updating #{puppet_module}"
         raise unless options[:skip_broken]
@@ -183,6 +185,7 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
   end
 
   def self.pr(module_options)
+    module_options ||= {}
     github_conf = module_options[:github]
     gitlab_conf = module_options[:gitlab]
 

data/lib/modulesync/pr/github.rb

@@ -18,23 +18,32 @@ module ModuleSync
         head = "#{namespace}:#{options[:branch]}"
         target_branch = options[:pr_target_branch] || 'master'
 
-        pull_requests = @api.pull_requests(repo_path, :state => 'open', :base => target_branch, :head => head)
-        if pull_requests.empty?
-          pr = @api.create_pull_request(repo_path,
-                                        target_branch,
-                                        options[:branch],
-                                        options[:pr_title],
-                                        options[:message])
+        if options[:noop]
           $stdout.puts \
-            "Submitted PR '#{options[:pr_title]}' to #{repo_path} - merges #{options[:branch]} into #{target_branch}"
-        else
+            "Using no-op. Would submit PR '#{options[:pr_title]}' to #{repo_path} " \
+            "- merges #{options[:branch]} into #{target_branch}"
+          return
+        end
+
+        pull_requests = @api.pull_requests(repo_path,
+                                           :state => 'open',
+                                           :base => target_branch,
+                                           :head => head)
+        unless pull_requests.empty?
           # Skip creating the PR if it exists already.
           $stdout.puts "Skipped! #{pull_requests.length} PRs found for branch #{options[:branch]}"
+          return
         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 = ModuleSync::Util.parse_list(options[:pr_labels])
+        pr = @api.create_pull_request(repo_path,
+                                      target_branch,
+                                      options[:branch],
+                                      options[:pr_title],
+                                      options[:message])
+        $stdout.puts \
+          "Submitted PR '#{options[:pr_title]}' to #{repo_path} " \
+          "- merges #{options[:branch]} into #{target_branch}"
 
         # 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.

data/lib/modulesync/pr/gitlab.rb

@@ -15,27 +15,38 @@ module ModuleSync
 
       def manage(namespace, module_name, options)
         repo_path = File.join(namespace, module_name)
-
         head = "#{namespace}:#{options[:branch]}"
         target_branch = options[:pr_target_branch] || 'master'
+
+        if options[:noop]
+          $stdout.puts \
+            "Using no-op. Would submit MR '#{options[:pr_title]}' to #{repo_path} " \
+            "- merges #{options[:branch]} into #{target_branch}"
+          return
+        end
+
         merge_requests = @api.merge_requests(repo_path,
                                              :state => 'opened',
                                              :source_branch => head,
                                              :target_branch => target_branch)
-        if merge_requests.empty?
-          mr_labels = ModuleSync::Util.parse_list(options[:pr_labels])
-          mr = @api.create_merge_request(repo_path, options[:pr_title],
-                                         :source_branch => options[:branch],
-                                         :target_branch => target_branch,
-                                         :labels => mr_labels)
-          $stdout.puts \
-            "Submitted MR '#{options[:pr_title]}' to #{repo_path} - merges #{options[:branch]} into #{target_branch}"
-          return if mr_labels.empty?
-          $stdout.puts "Attached the following labels to MR #{mr.iid}: #{mr_labels.join(', ')}"
-        else
+        unless merge_requests.empty?
           # Skip creating the MR if it exists already.
           $stdout.puts "Skipped! #{merge_requests.length} MRs found for branch #{options[:branch]}"
+          return
         end
+
+        mr_labels = ModuleSync::Util.parse_list(options[:pr_labels])
+        mr = @api.create_merge_request(repo_path,
+                                       options[:pr_title],
+                                       :source_branch => options[:branch],
+                                       :target_branch => target_branch,
+                                       :labels => mr_labels)
+        $stdout.puts \
+          "Submitted MR '#{options[:pr_title]}' to #{repo_path} " \
+          "- merges #{options[:branch]} into #{target_branch}"
+
+        return if mr_labels.empty?
+        $stdout.puts "Attached the following labels to MR #{mr.iid}: #{mr_labels.join(', ')}"
       end
     end
   end

data/lib/modulesync/util.rb

@@ -3,7 +3,10 @@ require 'yaml'
 module ModuleSync
   module Util
     def self.symbolize_keys(hash)
-      hash.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo }
+      hash.inject({}) do |memo, (k, v)|
+        memo[k.to_sym] = v.is_a?(Hash) ? symbolize_keys(v) : v
+        memo
+      end
     end
 
     def self.parse_config(config_file)

data/modulesync.gemspec

@@ -3,14 +3,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'modulesync'
-  spec.version               = '1.3.0'
+  spec.version               = '2.0.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'
   spec.description           = 'Utility to synchronize common files across puppet modules in Github.'
   spec.homepage              = 'http://github.com/voxpupuli/modulesync'
   spec.license               = 'Apache-2.0'
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -165,6 +165,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
@@ -204,14 +205,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer