deploy_changes_notifier 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c89752ea354cc918a35c7494349eb1d39e3665ca
+  data.tar.gz: 75b6aff3c508b22ae24014d49e50a62d6e749c2c
+SHA512:
+  metadata.gz: 6f54c96c9cc55e69bfc170cf5a4020eee555cd9aaa72fa60305b57e3da180969ba7a2ca5b602e36a0c24dae399bc08b557c3476b267513aca3682abeb443441c
+  data.tar.gz: accbc3a2f8aa17462cbeccd65853d116b7534abb53ad9a7fde59e02638ae5943cfdbc611de7d35666b355ec13471fa0f2c1059d4b93d018e81b8778f944991df

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+deploy_changes_notifier

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.13.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deploy_changes_notifier.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Subodh Khanduri
+
+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,67 @@
+# DeployChangesNotifier
+
+Send notifications for the changes deployed in each build, compared to the previous build. It is a good practise to create GIT tags for each deployment. DeployChangesNotifier compares the latest deployed tag with the previous deployed tag and sends the list of new commits deployed to a Slack channel. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deploy_changes_notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deploy_changes_notifier
+
+Or use the github url:
+
+```ruby
+gem 'deploy_changes_notifier', git: "https://github.com/subodhkhanduri1/deploy_changes_notifier.git"
+```
+
+## Usage
+
+Require the gem
+
+```ruby
+require 'deploy_changes'
+```
+
+Send notification
+
+```ruby
+notifier = DeployChanges::Notifier.new do |config|
+  config.git_repo_url = 'https://github.com/<your_organization>/<your_repo_name>'
+  # Tags are expected to be numbered in sequential order. Build numbers would work nicely.
+  config.tag_prefix = 'app-prd-'
+  config.deploy_job_name = '<your_deploy_job_name>'
+  config.deploy_job_build_number = 3 # The latest deploy job build number
+  config.slack_channel = 'Production'
+  config.slack_bot_api_token = '<some_token>'
+end
+
+notifier.send_deploy_changes_notification
+```
+
+To supply the config parameters to a script, pass in environment variables with the same name as the config variables. If you pass in environment variables, there is no need to pass config variables in the constructor.
+
+## 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 GitHub at https://github.com/subodhkhanduri1/deploy_changes_notifier.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+puts $LOAD_PATH
+require "bundler/setup"
+require "deploy_changes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deploy_changes_notifier.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deploy_changes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deploy_changes_notifier"
+  spec.version       = DeployChanges::VERSION
+  spec.authors       = ["Subodh Khanduri"]
+  spec.email         = ["subodhkhanduri1@gmail.com"]
+
+  spec.summary       = "Deploy changes notifier"
+  spec.description   = "This is a simple gem to push deploy changes notification to a Slack channel."
+  spec.homepage      = "https://github.com/subodhkhanduri1/deploy_changes_notifier"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "slack-ruby-client", "~> 0.5.0"
+end

data/lib/deploy_changes.rb

@@ -0,0 +1,6 @@
+require "deploy_changes/version"
+require "deploy_changes/notifier"
+
+module DeployChanges
+
+end

data/lib/deploy_changes/error_raiser.rb

@@ -0,0 +1,66 @@
+require_relative 'errors/errors'
+
+module DeployChanges
+  class ErrorRaiser
+
+    def raise_slack_channel_missing_error
+      fail(
+        Errors::SlackChannelMissing.new,
+        "SLACK_CHANNEL env variable missing. Ex: '#test_channel'"
+      )
+    end
+
+    def raise_slack_api_token_missing_error
+      fail(
+        Errors::SlackApiTokenMissing.new,
+        "SLACK_BOT_API_TOKEN env variable missing"
+      )
+    end
+
+    def raise_invalid_git_repo_url_error(repo_url)
+      fail(
+        Errors::InvalidGitRepoUrl.new(repo_url),
+        "'#{repo_url}' is not a valid SQ Git Repo URL"
+      )
+    end
+
+    def raise_invalid_tag_name_error(tag_name)
+      message = if tag_name.nil? || tag_name.empty?
+                  "Git tag name missing"
+                else
+                  "Git tag '#{tag_name}' not found"
+                end
+
+      fail Errors::InvalidTagName.new, message
+    end
+
+    def raise_git_repo_clone_failed_error(git_repo_url)
+      fail(
+        Errors::GitRepoCloneFailed.new,
+        "Git clone from '#{git_repo_url}' failed"
+      )
+    end
+
+    def raise_deploy_job_build_number_missing_error
+      fail(
+        Errors::DeployJobBuildNumberMissing.new,
+        "DEPLOY_JOB_BUILD_NUMBER env variable missing."
+      )
+    end
+
+    def raise_deploy_job_name_missing_error
+      fail(
+        Errors::DeployJobNameMissing.new,
+        "DEPLOY_JOB_NAME env variable missing."
+      )
+    end
+
+    def raise_tag_prefix_missing_error
+      fail(
+        Errors::TagPrefixMissingError.new,
+        "TAG_PREFIX env variable missing."
+      )
+    end
+
+  end
+end

