modulesync 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9799ba2b483f6370a71e6787b21862cf6aeab0246f1b7896be48175c37564db3
-  data.tar.gz: fccd8279e58613ac070d05175bce1a9b0f4afc292ffac78c347f343518434bc3
+  metadata.gz: aba3647204bfcc8853cafeddbf1e4f1083ceaade7fb1806bd06b36e37d6d593e
+  data.tar.gz: ce4305980ed768ffd80580c4618c7d921e0c7c6e17b57edc3dae0c10eacbeef6
 SHA512:
-  metadata.gz: f4f4e927a0d4df8a95859c23319cb395f3418ecd0fa4dadc5c9a68209dcc767bc821b71dd2206fa4b6c482a65464940803a2958849cd1a991276342490356351
-  data.tar.gz: c5cee9698af0bea865f69f5bed772db3a881e339e7a6626c6be70968c02568de8a5899c3dcebc3cfc3620f66fe51a65fa1b6887f2d929ac56bdf66a5dab59a82
+  metadata.gz: 0cfda65f2a020913fa4cd928e22daac9e5c141f7881afaed928b28af846fe86466fff64314e89b04b9d3cb32bf8e4387ec0410e7142215ac5e0412b15c845d62
+  data.tar.gz: 083fdbb949ce978be0958f3ac2baa8390d38d7221c846b934b5b2e3e49cc60992d662b0afd8322d4efeb3bbec9643faf73b7cba95ba3f91d388953365837494a

data/.travis.yml

@@ -3,9 +3,6 @@ sudo: false
 language: ruby
 cache: bundler
 dist: trusty
-before_install:
-  - gem update --system
-  - gem install bundler
 script: 'bundle exec rake test'
 rvm:
   - 2.0

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 2018-02-15
+
+## 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

data/Gemfile

@@ -1,3 +1,5 @@
 source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
 gemspec
+
+gem 'cucumber', '< 3.0' if RUBY_VERSION < '2.1'

data/features/step_definitions/git_steps.rb

@@ -22,3 +22,26 @@ Given 'a remote module repository' do
   git_base: file://#{expand_path('.')}/
   CONFIG
 end
+
+Given /a remote module repository with "(.+?)" as the default branch/ do |branch| # rubocop:disable Lint/AmbiguousRegexpLiteral
+  steps %(
+    Given a directory named "sources"
+    And I run `git clone --mirror https://github.com/maestrodev/puppet-test sources/puppet-test`
+    And a file named "managed_modules.yml" with:
+      """
+      ---
+        - puppet-test
+      """
+  )
+  write_file('modulesync.yml', <<-CONFIG)
+---
+  namespace: sources
+  git_base: file://#{expand_path('.')}/
+  CONFIG
+  cd('sources/puppet-test') do
+    steps %(
+      And I run `git branch -M master #{branch}`
+      And I run `git symbolic-ref HEAD refs/heads/#{branch}`
+    )
+  end
+end

data/features/update.feature

@@ -34,6 +34,32 @@ Feature: update
     Given I run `cat modules/puppet-test/test`
     Then the output should contain "aruba"
 
+  Scenario: Using skip_broken option and adding a new file to repo without write access
+    Given a file named "managed_modules.yml" with:
+      """
+      ---
+        - puppet-test
+      """
+    And a file named "modulesync.yml" with:
+      """
+      ---
+        namespace: maestrodev
+        git_base: 'git@github.com:'
+      """
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      test:
+        name: aruba
+      """
+    And a directory named "moduleroot"
+    And a file named "moduleroot/test.erb" with:
+      """
+      <%= @configs['name'] %>
+      """
+    When I run `msync update -s -m "Add test"`
+    Then the exit status should be 0
+
   Scenario: Adding a new file to repo without write access
     Given a file named "managed_modules.yml" with:
       """
@@ -44,7 +70,7 @@ Feature: update
       """
       ---
         namespace: maestrodev
-        git_base: git@github.com:
+        git_base: 'git@github.com:'
       """
     And a file named "config_defaults.yml" with:
       """
@@ -258,6 +284,34 @@ Feature: update
     When I run `msync update --noop -s`
     Then the exit status should be 0
 
+  Scenario: Using skip_broken and fail_on_warnings options with invalid files
+    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 file named "config_defaults.yml" with:
+      """
+      ---
+      test:
+        name: aruba
+      """
+    And a directory named "moduleroot"
+    And a file named "moduleroot/test.erb" with:
+      """
+      <% @configs.each do |c| -%>
+        <%= c['name'] %>
+      <% end %>
+      """
+    When I run `msync update --noop --skip_broken --fail_on_warnings`
+    Then the exit status should be 1
+
   Scenario: Modifying an existing file
     Given a file named "managed_modules.yml" with:
       """
@@ -831,3 +885,21 @@ Feature: update
     Then the exit status should be 0
     Then the output should not contain "error"
     Then the output should not contain "rejected"
