modulesync 0.9.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aba3647204bfcc8853cafeddbf1e4f1083ceaade7fb1806bd06b36e37d6d593e
-  data.tar.gz: ce4305980ed768ffd80580c4618c7d921e0c7c6e17b57edc3dae0c10eacbeef6
+  metadata.gz: 7fb5357d0ecf1e4f620be302b55c9f1e88779c446021097172866c87a1e57d8f
+  data.tar.gz: be3975ae4dbe2a4e6a32cc5851bc0e9ce8ac8dd0b9560175380f492e43dabe27
 SHA512:
-  metadata.gz: 0cfda65f2a020913fa4cd928e22daac9e5c141f7881afaed928b28af846fe86466fff64314e89b04b9d3cb32bf8e4387ec0410e7142215ac5e0412b15c845d62
-  data.tar.gz: 083fdbb949ce978be0958f3ac2baa8390d38d7221c846b934b5b2e3e49cc60992d662b0afd8322d4efeb3bbec9643faf73b7cba95ba3f91d388953365837494a
+  metadata.gz: 15051bcc97f904d9d886e67abf9e6ea99818410ec3f330f7d67ed9cc86451f322b79861801218f46b534a0f3241f3aa15dc16928360c471c0742e0b8f3c120f7
+  data.tar.gz: d527c5e7eeeccfabdbd5eb328759b826873aea33f12419179a89f84a1499af784788de9ca420eab8cbc5d2d83fdf1a9a8f6bbde1c536b25aca9c35b21c77c40b

data/.gitignore

@@ -1,5 +1,10 @@
-tmp/
-modules/
 *.gem
-Gemfile.lock
 .bundle/
+.ruby-version
+.vscode/
+Gemfile.lock
+bin/bundle
+bin/rspec
+modules/
+tmp/
+vendor/

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
     - 'tmp/**/*'
     - 'pkg/**/*'
     - 'lib/monkey_patches.rb'
+    - 'spec/**/*'
 
 Style/HashSyntax:
   Enabled: false
@@ -18,3 +19,7 @@ Style/TrailingCommaInLiteral:
 # would require external library
 Layout/IndentHeredoc:
   Enabled: false
+
+# sane line length
+Metrics/LineLength:
+  Max: 120

data/.rubocop_todo.yml

@@ -19,17 +19,12 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 105
+  Max: 107
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:
   Max: 13
 
-# Offense count: 29
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 319
-
 # Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/MethodLength:

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,6 +1,43 @@
 # Changelog
 
-## 2018-02-15
+## 2020-07-03 - 1.3.0
+
+* 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
 

data/Gemfile

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

data/README.md

