octopolo 0.0.1

data/lib/octopolo/commands/accept_pull.rb

@@ -0,0 +1,8 @@
+arg :pull_request_id
+desc 'Accept pull requests. Merges the given pull request into master and updates the changelog.'
+command 'accept-pull' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../scripts/accept_pull'
+    Octopolo::Scripts::AcceptPull.execute args.first
+  end
+end

data/lib/octopolo/commands/compare_release.rb

@@ -0,0 +1,9 @@
+arg :start, :name => 'starting_tag', :optional => true
+arg :stop,  :name => 'ending_tag',   :optional => true
+desc 'Opens up a link to compare releases'
+command 'compare-release' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../scripts/compare_release'
+    Octopolo::Scripts::CompareRelease.execute args[0], args[1]
+  end
+end

data/lib/octopolo/commands/deployable.rb

@@ -0,0 +1,8 @@
+arg :pull_request_id
+desc 'Merges PR into the deployable branch'
+command 'deployable' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../scripts/deployable'
+    Octopolo::Scripts::Deployable.execute args.first
+  end
+end

data/lib/octopolo/commands/github_auth.rb

@@ -0,0 +1,5 @@
+desc 'Generate a GitHub auth token for octopolo commands to use.'
+command 'github-auth' do |c|
+  require_relative '../scripts/github_auth'
+  c.action { Octopolo::Scripts::GithubAuth.execute }
+end

data/lib/octopolo/commands/new_branch.rb

@@ -0,0 +1,9 @@
+arg :new_branch_name,    :name => 'new_branch_name'
+arg :source_branch_name, :name => 'source_branch_name', :optional => true
+desc 'Create a new branch for features, bug fixes, or experimentation.'
+command 'new-branch' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../scripts/new_branch'
+    Octopolo::Scripts::NewBranch.execute args[0], args[1]
+  end
+end

data/lib/octopolo/commands/new_deployable.rb

@@ -0,0 +1,8 @@
+desc "Create a new deployable branch"
+long_desc "Create a new deployable branch with today's date and remove the others.
+
+Useful when we have changes in the current deployable branch that we wish to remove."
+command 'new-deployable' do |c|
+  require_relative '../scripts/new_deployable'
+  c.action { Octopolo::Scripts::NewDeployable.new.execute }
+end

data/lib/octopolo/commands/new_staging.rb

@@ -0,0 +1,8 @@
+desc "Create a new staging branch"
+long_desc "Create a new staging branch with today's date and remove the others.
+
+Useful when we have changes in the current staging branch that we wish to remove."
+command 'new-staging' do |c|
+  require_relative '../scripts/new_staging'
+  c.action { Octopolo::Scripts::NewStaging.new.execute }
+end

data/lib/octopolo/commands/octopolo_setup.rb

@@ -0,0 +1,5 @@
+desc 'Basic setup for octoplo'
+command 'setup' do |c|
+  require_relative '../scripts/octopolo_setup'
+  c.action { Octopolo::Scripts::OctopoloSetup.invoke }
+end

data/lib/octopolo/commands/pivotal_auth.rb

@@ -0,0 +1,5 @@
+desc 'Generate a Pivotal Tracker auth token for Octopolo commands to use.'
+command 'pivotal-auth' do |c|
+  require_relative '../scripts/pivotal_auth'
+  c.action { Octopolo::Scripts::PivotalAuth.execute }
+end

data/lib/octopolo/commands/pull_request.rb

@@ -0,0 +1,13 @@
+desc "Create a pull request from the current branch to the application's designated deploy branch."
+command 'pull-request' do |c|
+  config = Octopolo::Config.parse
+
+  c.desc "Branch to create the pull request against"
+  c.flag [:d, :dest, :destination], :arg_name => "destination_branch", :default_value => config.deploy_branch
+
+  c.action do |global_options, options, args|
+    require_relative '../scripts/pull_request'
+    options = global_options.merge(options)
+    Octopolo::Scripts::PullRequest.execute options[:destination_branch]
+  end
+end

data/lib/octopolo/commands/signoff.rb

@@ -0,0 +1,10 @@
+arg :pull_request_id
+
+desc 'Provide standardized signoff message to a pull request.'
+long_desc "pull_request_id - The ID of the pull request to sign off on"
+command 'signoff' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../scripts/signoff'
+    Octopolo::Scripts::Signoff.execute args.first
+  end
+end

data/lib/octopolo/commands/stage_up.rb