+
+  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
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      Gemfile:
+        gem_source: https://somehost.com
+      """
+    And a directory named "moduleroot"
+    And a file named "moduleroot/Gemfile.erb" with:
+      """
+      source '<%= @configs['gem_source'] %>'
+      """
+    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"

data/lib/modulesync.rb

@@ -43,10 +43,10 @@ module ModuleSync
     local_files.map { |file| file.sub(/#{path}/, '') }
   end
 
-  def self.managed_modules(path, filter, negative_filter)
-    managed_modules = Util.parse_config(path)
+  def self.managed_modules(config_file, filter, negative_filter)
+    managed_modules = Util.parse_config(config_file)
     if managed_modules.empty?
-      puts "No modules found at #{path}. Check that you specified the right configs directory containing managed_modules.yml."
+      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?
@@ -126,8 +126,9 @@ module ModuleSync
     local_files = self.local_files(path)
     module_files = self.module_files(local_files, path)
 
-    managed_modules = self.managed_modules("#{options[:configs]}/managed_modules.yml", options[:filter], options[:negative_filter])
+    managed_modules = self.managed_modules("#{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
@@ -135,8 +136,10 @@ module ModuleSync
       rescue # rubocop:disable Lint/RescueWithoutErrorClass
         STDERR.puts "Error while updating #{puppet_module}"
         raise unless options[:skip_broken]
+        errors = true
         puts "Skipping #{puppet_module} as update process failed"
       end
     end
+    exit 1 if errors && options[:fail_on_warnings]
   end
 end

data/lib/modulesync/cli.rb

@@ -53,8 +53,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 master.',
-                   :default => CLI.defaults[:branch] || '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'
       option :message,
@@ -106,6 +106,11 @@ module ModuleSync
       option :pre_commit_script,
              :desc => 'A script to be run before commiting',
              :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)',
+             :default => false
 
       def update
         config = { :command => 'update' }.merge(options)

data/lib/modulesync/git.rb

@@ -2,7 +2,7 @@ require 'git'
 require 'puppet_blacksmith'
 
 module ModuleSync
-  module Git
+  module Git # rubocop:disable Metrics/ModuleLength
     include Constants
 
     def self.remote_branch_exists?(repo, branch)
@@ -18,7 +18,17 @@ module ModuleSync
         repo.diff("#{local_branch}..origin/#{remote_branch}").any?
     end
 
+    def self.default_branch(repo)
+      symbolic_ref = repo.branches.find { |b| b.full =~ %r{remotes/origin/HEAD} }
+      return unless symbolic_ref
+      %r{remotes/origin/HEAD\s+->\s+origin/(?<branch>.+?)$}.match(symbolic_ref.full)[:branch]
+    end
+
     def self.switch_branch(repo, branch)
+      unless branch
+        branch = default_branch(repo)
+        puts "Using repository's default branch: #{branch}"
+      end
       return if repo.current_branch == branch
 
       if local_branch_exists?(repo, branch)
@@ -95,12 +105,19 @@ module ModuleSync
       repo.push('origin', tag)
     end
 
+    def self.checkout_branch(repo, branch)
+      selected_branch = branch || repo.current_branch || 'master'
+      repo.branch(selected_branch).checkout
+      selected_branch
+    end
+    private_class_method :checkout_branch
+
     # Git add/rm, git commit, git push
     def self.update(name, files, options)
       module_root = "#{options[:project_root]}/#{name}"
       message = options[:message]
       repo = ::Git.open(module_root)
-      repo.branch(options[:branch]).checkout
+      branch = checkout_branch(repo, options[:branch])
       files.each do |file|
         if repo.status.deleted.include?(file)
           repo.remove(file)
@@ -119,11 +136,11 @@ module ModuleSync
         end
         repo.commit(message, opts_commit)
         if options[:remote_branch]
-          if remote_branch_differ?(repo, options[:branch], options[:remote_branch])
-            repo.push('origin', "#{options[:branch]}:#{options[:remote_branch]}", opts_push)
+          if remote_branch_differ?(repo, branch, options[:remote_branch])
+            repo.push('origin', "#{branch}:#{options[:remote_branch]}", opts_push)
           end
         else
-          repo.push('origin', options[:branch], opts_push)
+          repo.push('origin', branch, opts_push)
         end
         # Only bump/tag if pushing didn't fail (i.e. there were changes)
         m = Blacksmith::Modulefile.new("#{module_root}/metadata.json")
@@ -136,7 +153,7 @@ module ModuleSync
           puts "There were no files to update in #{name}. Not committing."
         else
           puts git_error
-          exit(1)
+          raise
         end
       end
     end
@@ -154,7 +171,7 @@ module ModuleSync
       puts "Using no-op. Files in #{name} may be changed but will not be committed."
 
       repo = ::Git.open("#{options[:project_root]}/#{name}")
-      repo.branch(options[:branch]).checkout
+      checkout_branch(repo, options[:branch])
 
       puts 'Files changed:'
       repo.diff('HEAD', '--').each do |diff|

data/lib/monkey_patches.rb

@@ -37,4 +37,19 @@ module Git
       final.map { |e| [e[0], DiffFile.new(@base, e[1])] }
     end
   end
+
+  class Lib
+    # Monkey patch ls_files until https://github.com/ruby-git/ruby-git/pull/320 is resolved
+    def ls_files(location=nil)
+      location ||= '.'
+      hsh = {}
+      command_lines('ls-files', ['--stage', location]).each do |line|
+        (info, file) = line.split("\t")
+        (mode, sha, stage) = info.split
+        file = eval(file) if file =~ /^\".*\"$/ # This takes care of quoted strings returned from git
+        hsh[file] = {:path => file, :mode_index => mode, :sha_index => sha, :stage => stage}
+      end
+      hsh
+    end
+  end
 end

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.8.2'
+  spec.version               = '0.9.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'

data/spec/unit/modulesync_spec.rb

@@ -0,0 +1,14 @@
+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::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([])
+
+      options = { managed_modules_conf: 'test_file.yml' }
+      ModuleSync.update(options)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2018-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -159,6 +159,7 @@ files:
 - modulesync.gemspec
 - spec/spec_helper.rb
 - spec/unit/modulesync/settings_spec.rb
+- spec/unit/modulesync_spec.rb
 homepage: http://github.com/voxpupuli/modulesync
 licenses:
 - Apache-2.0
@@ -179,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer
@@ -191,3 +192,4 @@ test_files:
 - features/update.feature
 - spec/spec_helper.rb
 - spec/unit/modulesync/settings_spec.rb
+- spec/unit/modulesync_spec.rb