buildkite_watcher 0.1.0 → 0.3.0

checksums.yaml

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

data/.github/workflows/main.yml

@@ -1,16 +1,22 @@
-name: Ruby
+name: CI
 
 on: [push,pull_request]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+  buildtest:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.7, '3.0']
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.2

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.3.0] - 2021-07-20
+
+- Changed notification title to use name of this gem
+
+## [0.2.0] - 2021-07-17
+
+- Uses config files to store buildkite token and buildkite pipeline slug
+- Prompts the user for token and buildkite slug when running for the first time
+- Properly prints errors that are caught
+
 ## [0.1.0] - 2021-06-04
 
 - Initial release

data/Gemfile.lock

@@ -1,8 +1,11 @@
 PATH
   remote: .
   specs:
-    buildkite_watcher (0.1.0)
-      rest-client (~> 2.1.0)
+    buildkite_watcher (0.3.0)
+      rest-client (~> 2.0)
+      tty-config (~> 0.5)
+      tty-link (~> 0.1)
+      tty-prompt (~> 0.23)
 
 GEM
   remote: https://rubygems.org/
@@ -24,6 +27,8 @@ GEM
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -69,10 +74,23 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
+    tty-color (0.6.0)
+    tty-config (0.5.0)
+    tty-cursor (0.7.1)
+    tty-link (0.1.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
     unicode-display_width (2.0.0)
+    wisper (2.0.1)
 
 PLATFORMS
   x86_64-darwin-19
@@ -89,4 +107,4 @@ DEPENDENCIES
   rubocop-rspec (~> 2.3.0)
 
 BUNDLED WITH
-   2.2.17
+   2.2.22

data/README.md

@@ -1,24 +1,37 @@
 # Buildkite Watcher
 
-Command line utility that continuously watches for the buildkite job running current git HEAD and notifies on build status changes.
+[![Gem Version](https://badge.fury.io/rb/buildkite_watcher.svg)](https://badge.fury.io/rb/buildkite_watcher)
+[![CI Status](https://github.com/nulogy/buildkite_watcher/workflows/CI/badge.svg?branch=main)](https://github.com/nulogy/buildkite_watcher/actions?query=workflow%3ACI)
+
+It continuously watches the most recent buildkite job running the current git branch and notifies on build status changes.
+
+![Notification Screenshot](docs/notification_screenshot.png)
 
 ## Installation
 
 Run this command:
 
-    $ gem install buildkite_watcher
+    gem install buildkite_watcher
 
 ## Usage
 
-From a directory in your project, run.
+From your project's root directory, run:
 
-`$ bw `
+    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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` 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
 
-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).
+1. Update `CHANGELOG.md`
+1. Update the version number in `version.rb`
+1. Run `bundle install`
+1. Commit the changes
+1. Run `bundle exec rake release`
 
 ## Contributing
 

data/buildkite_watcher.gemspec

@@ -29,5 +29,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rest-client", "~> 2.1.0"
+  spec.add_dependency "rest-client", "~> 2.0"
+  spec.add_dependency "tty-config", "~> 0.5"
+  spec.add_dependency "tty-link", "~> 0.1"
+  spec.add_dependency "tty-prompt", "~> 0.23"
 end

data/docs/buildkite_token.md

@@ -0,0 +1,12 @@
+# How to create the API Access Token in Buildkite
+
+1. Go to [the New API Access Token page](https://buildkite.com/user/api-access-tokens/new) in Buildkite
+1. Add a description (e.g. buildkite_watcher)
+1. In "Organization Access", check the organization the pipeline is in.
+1. Check "Enable GraphQL API Access"
+1. Click "Create New API Access Token"
+1. Copy the new token
+
+Example:
+
+![New API Access Token page](new_api_access_token_page.png)

data/docs/pipeline_slug.md

@@ -0,0 +1,7 @@
+# How to find the Buildkite Pipeline Slug
+
+1. Go to https://buildkite.com/ and log in
+1. On the home page, find the pipeline you want to watch
+1. The URL in the browser will give you the pipeline slug.
+
+   For Example, if you see https://buildkite.com/foo-corp/bar-pipeline, the pipeline slug is `foo-corp/bar-pipeline`

data/lib/buildkite_watcher.rb

@@ -2,7 +2,9 @@
 
 require "rainbow"
 require "rest-client"
+require "json"
 require "buildkite_watcher/version"
+require "buildkite_watcher/config_loader"
 
 # Command line utility that continuously watches for the buildkite job running current git HEAD and
 # notifies on build status changes.
@@ -71,6 +73,8 @@ module BuildkiteWatcher
     BUILD_UNKNOWN_STATUS = "UNKNOWN"
 
     def result_watch
+      config = ConfigLoader.load
+
       Signal.trap("SIGINT") do
         puts
         puts Rainbow("Program interrupt received. Exiting.").red
@@ -80,7 +84,7 @@ module BuildkiteWatcher
       previous_result = BUILD_UNKNOWN_STATUS
       loop do
         system("clear")
-        new_result = result
+        new_result = result(config)
 
         maybe_notify(previous_result, new_result)
         previous_result = new_result
@@ -97,7 +101,7 @@ module BuildkiteWatcher
     # - current commit has a build, has passed
     # - current commit has a build, has failed
 
-    def result
+    def result(config)
       puts Rainbow("Branch: ").bright + Rainbow(branch_name)
       puts Rainbow("HEAD ➜  ").bright + Rainbow(commit_hash)
       puts
@@ -105,13 +109,13 @@ module BuildkiteWatcher
       buildkite_query = {
         query: GRAPHQL_QUERY,
         variables: {
-          pipelineSlug: pipeline_slug,
+          pipelineSlug: config.pipeline_slug,
           commitHash: commit_hash,
           branch: branch_name,
         },
       }
 
-      builds = fetch_build_data(buildkite_query)
+      builds = fetch_build_data(buildkite_query, config)
       commit_hash_builds = simplify_builds_response_data(builds.commit_hash_builds)
       branch_builds = simplify_builds_response_data(builds.branch_builds)
 
@@ -151,7 +155,7 @@ module BuildkiteWatcher
       build.state
     rescue StandardError => e
       puts
-      puts Rainbow("ERROR: #{e.message}\n#{e.backtrace}").red
+      puts Rainbow("ERROR: \n#{e.backtrace.reverse.join("\n")}\n#{e.message}").red
     end
 
     private
@@ -159,11 +163,12 @@ module BuildkiteWatcher
     def maybe_notify(previous_result, new_result)
       return if new_result == previous_result || previous_result == BUILD_UNKNOWN_STATUS
 
+      # You can find available sounds here: '/System/Library/Sounds'
       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_PASSED, BUILD_BLOCKED
+        system('osascript -e \'display notification "CI PASSED" with title "Buildkite Watcher" sound name "Glass"\'')
       when BUILD_FAILED
-        system('osascript -e \'display notification "CI FAILED" with title "CI Result Watch" sound name "Basso"\'')
+        system('osascript -e \'display notification "CI FAILED" with title "Buildkite Watcher" sound name "Funk"\'')
       end
     end
 
@@ -171,13 +176,13 @@ module BuildkiteWatcher
       [BUILD_PASSED, BUILD_BLOCKED].include?(state)
     end
 
-    def fetch_build_data(buildkite_query)
+    def fetch_build_data(buildkite_query, config)
       response =
         JSON.parse(
           RestClient.post(
             "https://graphql.buildkite.com/v1",
             buildkite_query.to_json,
-            { Authorization: "Bearer #{buildkite_token}", content_type: :json },
+            { Authorization: "Bearer #{config.buildkite_token}", content_type: :json },
           ),
           object_class: OpenStruct,
         )
@@ -210,7 +215,7 @@ module BuildkiteWatcher
 
     def print_state(state)
       case state
-      when build_passed?(state)
+      when BUILD_PASSED, BUILD_BLOCKED
         puts Rainbow("CI Status: ").bright + Rainbow(state).green
       when BUILD_RUNNING
         puts Rainbow("CI Status: ").bright + Rainbow(state).yellow
@@ -256,24 +261,26 @@ module BuildkiteWatcher
       puts
       puts Rainbow("#{failures.count} failures from these specs:").yellow
       puts
-      failures.map(&:name).map { |name| /\[(\w+)\] (.*): .*/.match(name).captures }.group_by(&:first)
+      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
+          puts key
+          values
+            .map { |e| e[1] }
+            .uniq
+            .each do |failure_file|
+              failure_file
+              puts Rainbow(failure_file).red
+            end
         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
@@ -281,9 +288,5 @@ module BuildkiteWatcher
     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/config.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BuildkiteWatcher
+  class Config
+    attr_reader :pipeline_slug, :buildkite_token
+
+    def initialize(config, secrets)
+      @pipeline_slug = config.fetch(:pipeline_slug)
+      @buildkite_token = secrets.fetch(:buildkite_token)
+    end
+  end
+end

data/lib/buildkite_watcher/config_loader.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "tty-config"
+require "tty-link"
+require "tty-prompt"
+require "buildkite_watcher/config"
+
+module BuildkiteWatcher
+  class ConfigLoader
+    CONFIG_FILE_NAME = ".buildkite_watcher"
+    SECRETS_FILE_NAME = ".buildkite_watcher_secrets"
+    EXTENSION = ".yml"
+
+    def self.load(config = TTY::Config.new, secrets = TTY::Config.new, prompt = TTY::Prompt.new)
+      new(config, secrets, prompt).load
+    end
+
+    def load
+      config.filename = CONFIG_FILE_NAME
+      config.extname = EXTENSION
+      config.append_path Dir.pwd
+      config.exist? ? config.read : generate_config_file
+
+      secrets.filename = SECRETS_FILE_NAME
+      config.extname = EXTENSION
+      secrets.append_path Dir.home
+
+      secrets.exist? ? secrets.read : generate_secrets_file
+
+      Config.new(config, secrets)
+    end
+
+    private
+
+    attr_reader :config, :secrets, :prompt
+
+    def initialize(config, secrets, prompt)
+      @config = config
+      @secrets = secrets
+      @prompt = prompt
+    end
+
+    def generate_config_file
+      prompt.ok("Welcome to Buildkite Watcher!")
+      prompt.say("I can't find the configuration file, so I'll generate one for you now.")
+      link_to_instructions =
+        TTY::Link.link_to("instructions", "https://github.com/nulogy/buildkite_watcher/blob/main/docs/pipeline_slug.md")
+      pipeline_slug = prompt.ask(<<~MSG)
+        What's the pipeline slug of the pipeline you want to watch? See #{link_to_instructions} if you don't know how to find the pipeline slug.
+      MSG
+      config.set(:pipeline_slug, value: pipeline_slug)
+      config.write(create: true)
+    end
+
+    def generate_secrets_file
+      link_to_instructions =
+        TTY::Link.link_to("here", "https://github.com/nulogy/buildkite_watcher/blob/main/docs/buildkite_token.md")
+      link_to_new_token =
+        TTY::Link.link_to("New API Access token in Buildkite", "https://buildkite.com/user/api-access-tokens/new")
+
+      # We use #chop as a work around for a defect in TTY::Prompt that reprints prompt on every character
+      # entered
+      buildkite_token = prompt.mask(<<~MSG.chop)
+        Create a #{link_to_new_token}.
+        Make sure it has Organization and GraphQL API Access (more detailed instructions #{link_to_instructions}), and paste the token here:
+      MSG
+      secrets.set(:buildkite_token, value: buildkite_token)
+      secrets.write(create: true)
+    end
+  end
+end

data/lib/buildkite_watcher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildkite_watcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Arturo Pie
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,14 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: tty-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tty-link
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
 description: |
   Command line utility that continuously watches for the buildkite job running current git HEAD and
   notifies on build status changes.
@@ -39,6 +81,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -47,8 +90,14 @@ files:
 - bin/console
 - bin/setup
 - buildkite_watcher.gemspec
+- docs/buildkite_token.md
+- docs/new_api_access_token_page.png
+- docs/notification_screenshot.png
+- docs/pipeline_slug.md
 - exe/bw
 - lib/buildkite_watcher.rb
+- lib/buildkite_watcher/config.rb
+- lib/buildkite_watcher/config_loader.rb
 - lib/buildkite_watcher/version.rb
 homepage:
 licenses: []
@@ -73,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: CLI utility that watches buildkite and notify on build status changes