@@ -0,0 +1,8 @@
+arg :pull_request_id
+desc 'Merges PR into the staging branch'
+command 'stage-up' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../scripts/stage_up'
+    Octopolo::Scripts::StageUp.execute args.first
+  end
+end

data/lib/octopolo/commands/stale_branches.rb

@@ -0,0 +1,11 @@
+desc "View and delete stale branches"
+command 'stale-branches' do |c|
+  c.desc "Delete the stale branches (default: false)"
+  c.switch :delete, :negatable => false
+
+  c.action do |global_options, options, args|
+    require_relative '../scripts/stale_branches'
+    options = global_options.merge(options)
+    Octopolo::Scripts::StaleBranches.new(options[:delete]).execute
+  end
+end

data/lib/octopolo/commands/sync_branch.rb

@@ -0,0 +1,11 @@
+config = Octopolo::Config.parse
+long_desc "branch - Which branch to merge into yours (default: #{config.deploy_branch})"
+
+arg :branch
+desc "Merge the #{config.deploy_branch} branch into the current working branch"
+command 'sync-branch' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../scripts/sync_branch'
+    Octopolo::Scripts::SyncBranch.execute args.first
+  end
+end

data/lib/octopolo/commands/tag_release.rb

@@ -0,0 +1,13 @@
+arg :suffix, :desc => "Suffix to apply to to the dated tag"
+
+desc "Create and push a timestamped tag with an optional suffix"
+command 'tag-release' do |c|
+  c.desc "Create tag even if not on deploy branch"
+  c.switch :force, :negatable => false
+
+  c.action do |global_options, options, args|
+    require_relative '../scripts/tag_release'
+    options = global_options.merge(options)
+    Octopolo::Scripts::TagRelease.execute args.first, options[:force]
+  end
+end

data/lib/octopolo/config.rb

@@ -0,0 +1,146 @@
+require "date" # necessary to get the Date.today convenience method
+require "yaml"
+require_relative "user_config"
+
+module Octopolo
+  class Config
+    FILE_NAMES = %w[.octopolo.yml .automation.yml]
+
+    RECENT_TAG_LIMIT = 9
+    # we use date-based tags, so look for anything starting with a 4-digit year
+    RECENT_TAG_FILTER = /^\d{4}.*/
+
+    attr_accessor :cli
+
+    def initialize(attributes={})
+      self.cli = Octopolo::CLI
+
+      assign attributes
+      load_plugins
+    end
+
+    # default values for these customizations
+    def deploy_branch
+      @deploy_branch || "master"
+    end
+
+    def branches_to_keep
+      @branches_to_keep || []
+    end
+
+    def deploy_environments
+      @deploy_environments || []
+    end
+
+    def deploy_methods
+      @deploy_methods || []
+    end
+
+    def github_repo
+      @github_repo || raise(MissingRequiredAttribute, "GitHub Repo is required")
+    end
+
+    def user_notifications
+      if [NilClass, Array, String].include?(@user_notifications.class)
+        Array(@user_notifications) if @user_notifications
+      else
+        raise(InvalidAttributeSupplied, "User notifications must be an array or string")
+      end
+    end
+
+    def plugins
+      case @plugins
+      when Array, String then Array(@plugins)
+      when NilClass then []
+      else
+        raise(InvalidAttributeSupplied, "Plugins must be an array or string")
+      end
+    end
+
+    def use_pivotal_tracker
+      !!@use_pivotal_tracker
+    end
+
+    def use_jira
+      !!@use_jira
+    end
+
+    def jira_user
+      @jira_user || raise(MissingRequiredAttribute, "Jira User is required") if use_jira
+    end
+
+    def jira_password
+      @jira_password || raise(MissingRequiredAttribute, "Jira Password is required") if use_jira
+    end
+
+    def jira_url
+      @jira_url || raise(MissingRequiredAttribute, "Jira Url is required") if use_jira
+    end
+
+    # end defaults
+
+    def self.parse
+      new(attributes_from_file)
+    end
+
+    def self.attributes_from_file
+      YAML.load_file(octopolo_config_path)
+    end
+
+    def self.octopolo_config_path
+      if filepath = FILE_NAMES.detect {|filename| File.exists?(filename)}
+        File.join(Dir.pwd, filepath)
+      else
+        old_dir = Dir.pwd
+        Dir.chdir('..')
+        if old_dir != Dir.pwd
+          octopolo_config_path
+        else
+          Octopolo::CLI.say "Could not find #{FILE_NAMES.join(' or ')}"
+          exit
+        end
+      end
+    end
+
+    def load_plugins
+      plugins.each do |plugin|
+        begin
+          require plugin
+        rescue LoadError
+          puts "Plugin '#{plugin}' failed to load"
+        end
+      end
+    end
+
+    def assign(attributes)
+      attributes.each do |key, value|
+        self.instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def basedir
+      File.basename File.dirname Config.octopolo_config_path
+    end
+
+    def remote_branch_exists?(branch)
+      branches = Octopolo::CLI.perform "git branch -r", false
+      branch_list = branches.split(/\r?\n/)
+      branch_list.each { |x| x.gsub!(/\*|\s/,'') }
+      branch_list.include? "origin/#{branch}"
+    end
+
+    def app_name
+      basedir
+    end
+
+    # To be used when attempting to call a Config attribute for which there is
+    # a value supplied that is of not the correct type
+    InvalidAttributeSupplied = Class.new(StandardError)
+    # To be used when attempting to call a Config attribute for which there is
+    # no sensible default and one hasn't been supplied by the app
+    MissingRequiredAttribute = Class.new(StandardError)
+    # To be used when looking for a branch of a given type (like staging or
+    # deployable), but none exist.
+    NoBranchOfType = Class.new(StandardError)
+  end
+end

