release_manager 0.8.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8c5f092e245aea42b984105f438d28a7c08ee105
-  data.tar.gz: 2f33d50455fdf64fb2ad9f6292ab1d438c5791a7
+SHA256:
+  metadata.gz: 4711f3474a2ef018068f10268dd3a89bab7da246713b800a0912901fc9b0a70c
+  data.tar.gz: 1f6ef1c783a37a09fa646f855fee88e36e058e9eef43f35101f68ee412606902
 SHA512:
-  metadata.gz: f1652bfddb2ab6671ad58216507116eab5beda0622bb977d01ce9102e09c9d047d0d5af0002a84d8b5d5e7c26ac849195263be49d384eb469763e40783606329
-  data.tar.gz: 5de1534bd90dcd3a4c1f133bacb114dc376a604f2888702391d6332126576f456f93fafa1d095c4d5961bc492b99b41dda599457915effa9f4721c360d77640d
+  metadata.gz: cc5ea77eb51f6753db50284ae1419f822908c5f1d7a02d2a0306211c50af2c33105b9d7d80b51d084e88a5f23ff98f212a156522e0fbbc60307605c92f6245f7
+  data.tar.gz: 5819cb50e9bd8c0c49d8b180e07577a9a1ca4b3fc7c614089e69ce57454ead371e822cf88b6d5c18fd68e86536157017179d33dd70e141a38bb9583b4101dfe5

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Release Manager
+## 0.9.3
+* Fixes gh-17 - Hiera 5 environment layer support
 
-## Unreleased
+## 0.9.2
+ * Removed slice_when in order to support older rubies.
+ 
+## 0.9.1
+ * Adds ability to publish release notes when tagging remotely
+
+## 0.9.0
+ * Adds ability to push a single tag
+ 
+## 0.8.3
+ * Fixes issue when git urls with hypens not being found
 
 ## 0.8.2
  * Fixes #7 - sandbox-create hangs when ssh does not have host id key

data/Gemfile

@@ -1,4 +1,6 @@
-source ENV['GEM_SOURCE'] ||'https://rubygems.org'
+# frozen_string_literal: true
+
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 # Specify your gem's dependencies in release_manager.gemspec
 gem 'gitlab'
 gem 'rugged', '~> 0.26'
@@ -9,7 +11,9 @@ group :test do
   gem 'rubocop'
   gem 'rake'
   gem 'rspec'
-  gem 'bundler'
+  gem 'bundler', '~> 2.1'
   # when docker compiles this it cannot find release manager until we mount the volume
-  gem 'release_manager', path: '.' if File.exists?(File.join('release_manager.gemspec'))
+  if File.exist?(File.join('release_manager.gemspec'))
+    gem 'release_manager', path: '.'
+  end
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    release_manager (0.8.2)
+    release_manager (0.9.3)
       gitlab (~> 4.2.0)
       highline (~> 1.7)
       rugged (~> 0.26)
@@ -9,58 +9,66 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.3.0)
-    coderay (1.1.2)
+    ast (2.4.1)
+    coderay (1.1.3)
     diff-lcs (1.3)
     gitlab (4.2.0)
       httparty
       terminal-table
-    highline (1.7.8)
-    httparty (0.15.6)
+    highline (1.7.10)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    method_source (0.9.0)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
     multi_xml (0.6.0)
-    parallel (1.12.0)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    powerpack (0.1.1)
-    pry (0.11.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rainbow (2.2.2)
-      rake
-    rake (12.3.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    rubocop (0.51.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 3.0)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    rugged (0.26.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    rugged (0.99.0)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
+  bundler (~> 2.1)
   gitlab
   highline (~> 1.7)
   pry
@@ -71,4 +79,4 @@ DEPENDENCIES
   rugged (~> 0.26)
 
 BUNDLED WITH
-   1.15.4
+   2.1.4

data/README.md

@@ -407,6 +407,35 @@ ssh-add
 
 ```
 
+### Unable to exchange encryption keys
+If you see an error message related to `Unable to exchange encryption keys` you may be dealing with an issue on your git server openssh
+does not support the key exchange that libssh2 supports.  Libssh2 is used by release_manager so it is important they can negotiate on the same algorithm.
+
+There are two possible fixes for this.  
+
+* Update libssh2 to 1.7.x+
+
+You can grab the libssh2 library on your puppetserver with r10k should you not have access to libssh2-1.7.0+
+
+`cp /opt/puppetlabs/server/apps/r10k/lib/libssh2.so.1.0.1 /usr/lib64/libssh2.so.1.0.1`
+
+Note: you will actually want to copy the the library whereever release_manager is used.  Additionally you need to recompile
+the rugged gem,  only after updating libssh2 in /usr/lib64
+
+`gem uninstall rugged && gem install rugged  `
+
+
+If you don't want to update libssh2 you should add support more more algorithms on the git server.  
+
+
+```
+# /etc/ssh/sshd_config
+
+KexAlgorithms hmac-sha2-512
+```
+
+Note:  you should have more algorithms as that is an example only.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -455,6 +484,7 @@ has wrong permission you will need to do the following:
 
 If the sandbox create command freezes after the first output make sure you can connect
 to the git server using git clone or running `ssh-add` to add your ssh key to the ssh agent.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on release_manager.

data/lib/release_manager/changelog.rb

@@ -35,6 +35,7 @@ class Changelog < WorkflowAction
     @root_dir
   end
 
+  # Create the changelog entries and commit
   # @param remote [Boolean] - if the commit is a remote git on the vcs server
   # @return [String] - sha of the commit
   def run(remote = false, branch = 'master')
@@ -79,6 +80,24 @@ class Changelog < WorkflowAction
     !!changelog_lines.each_index.find {|index| changelog_lines[index] =~ /\A\s*\#{2}\s*Version #{version}/i }
   end
 
+  # @return [Array] - array of lines of the unreleased content, text between unreleased and next version
+  def get_unreleased_content
+    start_content = changelog_lines.slice((unreleased_index + 1), changelog_lines.count)
+    end_index = start_content.find_index {|line| line.downcase.start_with?('## version')}
+    end_index ? start_content.slice(0, end_index) : start_content
+  end
+
+  # @return [Array] - array of lines of the specified version content, text between specified version and next version
+  # @param [String] - the version of content you want
+  # @note - returns empty string if version is not found
+  def get_version_content(version)
+    start_index = changelog_lines.find_index {|line| line.downcase.include?("version #{version}") }
+    return nil unless start_index
+    start_content = changelog_lines.slice((start_index + 1), changelog_lines.count)
+    end_index = start_content.find_index {|line| line.downcase.start_with?('## version')}
+    end_index ? start_content.slice(0, end_index) : start_content
+  end
+
   # @returns [Array[String]] - inserts the version header in the change log and returns the entire array of lines
   def update_unreleased
     time = Time.now.strftime("%B %d, %Y")

data/lib/release_manager/control_mod.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 class ControlMod
   attr_reader :name, :metadata, :repo
   attr_accessor :version
 
   def initialize(name, args)
     @name = name
-    @metadata = args.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+    @metadata = args.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
   end
 
   def repo
@@ -25,22 +27,28 @@ class ControlMod
 
   def to_s
     name_line = "mod '#{name}',"
-    data = metadata.map { |k, v| ":#{k} => '#{v}'" }.join(",\n\  ")
+    data = metadata.map do |k, v|
+      v == :control_branch ? ":#{k} => #{v.inspect}" : ":#{k} => '#{v}'"
+    end.join(",\n\  ")
     "#{name_line}\n  #{data}"
   end
 
   def bump_patch_version
     return unless metadata[:tag]
+
     pieces = metadata[:tag].split('.')
     raise "invalid semver structure #{metadata[:tag]}" if pieces.count != 3
+
     pieces[2] = pieces[2].next
     pin_version(pieces.join('.'))
   end
 
   def bump_minor_version
     return unless metadata[:tag]
+
     pieces = metadata[:tag].split('.')
     raise "invalid semver structure #{metadata[:tag]}" if pieces.count != 3
+
     pieces[2] = '0'
     pieces[1] = pieces[1].next
     pin_version(pieces.join('.'))
@@ -48,8 +56,10 @@ class ControlMod
 
   def bump_major_version
     return unless metadata[:tag]
+
     pieces = metadata[:tag].split('.')
     raise "invalid semver structure #{metadata[:tag]}" if pieces.count != 3
+
     pieces[2] = '0'
     pieces[1] = '0'
     pieces[0] = pieces[0].next
@@ -79,5 +89,4 @@ class ControlMod
   def pin_url(src)
     metadata[:git] = src
   end
-
 end

data/lib/release_manager/errors.rb

@@ -10,9 +10,11 @@ class GitError < Exception; end
 class RepoNotFound < Exception; end
 class InvalidModule < Exception; end
 class InvalidToken < Exception; end
+class RemoteNotFound < Exception; end
 class InvalidSshkey < Exception; end
 class InvalidBranchName < Exception; end
 class PatchError < Exception; end
 class AlreadyReleased < Exception; end
 class AlreadyDeployed < Exception; end
-class TagExists < Exception; end
+class TagExists < Exception; end
+class NoTagsExists < Exception; end

data/lib/release_manager/git/credentials.rb

@@ -74,7 +74,6 @@ module ReleaseManager
       # this method does currently now work
       def ssh_key_credentials(url = nil)
         logger.error("Must use ssh-agent, please run ssh-agent zsh, then ssh-add to load your ssh key")
-        exit 1
         unless File.readable?(global_private_key)
           raise Exception.new("Unable to use SSH key auth for %{url}: private key %{private_key} is missing or unreadable" % {url: url.inspect, private_key: global_private_key.inspect} )
         end

data/lib/release_manager/git/utilites.rb

@@ -47,7 +47,7 @@ module ReleaseManager
         else
           logger.info("Cloning repo with url: #{url} to #{path}")
           r = Rugged::Repository.clone_at(url, path, {
-              #progress: lambda { |output| puts output },
+              #progress: lambda { |output| logger.debug output },
               credentials: credentials.call(url)
           })
           r
@@ -130,6 +130,7 @@ module ReleaseManager
       # @param [String] remote_name - the remote name to push the branch to
       def push_branch(remote_name, branch, force = false)
         remote = find_or_create_remote(remote_name)
+        raise RemoteNotFound, "Remote named: #{remote_name} was not found" unless remote
         b = repo.branches[branch]
         raise InvalidBranchName.new("Branch #{branch} does not exist locally, cannot push") unless b
         refs = [b.canonical_name]
@@ -143,6 +144,16 @@ module ReleaseManager
         repo.tags.map(&:name)
       end
 
+      # @return [Rugged::Tag]
+      # @param id [String] - the tag name or oid
+      def find_tag(id)
+        if id.length >= 40
+          repo.tags.find {|t| t.target.oid == id  }
+        else
+          repo.tags.find {|t| t.name == id }
+        end
+      end
+
       # @param name [String] - the name of the tag to check for existence
       # @return [Boolean] - return true if the tag exists
       def tag_exists?(name)
@@ -151,9 +162,19 @@ module ReleaseManager
 
       # push all the tags to the remote
       # @param [String] remote_name - the remote name to push tags to
-      def push_tags(remote_name)
+      # @param id [String] - a ref spec to push, set to nil to push all
+      def push_tags(remote_name, id = nil)
         remote = find_or_create_remote(remote_name)
-        refs = repo.tags.map(&:canonical_name)
+        raise RemoteNotFound, "Remote named: #{remote_name} was not found" unless remote
+        all_refs = repo.tags.map(&:canonical_name)
+        refs = if id
+                 tag = find_tag(id)
+                 tag.canonical_name if tag
+               else
+                 all_refs
+               end
+        raise NoTagsExists, "No tags were pushed" if refs.empty?
+        logger.debug("Pushing refs #{refs}")
         logger.info("Pushing tags to remote #{remote.url}")
         remote.push(refs, credentials: credentials)
       end
@@ -219,7 +240,7 @@ module ReleaseManager
       # @return [MatchData] MatchData if the remote name is a url
       # Is the name actually a url?
       def git_url?(name)
-        /([A-Za-z0-9]+@|http(|s)\:\/\/)([A-Za-z0-9.]+)(:|\/)([A-Za-z0-9\/]+)(\.git)?/.match(name)
+        /(?:git|ssh|https?|git@[-\w.]+):(\/\/)?(.*?)(\.git)(\/?|\#[-\d\w._]+?)$/.match(name)
       end
 
       # @return [String] - the author name found in the config

data/lib/release_manager/puppet_module.rb

@@ -140,12 +140,13 @@ class PuppetModule < WorkflowAction
 
  # @param remote [Boolean] - create the tag remotely using the remote VCS
  # @param id [String] - the commit id to tag to
- def tag_module(remote = false, id = nil)
+ # @param remote [Boolean] - use the vcs adapter instead of local tag
+ # @param release_notes [Boolean] - add release notes to the tag when remote is true
+ def tag_module(remote = false, id = nil, release_notes = nil)
    id ||= repo.head.target_id
    if remote
-     # TODO add release_notes as the last argument, currently nil
      # where we get the latest from the changelog
-     create_tag(source, "v#{version}", id, "v#{version}", nil)
+     create_tag(source, "v#{version}", id, "v#{version}", release_notes)
    else
      create_local_tag("v#{version}", id)
    end
@@ -204,9 +205,10 @@ class PuppetModule < WorkflowAction
  end
 
  # pushes the source and tags
- def push_to_upstream
+ # @param id [String] - a ref spec to push
+ def push_to_upstream(id = nil)
    push_branch(source, src_branch)
-   push_tags(source)
+   push_tags(source, id)
  end
 
  # @return [String] the oid of the commit that was created

data/lib/release_manager/r10k_deployer.rb

@@ -24,7 +24,6 @@ class R10kDeployer
       # cleanup branch, checkout previous branch
     end
     if mr
-      ENV['MERGE_REQUEST_URL'] = mr.web_url
       puts mr.web_url
     end
   end

data/lib/release_manager/release.rb

@@ -34,12 +34,18 @@ class Release
     puppet_module.next_version(level)
   end
 
+  def release_notes
+    notes = changelog.get_version_content(version) || changelog.get_unreleased_content || []
+    notes.join(" ")
+  end
+
+  # @param id [String] - the commit id to tag to
   def tag(id)
     if dry_run?
       logger.info "Would have just tagged the module to #{version}"
       return
     end
-    puppet_module.tag_module(options[:remote], id)
+    puppet_module.tag_module(options[:remote], id, release_notes)
   end
 
   def bump
@@ -55,22 +61,26 @@ class Release
     puppet_module.commit_metadata(options[:remote])
   end
 
+  def changelog
+    @changelog ||= Changelog.new(puppet_module.path, version, {:commit => true})
+  end
+
   # @return [String] - sha of the commit
   def bump_log
     if dry_run?
       logger.info "Would have just bumped the CHANGELOG to version #{version}"
       return
     end
-    log = Changelog.new(puppet_module.path, version, {:commit => true})
-    log.run(options[:remote], puppet_module.src_branch)
+    changelog.run(options[:remote], puppet_module.src_branch)
   end
 
-  def push
+  # @param id [String] - a ref spec to push
+  def push(id = nil)
     if dry_run?
       logger.info "Would have just pushed the code and tag to #{puppet_module.source}"
       return
     end
-    puppet_module.push_to_upstream
+    puppet_module.push_to_upstream(id)
   end
 
   def dry_run?
@@ -125,13 +135,13 @@ class Release
       tag(id)
       # pushes the updated code and tags to the upstream repo
       if auto_release?
-       push
+       push(id)
        return
       end
       print "Ready to release version #{version} to #{puppet_module.source}\n and forever change history(y/n)?: ".yellow
       answer = gets.downcase.chomp
       if answer == 'y'
-        push
+        push(id)
         $?.success?
       else
         puts "Nah, forget it, this release wasn't that cool anyways.".yellow

data/lib/release_manager/version.rb

@@ -1,3 +1,3 @@
 module ReleaseManager
-  VERSION = "0.8.2"
+  VERSION = "0.9.3"
 end

data/release_manager.gemspec

@@ -1,39 +1,40 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'release_manager/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "release_manager"
+  spec.name          = 'release_manager'
   spec.version       = ReleaseManager::VERSION
-  spec.authors       = ["Corey Osman"]
-  spec.email         = ["corey@nwops.io"]
+  spec.authors       = ['Corey Osman']
+  spec.email         = ['corey@nwops.io']
 
-  spec.summary       = %q{Release tools for puppet code}
-  spec.description   = %q{Release management tools for releasing modules and r10k control repos}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.summary       = 'Release tools for puppet code'
+  spec.description   = 'Release management tools for releasing modules and r10k control repos'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.add_runtime_dependency "gitlab", "~> 4.2.0"
-  spec.add_runtime_dependency "rugged", "~> 0.26"
-  spec.add_runtime_dependency "highline", '~> 1.7'
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'gitlab', '~> 4.2.0'
+  spec.add_runtime_dependency 'rugged', '~> 0.26'
+  spec.add_runtime_dependency 'highline', '~> 1.7'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: release_manager
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -199,8 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Release tools for puppet code