modulesync 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf47637269ebb272e17ffe11db44344aff0677e8a93fec636d7fcf6ed4d66e01
-  data.tar.gz: c2496e33b76a8af894707b6615662f05bcdb4ff73378020238a633b88915f433
+  metadata.gz: 16cd854b2ba5a64f73b1051081fbf1e3bdbe39bbec2b7dacf5de3a3f37750625
+  data.tar.gz: d45c398dd5e7fc20d4bbf257ca0303bda0faa91ea49d3b6804d34fdbb25e1175
 SHA512:
-  metadata.gz: b9bc5072c017bff505be1f43e4e0bc2630645d0acee00bbb0a8a2d5b23804e4150414c904126570a5418e310ae873073ce207f91887e8f849db5f9cdc61fd680
-  data.tar.gz: 45588886c292dd533923614af9ea94d74685743a7b7708b3caeb4cbfbfe0539adafa2f78a8183d0d2384a4cd9d8f0c03535935b99c8278031f487317d36370e3
+  metadata.gz: 38ae3613c9b28a0d679445350dcf6d625ad0db7156db8e26df7b4a4703a79713b471ce786d20d879a4bcdf8cd23830ac8277f259435f6fb191eede8a5a49ac9f
+  data.tar.gz: 62cacbdc9b002371957bc732727774c79d3b5783280469e3a2a34379265b784a8b6c0a6bccf1ce47ceb4bccea27cdb0273933b86381a37d57fd39e011b382d49

data/.rubocop.yml

@@ -18,3 +18,7 @@ Style/TrailingCommaInLiteral:
 # would require external library
 Layout/IndentHeredoc:
   Enabled: false
+
+# sane line length
+Metrics/LineLength:
+  Max: 120

data/.rubocop_todo.yml

@@ -25,11 +25,6 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 13
 
-# Offense count: 29
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 319
-
 # Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/MethodLength:

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 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!

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'

data/lib/modulesync.rb

@@ -29,31 +29,39 @@ module ModuleSync
   end
 
   def self.local_file(config_path, file)
-    "#{config_path}/#{MODULE_FILES_DIR}/#{file}"
+    File.join(config_path, MODULE_FILES_DIR, file)
   end
 
-  def self.module_file(project_root, puppet_module, file)
-    "#{project_root}/#{puppet_module}/#{file}"
+  def self.module_file(project_root, namespace, puppet_module, file)
+    File.join(project_root, namespace, puppet_module, file)
   end
 
-  def self.local_files(path)
-    if File.exist?(path)
-      # 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
-      local_files = Find.find(path).find_all { |p| p =~ /.erb$/ && !File.directory?(p) }.collect { |p| p.chomp('.erb') }.to_a
+  # 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
+  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
-      puts "#{path} does not exist. Check that you are working in your module configs directory or that you have passed in the correct directory with -c."
+      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
 
-  def self.module_files(local_files, path)
-    local_files.map { |file| file.sub(/#{path}/, '') }
+  def self.relative_names(file_list, path)
+    file_list.map { |file| file.sub(/#{path}/, '') }
   end
 
   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}. Check that you specified the right :configs directory and :managed_modules_conf file."
+      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?
@@ -78,16 +86,17 @@ module ModuleSync
   end
 
   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)
     if configs['delete']
-      Renderer.remove(module_file(options[:project_root], module_name, filename))
+      Renderer.remove(module_file(options[:project_root], namespace, module_name, filename))
     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], module_name, filename))
+        Renderer.sync(template, module_file(options[:project_root], namespace, module_name, filename))
       rescue # rubocop:disable Lint/RescueWithoutErrorClass
         STDERR.puts "Error while rendering #{filename}"
         raise
@@ -101,20 +110,19 @@ module ModuleSync
       raise unless options[:skip_broken]
     end
 
-    puts "Syncing #{puppet_module}"
     namespace, module_name = module_name(puppet_module, options[:namespace])
+    git_repo = File.join(namespace, module_name)
     unless options[:offline]
-      git_base = options[:git_base]
-      git_uri = "#{git_base}#{namespace}"
-      Git.pull(git_uri, module_name, options[:branch], options[:project_root], module_options || {})
+      Git.pull(options[:git_base], git_repo, options[:branch], options[:project_root], module_options || {})
     end
-    module_configs = Util.parse_config("#{options[:project_root]}/#{module_name}/#{MODULE_CONF_FILE}")
+
+    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 => git_base,
+                            :git_base => options[:git_base],
                             :namespace => namespace)
     settings.unmanaged_files(module_files).each do |filename|
       puts "Not managing #{filename} in #{module_name}"
@@ -124,14 +132,14 @@ module ModuleSync
     files_to_manage.each { |filename| manage_file(filename, settings, options) }
 
     if options[:noop]
-      Git.update_noop(module_name, options)
+      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(module_name, files_to_manage, options)
+      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 = "#{namespace}/#{module_name}"
+      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])
@@ -152,13 +160,15 @@ module ModuleSync
 
   def self.update(options)
     options = config_defaults.merge(options)
-    defaults = Util.parse_config("#{options[:configs]}/#{CONF_FILE}")
+    defaults = Util.parse_config(File.join(options[:configs], CONF_FILE))
 
