modulesync 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c1dc855f2c78b421ce564326e848cb4622b887c
-  data.tar.gz: 6b9ea713d13af6cb4c079069a7e0883c7531ad52
+  metadata.gz: bcd0fbe76e6f665fb7122e17a5d6945f7be84bbe
+  data.tar.gz: 5f4e45bc2b44d51fb2b215d022e2269712f47a24
 SHA512:
-  metadata.gz: 6835740e963f045ec525312d2fa208eac048d9277af16699b7a5cf605eef4bf8c99b8f5eb522492b17d489905b49a7fa7a249f58f68b2e4a9e264d0da6936687
-  data.tar.gz: 93e83428fbc900e1e72889b6a1af73c20d41a35dfdd441575e17d5576a997a244cf7747e94e6d95756c292cf7511d063c63206daad4b75773a76699ec7f14fd7
+  metadata.gz: 150e69be961f2c98a69dd1e7f0469a67337991d01ca66279c61ecdfb63f41fd049682b1f4bafe16dbe5d808a4a3786cb7626ede3b82528c2276d686c9bf5f362
+  data.tar.gz: 326c5d4551c5398f22e635149b9cec5bf09f61047e198cb761910a13ba947cc4dffdd997ca12b14a0b53bd8704f25a4634f07fe6d18d8f33dcd0bcd9b30be5a3

data/CHANGELOG.md

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

data/README.md

@@ -68,7 +68,7 @@ This allows us to, for example, have a set of "required" gems that are added
 to all Gemfiles, and a set of "optional" gems that a single module might add.
 
 The list of modules to manage is in managed\_modules.yml in the configuration
-directory. This lists just the GitHub names of the modules to be managed.
+directory. This lists just the names of the modules to be managed.
 
 ModuleSync can be called from the command line with parameters to change the
 branch you're working on or the remote to clone from and push to. You can also
@@ -101,20 +101,18 @@ github organization and pushes to the master branch.
 
 Make changes to a file in the moduleroot. For sanity's sake you should commit
 and push these changes, but in this mode the update will be rendered from the
-state of the files locally. Run `msync update` from the root of the
-configuration directory (not moduleroot), or use -c <relative path> to point
-it to the location of the configuration directory.
+state of the files locally.
 
 #### Dry-run
 
 Do a dry-run to see what files will be changed, added and removed. This clones
-the modules to `modules/<namespace>-<modulename>` in the current working, or if
-the modules are already cloned, does an effective `git fetch origin; git
-checkout master; git reset --hard origin/master` on the modules. Don't run
-modulesync if the current working directory contains a modules/ directory with
-changes you want to keep. The dry-run makes local changes there, but does not
-commit or push changes. It is still destructive in that it overwrites local
-changes.
+the modules to `modules/<namespace>-<modulename>` in the current working
+directory, or if the modules are already cloned, does an effective `git fetch
+origin; git checkout master; git reset --hard origin/master` on the modules.
+Don't run modulesync if the current working directory contains a modules/
+directory with changes you want to keep. The dry-run makes local changes there,
+but does not commit or push changes. It is still destructive in that it
+overwrites local changes.
 
 ```
 msync update --noop 
@@ -130,6 +128,19 @@ found.
 msync update -m "Commit message"
 ```
 
+Amend the commit if changes are needed.
+
+```
+msync update --amend
+```
+
+For most workflows you will need to force-push an amended commit. Not required
+for gerrit.
+
+```
+msync update --amend --force
+```
+
 #### Automating Updates
 
 You can install a pre-push git hook to automatically clone, update, and push
@@ -155,18 +166,17 @@ you can use this on your own organization's modules. This functionality also
 applies if you want to work on a fork of the puppetlabs modules or work on a
 non-master branch of any organization's modules. ModuleSync does not support
 cloning from one remote and pushing to another, you are expected to fork
-manually. It does not yet support automating pull requests (coming soon).
+manually. It does not support automating pull requests.
 
 #### Dry-run
 
 If you dry-run before doing the live update, you need to specify what namespace
 to clone from because the live update will not re-clone if the modules are
-already cloned. The namespace should be your fork, not the upstream module. The
-format should be the SSH or HTTP prefix of the full URL minus the module name
-itself.
+already cloned. The namespace should be your fork, not the upstream module (if
+working on a fork).
 
 ```
-msync update -n git@github.com:puppetlabs --noop
+msync update -n puppetlabs --noop
 ```
 
 #### Damage mode
