march-audit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2421a60347f0ca6c971068bdf1d724c2038fb3e
+  data.tar.gz: b3a873b83c16750b97cc68e1b7e348b4d5b559f7
+SHA512:
+  metadata.gz: cfbfe0e315383109415b7b23636648c2916eaf8325a5b896a62f69422ff014e0e015fe4eb7911bdaff2b804e578040c8199d6eccf5061a0f2bccae987732d145
+  data.tar.gz: b00118106ea8306132a43315f3c8c16a3ce050d291c84264563771e1e0415be2e719803cfa22672a66362af351a9d6ea56caaa37bdfd4b93cb821cf0273d490c

data/bin/march

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+require 'march'
+require 'thor'
+
+module March
+  class Command < Thor
+    class_option :interactive, default: true, type: :boolean
+    class_option :destructive, default: false, type: :boolean
+
+    desc 'audit NAMESPACE REPO', 'audit of NAMESPACE/REPO branch health'
+    def audit(namespace, repo)
+      March::Audit.complete(namespace, repo, options[:interactive], options[:destructive])
+    rescue Octokit::NotFound
+      puts "Cannot find repository #{namespace}/#{repo}"
+    end
+
+    desc 'audit_merged NAMESPACE REPO', 'only audit merged branches'
+    def audit_merged(namespace, repo)
+      repo = March::Repo.new(namespace, repo)
+      March::Audit.merged(repo, options[:interactive], options[:destructive])
+    end
+
+    option :max_age, default: 3600*24*14, type: :numeric
+    desc 'audit_age NAMESPACE REPO', 'only audit branches for age'
+    def audit_age(namespace, repo)
+      ENV.store('MAX_AGE', options[:max_age])
+      repo = March::Repo.new(namespace, repo)
+      March::Audit.age(repo, options[:interactive], options[:destructive])
+    end
+
+    desc 'user', 'print the current username'
+    def user
+      puts March::Github.client.user.login
+    end
+  end
+end
+
+begin
+  March::Command.start
+rescue Faraday::SSLError => e
+  puts e
+  puts 'Cannot verify SSL certificate, consider setting VERIFY_SSL=false'
+rescue Interrupt
+  puts
+  puts 'Quitting...'
+end
+
+# vi:ft=ruby

data/lib/march.rb

@@ -0,0 +1,3 @@
+require 'march/client'
+require 'march/repo'
+require 'march/audit'

data/lib/march/audit.rb

@@ -0,0 +1,69 @@
+require 'chronic_duration'
+
+module March
+  class Audit
+    def self.complete(namespace, repository, interactive, destructive)
+      repo = March::Repo.new(namespace, repository)
+
+      merged(repo, interactive, destructive)
+      puts
+      age(repo, interactive, destructive)
+    end
+
+    def self.merged(repo, interactive, destructive)
+      puts 'Auditing merged branches...'
+
+      puts 'No merged branches.' if repo.merged_branches.empty?
+      return                     if repo.merged_branches.empty?
+
+      print 'These branches have been merged: '
+      puts repo.merged_branches.join(', ')
+
+      if interactive && destructive
+        print 'Delete merged branches? (y/N) '
+        bool = $stdin.gets
+
+        case bool.chomp
+        when 'y' then repo.delete_branches(repo.merged_branches)
+        else puts 'Canceled action'
+        end
+      elsif destructive
+        repo.delete_branches(repo.merged_branches)
+      else
+        puts 'Taking no action (destructive is disabled)'
+      end
+    end
+
+    def self.age(repo, interactive, destructive)
+      puts 'Auditing old branches...'
+      msgs = repo.branch_age.each_with_object({}) do |(name, dates), acc|
+        created = ChronicDuration.output(Time.now - dates[:oldest], weeks: true, units: 2)
+        updated = ChronicDuration.output(Time.now - dates[:newest], weeks: true, units: 2)
+        if (Time.now - dates[:newest]) > (ENV['MAX_AGE'] || 3600*24*14)
+          acc[name] = "Branch #{name} was created #{created} ago and updated #{updated} ago and is probably owned by #{repo.branch_owners[name].join(', ')}"
+        end
+      end
+
+      puts 'No old branches' if msgs.empty?
+      return if msgs.empty?
+
+      msgs.each { |_name, msg| puts msg }
+
+      old_branches = msgs.map(&:first)
+
+      if interactive && destructive
+        print 'Delete old branches? (y/N) '
+        delete = $stdin.gets
+
+        case delete.chomp
+        when 'y' then repo.delete_branches(old_branches)
+        else puts 'Canceled action'
+        end
+      elsif destructive
+        repo.delete_branches(old_branches)
+      else
+        puts 'Taking no action (destructive is disabled)'
+      end
+    end
+  end
+end