-    path = "#{options[:configs]}/#{MODULE_FILES_DIR}"
-    local_files = self.local_files(path)
-    module_files = self.module_files(local_files, path)
+    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("#{options[:configs]}/#{options[:managed_modules_conf]}", options[:filter], options[:negative_filter])
+    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

data/lib/modulesync/cli.rb

@@ -43,7 +43,8 @@ module ModuleSync
                    :default => CLI.defaults[:git_base] || 'git@github.com:'
       class_option :namespace,
                    :aliases => '-n',
-                   :desc => 'Remote github namespace (user or organization) to clone from and push to. Defaults to puppetlabs',
+                   :desc => 'Remote github namespace (user or organization) to clone from and push to.' \
+                              ' Defaults to puppetlabs',
                    :default => CLI.defaults[:namespace] || 'puppetlabs'
       class_option :filter,
                    :aliases => '-f',
@@ -53,7 +54,8 @@ module ModuleSync
                    :desc => 'A regular expression to skip repositories.'
       class_option :branch,
                    :aliases => '-b',
-                   :desc => 'Branch name to make the changes in. Defaults to the default branch of the upstream repository, but falls back to "master".',
+                   :desc => 'Branch name to make the changes in.' \
+                              ' Defaults to the default branch of the upstream repository, but falls back to "master".',
                    :default => CLI.defaults[:branch]
 
       desc 'update', 'Update the modules in managed_modules.yml'
@@ -63,7 +65,8 @@ module ModuleSync
              :default => CLI.defaults[:message]
       option :configs,
              :aliases => '-c',
-             :desc => 'The local directory or remote repository to define the list of managed modules, the file templates, and the default values for template variables.'
+             :desc => 'The local directory or remote repository to define the list of managed modules,' \
+                        ' the file templates, and the default values for template variables.'
       option :remote_branch,
              :aliases => '-r',
              :desc => 'Remote branch name to push the changes to. Defaults to the branch name.',
@@ -114,18 +117,21 @@ module ModuleSync
       option :tag_pattern,
              :desc => 'The pattern to use when tagging releases.'
       option :pre_commit_script,
-             :desc => 'A script to be run before commiting',
+             :desc => 'A script to be run before committing',
              :default => CLI.defaults[:pre_commit_script]
       option :fail_on_warnings,
              :type => :boolean,
              :aliases => '-F',
-             :desc => 'Produce a failure exit code when there are warnings (only has effect when --skip_broken is enabled)',
+             :desc => 'Produce a failure exit code when there are warnings' \
+                        ' (only has effect when --skip_broken is enabled)',
              :default => false
 
       def update
         config = { :command => 'update' }.merge(options)
         config = Util.symbolize_keys(config)
-        raise Thor::Error, 'No value provided for required option "--message"' unless config[:noop] || config[:message] || config[:offline]
+        raise Thor::Error, 'No value provided for required option "--message"' unless config[:noop] \
+                                                                                      || config[:message] \
+                                                                                      || config[:offline]
         config[:git_opts] = { 'amend' => config[:amend], 'force' => config[:force] }
         ModuleSync.update(config)
       end

data/lib/modulesync/git.rb

@@ -46,12 +46,13 @@ module ModuleSync
     end
 
     def self.pull(git_base, name, branch, project_root, opts)
+      puts "Syncing #{name}"
       Dir.mkdir(project_root) unless Dir.exist?(project_root)
 
       # Repo needs to be cloned in the cwd
       if !Dir.exist?("#{project_root}/#{name}") || !Dir.exist?("#{project_root}/#{name}/.git")
         puts 'Cloning repository fresh'
-        remote = opts[:remote] || (git_base.start_with?('file://') ? "#{git_base}/#{name}" : "#{git_base}/#{name}.git")
+        remote = opts[:remote] || (git_base.start_with?('file://') ? "#{git_base}#{name}" : "#{git_base}#{name}.git")
         local = "#{project_root}/#{name}"
         puts "Cloning from #{remote}"
         repo = ::Git.clone(remote, local)

data/lib/modulesync/settings.rb

@@ -19,10 +19,9 @@ module ModuleSync
 
     def build_file_configs(target_name)
       file_def = lookup_config(defaults, target_name)
-      file_md  = lookup_config(module_defaults, target_name)
       file_mc  = lookup_config(module_configs, target_name)
 
-      global_defaults.merge(file_def).merge(file_md).merge(file_mc).merge(additional_settings)
+      global_defaults.merge(file_def).merge(module_defaults).merge(file_mc).merge(additional_settings)
     end
 
     def managed?(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               = '0.10.0'
+  spec.version               = '1.0.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'

data/spec/unit/modulesync_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe ModuleSync do
   context '::update' do
     it 'loads the managed modules from the specified :managed_modules_conf' do
-      allow(ModuleSync).to receive(:local_files).and_return([])
+      allow(ModuleSync).to receive(:find_template_files).and_return([])
       allow(ModuleSync::Util).to receive(:parse_config).with('./config_defaults.yml').and_return({})
       expect(ModuleSync).to receive(:managed_modules).with('./test_file.yml', nil, nil).and_return([])
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-27 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer