codebuild-notifier 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17bc724453d29a4b9aebd6973816c86833effb926f93451fa2aa9872a8ffa0e5
-  data.tar.gz: c5ce3faadd2d87b2e778cc96e8bc27b4d8dde795b247292860ba0eed126d83b9
+  metadata.gz: 83a2bb81dc8815d9ccfa7073d97408297584a1e6f104f894d1f26c2e2cfd2453
+  data.tar.gz: bcf314b4c5f2e3b708ba5ff8a63b3deda7255291b803f3bd266c76219ffb4aad
 SHA512:
-  metadata.gz: 76104e28f126b94b13cd826ade8627fc94ef87070ba3071ade7795ce103e3dd18b5a663661841a38368886edd86753bc0de0769c3760e91ef2e40351171e39b5
-  data.tar.gz: 283a0f3a162e9672d718ffc9a420ecbb51c4dd8744d48c4f20a80b814c5f6a26b4d5a5123763e2ebfc179c6907e90817d95bff51ecf282e68718e065b94506b7
+  metadata.gz: e1671f03687d58d57ac917a08511e6cabeee8a687fb33087339d22c0ffae40a0e1b9efb69232ff4a5aa3cff1325c22c26560dd6af9c0084b0ea5caca18403675
+  data.tar.gz: d7e658e90f1bed0eb2ba2d413b4ef9548da102019690fb39bd8263ebbfbcc6206e113caac8ca9ef4264bd6d0657662c7d21bdb59acdac1065dc362ea05f9509d

data/.rubocop.yml

@@ -18,6 +18,9 @@ Style/Documentation:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/AsciiComments:
+  Enabled: false
+
 Style/AccessModifierDeclarations:
   EnforcedStyle: inline
 

data/README.md

@@ -192,6 +192,27 @@ phases:
       that region.
     </td>
   </tr>
+  <tr>
+    <th>
+      CBN_DEFAULT_NOTIFY_STRATEGY
+    </th>
+    <td>
+      <nobr>--default-notify-strategy</nobr>
+    </td>
+    <td>
+      fail_or_status_change
+    </td>
+    <td>
+      Determines when notifications will be sent.
+      'status_change' sends notifications for the first build in a PR or
+      whitelisted branch, thereafter if a build in that PR/branch has a
+      different status to the previous build.
+      'every_build' sends a notification regardless of status.
+      'fail_or_status_change', the default value, will send if the status
+      changes, but will also send notifications of every failure,
+      regardless of previous status.
+    </td>
+  </tr>
   <tr>
     <th>
       CBN_DYNAMO_TABLE
@@ -207,6 +228,25 @@ phases:
       in <a href="#infrastructure-requirements">Infrastructure Requirements</a>
     </td>
   </tr>
+  <tr>
+    <th>
+      CBN_OVERRIDE_NOTIFY_STRATEGY
+    </th>
+    <td>
+      <nobr>--override-notify-strategy</nobr>
+    </td>
+    <td>
+      not set
+    </td>
+    <td>
+      Allows overriding default notify strategy.
+      Specify a branch and strategy for that branch, with a colon separator.
+      Valid strategies are:
+      status_change, every_build, fail_or_status_change
+      Specify multiple branch strategies delimited by comma.
+      e.g. 'master:every_build,jira-15650:status_change'
+    </td>
+  </tr>
   <tr>
     <th>
       CBN_SLACK_ADMIN_USERNAMES

data/bin/update-build-status

@@ -60,29 +60,58 @@ OptionParser.new do |opts|
     '--additional-channel=CHANNEL',
     'status notifications for whitelisted branches will be sent here ' \
     'as well as to author/committer'
-  ) { |usernames| command_line_opts[:slack_admin_users] = usernames }
+  ) do |usernames|
+    command_line_opts[:slack_admin_users] = usernames
+  end
 
   opts.on(
-    '--slack-admin-usernames=USERS',
-    'comma-separated list of slack users to be notified if build status ' \
-    'notifications fail to send'
-  ) { |usernames| command_line_opts[:slack_admin_users] = usernames }
+    '--default-notify-strategy=STRATEGY',
+    'when to send notifications, in the absence of a branch-specific ' \
+    'override -- valid options are: status_change (the default), ' \
+    'every_build, fail_or_status_change'
+  ) do |default_strategy|
+    command_line_opts[:default_strategy] = default_strategy
+  end
 
   opts.on(
     '--dynamo-table=TABLE',
     'table for storing build statuses'
-  ) { |table| command_line_opts[:dynamo_table] = table }
+  ) do |table|
+    command_line_opts[:dynamo_table] = table
+  end
+
+  opts.on(
+    '--override-notify-strategy=BRANCH_STRATEGY_PAIRS',
+    'overrides default notify strategy; specify pairs of branch:strategy ' \
+    'Valid strategies are: status_change, every_build, fail_or_status_change ' \
+    'separate pairs with a comma' \
+    'e.g. master:every_build,jira-15650:status_change'
+  ) do |overrides|
+    command_line_opts[:strategy_overrides] = overrides
+  end
+
+  opts.on(
+    '--slack-admin-usernames=USERS',
+    'comma-separated list of slack users to be notified if build status ' \
+    'notifications fail to send'
+  ) do |usernames|
+    command_line_opts[:slack_admin_users] = usernames
+  end
 
   opts.on(
     '--slack-secret-name=SECRET',
     'name of Secrets Manager secret with slack app/bot auth token'
-  ) { |slack_secret| command_line_opts[:slack_secret_name] = slack_secret }
+  ) do |slack_secret|
+    command_line_opts[:slack_secret_name] = slack_secret
+  end
 
   opts.on(
     '--whitelist-branches=BRANCHES',
     'comma-separated list of branches that will have build notifications ' \
     'sent even if there is no open Pull Request'
-  ) { |whitelist| command_line_opts[:whitelist_branches] = whitelist }
+  ) do |whitelist|
+    command_line_opts[:whitelist_branches] = whitelist
+  end
 
   opts.on('--region=REGION', 'AWS region') do |region|
     command_line_opts[:region] = region