data/lib/deploy_changes/errors/errors.rb

@@ -0,0 +1,21 @@
+module DeployChanges
+  module Errors
+
+    class InvalidGitRepoUrl < StandardError; end
+
+    class InvalidTagName < StandardError; end
+
+    class DeployJobNameMissing < StandardError; end
+
+    class DeployJobBuildNumberMissing < StandardError; end
+
+    class TagPrefixMissingError < StandardError; end
+
+    class SlackChannelMissing < StandardError; end
+
+    class SlackApiTokenMissing < StandardError; end
+
+    class GitRepoCloneFailed < StandardError; end
+
+  end
+end

data/lib/deploy_changes/notifier.rb

@@ -0,0 +1,212 @@
+# This class compares the latest deployed tag and the one deployed before it,
+# and sends a Slack notification with the list of all new commits deployed
+#
+# Requirements:
+#
+#   The following environment variables must be supplied
+#     - GIT_REPO_URL: The url of the deployed repository
+#     - TAG_PREFIX: The prefix before the build number
+#       (Ex: "app-stg-")
+#     - DEPLOY_JOB_NAME: The name of the deploy job that was triggered
+#     - DEPLOY_JOB_BUILD_NUMBER: The latest build number of the deploy job
+#     - SLACK_BOT_API_TOKEN: The access token of the Slack bot which will post the notification
+#     - SLACK_CHANNEL: The Slack channel to post to
+#
+# Assumptions:
+#
+# - The DEPLOY_JOB_BUILD_NUMBER is always of the latest stable build
+
+require 'slack-ruby-client'
+require_relative 'validator'
+
+module DeployChanges
+
+  class Notifier
+
+    attr_reader(
+      :git_repo_url,
+      :tag_prefix,
+      :slack_channel,
+      :deploy_job_name,
+      :deploy_job_build_number,
+      :new_tag_name
+    )
+
+    def initialize
+      self.validator = Validator.new(self)
+
+      config = OpenStruct.new
+
+      yield config if block_given?
+
+      self.git_repo_url = config.git_repo_url || ENV["GIT_REPO_URL"]
+      self.tag_prefix = config.tag_prefix || ENV["TAG_PREFIX"]
+
+      self.deploy_job_build_number = config.deploy_job_build_number || ENV["DEPLOY_JOB_BUILD_NUMBER"]
+      self.deploy_job_name = config.deploy_job_name || ENV["DEPLOY_JOB_NAME"]
+
+      self.new_tag_name = tag_prefix + deploy_job_build_number
+
+      self.slack_channel = config.slack_channel || ENV["SLACK_CHANNEL"]
+      self.slack_bot_api_token = config.slack_bot_api_token || ENV["SLACK_BOT_API_TOKEN"]
+      configure_slack
+    end
+
+    def send_deploy_changes_notification
+      cleanup_repo
+      clone_repo
+      send_slack_notification
+    rescue StandardError => e
+      raise e
+    ensure
+      cleanup_repo
+    end
+
+    def git_repo_directory
+      @git_repo_directory ||= git_repo_url
+                                .split('/')
+                                .last
+                                .gsub('.git', '')
+    end
+
+    private
+
+    attr_writer :new_tag_name
+    attr_accessor :validator, :slack_bot_api_token
+
+    def configure_slack
+      validator.validate_slack_api_token(ENV["SLACK_BOT_API_TOKEN"])
+
+      Slack.configure do |config|
+        config.token = ENV["SLACK_BOT_API_TOKEN"]
+      end
+    end
+
+    def send_slack_notification
+      slack_client.auth_test
+
+      slack_client.chat_postMessage(
+        channel: slack_channel,
+        text: deploy_changes_message,
+        as_user: true
+      )
+    end
+
+    def deploy_changes_message
+      deploy_changes_array = deploy_changes_list
+
+      message = "*#{deploy_job_name} \##{deploy_job_build_number} changes:*\n"
+
+      message += if deploy_changes_array.empty?
+                   " - No changes"
+                 else
+                   deploy_changes_array
+                   .map { |commit_message| " - " + commit_message }
+                   .join("\n")
+                 end
+
+      puts message
+
+      message
+    end
+
+    def deploy_changes_list
+      return [] if previous_tag_name.nil? || previous_tag_name.empty?
+
+      deploy_changes_string = deploy_changes_command_output
+      return [] unless validator.last_command_successful?
+
+      deploy_changes_string.split("\n")
+    end
+
+    def deploy_changes_command_output
+      `#{deploy_changes_command}`
+    end
+
+    def deploy_changes_command
+      validator.validate_new_tag(new_tag_name)
+
+      puts "New tag name: #{new_tag_name}"
+
+      "cd #{git_repo_directory} && git log  --pretty=oneline --no-merges --format=\"%s [%an]\" #{previous_tag_name}...#{new_tag_name}"
+    end
+
+    def previous_tag_name
+      return @previous_tag_name if @previous_tag_name
+
+      previous_tag = previous_tag_from_tags_list(tags_list)
+
+      puts "Previous tag name: #{previous_tag}"
+      @previous_tag_name = previous_tag
+    end
+
+    def tags_list
+      tags = tags_list_command_output
+      tags.split("\n")
+        .reverse
+        .map { |ref| ref.gsub("refs/tags/", "") }
+    end
+
+    def tags_list_command_output
+      `cd #{git_repo_directory} && git for-each-ref --sort=taggerdate --format="%(refname)" refs/tags/#{tag_prefix}*`
+    end
+
+    def previous_tag_from_tags_list(tags_list)
+      tags_list.each_with_index do |tag, index|
+        return tags_list[index + 1] if tag == new_tag_name
+      end
+    end
+
+    def clone_repo
+      puts "Cloning from '#{git_repo_url}'"
+
+      `git clone #{git_repo_url}`
+
+      validator.validate_repo_cloned(git_repo_directory)
+    end
+
+    def cleanup_repo
+      return true unless Dir.exist?(git_repo_directory)
+
+      puts "Deleting '#{git_repo_directory}' folder"
+
+      `rm -rf #{git_repo_directory}`
+    end
+
+    def git_repo_url=(repo_url)
+      validator.validate_repo_url(repo_url)
+
+      @git_repo_url = repo_url
+    end
+
+    def tag_prefix=(prefix)
+      validator.validate_tag_prefix(prefix)
+
+      @tag_prefix = prefix
+    end
+
+    def deploy_job_build_number=(job_build_number)
+      validator.validate_deploy_job_build_number(job_build_number)
+
+      @deploy_job_build_number = job_build_number
+    end
+
+    def deploy_job_name=(job_name)
+      validator.validate_deploy_job_name(job_name)
+
+      @deploy_job_name = job_name
+    end
+
+    def slack_channel=(channel_name)
+      validator.validate_slack_channel_name(channel_name)
+
+      @slack_channel = channel_name
+    end
+
+    def slack_client
+      @slack_client ||= Slack::Web::Client.new
+    end
+
+  end
+
+end

