release_manager 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29e40c47ad25725e971c4fd352be640e3c099aa1
+  data.tar.gz: 262a70fdf287925fca29d271163b5b13a0681225
+SHA512:
+  metadata.gz: 8abb760003a84f0be08fcc20cd7705b238f033aa9c5a0eece9d73c60b5b1514e0ad5ec3b96e7439414cd5cf07faef492a6fa82ec6818b7a8d9f2e9a29880382e
+  data.tar.gz: f44e93faaa946b2732adb4654db2a37f85539d6a395d697961fe52a55926ea83ab54d86c3043d45e2b643da6f240ae25df330cd84cca4615ea3468b6045b53da

data/.bash_profile

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+#
+# setup ssh-agent
+#
+export PATH=~/.gems/bin:$PATH
+
+# set environment variables if user's agent already exists
+[ -z "$SSH_AUTH_SOCK" ] && SSH_AUTH_SOCK=$(ls -l /tmp/ssh-*/agent.* 2> /dev/null | grep $(whoami) | awk '{print $9}')
+[ -z "$SSH_AGENT_PID" -a -z `echo $SSH_AUTH_SOCK | cut -d. -f2` ] && SSH_AGENT_PID=$((`echo $SSH_AUTH_SOCK | cut -d. -f2` + 1))
+[ -n "$SSH_AUTH_SOCK" ] && export SSH_AUTH_SOCK
+[ -n "$SSH_AGENT_PID" ] && export SSH_AGENT_PID
+
+# start agent if necessary
+if [ -z $SSH_AGENT_PID ] && [ -z $SSH_TTY ]; then  # if no agent & not in ssh
+  eval `ssh-agent -s` > /dev/null
+fi
+
+# setup addition of keys when needed
+if [ -z "$SSH_TTY" ] ; then                     # if not using ssh
+  ssh-add -l > /dev/null                        # check for keys
+  if [ $? -ne 0 ] ; then
+    alias ssh='ssh-add -l > /dev/null || ssh-add && unalias ssh ; ssh'
+    if [ -f "/usr/lib/ssh/x11-ssh-askpass" ] ; then
+      SSH_ASKPASS="/usr/lib/ssh/x11-ssh-askpass" ; export SSH_ASKPASS
+    fi
+  fi
+fi

data/.dockerignore

@@ -0,0 +1 @@
+.bundle

data/.env

@@ -0,0 +1,3 @@
+export GITLAB_API_ENDPOINT='http://web/api/v3'
+export GITLAB_API_PRIVATE_TOKEN='A_zJJfgE8P-8mFGK2_r9'
+export R10K_REPO_URL="git@web:devops/control-repo.git"

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+.idea
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+srv/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Release Manager
+## Unreleased
+
+## v0.3.0
+ * Fixes color with fatal errors
+ * Changes PuppetModule to use rugged commit commands
+ * Auto corrects bad source attribute with metadata.json
+ * Adds new methods to git utilities
+ * Fixes error when fetching remotes that do not exist
+ * Fixes issue where pushing of remotes via url failed
+ * Adds automatic fetching or remote before creating branch from remote
+ * Fixes #11 - Add output during dry run for deploy-mod
+## v0.2.4
+ * Fixes puppetfile not return instance of controlmod
+## v0.2.3
+ * Allows the user to add new modules when they don't already exist
+ * Sets the upstream url based on the module source defined in metadata
+## v0.2.2
+ * Fixes issue when existing branch exists on remote but not local
+ * improves docker setup
+ * Fixes issue where module branch was not pushed
+## v0.2.1
+ * Improves docker setup
+ * Removes ability to push upon deploying module
+ * Fixes issue with git source not updating when deploying module
+ * Refactors cli into individual files
+ * Removes checking of modules before sandbox creation
+ 
+## v0.2.0
+ * adds the ability to auto generate a complete r10k sandbox
+ * adds gitlab adapter
+ * adds rugged git dependency
+## v0.1.8
+ * Fix pinning of version to puppetfile
+ * adds more testing
+ 
+## v0.1.7
+ * Adds more tests
+ * Fixes typos
+ * Fixes issue with push and commit during deployment
+ * Fixes stack level issue when calling upstream
+ * Adds ability to easily add upstream remote 
+## v0.1.6
+ * add dry run to deploy-mod
+ 
+## v0.1.5
+ * Fixes an issue where the latest tag was not being selected correctly
+
+## v0.1.4
+ * Fixes #8 - upstream does not exist
+ * Fixes #9 - bump changelog assumes changelog exists
+ * Fixes #10 - executable scripts should communicate options more clearly
+ 
+## v0.1.0
+* initial implementation

data/Dockerfile