data/lib/octopolo/convenience_wrappers.rb

@@ -0,0 +1,46 @@
+module Octopolo
+  # Provide access to the CLI class into other classes in the application
+  module CLIWrapper
+    attr_accessor :cli
+
+    # Public: Wrapper method around CLI class
+    #
+    # Returns the CLI class or equivalent
+    def cli
+      @cli ||= CLI
+    end
+  end
+
+  # Provide access to the config into other classes in the application
+  module ConfigWrapper
+    attr_accessor :config
+
+    # Public: Wrapper around the user's and app's configuration
+    #
+    # Returns an instance of Config or equivalent
+    def config
+      @config ||= Octopolo.config
+    end
+  end
+
+  # Provide access to user-supplied configuration values
+  module UserConfigWrapper
+    attr_accessor :user_config
+
+    # Returns an instance of UserConfig or equivalent
+    def user_config
+      @user_config ||= UserConfig.parse
+    end
+  end
+
+  module GitWrapper
+    attr_accessor :git
+
+    # Public: Wrapper method around Git class
+    #
+    # Returns the Git class or equivalent
+    def git
+      @git ||= Git
+    end
+  end
+end

data/lib/octopolo/dated_branch_creator.rb

@@ -0,0 +1,81 @@
+require_relative "git"
+require_relative "scripts/new_branch"
+require "date"
+
+module Octopolo
+  class DatedBranchCreator
+    include ConfigWrapper
+    include CLIWrapper
+    include GitWrapper
+
+    attr_accessor :branch_type
+
+    # Public: Initialize a new instance of DatedBranchCreator
+    #
+    # branch_type - Name of the type of branch (e.g., staging or deployable)
+    def initialize(branch_type)
+      self.branch_type = branch_type
+    end
+
+    # Public: Create a new branch of the given type for today's date
+    #
+    # branch_type - Name of the type of branch (e.g., staging or deployable)
+    #
+    # Returns a DatedBranchCreator
+    def self.perform(branch_type)
+      new(branch_type).tap do |creator|
+        creator.perform
+      end
+    end
+
+    # Public: Create the branch and handle related processing
+    def perform
+      create_branch
+      delete_old_branches
+    end
+
+    # Public: Create the desired branch
+    def create_branch
+      git.new_branch(branch_name, config.deploy_branch)
+    end
+
+    # Public: The date suffix to append to the branch name
+    def date_suffix
+      Date.today.strftime("%Y.%m.%d")
+    end
+
+    # Public: The name of the branch to create
+    def branch_name
+      case branch_type
+      when Git::DEPLOYABLE_PREFIX, Git::STAGING_PREFIX, Git::QAREADY_PREFIX
+        "#{branch_type}.#{date_suffix}"
+      else
+        raise InvalidBranchType, "'#{branch_type}' is not a valid branch type"
+      end
+    end
+
+    # Public: If necessary, and if user opts to, delete old branches of its type
+    def delete_old_branches
+      if extra_branches.any? && cli.ask_boolean("Do you want to delete the old #{branch_type} branch(es)? (#{extra_branches.join(", ")})")
+        extra_branches.each do |extra|
+          Git.delete_branch(extra)
+        end
+      end
+    end
+
+    # Public: The list of extra branches that exist after creating the new branch
+    #
+    # Returns an Array of Strings of the branch names
+    def extra_branches
+      case branch_type
+      when Git::DEPLOYABLE_PREFIX, Git::STAGING_PREFIX, Git::QAREADY_PREFIX
+        Git.branches_for(branch_type) - [branch_name]
+      else
+        raise InvalidBranchType, "'#{branch_type}' is not a valid branch type"
+      end
+    end
+
+    InvalidBranchType = Class.new(StandardError)
+  end
+end
+