data/lib/deploy_changes/validator.rb

@@ -0,0 +1,77 @@
+require_relative 'error_raiser'
+require 'English'
+
+module DeployChanges
+  class Validator
+
+    attr_accessor :notifier, :error_raiser
+
+    def initialize(notifier_object)
+      self.notifier = notifier_object
+      self.error_raiser = ErrorRaiser.new
+    end
+
+    def validate_repo_url(repo_url)
+      error_raiser.raise_invalid_git_repo_url_error(
+        repo_url
+      ) unless repo_url =~ git_repo_url_regex
+    end
+
+    def validate_tag_prefix(prefix)
+      error_raiser.raise_tag_prefix_missing_error unless non_empty_string?(prefix)
+    end
+
+    def validate_deploy_job_build_number(job_build_number)
+      return if non_empty_string?(job_build_number) && job_build_number.to_i > 0
+
+      error_raiser.raise_deploy_job_build_number_missing_error
+    end
+
+    def validate_deploy_job_name(job_name)
+      error_raiser.raise_deploy_job_name_missing_error unless non_empty_string?(job_name)
+    end
+
+    def validate_slack_channel_name(channel_name)
+      error_raiser.raise_slack_channel_missing_error unless non_empty_string?(channel_name)
+    end
+
+    def validate_new_tag(new_tag_name)
+      return if non_empty_string?(new_tag_name) && git_tag_exists?(new_tag_name)
+
+      error_raiser.raise_invalid_tag_name_error(new_tag_name)
+    end
+
+    def validate_slack_api_token(token)
+      return if non_empty_string?(token)
+
+      error_raiser.raise_slack_api_token_missing_error
+    end
+
+    def validate_repo_cloned(repo_directory_name)
+      error_raiser.raise_git_repo_clone_failed_error(
+        notifier.git_repo_url
+      ) unless last_command_successful? && Dir.exist?(repo_directory_name)
+    end
+
+    def last_command_successful?
+      $CHILD_STATUS.success?
+    end
+
+    private
+
+    def git_repo_url_regex
+      /^https:\/\/github.com\/(.*)\/(.*)/
+    end
+
+    def git_tag_exists?(tag_name)
+      tag_command_output = `cd #{notifier.git_repo_directory} && git tag -l #{tag_name}`
+
+      $CHILD_STATUS.success? && tag_command_output.split("\n").count == 1
+    end
+
+    def non_empty_string?(string_var)
+      string_var.is_a?(String) && !string_var.empty?
+    end
+
+  end
+end

data/lib/deploy_changes/version.rb

@@ -0,0 +1,3 @@
+module DeployChanges
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: deploy_changes_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Subodh Khanduri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: This is a simple gem to push deploy changes notification to a Slack channel.
+email:
+- subodhkhanduri1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deploy_changes_notifier.gemspec
+- lib/deploy_changes.rb
+- lib/deploy_changes/error_raiser.rb
+- lib/deploy_changes/errors/errors.rb
+- lib/deploy_changes/notifier.rb
+- lib/deploy_changes/validator.rb
+- lib/deploy_changes/version.rb
+homepage: https://github.com/subodhkhanduri1/deploy_changes_notifier
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Deploy changes notifier
+test_files: []