modulesync 0.5.0 → 0.6.0

data/.gitignore

@@ -1,3 +1,4 @@
+tmp/
 modules/
 *.gem
-Gemfile.lock
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+script: 'bundle exec rake test'
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+##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

data/README.md

@@ -121,6 +121,17 @@ overwrites local changes.
 msync update --noop
 ```
 
+#### Offline support
+The --offline flag was added to allow a user to disable git support within
+msync. One reason for this is because the user wants to control git commands
+external to msync.  Note, when using this command, msync assumes you have
+create the folder structure and git repositories correctly. If not, msync will
+fail to update correctly.
+
+```
+msync update --offline
+```
+
 #### Damage mode
 
 Make changes for real and push them back to master. This operates on the

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/clean'
+require 'cucumber/rake/task'
+
+CLEAN.include("pkg/", "tmp/")
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = ""
+  t.cucumber_opts << "--format pretty"
+end
+
+task :test => [:clean, :cucumber]

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'aruba/cucumber'
+
+Before do
+  @aruba_timeout_seconds = 5
+end

data/features/update.feature

@@ -0,0 +1,201 @@
+Feature: update
+  ModuleSync needs to update module boilerplate
+
+  Scenario: Adding a new file
+    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" with:
+      """
+      <%= @configs['name'] %>
+      """
+    When I run `msync update --noop`
+    Then the exit status should be 0
+    And the output should match /Files added:\s+test/
+    Given I run `cat modules/puppet-test/test`
+    Then the output should contain "aruba"
+
+  Scenario: Adding a new file into foobar project-root
+    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" with:
+      """
+      <%= @configs['name'] %>
+      """
+    When I run `msync update --noop --project-root=foobar`
+    Then the exit status should be 0
+    And the output should match /Files added:\s+test/
+    Given I run `cat foobar/puppet-test/test`
+    Then the output should contain "aruba"
+
+  Scenario: Modifying an existing file
+    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:
+      """
+      ---
+      Gemfile:
+        gem_source: https://somehost.com
+      """
+    And a directory named "moduleroot"
+    And a file named "moduleroot/Gemfile" with:
+      """
+      source '<%= @configs['gem_source'] %>'
+      """
+    When I run `msync update --noop`
+    Then the exit status should be 0
+    And the output should match:
+      """
+      Files changed:\s+
+      +diff --git a/Gemfile b/Gemfile
+      """
+    Given I run `cat modules/puppet-test/Gemfile`
+    Then the output should contain:
+      """
+      source 'https://somehost.com'
+      """
+
+  Scenario: Adding a new file in a new subdirectory
+    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:
+      """
+      ---
+      spec/spec_helper.rb:
+        require:
+          - puppetlabs_spec_helper/module_helper
+      """
+    And a file named "moduleroot/spec/spec_helper.rb" with:
+      """
+      <% @configs['require'].each do |required| -%>
+        require '<%= required %>'
+      <% end %>
+      """
+    When I run `msync update --noop`
+    Then the exit status should be 0
+    And the output should match:
+      """
+      Files added:\s+
+      spec/spec_helper.rb
+      """
+    Given I run `cat modules/puppet-test/spec/spec_helper.rb`
+    Then the output should contain:
+      """
+      require 'puppetlabs_spec_helper/module_helper'
+      """
+    When I run `msync update --offline --noop`
+    Then the exit status should be 0
+    And the output should match:
+      """
+      Files added:\s+
+      spec/spec_helper.rb
+      """
+    When I run `msync update --offline`
+    Then the exit status should be 0
+    And the output should match:
+      """
+      """
+
+  Scenario: Updating a module with a .sync.yml file
+    Given a file named "managed_modules.yml" with:
+      """
+      ---
+        - puppetlabs-stdlib
+      """
+    And a file named "modulesync.yml" with:
+      """
+      ---
+        git_base: https://github.com/
+      """
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      spec/spec_helper.rb:
+        require:
+          - puppetlabs_spec_helper/module_helper
+      """
+    And a file named "moduleroot/spec/spec_helper.rb" with:
+      """
+      <% @configs['require'].each do |required| -%>
+        require '<%= required %>'
+      <% end %>
+      """
+    And a file named "moduleroot/.travis.yml" with:
+      """
+      ---
+      sudo: false
+      language: ruby
+      cache: bundler
+      bundler_args: --without system_tests
+      script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--color --format documentation'"
+      matrix:
+        fast_finish: true
+        include:
+        - rvm: 1.8.7
+          env: PUPPET_GEM_VERSION="~> 3.0"
+        - rvm: 1.9.3
+          env: PUPPET_GEM_VERSION="~> 3.0"
+        - rvm: 2.1.5
+          env: PUPPET_GEM_VERSION="~> 3.0"
+        - rvm: 2.1.5
+          env: PUPPET_GEM_VERSION="~> 3.0" FUTURE_PARSER="yes"
+        - rvm: 2.1.6
+          env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes"
+      notifications:
+        email: false
+      """
+    When I run `msync update --noop`
+    Then the exit status should be 0
+    And the output should match:
+      """
+      Not managing spec/spec_helper.rb in puppetlabs-stdlib
+      """

data/lib/modulesync.rb

@@ -13,8 +13,8 @@ module ModuleSync
     "#{config_path}/#{MODULE_FILES_DIR}/#{file}"
   end
 
-  def self.module_file(puppet_module, file)
-    "#{PROJ_ROOT}/#{puppet_module}/#{file}"
+  def self.module_file(project_root, puppet_module, file)
+    "#{project_root}/#{puppet_module}/#{file}"
   end
 
   def self.local_files(path)
@@ -56,9 +56,11 @@ module ModuleSync
       # managed_modules is either an array or a hash
       managed_modules.each do |puppet_module, opts|
         puts "Syncing #{puppet_module}"
-        git_base = "#{options[:git_base]}#{options[:namespace]}"
-        Git.pull(git_base, puppet_module, options[:branch], opts || {})
-        module_configs = Util.parse_config("#{PROJ_ROOT}/#{puppet_module}/#{MODULE_CONF_FILE}")
+        unless options[:offline]
+          git_base = "#{options[:git_base]}#{options[:namespace]}"
+          Git.pull(git_base, puppet_module, options[:branch], options[:project_root], opts || {})
+        end
+        module_configs = Util.parse_config("#{options[:project_root]}/#{puppet_module}/#{MODULE_CONF_FILE}")
         global_defaults = defaults[GLOBAL_DEFAULTS_KEY] || {}
         module_defaults = module_configs[GLOBAL_DEFAULTS_KEY] || {}
         files_to_manage = (module_files | defaults.keys | module_configs.keys) - [GLOBAL_DEFAULTS_KEY]
@@ -70,17 +72,17 @@ module ModuleSync
             puts "Not managing #{file} in #{puppet_module}"
             files_to_delete << file
           elsif file_configs['delete']
-            Renderer.remove(module_file(puppet_module, file))
+            Renderer.remove(module_file(options['project_root'], puppet_module, file))
           else
             erb = Renderer.build(local_file(options[:configs], file))
             template = Renderer.render(erb, file_configs)
-            Renderer.sync(template, "#{PROJ_ROOT}/#{puppet_module}/#{file}")
+            Renderer.sync(template, "#{options[:project_root]}/#{puppet_module}/#{file}")
           end
         end
         files_to_manage -= files_to_delete
         if options[:noop]
           Git.update_noop(puppet_module, options)
-        else
+        elsif not options[:offline]
           Git.update(puppet_module, files_to_manage, options)
         end
       end

data/lib/modulesync/cli.rb

@@ -14,6 +14,7 @@ module ModuleSync
         :managed_modules_conf => 'managed_modules.yml',
         :configs              => '.',
         :tag_pattern          => '%s',
+        :project_root         => './modules',
       }
     end
 
@@ -35,7 +36,7 @@ module ModuleSync
       @options.merge!(Hash.transform_keys_to_symbols(Util.parse_config(MODULESYNC_CONF_FILE)))
       @options[:command] = args[0] if commands_available.include?(args[0])
       opt_parser = OptionParser.new do |opts|
-        opts.banner = "Usage: msync update [-m <commit message>] [-c <directory> ] [--noop] [--bump] [--changelog] [--tag] [--tag-pattern <tag_pattern>] [-n <namespace>] [-b <branch>] [-r <branch>] [-f <filter>] | hook activate|deactivate [-c <directory> ] [-n <namespace>] [-b <branch>]"
+        opts.banner = "Usage: msync update [-m <commit message>] [-c <directory> ] [--offline] [--noop] [--bump] [--changelog] [--tag] [--tag-pattern <tag_pattern>] [-p <project_root> [-n <namespace>] [-b <branch>] [-r <branch>] [-f <filter>] | hook activate|deactivate [-c <directory> ] [-n <namespace>] [-b <branch>]"
         opts.on('-m', '--message <msg>',
                 'Commit message to apply to updated modules') do |msg|
           @options[:message] = msg
@@ -52,6 +53,10 @@ module ModuleSync
                 'Branch name to make the changes in. Defaults to "master"') do |branch|
           @options[:branch] = branch
         end
+        opts.on('-p', '--project-root <path>',
+                'Path used by git to clone modules into. Defaults to "modules"') do |project_root|
+          @options[:project_root] = project_root
+        end
         opts.on('-r', '--remote-branch <branch>',
                 'Remote branch name to push the changes to. Defaults to the branch name') do |branch|
           @options[:remote_branch] = branch
@@ -72,6 +77,10 @@ module ModuleSync
                 'No-op mode') do |msg|
           @options[:noop] = true
         end
+        opts.on('--offline',
+                'Do not run git command. Helpful if you have existing repositories locally.') do |msg|
+          @options[:offline] = true
+        end
         opts.on('--bump',
                 'Bump module version to the next minor') do |msg|
           @options[:bump] = true
@@ -92,8 +101,8 @@ module ModuleSync
       end.parse!
 
       @options.fetch(:message) do
-        if @options[:command] == 'update' && ! @options[:noop] && ! @options[:amend]
-          fail("A commit message is required unless using noop.")
+        if @options[:command] == 'update' && ! @options[:noop] && ! @options[:amend] && ! @options[:offline]
+          fail("A commit message is required unless using noop or offline.")
         end
       end
 

data/lib/modulesync/constants.rb

@@ -4,7 +4,6 @@ module ModuleSync
     CONF_FILE            = 'config_defaults.yml'
     MODULE_CONF_FILE     = '.sync.yml'
     MODULESYNC_CONF_FILE = 'modulesync.yml'
-    PROJ_ROOT            = './modules'
     HOOK_FILE            = '.git/hooks/pre-push'
     GLOBAL_DEFAULTS_KEY  = :global
   end

data/lib/modulesync/git.rb

@@ -30,24 +30,24 @@ module ModuleSync
       end
     end
 
-    def self.pull(git_base, name, branch, opts)
-      if ! Dir.exists?(PROJ_ROOT)
-        Dir.mkdir(PROJ_ROOT)
+    def self.pull(git_base, name, branch, project_root, opts)
+      if ! Dir.exists?(project_root)
+        Dir.mkdir(project_root)
       end
 
       # Repo needs to be cloned in the cwd
-      if ! Dir.exists?("#{PROJ_ROOT}/#{name}") || ! Dir.exists?("#{PROJ_ROOT}/#{name}/.git")
+      if ! Dir.exists?("#{opts[:project_root]}/#{name}") || ! Dir.exists?("#{opts[:project_root]}/#{name}/.git")
         puts "Cloning repository fresh"
-        remote = opts[:remote] || git_base.start_with?('file://') ? "#{git_base}/#{name}" : "#{git_base}/#{name}.git"
-        local = "#{PROJ_ROOT}/#{name}"
+        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)
         switch_branch(repo, branch)
       # Repo already cloned, check out master and override local changes
       else
         # Some versions of git can't properly handle managing a repo from outside the repo directory
-        Dir.chdir("#{PROJ_ROOT}/#{name}") do
-          puts "Overriding any local changes to repositories in #{PROJ_ROOT}"
+        Dir.chdir("#{project_root}/#{name}") do
+          puts "Overriding any local changes to repositories in #{project_root}"
           repo = ::Git.open('.')
           repo.fetch
           repo.reset_hard
@@ -96,7 +96,7 @@ module ModuleSync
 
     # Git add/rm, git commit, git push
     def self.update(name, files, options)
-      module_root = "#{PROJ_ROOT}/#{name}"
+      module_root = "#{options[:project_root]}/#{name}"
       message = options[:message]
       if options[:remote_branch]
         branch = "#{options[:branch]}:#{options[:remote_branch]}"
@@ -159,7 +159,7 @@ module ModuleSync
     def self.update_noop(name, options)
       puts "Using no-op. Files in #{name} may be changed but will not be committed."
 
-      repo = ::Git.open("#{PROJ_ROOT}/#{name}")
+      repo = ::Git.open("#{options[:project_root]}/#{name}")
       repo.branch(options[:branch]).checkout
 
       puts "Files changed: "

data/modulesync.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'modulesync'
-  spec.version       = '0.5.0'
+  spec.version       = '0.6.0'
   spec.authors       = ['Colleen Murphy']
   spec.email         = ['colleen@puppetlabs.com']
   spec.summary       = %q{Puppet Module Synchronizer}
@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "aruba"
 
   spec.add_runtime_dependency 'git', '~>1.2'
   spec.add_runtime_dependency 'puppet-blacksmith', '~>3.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,6 +27,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -68,12 +100,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - bin/msync
 - contrib/openstack-commit-msg-hook.sh
+- features/support/env.rb
+- features/update.feature
 - lib/modulesync.rb
 - lib/modulesync/cli.rb
 - lib/modulesync/constants.rb
@@ -107,4 +143,6 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Puppet Module Synchronizer
-test_files: []
+test_files:
+- features/support/env.rb
+- features/update.feature