@@ -95,6 +124,7 @@ build = CodeBuildNotifier::CurrentBuild.new
 history = CodeBuildNotifier::BuildHistory.new(config, build)
 
 last_build = history.last_entry
+build.previous_build = last_build
 
 if build.launched_by_retry?
   # Whenever a build is triggered by a PR or whitelisted branch, we update
@@ -103,27 +133,33 @@ if build.launched_by_retry?
   # only if the re-tried build was for the latest commit. Otherwise re-trying
   # an older commit could result in inaccurate notifications.
   quit(not_latest_commit_in_branch_message(build, config)) unless last_build
-
-  source_id = last_build.source_id
-  source_ref = last_build.source_ref
 else
   # We only want to track information for whitelisted branches and branches
   # with open Pull Requests.
   unless config.non_pr_branch_ids.include?(build.trigger) || build.for_pr?
     quit(not_pr_or_whitelisted_branch_message(config))
   end
-  source_id = build.source_id
-  source_ref = build.trigger
 end
 
 # Update record for this project + branch/pr in DynamoDb even if the
 # status hasn't changed, so the latest commit hash is stored.
-history.write_entry(source_id) do |new_item|
+history.write_entry(build.source_id) do |new_item|
   cb_puts "Updating dynamo table #{config.dynamo_table} with: #{new_item}"
 end
 
-quit(no_status_diff_message(build)) if last_build&.status == build.status
+status_changed = last_build&.status != build.status
+
+strategy = config.strategy_for_branch(build.branch_name)
+
+unless strategy == 'every_build'
+  if strategy == 'status_change'
+    quit(no_status_diff_message(build)) unless status_changed
+  elsif strategy == 'fail_or_status_change'
+    # TODO: Find good wording for a different exit message for this case.
+    quit(no_status_diff_message(build)) if build.status == 'SUCCEEDED' && !status_changed
+  end
+end
 
-slack_message = CodeBuildNotifier::SlackMessage.new(build, config, source_ref)
+slack_message = CodeBuildNotifier::SlackMessage.new(build, config, build.source_ref)
 sender = CodeBuildNotifier::SlackSender.new(config)
 sender.send(slack_message)

data/lib/codebuild-notifier/build_history.rb

@@ -25,7 +25,7 @@ module CodeBuildNotifier
     attr_reader :config, :current_build
 
     delegate :dynamo_table, to: :config
-    delegate :launched_by_retry?, to: :current_build
+    delegate :branch_name, :launched_by_retry?, to: :current_build
 
     def initialize(config, current_build)
       @config = config
@@ -86,7 +86,10 @@ module CodeBuildNotifier
         # If launched via manual re-try instead of via a webhook, we don't
         # want to overwrite the current source_ref value that tells us which
         # branch or pull request originally created the dynamo record.
-        memo[:source_ref] = current_build.trigger unless launched_by_retry?
+        unless launched_by_retry?
+          memo[:source_ref] = current_build.trigger
+          memo[:branch_name] = branch_name unless branch_name.empty?
+        end
       end
     end
 

data/lib/codebuild-notifier/config.rb

@@ -19,27 +19,36 @@ module CodeBuildNotifier
   class Config
     DEFAULT_WHITELIST = %w[master release]
 