@@ -177,7 +187,7 @@ namespace if the modules are not pre-cloned. You need to specify a branch to
 push to if you are not pushing to master.
 
 ```
-msync update -n git@github.com:puppetlabs -b sync_branch -m "Commit message"
+msync update -n puppetlabs -b sync_branch -m "Commit message"
 ```
 
 #### Configuring ModuleSync defaults
@@ -201,6 +211,43 @@ msync update --noop
 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)
+* pre_commit_script : A script to be run before commiting (ie. contrib/myfooscript.sh)
+
+##### Example
+
+###### Github
+
+```
+---
+namespace: MySuperOrganization
+branch: modulesyncbranch
+```
+
+###### Gitlab
+
+```
+---
+git_base: 'user@gitlab.example.com:'
+namespace: MySuperOrganization
+branch: modulesyncbranch
+
+###### Gerrit
+
+```
+---
+namespace: stackforge
+git_base:  ssh://jdoe@review.openstack.org:29418/
+branch: msync_foo
+remote_branch: refs/publish/master/msync_foo
+pre_commit_script: openstack-commit-msg-hook.sh
+```
+
 #### Filtering Repositories
 
 If you only want to sync some of the repositories in your managed_modules.yml, use the -f flag to filter by a regex:
@@ -217,9 +264,55 @@ different remote. The hook will also look in modulesync.yml for default
 arguments.
 
 ```