data/lib/march/client.rb

@@ -0,0 +1,39 @@
+require 'octokit'
+require 'singleton'
+require 'dotenv'
+Dotenv.load
+
+module March
+  module Github
+    class Configuration
+      include Singleton
+
+      attr_accessor :username, :password
+    end
+
+    def self.configure
+      yield(configuration) if block_given?
+    end
+
+    def self.configuration
+      Configuration.instance
+    end
+
+    def self.client
+      return @client if @client
+
+      Octokit.api_endpoint = ENV['GITHUB_API'] if ENV['GITHUB_API']
+      opts = { :access_token => ENV.fetch('GITHUB_TOKEN') }
+      @client = Octokit::Client.new(opts)
+      verify = 
+        case ENV['VERIFY_SSL'] || 'true'
+        when 'false', 'no' then false
+        else true
+        end
+
+      @client.connection_options[:ssl] = { verify: verify }
+
+      @client
+    end
+  end
+end

data/lib/march/repo.rb

@@ -0,0 +1,75 @@
+require 'chronic_duration'
+
+module March
+  class Repo
+    def initialize(namespace, repo)
+      @string = "#{namespace}/#{repo}"
+      @repo = client.repo(@string)
+    end
+
+    def client
+      March::Github.client
+    end
+
+    def id
+      @repo.id
+    end
+
+    def default_branch_name
+      @repo.default_branch
+    end
+
+    def default_branch
+      branches[branches.find_index { |b| b.name == default_branch_name }]
+    end
+
+    def default_tip
+      default_branch.commit.sha
+    end
+
+    def branches
+      @branches ||= @repo.rels[:branches].get.data
+    end
+
+    def compare_branches
+      branches.each_with_object({}) do |branch, acc|
+        acc[branch.name] = client.compare(id, default_tip, branch.commit.sha)
+      end
+    end
+
+    def merged_branches
+      @merged_branches ||= compare_branches.select do |_name, diff|
+        diff.commits.empty?
+      end.map(&:first).reject { |name| name == default_branch.name }
+    end
+
+    def branch_owners
+      @branch_owners ||=
+        compare_branches.each_with_object({}) do |(name, diff), acc|
+          author_ary   = diff.commits.map { |c| c.commit.author }
+          authors      =
+            author_ary.map do |h|
+              h.map { |k, v| v if k == :email }.compact
+            end.uniq
+
+          acc[name] = authors.flatten
+        end
+    end
+
+    def branch_age
+      compare_branches.each_with_object({}) do |(name, diff), acc|
+        oldest = diff.merge_base_commit.commit.author.date
+        newest = diff.commits.map { |c| c.commit.author.date }.sort.last
+        res = { oldest: oldest, newest: newest }
+        acc[name] = res unless name == default_branch_name || newest.nil?
+      end
+    end
+
+    def delete_branches(branch_names)
+      branch_names.each do |name|
+        puts 'Deleting ' + name
+        client.delete_branch(id, name)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: march-audit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Gwilliam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+description: tiny application that helps identify and cull branches that shouldn't
+  exist
+email: david.gwilliam@slalom.com
+executables:
+- march
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/march
+- lib/march.rb
+- lib/march/audit.rb
+- lib/march/client.rb
+- lib/march/repo.rb
+homepage: https://github.com/slalompdx/march-audit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: automate audit of repository branches
+test_files: []