-    attr_reader :additional_channel, :dynamo_table, :region, :slack_admins,
-                :slack_secret_name, :whitelist_branches
+    attr_reader :additional_channel, :default_strategy, :dynamo_table, :region,
+                :slack_admins, :slack_secret_name, :whitelist_branches
 
     # Configuration values specific to CodeBuild Notifier. CBN_ prefix is
     # used because ENV vars with CODEBUILD_ prefix are reserved for use by AWS.
     def initialize(
       additional_channel: ENV['CBN_ADDITIONAL_CHANNEL'],
+      default_strategy: ENV['CBN_DEFAULT_NOTIFY_STRATEGY'] || 'fail_or_status_change',
       dynamo_table: ENV['CBN_DYNAMO_TABLE'] || 'branch-build-status',
       region: ENV['CBN_AWS_REGION'] || ENV['AWS_REGION'],
       slack_admins: ENV['CBN_SLACK_ADMIN_USERNAMES'],
       slack_secret_name: ENV['CBN_SLACK_SECRET_NAME'] || 'slack/codebuild',
+      strategy_overrides: ENV['CBN_OVERRIDE_NOTIFY_STRATEGY'],
       whitelist_branches: ENV['CBN_WHITELIST_BRANCHES']
     )
       @additional_channel = additional_channel
+      @default_strategy = default_strategy
       @dynamo_table = dynamo_table
       @region = region
       @slack_admins = slack_admins&.split(',') || []
       @slack_secret_name = slack_secret_name
+      @strategy_overrides = strategy_overrides&.split(',') || []
       @whitelist_branches = whitelist_branches&.split(',') || DEFAULT_WHITELIST
     end
 
+    def strategy_for_branch(branch_name)
+      lookup = @strategy_overrides.map { |override| override.split(':') }.to_h
+      lookup.fetch(branch_name, default_strategy)
+    end
+
     # Match the format of the CodeBuild trigger variable
     def non_pr_branch_ids
       whitelist_branches.map { |name| "branch/#{name}" }

data/lib/codebuild-notifier/current_build.rb

@@ -18,6 +18,7 @@
 module CodeBuildNotifier
   class CurrentBuild
     attr_reader :build_id, :commit_hash, :git_repo_url, :status_code, :trigger
+    attr_accessor :previous_build
 
     # Default values are extracted from CODEBUILD_* ENV vars present in each
     # CodeBuild # job container.
@@ -25,6 +26,7 @@ module CodeBuildNotifier
       build_id: ENV['CODEBUILD_BUILD_ID'],
       commit_hash: ENV['CODEBUILD_RESOLVED_SOURCE_VERSION'],
       git_repo: ENV['CODEBUILD_SOURCE_REPO_URL'],
+      head_ref: ENV['CODEBUILD_WEBHOOK_HEAD_REF'],
       status_code: ENV['CODEBUILD_BUILD_SUCCEEDING'],
       trigger: ENV['CODEBUILD_WEBHOOK_TRIGGER']
     )
@@ -32,10 +34,22 @@ module CodeBuildNotifier
       @commit_hash = commit_hash
       # Handle repos specified with and without optional .git suffix.
       @git_repo_url = git_repo.to_s.gsub(/\.git\z/, '')
+      @head_ref = head_ref
       @status_code = status_code
       @trigger = trigger
     end
 
+    # If launched via retry, the webhook head ref env var is blank,
+    # but if the previous build for this branch has been located,
+    # the branch_name of that build is the same as for this build
+    def branch_name
+      if launched_by_retry?
+        previous_build&.branch_name
+      else
+        @head_ref.to_s.gsub(%r{^refs/heads/}, '')
+      end
+    end
+
     def status
       status_code.to_s == '1' ? 'SUCCEEDED' : 'FAILED'
     end
@@ -63,7 +77,25 @@ module CodeBuildNotifier
     # multiple projects, for example, with different buildspec files for
     # different ruby versions, or for rspec vs cucumber.
     def source_id
-      "#{project_code}:#{trigger}"
+      # If launched via retry, trigger is blank, but if the previous
+      # build for this branch has been located, the source_id of that
+      # build is the same as for this build
+      if launched_by_retry?
+        previous_build&.source_id
+      else
+        "#{project_code}:#{trigger}"
+      end
+    end
+
+    def source_ref
+      # If launched via retry, trigger is blank, but if the previous
+      # build for this branch has been located, the source_ref of that
+      # build is the same as for this build
+      if launched_by_retry?
+        previous_build&.source_ref
+      else
+        trigger
+      end
     end
   end
 end

data/lib/codebuild-notifier/slack_message.rb

@@ -18,12 +18,13 @@
 module CodeBuildNotifier
   class SlackMessage
     attr_reader :author_email, :author_name, :build, :committer_email,
-                :commit_message_subject, :config, :short_hash, :source_ref
+                :commit_message_subject, :config, :short_hash
 
-    def initialize(build, config, source_ref)
+    delegate :source_ref, to: :build
+
+    def initialize(build, config)
       @build = build
       @config = config
-      @source_ref = source_ref
       @short_hash, @author_name, @author_email,
         @committer_email, @commit_message_subject = git_info
     end

data/lib/codebuild-notifier/version.rb

@@ -16,5 +16,5 @@
 # along with codebuild-notifier.  If not, see <http://www.gnu.org/licenses/>.
 
 module CodeBuildNotifier
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codebuild-notifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - VHL Ops Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport