release_manager 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 101f96a16896083f39a5ec3509e7d93d03eff654
-  data.tar.gz: 5f55de39b68dc927703e2253a8bdf6132061b6c8
+  metadata.gz: 1b5f2fca5358264908a1a51ed4cb1af63cc69104
+  data.tar.gz: 409fdbe6392f38daf968ca3379524d70b379ae2b
 SHA512:
-  metadata.gz: 7ab633ea59d29b4a5badbc1d1210deb360d7d87d92470a33532587aa5530254188673452504b5fc737bdb2b7e48b92a67f15f125a24eba2f5ffd2b7c9c7dfe60
-  data.tar.gz: 1a2f26aee604130ac803958725e97d8d0d47251b1e71c3c159412b6fd8376cccf7cd9e72ee77f48966bc5fb9078213f76f8f133f8fafebd5affdcb01c4e26a52
+  metadata.gz: b0b5862f7aceb14806d670ab9cc6a743533ec9ae17a25eb8b1f7ee5f803bc4ee7f68252e8c0af246d29a9da8aafe9db779baf377ee2494ceb10728359357dfe2
+  data.tar.gz: e61f58c5af387848e48903a7df2998f28b6474f0b465d529fb42958f632e56ba4713c9147d28ebf868c4a564fd2b7577b974a30fb4f9da38eb596b03ed9d504c

data/.gitignore

@@ -8,6 +8,6 @@
 /spec/reports/
 /tmp/
 srv/
-
+bundl
 # rspec failure tracking
 .rspec_status

data/.gitlab-ci-dev.yml

@@ -0,0 +1,51 @@
+# setup
+# Please set the following variables in the UI
+# GITLAB_API_PRIVATE_TOKEN (token of user who should execute the scripts and create Merge requests)
+#
+before_script:
+  - gem install bundler
+  - bundle install
+stages:
+  - release
+  - deploy_release
+#before_script:
+  # Run ssh-agent (inside the build environment)
+
+  #- eval $(ssh-agent -s)
+  # Add the SSH key stored in SSH_PRIVATE_KEY variable to the agent store
+  #- ssh-add <(echo "$SSH_PRIVATE_KEY")
+variables:
+  GITLAB_API_ENDPOINT: "http://web/api/v4"
+  MAX_THREAD_COUNT: '30'
+  BUNDLE_DISABLE_VERSION_CHECK: '1'
+  GITLAB_API_HTTPARTY_OPTIONS: "{verify: false}"
+
+# we don't always want validation to run so we skip it if SKIP_VALIDATION is set
+validate:
+    stage: validate
+    tags: ['ruby']
+    script: if [ ! -n "${SKIP_VALIDATION}" ]; then ./scripts/validate_r10k.rb Puppetfile; fi
+
+# tags the current head and bumps the version to the next number, creating a release
+create_release:
+  stage: release
+  tags: 
+    - ruby 
+  script:
+    - bundle exec release-mod -r -a
+  only:
+    - dev@devops/r10k-control
+  when: manual
+
+deploy_to_qa:
+  tags: 
+    - ruby 
+  variables:
+    DEPLOY_BRANCH: qa
+  stage: deploy_release
+  #when: manual
+  script:
+    - bundle exec deploy-r10k -s $CI_COMMIT_REF_NAME -d $DEPLOY_BRANCH
+#  only:
+#    - tags@devops/r10k-control
+

data/CHANGELOG.md

@@ -1,4 +1,17 @@
 # Release Manager
+## Unreleased
+
+## 0.5.0
+ * Adds more error handling instead of stack dumps
+ * Updates gitlab gem to 4.2
+ * Updates rugged gem to 0.26
+ * Adds deploy-r10k cli command
+ * Refactors more git commands to use rugged
+ * Adds ability to run deploy-mod  without interaction
+ * Moves gitlab methods to gitlab adapter
+ * Adds support to create merge request
+ * Adds ability to remote create a commit with the changelog
+ * Adds ability to calculate changes files between two refs
 ## v0.4.0
  * Adds ability to sort the puppetfile when writing to file
 ## v0.3.1

data/Dockerfile

@@ -1,6 +1,6 @@
 FROM ruby:2.3.4
 RUN apt-get update && apt-get install -y libssh2-1-dev tree git zsh libssh2-1 vim cmake && apt-get clean
-RUN useradd -m appuser && su - appuser -c 'ssh-keygen -t rsa -N "password" -f /home/appuser/.ssh/id_rsa' && mkdir /app \
+RUN useradd -m appuser && su - appuser -c 'ssh-keygen -t rsa -N "" -f /home/appuser/.ssh/id_rsa' && mkdir /app \
     && chown appuser:appuser /app
 COPY ./Gemfile* /app/
 COPY .bash_profile /home/appuser/.bash_profile
@@ -11,4 +11,5 @@ RUN su - appuser -c 'git config --global user.email "user@example.com"' && \
 RUN su - appuser -c "BUNDLE_PATH='/home/appuser/.bundle' GEM_HOME='/home/appuser/.gems' bundle install --gemfile=/app/Gemfile" \
     && rm -f /app/*
 # update PATH to find local gems
+
 USER appuser

data/Gemfile

@@ -1,7 +1,7 @@
 source ENV['GEM_SOURCE'] ||'https://rubygems.org'
 # Specify your gem's dependencies in release_manager.gemspec
-gem 'gitlab', '~> 3.7.0'
-gem 'rugged'
+gem 'gitlab', '~> 4.2.0'
+gem 'rugged', '~> 0.26'
 gem 'highline', '~> 1.7'
 
 group :test do

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    release_manager (0.4.0)
-      gitlab (~> 3.7.0)
+    release_manager (0.5.0)
+      gitlab (~> 4.2.0)
       highline (~> 1.7)
-      rugged
+      rugged (~> 0.26)
 
 GEM
   remote: https://rubygems.org/
@@ -12,16 +12,15 @@ GEM
     ast (2.3.0)
     coderay (1.1.1)
     diff-lcs (1.3)
-    gitlab (3.7.0)
-      httparty (~> 0.13.0)
+    gitlab (4.2.0)
+      httparty
       terminal-table
     highline (1.7.8)
-    httparty (0.13.7)
-      json (~> 1.8)
+    httparty (0.15.5)
       multi_xml (>= 0.5.2)
-    json (1.8.6)
     method_source (0.8.2)
     multi_xml (0.6.0)
+    parallel (1.11.2)
     parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
@@ -29,47 +28,49 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rainbow (2.2.1)
-    rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    rubocop (0.48.1)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
-    rugged (0.25.1.1)
+    rugged (0.26.0)
     slop (3.6.0)
-    terminal-table (1.7.3)
-      unicode-display_width (~> 1.1.1)
-    unicode-display_width (1.1.3)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
-  gitlab (~> 3.7.0)
+  gitlab (~> 4.2.0)
   highline (~> 1.7)
   pry
   rake
   release_manager!
   rspec
   rubocop
-  rugged
+  rugged (~> 0.26)
 
 BUNDLED WITH
-   1.14.6
+   1.15.2

data/README.md

@@ -39,7 +39,7 @@ This gem provides workflow automations around releasing and deploying puppet mod
 
 ## Prerequisites 
 
-1. Must be running Gitlab 8.16+
+1. Must be running Gitlab 9.0+
 2. Must be using ssh keys with gitlab
 3. Must be using ssh-agent to handle git authentication
 4. Must be using Git
@@ -48,8 +48,6 @@ This gem provides workflow automations around releasing and deploying puppet mod
 7. Must have a Gitlab API Access token (per user)
 8. Must have the libssh-dev library package installed
 
-
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/docker-compose.yml

@@ -9,7 +9,7 @@ services:
     environment:
       GEM_HOME: '/home/appuser/.gems'
       BUNDLE_PATH: '/home/appuser/.bundle'
-      GITLAB_API_ENDPOINT: 'http://web/api/v3'
+      GITLAB_API_ENDPOINT: 'http://web/api/v4'
       # the token may change so this really needs to be more dynamic
       GITLAB_API_PRIVATE_TOKEN: 'A_zJJfgE8P-8mFGK2_r9'
       R10K_REPO_URL: "git@web:devops/control-repo.git"
@@ -18,7 +18,25 @@ services:
 #      - app_startup_script.sh
     volumes:
       - .:/app
-
+  runner:
+    image: 'registry.gitlab.com/gitlab-org/gitlab-ci-multi-runner:ubuntu-v9.3.0'
+    volumes:
+      - './srv/gitlab-runner/config:/etc/gitlab-runner'
+      - '/var/run/docker.sock:/var/run/docker.sock'
+    environment:
+      DOCKER_NETWORK_MODE: 'releasemanager_default'
+      RUNNER_TAG_LIST: 'ruby'
+      REGISTRATION_TOKEN: 'W_nSSWTvuYmGUmUbh65y'
+      RUNNER_NAME: 'test-runner'
+      CI_SERVER_URL: 'http://web/ci'
+      RUNNER_EXECUTOR: 'docker'
+      GITLAB_API_ENDPOINT: 'http://web/api/v4'
+      REGISTER_RUN_UNTAGGED: 'true'
+      DOCKER_IMAGE: 'ruby:2.1'
+      REGISTER_LOCKED: 'false'
+      # the token may change so this really needs to be more dynamic
+      GITLAB_API_PRIVATE_TOKEN: 'A_zJJfgE8P-8mFGK2_r9'
+      #entrypoint:
   web:
     image: 'gitlab/gitlab-ce:latest'
     restart: always

data/exe/bump-changelog

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
-
 require 'release_manager'
+require 'release_manager/cli/bump_changelog_cli'
+
+ReleaseManager::BumpChangelogCli.run
 
-Changelog.run

data/exe/deploy-r10k

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'release_manager'
+require 'release_manager/cli/deploy_r10k_cli'
+ReleaseManager::DeployR10kCli.run

data/lib/release_manager/changelog.rb

@@ -15,6 +15,7 @@ class Changelog < WorkflowAction
 
   include ReleaseManager::Git::Utilities
   include ReleaseManager::Logger
+  include ReleaseManager::VCSManager
 
   def initialize(module_path, version, options = {})
     @options = options
@@ -22,58 +23,29 @@ class Changelog < WorkflowAction
     @version = version
   end
 
-  def create_changelog_file
-    return if File.exists?(changelog_file)
-    contents = "# Module Name\n\n## Unreleased\n"
-    File.write(changelog_file, contents)
-    logger.info("Creating initial changelog file")
-    commit_changelog("[ReleaseManager] - create empty changelog")
+  def empty_changelog_contents
+    "# #{module_name}\n\n## Unreleased\n"
+  end
+
+  def module_name
+    metadata['name']
   end
 
   def path
     @root_dir
   end
 
-  def run
-    create_changelog_file
-    # write the new changelog unless it does not need updating
-    if already_released? 
+  # @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')
+    if already_released?
       logger.fatal "Version #{version} had already been released, did you bump the version manually?"
       exit 1
-    else
-      File.write(changelog_file, new_content)
-      commit_changelog if options[:commit]
-      logger.info "The changelog has been updated to version #{version}"
-    end
-  end
-
-  def self.run
-    options = {}
-    OptionParser.new do |opts|
-      opts.program_name = 'bump_changelog'
-      opts.version = ReleaseManager::VERSION
-      opts.on_head(<<-EOF
-
-Summary: updates the changelog.md file with the new
-         version by reading the metadata.json file
-
-EOF
-)
-      opts.on("-c", "--[no-]commit", "Commit the updated changelog") do |c|
-	options[:commit] = c
-      end
-      opts.on("-f", "--changelog FILE", "Path to the changelog file") do |c|
-	options[:file] = c
-      end
-    end.parse!
-    unless options[:file]
-      puts "Must supply --changelog FILE"
-      exit 1
     end
-    module_path = File.dirname(options[:file])
-    puppet_module = PuppetModule.new(module_path)   
-    log = Changelog.new(module_path, puppet_module.version, options)
-    log.run
+    File.write(changelog_file, new_content) unless remote
+    id = commit_changelog(nil, remote, branch) if options[:commit]
+    logger.info "The changelog has been updated to version #{version}"
+    id
   end
 
   # @returns [String] the full path to the change log file
@@ -83,7 +55,11 @@ EOF
 
   # @returns [Array[String]]
   def changelog_lines
-    @changelog_lines ||= File.readlines(changelog_file)
+    unless @changelog_lines
+      @changelog_lines = File.exists?(changelog_file) ?
+          File.readlines(changelog_file) : empty_changelog_contents.lines
+    end
+    @changelog_lines
   end
 
   # @returns [Integer] line number of where the word unreleased is located
@@ -115,10 +91,20 @@ EOF
   end
 
   # @return [String] the oid of the commit that was created
-  def commit_changelog(msg = nil)
-    add_file(changelog_file)
+  def commit_changelog(msg = nil, remote = false, branch = 'master')
     message = msg || "[ReleaseManager] - bump changelog to version #{version}"
-    create_commit(message)
+    if remote
+      actions = [{
+         action: 'update',
+         file_path: changelog_file.split(repo.workdir).last,
+         content: new_content
+      }]
+      obj = vcs_create_commit(source, branch, message, actions)
+      obj.id if obj
+    else
+      add_file(changelog_file)
+      create_commit(message)
+    end
   end
 
   # checks to make sure the unreleased line is valid, and the file exists
@@ -126,5 +112,21 @@ EOF
     log = new(path, nil)
     log.unreleased_index if File.exists?(log.changelog_file)
   end
+
+  private
+
+  # @returns [Hash] the metadata object as a ruby hash
+  def metadata
+    unless @metadata
+      metadata_file =File.join(path, 'metadata.json')
+      raise ModNotFoundException unless File.exists?(metadata_file)
+      @metadata ||= JSON.parse(File.read(metadata_file))
+    end
+    @metadata
+  end
+
+  def source
+    metadata['source']
+  end
 end
 

data/lib/release_manager/cli/bump_changelog_cli.rb

@@ -0,0 +1,36 @@
+require 'optparse'
+require 'release_manager/version'
+require 'release_manager/changelog'
+module ReleaseManager
+  class BumpChangelogCli
+
+    def self.run
+      options = {}
+      OptionParser.new do |opts|
+        opts.program_name = 'bump_changelog'
+        opts.version = ReleaseManager::VERSION
+        opts.on_head(<<-EOF
+  
+  Summary: updates the changelog.md file with the new
+           version by reading the metadata.json file
+
+        EOF
+        )
+        opts.on("-c", "--[no-]commit", "Commit the updated changelog") do |c|
+          options[:commit] = c
+        end
+        opts.on("-f", "--changelog FILE", "Path to the changelog file") do |c|
+          options[:file] = c
+        end
+      end.parse!
+      unless options[:file]
+        puts "Must supply --changelog FILE"
+        exit 1
+      end
+      module_path = File.dirname(options[:file])
+      puppet_module = PuppetModule.new(module_path)
+      log = Changelog.new(module_path, puppet_module.version, options)
+      log.run
+    end
+  end
+end

data/lib/release_manager/cli/deploy_mod_cli.rb

@@ -26,16 +26,16 @@ module ReleaseManager
         opts.on('-c', '--commit', 'Optionally, Commit the Puppetfile change') do |p|
           options[:commit] = p
         end
-        # removing this option as it seems a little dangerous for now
-        # opts.on('-u', '--push', 'Optionally, Push the changes to the remote') do |p|
-        #   options[:push] = p
-        # end
-        # opts.on('-r', '--remote REMOTE', 'Optionally, specify a remote name or url to push changes to') do |p|
-        #   options[:remote] = p
-        # end
         opts.on('-d', 'Perform a dry run without making changes') do |p|
           options[:dry_run] = p
         end
+        opts.on('-a', '--auto', 'Run this script without interaction') do |c|
+          options[:auto] = c
+        end
+        opts.on('-r', '--remote-deploy', "Perform a remote deploy (For CI systems)") do |c|
+          options[:remote] = c
+          options[:auto] = true
+        end
       end.parse!
       m = ModuleDeployer.new(options)
       m.run

data/lib/release_manager/cli/deploy_r10k_cli.rb

@@ -0,0 +1,64 @@
+require 'release_manager/r10k_deployer'
+require 'optparse'
+require 'release_manager/version'
+module ReleaseManager
+  class DeployR10kCli
+
+    def self.puppetfile_path
+      ENV['PUPPET_FILE_PATH'] || File.join(File.expand_path(Dir.pwd), 'Puppetfile')
+    end
+
+    def self.validate(options)
+      if options[:src_ref].nil? or options[:dest_ref].nil?
+        puts "You must supply --source and --dest arguments".red
+        puts @o
+        exit 1
+      end
+
+    end
+
+    def self.run
+      options = {}
+      @o = OptionParser.new do |opts|
+        opts.program_name = 'deploy-r10k'
+        opts.version = ReleaseManager::VERSION
+        opts.on_head(<<-EOF
+    
+Summary: Deploys the source ref into the dest branch by diffing the two and applying the diff.  Generates a merge 
+         request after committing the changes to the dest branch.
+
+   1. fetches the latest code
+   2. creates the necessary remotes
+   3. Forks project
+   4. creates new branch 
+   5. creates diff and applies diff to new branch
+   6. push branch and create merge request
+
+   Examples:
+      deploy-r10k dev qa
+      deploy-r10k -s dev -d qa
+      deploy-r10k -p ~/repos/r10k-control -s dev -d qa
+
+
+        EOF
+        )
+        opts.on('-p', "--puppetfile [PUPPETFILE]", "Path to R10k Puppetfile, defaults to #{puppetfile_path}") do |p|
+          options[:puppetfile] = File.expand_path(p)
+        end
+        opts.on('-s', "--source [SRC_REF]", "The source ref or branch you want to deploy") do |p|
+          options[:src_ref] = p
+        end
+        opts.on('-d', "--dest [DEST_BRANCH]", "The destination branch you want to deploy to") do |p|
+          options[:dest_ref] = p
+        end
+      end
+      @o.parse!
+      options[:puppetfile] = options[:puppetfile] || puppetfile_path
+      options[:src_ref] ||= ARGV[0]
+      options[:dest_ref] ||= ARGV[1]
+      validate(options)
+      path = File.dirname(options[:puppetfile])
+      R10kDeployer.run(path, options)
+    end
+  end
+end

data/lib/release_manager/cli/release_mod_cli.rb

@@ -1,4 +1,19 @@
+# Purpose: release a new version of a module or r10k-control from the src branch by performing
+#          the following tasks:
+#           - bump version in metadata file
+#           - bump changelog version using version in metadata file
+#           - tag the code matching the version in the metadata file
+#           - push to upstream
+#  This script can be used on modules or r10k-control.  If using on a module
+#  be sure to pass in the repo path using --repo.  The repo is where this script
+#  pushes too.
+#
+#  You should also use the -d feature which simulates a run of the script without doing
+#  anything harmful.
+#
+#  Run with -h to see the help
 require 'release_manager/release'
+require 'release_manager/remote_release'
 require 'optparse'
 require 'release_manager/version'
 module ReleaseManager
@@ -35,8 +50,12 @@ Summary: Bumps the module version to the next revision and
         opts.on('--verbose', "Extra logging") do |c|
           options[:verbose] = c
         end
+        opts.on('-r', '--remote-release', "Perform a remote release (For CI systems)") do |c|
+          options[:remote] = true
+        end
       end.parse!
-      r = Release.new(options[:path], options)
+      r = options[:remote] ?
+          RemoteRelease.new(options[:path], options) : Release.new(options[:path], options)
       r.run
     end
   end

data/lib/release_manager/cli/sandbox_create_cli.rb

@@ -1,4 +1,5 @@
 require 'release_manager/sandbox'
+require 'release_manager'
 module ReleaseManager
   class SandboxCreateCli
 

data/lib/release_manager/control_repo.rb

@@ -4,9 +4,12 @@ require 'release_manager/git/utilites'
 
 class ControlRepo
   attr_accessor :path, :repo, :url
+  DEFAULT_BRANCH = ENV['CONTROL_REPO_DEFAULT_BRANCH'] || 'dev'
+  DEFAULT_BRANCHES = ENV['CONTROL_REPO_DEFAULT_BRANCHES'] || %w(dev qa integration acceptance production)
 
   include ReleaseManager::Git::Utilities
   include ReleaseManager::Logger
+  include ReleaseManager::VCSManager
 
   def initialize(path, url = nil)
     @path = path
@@ -32,4 +35,15 @@ class ControlRepo
     @puppetfile
   end
 
+  def commit(message, diff_obj, branch_name, remote = false)
+    message = "[ReleaseManager] - #{message}"
+    if remote
+      actions = diff_2_commit(diff_obj)
+      obj = vcs_create_commit(url, branch_name, message, actions)
+      obj.id if obj
+    else
+      create_commit(message)
+    end
+  end
+
 end

data/lib/release_manager/errors.rb

@@ -11,3 +11,7 @@ class RepoNotFound < Exception; end
 class InvalidModule < Exception; end
 class InvalidToken < Exception; end
 class InvalidSshkey < Exception; end
+class InvalidBranchName < Exception; end
+class PatchError < Exception; end
+class AlreadyReleased < Exception; end
+class TagExists < Exception; end