-msync hook activate -n git@github.com:puppetlabs -b sync_branch
+msync hook activate -n puppetlabs -b sync_branch
+```
+
+#### Updating metadata.json
+
+Modulesync can optionally bump the minor version in `metadata.json` for each
+modified modules if you add the `--bump` flag to the command line:
+
+```
+msync update -m "Commit message" --bump
+```
+
+#### Tagging repositories
+
+If you wish to tag the modified repositories with the newly bumped version,
+you can do so by using the `--tag` flag:
+
+```
+msync update -m "Commit message" --bump --tag
+```
+
+#### Setting the tag pattern
+
+You can also set the format of the tag to be used (`printf`-formatted)
+by setting the `tag_pattern` option:
+
+```
+msync update -m "Commit message" --bump --tag --tag_pattern 'v%s'
 ```
 
+The default for the tag pattern is `%s`.
+
+#### Updating the CHANGELOG
+
+When bumping the version in `metadata.json`, modulesync can let you
+updating `CHANGELOG.md` in each modified repository.
+
+This is one by using the `--changelog` flag:
+
+```
+msync update -m "Commit message" --bump --changelog
+```
+
+This flag will cause the `CHANGELOG.md` file to be updated with the
+current date, bumped (minor) version, and commit message.
+
+If `CHANGELOG.md` is absent in the repository, nothing will happen.
+
+
 The Templates
 -------------
 

data/contrib/openstack-commit-msg-hook.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+commit_msg_path=$1/.git/hooks/commit-msg
+
+if [ ! -f $commit_msg_path ]; then
+  curl -s -Lo $commit_msg_path http://review.openstack.org/tools/hooks/commit-msg
+  chmod 775 $commit_msg_path
+fi

data/lib/modulesync/cli.rb

@@ -10,10 +10,10 @@ module ModuleSync
       {
         :namespace            => 'puppetlabs',
         :branch               => 'master',
-        :git_user             => 'git',
-        :git_provider_address => 'github.com',
+        :git_base             => 'git@github.com:',
         :managed_modules_conf => 'managed_modules.yml',
         :configs              => '.',
+        :tag_pattern          => '%s',
       }
     end
 
@@ -35,7 +35,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] [-n <namespace>] [-b <branch>] [-f <filter>] | hook activate|deactivate [-c <directory> ] [-n <namespace>] [-b <branch>]"
+        opts.banner = "Usage: msync update [-m <commit message>] [-c <directory> ] [--noop] [--bump] [--changelog] [--tag] [--tag-pattern <tag_pattern>] [-n <namespace>] [-b <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
@@ -56,15 +56,39 @@ module ModuleSync
                 'A regular expression to filter repositories to update.') do |filter|
           @options[:filter] = filter
         end
+        opts.on('--amend',
+                'Amend previous commit') do |msg|
+          @options[:amend] = true
+        end
+        opts.on('--force',
+                'Force push amended commit') do |msg|
+          @options[:force] = true
+        end
         opts.on('--noop',
                 'No-op mode') do |msg|
           @options[:noop] = true
         end
+        opts.on('--bump',
+                'Bump module version to the next minor') do |msg|
+          @options[:bump] = true
+        end
+        opts.on('--changelog',
+                'Update CHANGELOG.md if version was bumped') do |msg|
+          @options[:changelog] = true
+        end
+        opts.on('--tag',
+                'Git tag with the current module version') do |msg|
+          @options[:tag] = true
+        end
+        opts.on('--tag-pattern',
+                'The pattern to use when tagging releases.') do |pattern|
+          @options[:tag_pattern] = pattern
+        end
         @options[:help] = opts.help
       end.parse!
 
       @options.fetch(:message) do
-        if @options[:command] == 'update' && ! @options[:noop]
+        if @options[:command] == 'update' && ! @options[:noop] && ! @options[:amend]
           fail("A commit message is required unless using noop.")
         end
       end

data/lib/modulesync/git.rb

@@ -1,10 +1,36 @@
 require 'git'
+require 'puppet_blacksmith'
 
 module ModuleSync
   module Git
     include Constants
 
-    def self.pull(git_user, git_provider_address, org, name)
+    def self.remote_branch_exists?(repo, branch)
+      repo.branches.remote.collect { |b| b.name }.include?(branch)
+    end
+
+    def self.local_branch_exists?(repo, branch)
+      repo.branches.local.collect { |b| b.name }.include?(branch)
+    end
+
+    def self.switch_branch(repo, branch)
+      unless repo.branch.name == branch
+        if local_branch_exists?(repo, branch)
+          puts "Switching to branch #{branch}"
+          repo.checkout(branch)
+        elsif remote_branch_exists?(repo, branch)
+          puts "Creating local branch #{branch} from origin/#{branch}"
+          repo.checkout("origin/#{branch}")
+          repo.branch(branch).checkout
+        else
+          repo.checkout('origin/master')
+          puts "Creating new branch #{branch}"
+          repo.branch(branch).checkout
+        end
+      end
+    end
+
+    def self.pull(git_base, name, branch, opts)
       if ! Dir.exists?(PROJ_ROOT)
         Dir.mkdir(PROJ_ROOT)
       end
@@ -12,25 +38,73 @@ module ModuleSync
       # Repo needs to be cloned in the cwd
       if ! Dir.exists?("#{PROJ_ROOT}/#{name}") || ! Dir.exists?("#{PROJ_ROOT}/#{name}/.git")
         puts "Cloning repository fresh"
-        remote = "#{git_user}@#{git_provider_address}:#{org}/#{name}.git"
+        remote = opts[:remote] || "#{git_base}/#{name}.git"
         local = "#{PROJ_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
-        puts "Overriding any local changes to repositories in #{PROJ_ROOT}"
-        repo = ::Git.open("#{PROJ_ROOT}/#{name}")
-        repo.branch('master').checkout
-        repo.reset_hard
-        repo.pull
+        # 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}"
+          repo = ::Git.open('.')
+          repo.fetch
+          repo.reset_hard
+          switch_branch(repo, branch)
+          if remote_branch_exists?(repo, branch)
+            repo.pull('origin', branch)
+          end
+        end
       end
     end
 
+    def self.update_changelog(repo, version, message, module_root)
+      changelog = "#{module_root}/CHANGELOG.md"
+      if File.exists?(changelog)
+        puts "Updating #{changelog} for version #{version}"
+        changes = File.readlines(changelog)
+        File.open(changelog, 'w') do |f|
+          date = Time.now.strftime("%Y-%m-%d")
+          f.puts "## #{date} - Release #{version}\n\n"
+          f.puts "#{message}\n\n"
+          # Add old lines again
+          f.puts changes
+        end
+        repo.add('CHANGELOG.md')
+      else
+        puts "No CHANGELOG.md file found, not updating."
+      end
+    end
+
+    def self.bump(repo, m, message, module_root, changelog=false)
+      new = m.bump!
+      puts "Bumped to version #{new}"
+      repo.add('metadata.json')
+      self.update_changelog(repo, new, message, module_root) if changelog
+      repo.commit("Release version #{new}")
+      repo.push
+      new
+    end
+
+    def self.tag(repo, version, tag_pattern)
+      tag = tag_pattern % version
+      puts "Tagging with #{tag}"
+      repo.add_tag(tag)
+      repo.push('origin', tag)
+    end
+
     # Git add/rm, git commit, git push
-    def self.update(name, files, message, branch)
-      repo = ::Git.open("#{PROJ_ROOT}/#{name}")
-      repo.branch(branch).checkout
+    def self.update(name, files, options)
+      module_root = "#{PROJ_ROOT}/#{name}"
+      message = options[:message]
+      if options[:remote_branch]
+        branch = "#{options[:branch]}:#{options[:remote_branch]}"
+      else
+        branch = options[:branch]
+      end
+      repo = ::Git.open(module_root)
+      repo.branch(options[:branch]).checkout
       files.each do |file|
         if repo.status.deleted.include?(file)
           repo.remove(file)
@@ -39,8 +113,26 @@ module ModuleSync
         end
       end
       begin
-        repo.commit(message)
-        repo.push
+        opts_commit = {}
+        opts_push = {}
+        if options[:amend]
+          opts_commit = {:amend => true}
+        end
+        if options[:force]
+          opts_push = {:force => true}
+        end
+        if options[:pre_commit_script]
+          script = "#{File.dirname(File.dirname(__FILE__))}/../contrib/#{options[:pre_commit_script]}"
+          %x[#{script} #{module_root}]
+        end
+        repo.commit(message, opts_commit)
+        repo.push('origin', branch, opts_push)
+        # Only bump/tag if pushing didn't fail (i.e. there were changes)
+        m = Blacksmith::Modulefile.new("#{module_root}/metadata.json")
+        if options[:bump]
+          new = self.bump(repo, m, message, module_root, options[:changelog])
+          self.tag(repo, new, options[:tag_pattern]) if options[:tag]
+        end
       rescue ::Git::GitExecuteError => git_error
         if git_error.message.include? "nothing to commit, working directory clean"
           puts "There were no files to update in #{name}. Not committing."
@@ -55,15 +147,20 @@ module ModuleSync
     # untracked under some circumstances
     # https://github.com/schacon/ruby-git/issues/130
     def self.untracked_unignored_files(repo)
-      ignored = File.open("#{repo.dir.path}/.gitignore").read.split
+      ignore_path = "#{repo.dir.path}/.gitignore"
+      if File.exists?(ignore_path)
+        ignored = File.open(ignore_path).read.split
+      else
+        ignored = []
+      end
       repo.status.untracked.keep_if{|f,_| !ignored.any?{|i| File.fnmatch(i, f)}}
     end
 
-    def self.update_noop(name, branch)
+    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.branch(branch).checkout
+      repo.branch(options[:branch]).checkout
 
       puts "Files changed: "
       repo.diff('HEAD', '--').each do |diff|

data/lib/modulesync.rb

@@ -53,14 +53,17 @@ module ModuleSync
 
       managed_modules = self.managed_modules("#{options[:configs]}/managed_modules.yml", options[:filter])
 
-      managed_modules.each do |puppet_module|
+      # managed_modules is either an array or a hash
+      managed_modules.each do |puppet_module, opts|
         puts "Syncing #{puppet_module}"
-        Git.pull(options[:git_user], options[:git_provider_address], options[:namespace], 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}")
         files_to_manage = module_files | defaults.keys | module_configs.keys
         files_to_delete = []
         files_to_manage.each do |file|
           file_configs = (defaults[file] || {}).merge(module_configs[file] || {})
+          file_configs[:puppet_module] = puppet_module
           if file_configs['unmanaged']
             puts "Not managing #{file} in #{puppet_module}"
             files_to_delete << file
@@ -74,9 +77,9 @@ module ModuleSync
         end
         files_to_manage -= files_to_delete
         if options[:noop]
-          Git.update_noop(puppet_module, options[:branch])
+          Git.update_noop(puppet_module, options)
         else
-          Git.update(puppet_module, files_to_manage, options[:message], options[:branch])
+          Git.update(puppet_module, files_to_manage, options)
         end
       end
     elsif options[:command] == 'hook'

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.2.0'
+  spec.version       = '0.3.0'
   spec.authors       = ['Colleen Murphy']
   spec.email         = ['colleen@puppetlabs.com']
   spec.summary       = %q{Puppet Module Synchronizer}
@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
 
   spec.add_runtime_dependency 'git', '~>1.2'
+  spec.add_runtime_dependency 'puppet-blacksmith', '~>3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Colleen Murphy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: puppet-blacksmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Utility to synchronize common files across puppet modules in Github.
 email:
 - colleen@puppetlabs.com
@@ -52,6 +66,7 @@ files:
 - LICENSE
 - README.md
 - bin/msync
+- contrib/openstack-commit-msg-hook.sh
 - lib/modulesync.rb
 - lib/modulesync/cli.rb
 - lib/modulesync/constants.rb
@@ -80,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer
 test_files: []
-has_rdoc: