release_manager 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93411362c88f291cac34ce961bc4c40ab7e524af
-  data.tar.gz: b53bb842f8c4fb2a2990321ccbfc5c6205a46763
+  metadata.gz: 03f488ec3c5ca203a22ebc5fdc6c3f35659fc3ab
+  data.tar.gz: e0d8bc478030066ccaf0aea96a548bcda45461c1
 SHA512:
-  metadata.gz: a09045619e1e27ef1ed4a723326ba7e069b8fb5b1a3b5e342572f06889675f43887addee10028c96a7d19d504c15550c8ee14c532d7693a71db90e912fe012f8
-  data.tar.gz: 4c4ba1d7e48ddd825397e3e315ffe4d48c2b6e9698dc35cffd303a3b87cb0ce39db7e84a5d91f913daeefdc5f46db3ee90db92336730883935c973b72d7aeaa9
+  metadata.gz: bdf95bd7a453b7ae03e108d23808dfce2194e50dfd3a27680d0219ddb32ad05ed45534e282af17f12f3bb8a39e653f905cdc9786b899e6268865a8b5f0a964db
+  data.tar.gz: b9af8ec32da6a2743e822e3451b198d3663062d3866519f6fb19bbf1bab3c0703c66925f824c94d4cf8202b5cdeef677a41cd731d76575bbb4a79a774d1a3788

data/.gitignore

@@ -8,7 +8,10 @@
 /pkg/
 /spec/reports/
 /tmp/
-srv/
+srv/gitlab/data
+srv/gitlab/logs
+.env
+srv2
 bundl
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -2,10 +2,18 @@
 
 ## Unreleased
 
+## 0.6.0
+ * Adds the ability to release-mod to dump a specific SemVer release level
+ * Fixes issue with changelog file not existing
+
 ## 0.5.3
+
  * Fixes output when applying patch
+
 ## 0.5.2
+
  * Adds proper error handling when missing git author name and email with r10k-deploy
+
 ## 0.5.1
  * Fixes missing error object when credentials are not present
  * Fixes error when deploy-r10k is used and remote setting was not set

data/Dockerfile

@@ -1,5 +1,5 @@
 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 apt-get update && apt-get install -y libssh2-1-dev tree git zsh libssh2-1 zlib1g-dev vim cmake && apt-get clean
 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/
@@ -7,8 +7,9 @@ COPY .bash_profile /home/appuser/.bash_profile
 RUN su - appuser -c 'git config --global user.email "user@example.com"' && \
     su - appuser -c 'git config --global user.name "Example User"' && \
     chown -R appuser:appuser /home/appuser/ && \
-    chown -R appuser:appuser /app
-RUN su - appuser -c "BUNDLE_PATH='/home/appuser/.bundle' GEM_HOME='/home/appuser/.gems' bundle install --gemfile=/app/Gemfile" \
+    chown -R appuser:appuser /app && \
+    gem install gitlab rugged
+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
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    release_manager (0.5.3)
+    release_manager (0.6.0)
       gitlab (~> 4.2.0)
       highline (~> 1.7)
       rugged (~> 0.26)
@@ -10,27 +10,26 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.3.0)
-    coderay (1.1.1)
+    coderay (1.1.2)
     diff-lcs (1.3)
     gitlab (4.2.0)
       httparty
       terminal-table
     highline (1.7.8)
-    httparty (0.15.5)
+    httparty (0.15.6)
       multi_xml (>= 0.5.2)
-    method_source (0.8.2)
+    method_source (0.9.0)
     multi_xml (0.6.0)
-    parallel (1.11.2)
+    parallel (1.12.0)
     parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
-    pry (0.10.4)
+    pry (0.11.1)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+      method_source (~> 0.9.0)
     rainbow (2.2.2)
       rake
-    rake (12.0.0)
+    rake (12.1.0)
     rspec (3.6.0)
       rspec-core (~> 3.6.0)
       rspec-expectations (~> 3.6.0)
@@ -44,16 +43,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
-    rubocop (0.49.1)
+    rubocop (0.50.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
+    ruby-progressbar (1.8.3)
     rugged (0.26.0)
-    slop (3.6.0)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     unicode-display_width (1.3.0)
@@ -73,4 +71,4 @@ DEPENDENCIES
   rugged (~> 0.26)
 
 BUNDLED WITH
-   1.15.2
+   1.15.4

data/README.md

@@ -202,6 +202,7 @@ Summary: Bumps the module version to the next revision and
 
     -d, --dry-run                    Do a dry run, without making changes
     -a, --auto                       Run this script without interaction
+    -l, --level			     Semantic versioning level to bump (major.minor.patch), defaults to patch
     -m, --module-path                The path to the module, defaults to current working directory
     -b, --no-bump                    Do not bump the version in metadata.json
     -r, --repo [REPO]                The repo to use, defaults to repo found in the metadata source
@@ -311,6 +312,50 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
+## Develpment Environment Setup
+### Setting up your Gitlab Instance
+1. Ensure you have docker installed
+2. `docker-compose up`
+3. Visit http://localhost:8000/
+4. Create a password  (password123)
+5. Login (root/password123)
+6. Create a user account for yourself (add Admin role)
+7. Logout as Admin and login as the new user account
+8. Add a group named devops and add yourself to this group
+9. Add another group called mirrors and add yourself to this group
+10. Create a `.env` file in the repo directory and paste these contents in it
+  ```ruby
+GITLAB_API_ENDPOINT='http://web/api/v4'
+GITLAB_API_PRIVATE_TOKEN='your token goes here'
+R10K_REPO_URL="git@web:devops/control-repo.git"
+
+  ```
+11. Create an Personal Access Token (API) token for your user account
+12. Replace the token in your .env file
+
+### Configure your release manager client
+1. run `docker-compose run client`
+2. From the container run source .env
+3. From client container `source .bash_profile`
+4. Add the ~/.ssh/id_rsa.pub key to your gitlab account
+5. From the new client container session, run `bundle exec bash app_startup_script.sh`
+6. From the client container, run `bundle exec ruby setup_repos.rb`
+7. From the client container attempt to connect to the git server and accept the key `ssh git@web`
+8. Test to ensure you can clone a repository inside the container `git clone git@web:devops/docker.git /tmp/docker`
+
+### Testing the cli commands
+1. `bundle exec exe/sandbox-create -n my_sandbox -m docker`  # example
+2. `bundle exec exe/release-mod --level minor -m ~/repos/docker`
+
+### Debugging
+if you cannot connect to the gitlab server via ssh you see errros about private key 
+has wrong permission you will need to do the following:
+
+`chmod 600 srv/gitlab/config/ssh_host_ecdsa_key srv/gitlab/config/ssh_host_ed25519_key srv/gitlab/config/ssh_host_rsa_key`
+
+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/app_startup_script.sh

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 
 bundle install
-ssh-add
+ssh-add

data/docker-compose.yml

@@ -1,48 +1,49 @@
-version: '2'
+version: '3'
 services:
-  app:
-    image: nwops/release_manager
+  client:
+    image: nwops/release_manager:latest
     build: .
     entrypoint:
       - ssh-agent
       - /bin/bash
     environment:
-      GEM_HOME: '/home/appuser/.gems'
-      BUNDLE_PATH: '/home/appuser/.bundle'
-      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"
+      - GEM_HOME=/home/appuser/.gems
+      - BUNDLE_PATH=/home/appuser/.bundle
+      - GITLAB_API_ENDPOINT=http://web/api/v4
+      - GITLAB_API_PRIVATE_TOKEN
+      - R10K_REPO_URL="git@web:devops/control-repo.git"
     working_dir: /app
 #    command:
 #      - app_startup_script.sh
     volumes:
       - .:/app
   runner:
-    image: 'registry.gitlab.com/gitlab-org/gitlab-ci-multi-runner:ubuntu-v9.3.0'
+    depends_on:
+      - web
+    image: 'gitlab/gitlab-runner:ubuntu-v9.5.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'
+      - 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'
+      - GITLAB_API_PRIVATE_TOKEN
       #entrypoint:
   web:
-    image: 'gitlab/gitlab-ce:latest'
+    image: 'gitlab/gitlab-ce:9.5.5-ce.0'
     restart: always
-    environment:
-      GITLAB_OMNIBUS_CONFIG: |
-        external_url 'http://web'
+#    environment:
+#      GITLAB_OMNIBUS_CONFIG: |
+#        external_url http://web
     ports:
       - '8000:80'
       - '4433:443'

data/lib/release_manager/changelog.rb

@@ -110,7 +110,7 @@ class Changelog < WorkflowAction
   # checks to make sure the unreleased line is valid, and the file exists
   def self.check_requirements(path)
     log = new(path, nil)
-    log.unreleased_index if File.exists?(log.changelog_file)
+    log.unreleased_index
   end
 
   private

data/lib/release_manager/cli/release_mod_cli.rb

@@ -25,10 +25,10 @@ module ReleaseManager
         opts.version = ReleaseManager::VERSION
         opts.on_head(<<-EOF
 
-Summary: Bumps the module version to the next revision and 
+Summary: Bumps the module version to the next revision and
          updates the changelog.md file with the new
          version by reading the metadata.json file. This should
-         be run inside a module directory. 
+         be run inside a module directory.
 
         EOF
         )
@@ -36,7 +36,10 @@ Summary: Bumps the module version to the next revision and
           options[:dry_run] = c
         end
         opts.on('-a', '--auto', 'Run this script without interaction') do |c|
-          options[:auto] = c
+          options[:auto] = c 
+        end
+        opts.on('-l', '--level [LEVEL]', 'Semantic versioning level to bump (major,minor,patch), defaults to patch') do |c|
+          options[:level] = c 
         end
         opts.on('-m', '--module-path [MODULEPATH]', "The path to the module, defaults to #{Dir.getwd}") do |c|
           options[:path] = c
@@ -54,6 +57,15 @@ Summary: Bumps the module version to the next revision and
           options[:remote] = true
         end
       end.parse!
+
+      # default to patch
+      options[:level] ||= 'patch'
+
+      # validate -l, --level input
+      unless %w(major minor patch).include?(options[:level])
+        puts "expected major minor or patch for parameter -l,  --level. You supplied #{options[:level]}.".fatal
+        exit 1
+      end
       r = options[:remote] ?
           RemoteRelease.new(options[:path], options) : Release.new(options[:path], options)
       r.run

data/lib/release_manager/puppet_module.rb

@@ -16,7 +16,7 @@ class PuppetModule < WorkflowAction
  def initialize(mod_path, upstream = nil)
    raise ModNotFoundException.new("#{mod_path} is not a valid puppet module path") if mod_path.nil?
    @path = mod_path
-   @upstream = upstream 
+   @upstream = upstream
    @metadata_file = File.join(mod_path, 'metadata.json')
  end
 
@@ -33,8 +33,8 @@ class PuppetModule < WorkflowAction
  def name
    namespaced_name.split(/\/|\-/).last
  end
- 
- def namespaced_name 
+
+ def namespaced_name
    metadata['name']
  end
 
@@ -105,6 +105,28 @@ class PuppetModule < WorkflowAction
    metadata['version']
  end
 
+ # @returns [String] the next version based on the release level
+ def next_version(level = 'patch')
+   return unless version
+   pieces = version.split('.')
+   raise "invalid semver structure #{version}" if pieces.count != 3
+
+   case level
+     when 'major'
+       pieces[2] = '0'
+       pieces[1] = '0'
+       pieces[0] = pieces[0].next
+     when 'minor'
+       pieces[2] = '0'
+       pieces[1] = pieces[1].next
+     when 'patch'
+       pieces[2] = pieces[2].next
+     else
+       raise "expected semver release level major, minor or patch"
+   end
+   pieces.join('.')
+ end
+
  # @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)
@@ -120,32 +142,17 @@ class PuppetModule < WorkflowAction
 
  # Updates the version in memory
  def bump_patch_version
-    return unless version
-    pieces = version.split('.')
-    raise "invalid semver structure #{version}" if pieces.count != 3
-    pieces[2] = pieces[2].next
-    metadata['version'] = pieces.join('.')
+    metadata['version'] = next_version('patch')
  end
 
  # Updates the version in memory
  def bump_minor_version
-    return unless version
-    pieces = version.split('.')
-    raise "invalid semver structure #{version}" if pieces.count != 3
-    pieces[2] = '0'
-    pieces[1] = pieces[1].next
-    metadata['version'] = pieces.join('.')
+    metadata['version'] = next_version('minor')
  end
 
  # Updates the version in memory
  def bump_major_version
-    return unless version
-    pieces = version.split('.')
-    raise "invalid semver structure #{version}" if pieces.count != 3
-    pieces[2] = '0'
-    pieces[1] = '0'
-    pieces[0] = pieces[0].next
-    metadata['version'] = pieces.join('.')
+    metadata['version'] = next_version('major')
  end
 
  def to_s

data/lib/release_manager/release.rb

@@ -6,16 +6,16 @@ class Release
   include ReleaseManager::Logger
 
   def initialize(path = Dir.getwd, options = {})
-    @path = path || Dir.getwd    
+    @path = path || Dir.getwd
     @options = options
   end
-  
+
   def puppet_module
     @puppet_module ||= PuppetModule.new(path, upstream_repo)
   end
 
-  def upstream_repo 
-    options[:repo] || ENV['UPSTREAM_REPO']  
+  def upstream_repo
+    options[:repo] || ENV['UPSTREAM_REPO']
   end
 
   # @returns [String] the version found in the metadata file
@@ -23,8 +23,13 @@ class Release
      dry_run? ? next_version : puppet_module.version
   end
 
+  # @returns [String] the release level
+  def level
+     options[:level] || 'patch'
+  end
+
   def next_version
-    puppet_module.version.next
+    puppet_module.next_version(level)
   end
 
   def tag(id)
@@ -41,7 +46,9 @@ class Release
       return
     end
     raise TagExists.new("Tag v#{version} already exists") if puppet_module.tag_exists?("v#{next_version}", options[:remote])
-    version = puppet_module.bump_patch_version unless options[:bump]
+    if puppet_module.respond_to?("bump_#{level}_version".to_sym)
+      version = puppet_module.public_send("bump_#{level}_version".to_sym) unless options[:bump]
+    end
     # save the update version to the metadata file, then commit
     puppet_module.commit_metadata(options[:remote])
   end
@@ -95,9 +102,9 @@ class Release
     end
   end
 
-  # runs all the required steps to release the software 
+  # runs all the required steps to release the software
   # currently this must be done manually by a release manager
-  # 
+  #
   def release
     unless auto_release?
       print "Have you merged your code?  Did you fetch and rebase against the upstream?  Want to continue (y/n)?: ".yellow
@@ -114,7 +121,7 @@ class Release
     # tags the r10k-module with the version found in the metadata.json file
     tag(id)
     # pushes the updated code and tags to the upstream repo
-    if auto_release? 
+    if auto_release?
      push
      return
     end
@@ -125,8 +132,8 @@ class Release
       $?.success?
     else
       puts "Nah, forget it, this release wasn't that cool anyways.".yellow
-      false 
-    end 
+      false
+    end
   end
 
   def add_upstream_remote