@@ -176,6 +176,51 @@ touching the modules, you can deactivate the hook.
 msync hook deactivate
 ```
 
+#### Submitting PRs/MRs to GitHub or GitLab
+
+You can have modulesync submit Pull Requests on GitHub or Merge Requests on
+GitLab automatically with the `--pr` CLI option.
+
+```
+msync update --pr
+```
+
+In order for GitHub PRs or GitLab MRs to work, you must either provide
+the `GITHUB_TOKEN` or `GITLAB_TOKEN` environment variables,
+or set them per repository in `managed_modules.yml`, using the `github` or
+`gitlab` keys respectively.
+
+For GitHub Enterprise and self-hosted GitLab instances you also need to set the
+`GITHUB_BASE_URL` or `GITLAB_BASE_URL` environment variables, or use the
+`base_url` parameter in `managed_modules.yml`:
+
+```yaml
+---
+repo1:
+  :github:
+    :token: 'EXAMPLE_TOKEN'
+    :base_url: 'https://api.github.com/'
+
+repo2:
+  :gitlab:
+    :token: 'EXAMPLE_TOKEN'
+    :base_url: 'https://git.example.com/api/v4'
+```
+
+Then:
+
+* Set the PR/MR title with `--pr-title` or in `modulesync.yml` with the
+  `pr_title` attribute.
+* Assign labels to the PR/MR with `--pr-labels` or in `modulesync.yml` with
+  the `pr_labels` attribute. **NOTE:** `pr_labels` should be a list. When
+  using the `--pr-labels` CLI option, you should use a comma separated list.
+* Set the target branch with `--pr_target_branch` or in `modulesync.yml` with
+  the `pr_target_branch` attribute.
+
+More details for GitHub:
+
+* Octokit [`api_endpoint`](https://github.com/octokit/octokit.rb#interacting-with-the-githubcom-apis-in-github-enterprise)
+
 ### Using Forks and Non-master branches
 
 The default functionality is to run ModuleSync on the puppetlabs modules, but
@@ -215,7 +260,7 @@ probably seems excessive. You can create a file called modulesync.yml in the
 configuration directory that provides these arguments automatically. This file
 has a form such as:
 
-```
+```yaml
 ---
 namespace: mygithubusername
 branch: modulesyncbranch
@@ -230,26 +275,35 @@ msync update -m "Commit message"
 
 Available parameters for modulesync.yml
 
-* git_base : The default URL to git clone from (Default: 'git@github.com:')
-* namespace : Namespace of the projects to manage (Default: 'puppetlabs')
-* branch : Branch to push to (Default: 'master')
-* remote_branch : Remote branch to push to (Default: Same value as branch)
-* message : Commit message to apply to updated modules.
-* pre_commit_script : A script to be run before commiting (e.g. 'contrib/myfooscript.sh')
+* `git_base` : The default URL to git clone from (Default: 'git@github.com:')
+* `namespace` : Namespace of the projects to manage (Default: 'puppetlabs').
+  This value can be overridden in the module name (e.g. 'namespace/mod') or by
+  using the `namespace` key for the module in `managed_modules.yml`.
+* `branch` : Branch to push to (Default: 'master')
+* `remote_branch` : Remote branch to push to (Default: Same value as branch)
+* `message` : Commit message to apply to updated modules.
+* `pre_commit_script` : A script to be run before commiting (e.g. 'contrib/myfooscript.sh')
+* `pr_title` : The title to use when submitting PRs/MRs to GitHub or GitLab.
+* `pr_labels` : A list of labels to assign PRs/MRs created on GitHub or GitLab.
 
 ##### Example
 
-###### Github
+###### GitHub
 
-```
+```yaml
 ---
 namespace: MySuperOrganization
 branch: modulesyncbranch
+pr_title: "Updates to module template files via modulesync"
+pr_labels:
+  - TOOLING
+  - MAINTENANCE
+  - MODULESYNC
 ```
 
-###### Gitlab
+###### GitLab
 
-```
+```yaml
 ---
 git_base: 'user@gitlab.example.com:'
 namespace: MySuperOrganization
@@ -258,7 +312,7 @@ branch: modulesyncbranch
 
 ###### Gerrit
 
-```
+```yaml
 ---
 namespace: stackforge
 git_base:  ssh://jdoe@review.openstack.org:29418/
@@ -350,16 +404,33 @@ current date, bumped (minor) version, and commit message.
 If `CHANGELOG.md` is absent in the repository, nothing will happen.
 
 
-#### Defining templates
+#### Working with templates
 
-As commented, files within moduleroot directory can be flat files or ERB templates. These files have direct access to @configs hash, which gets values from config_defaults.yml file and from the module being processed:
+As mentioned, files in the moduleroot directory must be ERB templates (they must have an .erb extension, or they will be ignored). These files have direct access to @configs hash, which gets values from config_defaults.yml file and from the module being processed:
 
-```
+```erb
 <%= @configs[:git_base] %>
 <%= @configs[:namespace] %>
 <%= @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/step_definitions/git_steps.rb

@@ -23,7 +23,7 @@ Given 'a remote module repository' do
   CONFIG
 end
 
-Given /a remote module repository with "(.+?)" as the default branch/ do |branch| # rubocop:disable Lint/AmbiguousRegexpLiteral
+Given Regexp.new(/a remote module repository with "(.+?)" as the default branch/) do |branch|
   steps %(
     Given a directory named "sources"
     And I run `git clone --mirror https://github.com/maestrodev/puppet-test sources/puppet-test`

data/features/update.feature

@@ -31,7 +31,7 @@ Feature: update
       Files added:
       test
       """
-    Given I run `cat modules/puppet-test/test`
+    Given I run `cat modules/maestrodev/puppet-test/test`
     Then the output should contain "aruba"
 
   Scenario: Using skip_broken option and adding a new file to repo without write access
@@ -113,14 +113,14 @@ Feature: update
     Then the exit status should be 0
     And the output should match:
       """
-      Warning: using './moduleroot//test' as template without '.erb' suffix
+      Warning: using './moduleroot/test' as template without '.erb' suffix
       """
     And the output should match:
       """
       Files added:
       test
       """
-    Given I run `cat modules/puppet-test/test`
+    Given I run `cat modules/maestrodev/puppet-test/test`
     Then the output should contain "aruba"
 
   Scenario: Adding a new file using global values
@@ -153,7 +153,7 @@ Feature: update
       Files added:
       test
       """
-    Given I run `cat modules/puppet-test/test`
+    Given I run `cat modules/maestrodev/puppet-test/test`
     Then the output should contain "aruba"
 
   Scenario: Adding a new file overriding global values
@@ -189,7 +189,7 @@ Feature: update
       Files added:
       test
       """
-    Given I run `cat modules/puppet-test/test`
+    Given I run `cat modules/maestrodev/puppet-test/test`
     Then the output should contain "aruba"
 
   Scenario: Adding a new file ignoring global values
@@ -225,7 +225,7 @@ Feature: update
       Files added:
       test
       """
-    Given I run `cat modules/puppet-test/test`
+    Given I run `cat modules/maestrodev/puppet-test/test`
     Then the output should contain "aruba"
 
   Scenario: Adding a file that ERB can't parse
@@ -342,7 +342,7 @@ Feature: update
       Files changed:
       +diff --git a/Gemfile b/Gemfile
       """
-    Given I run `cat modules/puppet-test/Gemfile`
+    Given I run `cat modules/maestrodev/puppet-test/Gemfile`
     Then the output should contain:
       """
       source 'https://somehost.com'
@@ -405,7 +405,7 @@ Feature: update
       Not managing Gemfile in puppet-test
       """
     And the exit status should be 0
-    Given I run `cat modules/puppet-test/Gemfile`
+    Given I run `cat modules/maestrodev/puppet-test/Gemfile`
     Then the output should contain:
       """
       source 'https://rubygems.org'
@@ -488,8 +488,8 @@ Feature: update
       """
       some spec_helper fud
       """
-    And a directory named "modules/puppetlabs-apache/spec"
-    And a file named "modules/puppetlabs-apache/spec/spec_helper.rb" with:
+    And a directory named "modules/puppetlabs/puppetlabs-apache/spec"
+    And a file named "modules/puppetlabs/puppetlabs-apache/spec/spec_helper.rb" with:
       """
       This is a fake spec_helper!
       """
@@ -499,7 +499,7 @@ Feature: update
       Not managing spec/spec_helper.rb in puppetlabs-apache
       """
     And the exit status should be 0
-    Given I run `cat modules/puppetlabs-apache/spec/spec_helper.rb`
+    Given I run `cat modules/puppetlabs/puppetlabs-apache/spec/spec_helper.rb`
     Then the output should contain:
       """
       This is a fake spec_helper!
@@ -538,7 +538,7 @@ Feature: update
       Files added:
       spec/spec_helper.rb
       """
-    Given I run `cat modules/puppet-test/spec/spec_helper.rb`
+    Given I run `cat modules/maestrodev/puppet-test/spec/spec_helper.rb`
     Then the output should contain:
       """
       require 'puppetlabs_spec_helper/module_helper'
@@ -577,7 +577,7 @@ Feature: update
     Given a file named "managed_modules.yml" with:
       """
       ---
-        - puppet-test
+        - maestrodev/puppet-test
       """
     And a file named "modulesync.yml" with:
       """
@@ -597,8 +597,8 @@ Feature: update
         require '<%= required %>'
       <% end %>
       """
-    Given I run `git init modules/puppet-test`
-    Given a file named "modules/puppet-test/.git/config" with:
+    Given I run `git init modules/maestrodev/puppet-test`
+    Given a file named "modules/maestrodev/puppet-test/.git/config" with:
       """
       [core]
           repositoryformatversion = 0
@@ -667,7 +667,7 @@ Feature: update
       Files added:
       test
       """
-    Given I run `cat modules/puppet-test/test`
+    Given I run `cat modules/maestrodev/puppet-test/test`
     Then the output should contain "aruba"
 
   Scenario: When specifying configurations in managed_modules.yml and using a filter
@@ -702,9 +702,9 @@ Feature: update
       Files added:
       test
       """
-    Given I run `cat modules/puppet-test/test`
+    Given I run `cat modules/maestrodev/puppet-test/test`
     Then the output should contain "aruba"
-    And a directory named "modules/puppet-blacksmith" should not exist
+    And a directory named "modules/maestrodev/puppet-blacksmith" should not exist
 
   Scenario: When specifying configurations in managed_modules.yml and using a negative filter
     Given a file named "managed_modules.yml" with:
@@ -738,15 +738,15 @@ Feature: update
       Files added:
       test
       """
-    Given I run `cat modules/puppet-test/test`
+    Given I run `cat modules/maestrodev/puppet-test/test`
     Then the output should contain "aruba"
-    And a directory named "modules/puppet-blacksmith" should not exist
+    And a directory named "modules/maestrodev/puppet-blacksmith" should not exist
 
   Scenario: Updating a module with a .sync.yml file
     Given a file named "managed_modules.yml" with:
       """
       ---
-        - puppet-test
+        - maestrodev/puppet-test
       """
     And a file named "modulesync.yml" with:
       """
@@ -756,6 +756,9 @@ Feature: update
     And a file named "config_defaults.yml" with:
       """
       ---
+      :global:
+        global-default: some-default
+        global-to-overwrite: to-be-overwritten
       spec/spec_helper.rb:
         require:
           - puppetlabs_spec_helper/module_helper
@@ -766,8 +769,14 @@ Feature: update
         require '<%= required %>'
       <% end %>
       """
-    Given I run `git init modules/puppet-test`
-    Given a file named "modules/puppet-test/.git/config" with:
+    And a file named "moduleroot/global-test.md.erb" with:
+      """
+      <%= @configs['global-default'] %>
+      <%= @configs['global-to-overwrite'] %>
+      <%= @configs['module-default'] %>
+      """
+    Given I run `git init modules/maestrodev/puppet-test`
+    Given a file named "modules/maestrodev/puppet-test/.git/config" with:
       """
       [core]
           repositoryformatversion = 0
@@ -780,9 +789,12 @@ Feature: update
           url = https://github.com/maestrodev/puppet-test.git
           fetch = +refs/heads/*:refs/remotes/origin/*
       """
-    Given a file named "modules/puppet-test/.sync.yml" with:
+    Given a file named "modules/maestrodev/puppet-test/.sync.yml" with:
       """
       ---
+      :global:
+        global-to-overwrite: it-is-overwritten
+        module-default: some-value
       spec/spec_helper.rb:
         unmanaged: true
       """
@@ -792,6 +804,13 @@ Feature: update
       """
       Not managing spec/spec_helper.rb in puppet-test
       """
+    Given I run `cat modules/maestrodev/puppet-test/global-test.md`
+    Then the output should match:
+      """
+      some-default
+      it-is-overwritten
+      some-value
+      """
 
   Scenario: Module with custom namespace
     Given a file named "managed_modules.yml" with:
@@ -824,9 +843,9 @@ Feature: update
       Files added:
       test
       """
-    Given I run `cat modules/puppet-test/.git/config`
+    Given I run `cat modules/maestrodev/puppet-test/.git/config`
     Then the output should contain "url = https://github.com/maestrodev/puppet-test.git"
-    Given I run `cat modules/puppet-lib-file_concat/.git/config`
+    Given I run `cat modules/electrical/puppet-lib-file_concat/.git/config`
     Then the output should contain "url = https://github.com/electrical/puppet-lib-file_concat.git"
 
   Scenario: Modifying an existing file with values exposed by the module
@@ -858,7 +877,7 @@ Feature: update
       Files changed:
       +diff --git a/README.md b/README.md
       """
-    Given I run `cat modules/puppet-test/README.md`
+    Given I run `cat modules/maestrodev/puppet-test/README.md`
     Then the output should contain:
       """
       echo 'https://github.com/maestrodev'
@@ -903,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
+      """