buildkite_watcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce94c9f805c452c1c2d347d496c6035f2c46978c4380ece167df5d4fc8e185bf
+  data.tar.gz: 37134a0e829761200e9c864416f023325ef3d716cadc929f7c5c1c9817786f8c
+SHA512:
+  metadata.gz: 84da1398fdb493ff787030ce14e9499a58dda0b8b5c6c6e55310b76a389204c7345cd02febd7824bab80f730cf46e5bfa2561db94580f58c450353e40f648d55
+  data.tar.gz: fe35e7b28d99cf4bb0e44667cf4f35b96381b5aa499dc6aabd8e7c9725ddb8a963f931006c4742f8e30be5e94b2163094c13ec30c138727a2e172ad93cf82d3c

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,43 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*_spec.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - '**/*_spec.rb'
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "**/*_spec.rb"

data/.rubocop_todo.yml

@@ -0,0 +1,52 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-06-04 19:01:24 UTC using RuboCop version 1.16.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'buildkite_watcher.gemspec'
+
+# Offense count: 1
+# Configuration parameters: CheckForMethodsWithNoSideEffects.
+Lint/Void:
+  Exclude:
+    - 'lib/buildkite_watcher.rb'
+
+# Offense count: 4
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 100
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 50
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 300
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/buildkite_watcher.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-06-04
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in buildkite_watcher.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+gem "rubocop-rake", "~> 0.5.1"
+gem "rubocop-rspec", "~> 2.3.0"
+
+gem "pry-byebug"

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    buildkite_watcher (0.1.0)
+      rest-client (~> 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    netrc (0.11.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.16.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  buildkite_watcher!
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rake (~> 0.5.1)
+  rubocop-rspec (~> 2.3.0)
+
+BUNDLED WITH
+   2.2.17

data/README.md

@@ -0,0 +1,25 @@
+# Buildkite Watcher
+
+Command line utility that continuously watches for the buildkite job running current git HEAD and notifies on build status changes.
+
+## Installation
+
+Run this command:
+
+    $ gem install buildkite_watcher
+
+## Usage
+
+From a directory in your project, run.
+
+`$ bw `
+
+## 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 the created tag, 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/nulogy/buildkite_watcher.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "buildkite_watcher"
+
+# 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(__FILE__)

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/buildkite_watcher.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/buildkite_watcher/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "buildkite_watcher"
+  spec.version = BuildkiteWatcher::VERSION
+  spec.authors = ["Arturo Pie"]
+  spec.email = ["arturop@nulogy.com"]
+
+  spec.summary = "CLI utility that watches buildkite and notify on build status changes"
+  spec.description = <<~MSG
+    Command line utility that continuously watches for the buildkite job running current git HEAD and
+    notifies on build status changes.
+  MSG
+
+  spec.required_ruby_version = ">= 2.7", "< 3.1"
+
+  spec.metadata["source_code_uri"] = "https://github.com/nulogy/buildkite_watcher"
+  spec.metadata["changelog_uri"] = "https://github.com/nulogy/buildkite_watcher/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", "~> 2.1.0"
+end

data/exe/bw

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "buildkite_watcher"
+
+BuildkiteWatcher.result_watch

data/lib/buildkite_watcher.rb

@@ -0,0 +1,289 @@
+# frozen_string_literal: true
+
+require "rainbow"
+require "rest-client"
+require "buildkite_watcher/version"
+
+# Command line utility that continuously watches for the buildkite job running current git HEAD and
+# notifies on build status changes.
+module BuildkiteWatcher
+  class << self
+    GRAPHQL_QUERY = <<~GRAPHQL
+      query ($pipelineSlug: ID!, $commitHash: [String!], $branch: [String!]) {
+        pipeline(slug: $pipelineSlug) {
+          commit_hash_builds: builds(commit: $commitHash, state: [PASSED, RUNNING, FAILED, BLOCKED], first: 1) {
+            edges {
+              node {
+                commit
+                message
+                state
+                jobs(first: 1, step: { key: "aggregate_results" }) {
+                  edges {
+                    node {
+                      ... on JobTypeCommand {
+                        label
+                        artifacts {
+                          edges {
+                            node {
+                              downloadURL
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+          branch_builds: builds(branch: $branch, state: [PASSED, RUNNING, FAILED, BLOCKED], first: 2) {
+            edges {
+              node {
+                commit
+                message
+                state
+                jobs(first: 1, step: { key: "aggregate_results" }) {
+                  edges {
+                    node {
+                      ... on JobTypeCommand {
+                        label
+                        artifacts {
+                          edges {
+                            node {
+                              downloadURL
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    GRAPHQL
+    BUILD_PASSED = "PASSED"
+    BUILD_BLOCKED = "BLOCKED"
+    BUILD_RUNNING = "RUNNING"
+    BUILD_FAILED = "FAILED"
+    BUILD_UNKNOWN_STATUS = "UNKNOWN"
+
+    def result_watch
+      Signal.trap("SIGINT") do
+        puts
+        puts Rainbow("Program interrupt received. Exiting.").red
+        exit 1
+      end
+
+      previous_result = BUILD_UNKNOWN_STATUS
+      loop do
+        system("clear")
+        new_result = result
+
+        maybe_notify(previous_result, new_result)
+        previous_result = new_result
+
+        sleep 30
+      end
+    end
+
+    # Scenarios:
+    # - current commit doesn't have a build, no prior failed build
+    # - current commit doesn't have a build, there is a prior failed build
+    # - current commit has a build, is running, no prior failed build
+    # - current commit has a build, is running, there is a prior failed build
+    # - current commit has a build, has passed
+    # - current commit has a build, has failed
+
+    def result
+      puts Rainbow("Branch: ").bright + Rainbow(branch_name)
+      puts Rainbow("HEAD ➜  ").bright + Rainbow(commit_hash)
+      puts
+
+      buildkite_query = {
+        query: GRAPHQL_QUERY,
+        variables: {
+          pipelineSlug: pipeline_slug,
+          commitHash: commit_hash,
+          branch: branch_name,
+        },
+      }
+
+      builds = fetch_build_data(buildkite_query)
+      commit_hash_builds = simplify_builds_response_data(builds.commit_hash_builds)
+      branch_builds = simplify_builds_response_data(builds.branch_builds)
+
+      if commit_hash_builds.any?
+        build = commit_hash_builds.first
+        print_state(build.state)
+        return build.state if build_passed?(build.state) || branch_builds.empty?
+
+        if build.state == BUILD_RUNNING && prior_build_failed?(branch_builds)
+          puts
+          puts Rainbow("Prior failure summary:").bright
+          print_failures(prior_failed_build(branch_builds))
+        elsif build.state == BUILD_FAILED
+          print_failures(build)
+        end
+      else
+        print_no_current_build
+
+        return build.state if branch_builds.empty?
+
+        puts
+        puts Rainbow("Prior finished build summary:").bright
+        puts
+
+        build = branch_builds.first
+        print_state(build.state)
+        return build.state if build_passed?(build.state)
+
+        if last_build_failed?(branch_builds)
+          puts
+          puts Rainbow("Failure summary:").bright
+
+          build = branch_builds.first
+          print_failures(build)
+        end
+      end
+      build.state
+    rescue StandardError => e
+      puts
+      puts Rainbow("ERROR: #{e.message}\n#{e.backtrace}").red
+    end
+
+    private
+
+    def maybe_notify(previous_result, new_result)
+      return if new_result == previous_result || previous_result == BUILD_UNKNOWN_STATUS
+
+      case new_result
+      when build_passed?(new_result)
+        system('osascript -e \'display notification "CI PASSED" with title "CI Result Watch" sound name "Glass"\'')
+      when BUILD_FAILED
+        system('osascript -e \'display notification "CI FAILED" with title "CI Result Watch" sound name "Basso"\'')
+      end
+    end
+
+    def build_passed?(state)
+      [BUILD_PASSED, BUILD_BLOCKED].include?(state)
+    end
+
+    def fetch_build_data(buildkite_query)
+      response =
+        JSON.parse(
+          RestClient.post(
+            "https://graphql.buildkite.com/v1",
+            buildkite_query.to_json,
+            { Authorization: "Bearer #{buildkite_token}", content_type: :json },
+          ),
+          object_class: OpenStruct,
+        )
+
+      response.data.pipeline
+    end
+
+    def simplify_builds_response_data(builds)
+      simplified_builds = builds.edges.map(&:node)
+      simplified_builds.map do |build|
+        OpenStruct.new(
+          commit: build.commit,
+          message: build.message,
+          state: build.state,
+          aggregate_results_job: simplify_jobs_response_data(build.jobs),
+        )
+      end
+    end
+
+    def simplify_jobs_response_data(jobs)
+      simplified_jobs = jobs.edges.map(&:node)
+      simplified_jobs.map do |job|
+        OpenStruct.new(label: job.label, artifacts: simplify_artifacts_response_data(job.artifacts))
+      end.first
+    end
+
+    def simplify_artifacts_response_data(artifacts)
+      artifacts.edges.map(&:node)
+    end
+
+    def print_state(state)
+      case state
+      when build_passed?(state)
+        puts Rainbow("CI Status: ").bright + Rainbow(state).green
+      when BUILD_RUNNING
+        puts Rainbow("CI Status: ").bright + Rainbow(state).yellow
+      when BUILD_FAILED
+        puts Rainbow("CI Status: ").bright + Rainbow(state).red
+      end
+    end
+
+    def print_no_current_build
+      no_builds_for_head_message =
+        "Your HEAD pointer is at commit #{commit_hash} but Buildkite has no finished builds for this commit."
+      puts Rainbow(no_builds_for_head_message).yellow
+      puts Rainbow("Push the current branch to trigger a build.").bright.yellow
+    end
+
+    def last_build_failed?(builds)
+      builds.first.state == BUILD_FAILED
+    end
+
+    def prior_build_failed?(builds)
+      builds[1].present? && builds[1].state == BUILD_FAILED
+    end
+
+    def prior_failed_build(builds)
+      builds[1]
+    end
+
+    def print_failures(build)
+      aggregate_result_job = build.aggregate_results_job
+
+      unless aggregate_result_job&.artifacts&.any?
+        puts
+        return(
+          puts Rainbow("Could not retrieve failures. Please check the Aggregate Results step of the CI pipeline.")
+                 .yellow
+        )
+      end
+      failures_artifact = aggregate_result_job.artifacts.first
+      download_url = failures_artifact.downloadURL
+
+      failures = fetch_failures(download_url)
+
+      puts
+      puts Rainbow("#{failures.count} failures from these specs:").yellow
+      puts
+      failures.map(&:name).map { |name| /\[(\w+)\] (.*): .*/.match(name).captures }.group_by(&:first)
+        .each do |key, values|
+        puts key
+        values.map { |e| e[1] }.uniq.each do |failure_file|
+          failure_file
+          puts Rainbow(failure_file).red
+        end
+      end
+    end
+
+    def fetch_failures(download_url)
+      JSON.parse(RestClient.get(download_url), object_class: OpenStruct)
+    end
+
+    def pipeline_slug
+      ENV.fetch("PIPELINE_SLUG")
+    end
+
+    def branch_name
+      ENV.fetch("BRANCH_NAME", `git symbolic-ref --short HEAD`.strip)
+    end
+
+    def commit_hash
+      ENV.fetch("COMMIT_HASH", `git rev-parse HEAD`.strip)
+    end
+
+    def buildkite_token
+      @_buildkite_token ||= `cat ~/.buildkite_token`
+    end
+  end
+end

data/lib/buildkite_watcher/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BuildkiteWatcher
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: buildkite_watcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arturo Pie
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: |
+  Command line utility that continuously watches for the buildkite job running current git HEAD and
+  notifies on build status changes.
+email:
+- arturop@nulogy.com
+executables:
+- bw
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- buildkite_watcher.gemspec
+- exe/bw
+- lib/buildkite_watcher.rb
+- lib/buildkite_watcher/version.rb
+homepage:
+licenses: []
+metadata:
+  source_code_uri: https://github.com/nulogy/buildkite_watcher
+  changelog_uri: https://github.com/nulogy/buildkite_watcher/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: CLI utility that watches buildkite and notify on build status changes
+test_files: []