data/lib/octopolo/git.rb

@@ -0,0 +1,262 @@
+module Octopolo
+  # Abstraction around local Git commands
+  class Git
+    NO_BRANCH = "(no branch)"
+    DEFAULT_DIRTY_MESSAGE = "Your Git index is not clean. Commit, stash, or otherwise clean up the index before continuing."
+    # we use date-based tags, so look for anything starting with a 4-digit year
+    RELEASE_TAG_FILTER = /^\d{4}.*/
+    RECENT_TAG_LIMIT = 9
+    # branch prefixes
+    DEPLOYABLE_PREFIX = "deployable"
+    STAGING_PREFIX = "staging"
+    QAREADY_PREFIX = "qaready"
+
+    include CLIWrapper
+    extend CLIWrapper # add class-level .cli and .cli= methods
+
+    # Public: Perform the given Git subcommand
+    #
+    # subcommand - String containing the subcommand and its parameters
+    #
+    # Example:
+    #
+    #   > Git.perform "status"
+    #   # => output of `git status`
+    def self.perform(subcommand)
+      cli.perform "git #{subcommand}"
+    end
+
+    # Public: Perform the given Git subcommand without displaying the output
+    #
+    # subcommand - String containing the subcommand and its parameters
+    #
+    # Example:
+    #
+    #   > Git.perform_quietly "status"
+    #   # => no output
+    def self.perform_quietly(subcommand)
+      cli.perform_quietly "git #{subcommand}"
+    end
+
+    # Public: The name of the currently check-out branch
+    #
+    # Returns a String of the branch name
+    def self.current_branch
+      # cut trims the first three characters (whitespace or "*  " for current branch)
+      # the chomp removes the newline from the command output
+      name = cli.perform_quietly("git branch | grep '^* ' | cut -c 3-").chomp
+      if name == NO_BRANCH
+        raise NotOnBranch, "Not currently checked out to a particular branch"
+      else
+        name
+      end
+    end
+
+    # Public: Determine if current_branch is reserved
+    #
+    # Returnsa boolean value
+    def self.reserved_branch?
+      !(current_branch =~ /^(?:#{Git::STAGING_PREFIX}|#{Git::DEPLOYABLE_PREFIX}|#{Git::QAREADY_PREFIX})/).nil?
+    end
+
+    # Public: Check out the given branch name
+    #
+    # branch_name - The name of the branch to check out
+    def self.check_out branch_name
+      fetch
+      perform "checkout #{branch_name}"
+      pull
+      unless current_branch == branch_name
+        raise CheckoutFailed, "Failed to check out '#{branch_name}'"
+      end
+    end
+
+    # Public: Create a new branch from the given source
+    #
+    # new_branch_name - The name of the branch to create
+    # source_branch_name - The name of the branch to branch from
+    #
+    # Example:
+    #
+    #   Git.new_branch("bug-123-fix-thing", "master")
+    def self.new_branch(new_branch_name, source_branch_name)
+      fetch
+      perform("branch --no-track #{new_branch_name} origin/#{source_branch_name}")
+      check_out new_branch_name
+      perform("push --set-upstream origin #{new_branch_name}")
+    end
+
+    # Public: Whether the Git index is clean (has no uncommited changes)
+    #
+    # Returns a Boolean
+    def self.clean?
+      # git status --short returns one line for any uncommited changes, if any
+      # e.g.,
+      # ?? untracked.txt
+      # D  deleted.txt
+      # M  modified.txt
+      cli.perform_quietly("git status --short").empty?
+    end
+
+    # Public: Perform the block if the Git index is clean
+    def self.if_clean(message=DEFAULT_DIRTY_MESSAGE)
+      if clean?
+        yield
+      else
+        alert_dirty_index message
+      end
+    end
+
+    # Public: Display the message and show the git status
+    def self.alert_dirty_index(message)
+      cli.say " "
+      cli.say message
+      cli.say " "
+      perform "status"
+    end
+
+    # Public: Merge the given remote branch into the current branch
+    def self.merge(branch_name)
+      Git.if_clean do
+        Git.fetch
+        perform "merge --no-ff origin/#{branch_name}"
+        raise MergeFailed unless Git.clean?
+        Git.push
+      end
+    end
+
+    # Public: Fetch the latest changes from GitHub
+    def self.fetch
+      perform_quietly "fetch --prune"
+    end
+
+    # Public: Push the current branch to GitHub
+    def self.push
+      if_clean do
+        perform "push origin #{current_branch}"
+      end
+    end
+
+    # Public: Pull the latest changes for the checked-out branch
+    def self.pull
+      if_clean do
+        perform "pull"
+      end
+    end
+
+    # Public: The list of branches on GitHub
+    #
+    # Returns an Array of Strings containing the branch names
+    def self.remote_branches
+      Git.fetch
+      raw = Git.perform_quietly "branch --remote"
+      all_branches = raw.split("\n").map do |raw_name|
+        # will come in as "  origin/foo", we want just "foo"
+        raw_name.split("/").last
+      end
+
+      all_branches.uniq.sort
+    end
+
+    # Public: List of branches starting with the given string
+    #
+    # prefix - String to match branch names against
+    #
+    # Returns an Array of Strings containing the branch names
+    def self.branches_for(prefix)
+      remote_branches.select do |branch_name|
+        branch_name =~ /^#{prefix}/
+      end
+    end
+
+    def self.latest_branch_for(branch_prefix)
+      branches_for(branch_prefix).last || raise(NoBranchOfType, "No #{branch_prefix} branch")
+    end
+
+    # Public: The name of the current deployable branch
+    def self.deployable_branch
+      latest_branch_for(DEPLOYABLE_PREFIX)
+    end
+
+    # Public: The name of the current staging branch
+    def self.staging_branch
+      latest_branch_for(STAGING_PREFIX)
+    end
+
+    # Public: The name of the current QA-ready branch
+    def self.qaready_branch
+      latest_branch_for(QAREADY_PREFIX)
+    end
+
+    # Public: The list of releases which have been tagged
+    #
+    # Returns an Array of Strings containing the tag names
+    def self.release_tags
+      Git.perform_quietly("tag").split("\n").select do |tag|
+        tag =~ RELEASE_TAG_FILTER
+      end
+    end
+
+    # Public: Only the most recent release tags
+    #
+    # Returns an Array of Strings containing the tag names
+    def self.recent_release_tags
+      release_tags.last(RECENT_TAG_LIMIT)
+    end
+
+    # Public: Create a new tag with the given name
+    #
+    # tag_name - The name of the tag to create
+    def self.new_tag(tag_name)
+      perform "tag #{tag_name}"
+      push
+      perform "push --tag"
+    end
+
+    # Public: Delete the given branch
+    #
+    # branch_name - The name of the branch to delete
+    def self.delete_branch(branch_name)
+      perform "push origin :#{branch_name}"
+      perform "branch -D #{branch_name}"
+    end
+
+    # Public: Branches which have been merged into the given branch
+    #
+    # source_branch_name - The name of the branch to check against
+    # branches_to_ignore - An Array of branches to exclude from results
+    #
+    # Returns an Array of Strings
+    def self.stale_branches(source_branch_name="master", branches_to_ignore=[])
+      Git.fetch
+      command = "branch --remote --merged #{recent_sha(source_branch_name)} | grep -E -v '(#{stale_branches_to_ignore(branches_to_ignore).join("|")})'"
+      raw_result = Git.perform_quietly command
+      raw_result.split.map { |full_name| full_name.gsub("origin/", "") }
+    end
+
+    # Private: The SHA from 1 day ago for the given branch
+    #
+    # branch_name - The name of the branch to check
+    #
+    # Returns a String
+    def self.recent_sha(branch_name)
+      raw = perform_quietly "rev-list `git rev-parse remotes/origin/#{branch_name} --before=1.day.ago` --max-count=1"
+      raw.chomp
+    end
+    private_class_method :recent_sha
+
+    # Private: Branches to ignore when looking for stale branches
+    #
+    # Returns an Array of Strings
+    def self.stale_branches_to_ignore(additional_branches=[])
+      %w(HEAD master staging deployable) + Array(additional_branches)
+    end
+    private_class_method :stale_branches_to_ignore
+
+    # Exceptions
+    NotOnBranch = Class.new(StandardError)
+    CheckoutFailed = Class.new(StandardError)
+    MergeFailed = Class.new(StandardError)
+    NoBranchOfType = Class.new(StandardError)
+  end
+end