@@ -0,0 +1,14 @@
+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 \
+    && chown appuser:appuser /app
+COPY ./Gemfile* /app/
+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" \
+    && rm -f /app/*
+# update PATH to find local gems
+USER appuser

data/Gemfile

@@ -0,0 +1,14 @@
+source ENV['GEM_SOURCE'] ||'https://rubygems.org'
+# Specify your gem's dependencies in release_manager.gemspec
+gem 'gitlab', '~> 3.7.0'
+gem 'rugged'
+
+group :test do
+  gem 'pry'
+  gem 'rubocop'
+  gem 'rake'
+  gem 'rspec'
+  gem 'bundler'
+  # 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'))
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    release_manager (0.3.0)
+      gitlab (~> 3.7.0)
+      rugged
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    gitlab (3.7.0)
+      httparty (~> 0.13.0)
+      terminal-table
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.6)
+    method_source (0.8.2)
+    multi_xml (0.6.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.48.1)
+      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)
+    slop (3.6.0)
+    terminal-table (1.7.3)
+      unicode-display_width (~> 1.1.1)
+    unicode-display_width (1.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  gitlab (~> 3.7.0)
+  pry
+  rake
+  release_manager!
+  rspec
+  rubocop
+  rugged
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Corey Osman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,311 @@
+```shell
+
+__________       .__                                   _____                                             
+\______   \ ____ |  |   ____ _____    ______ ____     /     \ _____    ____ _____     ____   ___________ 
+ |       _// __ \|  | _/ __ \\__  \  /  ___// __ \   /  \ /  \\__  \  /    \\__  \   / ___\_/ __ \_  __ \
+ |    |   \  ___/|  |_\  ___/ / __ \_\___ \\  ___/  /    Y    \/ __ \|   |  \/ __ \_/ /_/  >  ___/|  | \/
+ |____|_  /\___  >____/\___  >____  /____  >\___  > \____|__  (____  /___|  (____  /\___  / \___  >__|   
+        \/     \/          \/     \/     \/     \/          \/     \/     \/     \//_____/      \/       
+```
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [ReleaseManager](#releasemanager)
+  - [Installation](#installation)
+    - [Install directly from source](#install-directly-from-source)
+  - [The workflow problem](#the-workflow-problem)
+    - [R10k Sandbox Creation Steps (the hard way)](#r10k-sandbox-creation-steps-the-hard-way)
+    - [R10k Sandbox Creation steps (the easy way)](#r10k-sandbox-creation-steps-the-easy-way)
+  - [Usage](#usage)
+    - [sandbox-create](#sandbox-create)
+    - [release-mod](#release-mod)
+    - [deploy-mod](#deploy-mod)
+    - [bump-changelog](#bump-changelog)
+  - [Configuration Settings](#configuration-settings)
+    - [Sandbox-create environment variables](#sandbox-create-environment-variables)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# ReleaseManager
+
+This gem provides workflow automations around releasing and deploying puppet modules within r10k environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'release_manager'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install release_manager
+    
+### Install directly from source
+If you don't have access to a gem server you can use the `specific_install` gem.  This will install the latest version
+directly from source.
+
+```
+gem install specific_install  # unless already installed
+gem specific_install <git url to release manager>  
+
+ie. gem specific_install git@github.com/nwops/release_manager.git
+```
+
+
+## The workflow problem
+R10k allows us to create a puppet environment for each branch on the r10k-control repository. This makes isolating code deployments
+simple to use because each branch corresponds to a puppet environment.  However, this workflow implies that you will fork
+all the modules you work on and create branches on those forks.  Additionally, you then need to update the r10k-control Puppetfile
+to use those new branches and forks.  This can be a huge burden and consume some of your time.  Below is an example of that workflow.
+
+### R10k Sandbox Creation Steps (the hard way)
+1. fork r10k-control
+2. clone r10k-control fork
+3. create new branch called my_sandbox on r10k-control fork
+4. Decide which module(s) you need to work on  (ie. roles, profiles, sqlserver) for a given sandbox (branch)
+5. Fork the roles repo
+6. Fork the profiles repo
+7. Fork the sqlserver repo
+8. Clone all three of the forked repos above
+9. Create a branch called my_sandbox on each of the repos above
+10. Update the puppetfile in r10k-control to use your fork and branch for each module above
+11. Commit the puppetfile
+12. Push the commit to the r10k-control
+13. Add the upstream remote for all of the repos you just cloned
+14. Add members to your forked projects
+15. push new branch on each forked project
+
+Yikes!  This is a long list of things to do.  It is human nature to skip some or all of these steps to save time even though
+it is in our best interest to follow these steps.  As humans we will always resort to the path of least resistance. 
+
+In an effort to force good practices and reduce time and effort, release-manager will automate almost all of the tasks into 
+a single command called `sandbox-create`.
+
+Additionally there are other commands that help with the release and deploy process of modules to the r10k-control repository.
+
+### R10k Sandbox Creation steps (the easy way)
+`sandbox-create -n my_sandbox --modules='roles,profiles,hieradata,sqlserver'`  
+
+## Usage
+
+Release manager provides the following commands to help you create sandboxes, release and deploy puppet code.
+
+### sandbox-create
+The sandbox-create command wraps all the git, git cloning, and git forking tasks into a single command.  Usage of this command
+will save you a great deal of time upon each run.
+
+Please note: this requires the usage of [ssh-agent](#ssh-agent-usage). 
+
+
+```
+Usage: sandbox-create [options]
+
+Summary: Creates a new r10k sandbox by forking and creating a new branch on r10k-control,
+         creates a fork and branch for each module passed in, adds the upstream remote
+         for each module, updates the r10k-control Puppetfile to use those forks and branches
+         and pushes the branch to the upstream r10k-control.
+
+Example: sandbox-create -n my_sandbox -m "roles,profiles,developer"
+Example: sandbox-create -n my_sandbox -m "roles,profiles,developer" --members="p1dksk2, p2ksdafs,devops,ci_runner" 
+
+
+Note: If you already have any of these modules cloned, this script will attempt to update those modules
+      using git fetch and git checkout -b sandbox_name upstream/master.  So this should not destroy anything.
+
+        --members DEFAULT_MEMBERS    A comman seperated list of members to add to forked projects
+    -n, --name NAME                  The name of your sandbox
+        --control-url R10K_REPO_URL  git url to the r10k-control repo, defaults to R10K_CONTROL_URL env variable
+    -m, --modules MODULES            A comma separated list of modules names from the Puppetfile to fork and branch
+    -r, --repos-dir [REPOS_PATH]     The repos path to clone modules to. Defaults to: /home/appuser/repos
+    -c, --control-dir [CONTROL_DIR]  The r10k-control repo path. Defaults to: /home/appuser/repos/r10k-control
+        --verbose                    Extra logging
+
+
+```
+
+Example Run
+
+```shell
+appuser@28523330e507:/app$ export DEFAULT_MODULES=gitlab 
+appuser@28523330e507:/app$ export DEFAULT_MEMBERS=r10k_user,ci_runner
+appuser@28523330e507:/app$ sandbox-create -n sdafsd -m r10k
+
+INFO - ReleaseManager: Resetting upstream remote to git@web:cosman/control-repo.git for /home/appuser/repos/r10k-control
+INFO - ReleaseManager: Fetching upstream from git@web:cosman/control-repo.git
+INFO - ReleaseManager: Resetting upstream remote to git@web:devops/control-repo.git for /home/appuser/repos/r10k-control
+INFO - ReleaseManager: Fetching upstream from git@web:devops/control-repo.git
+INFO - ReleaseManager: Checking out branch: upstream/dev for /home/appuser/repos/r10k-control
+INFO - ReleaseManager: Fetching upstream from git@web:cosman/r10k.git
+INFO - ReleaseManager: Fetching upstream from git@web:cosman/r10k.git
+INFO - ReleaseManager: Updating r10k-control Puppetfile to use fork: git@web:cosman/r10k.git with branch: sdafsd
+INFO - ReleaseManager: Adding member r10k_user to project cosman/puppet-gitlab
+INFO - ReleaseManager: Adding member ci_runner to project cosman/puppet-gitlab
+INFO - ReleaseManager: Resetting upstream remote to git@web:cosman/puppet-gitlab.git for /home/appuser/repos/gitlab
+INFO - ReleaseManager: Fetching upstream from git@web:cosman/puppet-gitlab.git
+INFO - ReleaseManager: Fetching upstream from git@web:cosman/puppet-gitlab.git
+INFO - ReleaseManager: Updating r10k-control Puppetfile to use fork: git@web:cosman/puppet-gitlab.git with branch: sdafsd
+INFO - ReleaseManager: Checking out branch: sdafsd for /home/appuser/repos/r10k-control
+INFO - ReleaseManager: Committing Puppetfile changes to r10k-control branch: sdafsd
+
+```
+
+**Note: This script assumes you will have the following environment variables set:**
+
+You can throw this in your .bash_profile or .zprofile and have this set automatically for each run.
+
+Example Only:
+
+```
+export GITLAB_API_ENDPOINT='http://web/api/v3'
+export GITLAB_API_PRIVATE_TOKEN='A_zJJfgE8P-8mFGK2_r9'
+export R10K_REPO_URL="git@web:devops/control-repo.git"
+
+```
+
+### release-mod
+The `release-mod` command will help you release new module and r10k-control repo code by doing the following
+1. increment the version in the metadata.json file version field
+2. increment the version in the changelog file
+3. create a commit with the above changes
+4. create a git tag with the name as the version ie. v0.1.4
+5. push the changes and tag to the upstream repo using the metadata.json's source field
+
+```
+Usage: release-mod [options]
+
+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.
+
+    -d, --dry-run                    Do a dry run, without making changes
+    -a, --auto                       Run this script without interaction
+    -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
+        --verbose                    Extra logging
+```
+
+### deploy-mod
+The `deploy-mod` command assists you with updating an r10k environment with the new module version by doing the following.
+1. search the r10k-control repo's Puppetfile for a module with a similar name of the current module
+2. removes the branch or ref argument from the "mod" declaration
+3. adds a tag argument with the latest version defined in the module's metadata.json file.
+
+You can also optionally pass in the `--commmit` flag to create a commit.  
+
+Additonally if you wish to push the current branch you can also
+pass in the `--push` and `--remote r10k-control` option.
+
+```
+Usage: deploy-mod [options]
+
+Summary: Gets the version of your module found in the metadata
+         and populates the r10k-control Puppetfile with the updated
+         tag version. Revmoes any branch or ref reference and replaces
+         with tag.  Currently it is up to you to commit and push the Puppetfile change.
+
+    -p, --puppetfile PUPPETFILE      Path to R10k Puppetfile, defaults to ~/repos/r10k-control/Puppetfile
+    -m, --modulepath MODULEPATH      Path to to module, defaults to: /home/p1cxom2/repos/release_manager
+    -c, --commit                     Commit the Puppetfile change
+    -u, --push                       Push the changes to the remote
+    -r, --remote REMOTE              Remote name or url to push changes to
+```
+
+### bump-changelog
+The `bump-changelog` command simply changes 'Unreleased' section with the version string found the in the module's metadata file
+and creates a new 'Unrelease Section on top
+1. increment version in changelog
+2. create commit with change
+
+If using the `release-mod` command there is no need to run the `bump-changelog`command as it is part of the process already.
+
+
+## Configuration Settings
+The following environment variables will automatically set required parameters and defaults.  It is suggested you put 
+this in your shell script like .bash_profile or .zprofile
+
+### Sandbox-create environment variables
+
+GITLAB_API_ENDPOINT - The api path to the gitlab server (ie. https://gitlab.com/api/v3)
+
+GITLAB_API_PRIVATE_TOKEN - The gitlab user api token 
+
+DEFAULT_MODULES - The default set of modules to use when creating a sandbox  (ie. hieradata)
+
+R10K_REPO_URL - The git repo url to r10k-control (ie. git@gitlab.com:nwops/r10k-control.git)
+
+DEFAULT_MEMBERS - The default members each forked project should add permissions to (ie, 'ci_runner', 'r10k_user')
+
+## Ssh agent usage
+In order to use sandbox-create you need to ensure you have ssh-agent running in the background and the following 
+environment variables are exported.  In some cases you might have this automated via a shell login script.
+
+* SSH_AUTH_SOCK
+* SSH_AGENT_PID
+
+Automated usage
+
+```
+#!/usr/bin/env bash
+#
+# setup ssh-agent
+#
+# set environment variables if user's agent already exists
+[ -z "$SSH_AUTH_SOCK" ] && SSH_AUTH_SOCK=$(ls -l /tmp/ssh-*/agent.* 2> /dev/null | grep $(whoami) | awk '{print $9}')
+[ -z "$SSH_AGENT_PID" -a -z `echo $SSH_AUTH_SOCK | cut -d. -f2` ] && SSH_AGENT_PID=$((`echo $SSH_AUTH_SOCK | cut -d. -f2` + 1))
+[ -n "$SSH_AUTH_SOCK" ] && export SSH_AUTH_SOCK
+[ -n "$SSH_AGENT_PID" ] && export SSH_AGENT_PID
+
+# start agent if necessary
+if [ -z $SSH_AGENT_PID ] && [ -z $SSH_TTY ]; then  # if no agent & not in ssh
+  eval `ssh-agent -s` > /dev/null
+fi
+
+# setup addition of keys when needed
+if [ -z "$SSH_TTY" ] ; then                     # if not using ssh
+  ssh-add -l > /dev/null                        # check for keys
+  if [ $? -ne 0 ] ; then
+    alias ssh='ssh-add -l > /dev/null || ssh-add && unalias ssh ; ssh'
+    if [ -f "/usr/lib/ssh/x11-ssh-askpass" ] ; then
+      SSH_ASKPASS="/usr/lib/ssh/x11-ssh-askpass" ; export SSH_ASKPASS
+    fi
+  fi
+fi
+
+```
+Manual Usage
+
+```
+ssh-agent bash
+ssh-add
+# this should prompt for password if your ssh key is protected
+
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on release_manager.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+