buildkite-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54ac29683a5b656c0b77fa4006c3d479ddc6b636b184ebbe5528886af788d5d5
+  data.tar.gz: e413c8e3c6935c79605046bed1d438752b088f2fb05d908a7f6d0792617d7ed4
+SHA512:
+  metadata.gz: 647c6117019a268e476a8e34333259344d874585f06c83bb0b114771d600fb6fcfad8d7992740d4cfe148585c7627ec8bf922cfc948d58164c4f3c432f8d765a
+  data.tar.gz: 941e18fbf12e853be9735d52ce1a9348a0b226227802ccaa65e2c1ff09cffd0a779c79d54347cb27c7c02f61be31e29dbb396f6d6058d90ee3d1a328261cf389

data/.pryrc

@@ -0,0 +1,4 @@
+require "pry-rescue"
+require "pry-stack_explorer"
+
+require_relative "./lib/bk"

data/.rubocop.yml

@@ -0,0 +1,9 @@
+# Only use standardrb, but keep .rubocop.yml for tool compatibility: https://github.com/standardrb/standard#running-standards-rules-via-rubocop
+require:
+  - standard
+  - rubocop-performance
+
+inherit_gem:
+  standard: config/base.yml
+  standard-performance: config/base.yml
+  standard-custom: config/base.yml

data/.standard.yml

@@ -0,0 +1,2 @@
+fix: true               # default: false
+parallel: true          # default: false

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bk.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: .
+  specs:
+    buildkite-cli (0.1.0)
+      dry-cli
+      graphql-client
+      httparty
+      json
+      tty-box
+      tty-markdown
+      tty-pager
+      tty-spinner
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    debug_inspector (1.1.0)
+    dry-cli (0.7.0)
+    graphql (2.0.21)
+    graphql-client (0.18.0)
+      activesupport (>= 3.0)
+      graphql
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    multi_xml (0.6.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    prettier_print (1.2.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-stack_explorer (0.6.1)
+      binding_of_caller (~> 1.0)
+      pry (~> 0.13)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rouge (4.1.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-lsp (0.5.1)
+      language_server-protocol (~> 3.17.0)
+      sorbet-runtime
+      syntax_tree (>= 6.1.1, < 7)
+    ruby-progressbar (1.13.0)
+    sorbet-runtime (0.5.10821)
+    standard (1.28.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    syntax_tree (6.1.1)
+      prettier_print (>= 1.2.0)
+    tty-box (0.7.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-cursor (~> 0.7)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-markdown (0.7.2)
+      kramdown (>= 1.16.2, < 3.0)
+      pastel (~> 0.8)
+      rouge (>= 3.14, < 5.0)
+      strings (~> 0.2.0)
+      tty-color (~> 0.5)
+      tty-screen (~> 0.8)
+    tty-pager (0.14.0)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
+    tty-screen (0.8.1)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    unicode_utils (1.4.0)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+
+DEPENDENCIES
+  buildkite-cli!
+  pry
+  pry-stack_explorer
+  rake (~> 13.0)
+  ruby-lsp
+  standard
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Joshua Nichols
+
+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,65 @@
+# Bk
+
+CLI for poking around Buildkite, like `gh` for GitHub
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bk`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+See Development section while in release
+
+## Usage
+
+See `bk --help` and `bk <subcommand> --help` for most accurate usage. Below are some examples!
+
+### Annotations
+
+Usage: `bk annotations [slug_or_url]`
+
+Display annotations of a specific build:
+
+    $ bk annotations https://buildkite.com/your-org/your-pipeline/builds/1234
+
+Display annotations of the most recent build (requires `gh`):
+
+    $ bk annotations
+
+### Artifacts
+
+Usage: `bk artifacts [slug_or_url] [--glob <pattern>] [--download]`
+
+Display artifacts of a specific build:
+
+    $ bk annotations https://buildkite.com/your-org/your-pipeline/builds/1234
+
+Display artifacts of a specific build matching a glob (tip: quote the glob pattern to avoid your shell expanding):
+
+    $ bk annotations https://buildkite.com/your-org/your-pipeline/builds/1234 --glob "*.log"
+
+Download artifacts of a specific build matching a glob (tip: quote the glob pattern to avoid your shell expanding):
+
+    $ bk annotations https://buildkite.com/your-org/your-pipeline/builds/1234 --glob "*.log" --download
+
+### To be continue?
+
+More to come? Whatchu want? Feature requests and PRs welcome!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. You can run the command from this checkout with:
+
+    bk $ bundle exec exe/bk [args...]
+
+To install this gem onto your local machine, run `bundle exec rake install`. If you want to use `bk` in different ruby versions, you'll need to use your version manager to switch and install it. You might find this snippet useful:
+
+    bk $ rake build
+    bk 0.1.0 built to pkg/bk-0.1.0.gem.
+
+    bk $ cd ~/workspace/some-project
+    some-project $ gem install ~/workspace/bk/bk-0.1.0.gem
+
+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/technicalpickles/bk.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]
+
+namespace :buildkite do
+  task :dump_schema do
+    require "./lib/bk"
+    require "graphql/client"
+    GraphQL::Client.dump_schema(Bk::HTTP, "schema.json")
+  end
+end

data/exe/bk

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "bk"
+
+require "pry"
+Dry::CLI.new(Bk::Commands).call

data/lefthook.yml

@@ -0,0 +1,7 @@
+pre-commit:
+  parallel: true
+  commands:
+    standardrb:
+      glob: "{*.rb,exe/*}"
+      run: standardrb --fix {staged_files}
+      auto_stage: true

data/lib/bk/annotation_formatter/markdown.rb

@@ -0,0 +1,58 @@
+module TTYMarkdownConverterExtension
+  def convert_html_element(el, opts)
+    if el.value == "span"
+      color = color_from_span_class(el.attr["class"])
+      return super unless color
+
+      pastel.send(color, inner(el, opts))
+    else
+      super
+    end
+  end
+
+  def color_from_span_class(css_class)
+    match = css_class.match(/^term-(?:[fb]g)(\d+)$/)
+    return unless match
+
+    color_code = Integer(match[1])
+
+    Pastel::ANSI::ATTRIBUTES.key(color_code)
+  end
+
+  def pastel
+    @pastel ||= Pastel.new
+  end
+end
+
+class TTY::Markdown::Converter
+  prepend TTYMarkdownConverterExtension
+end
+
+module Bk
+  module AnnotationFormatter
+    class Markdown
+      include Color
+      include Format
+
+      def call(annotation)
+        io = StringIO.new
+
+        style = annotation.style
+        color = annotation_colors[style]
+
+        context = annotation.context
+        io.puts "  #{color.call("#{vertical_pipe}#{context}")}"
+        io.puts "  #{color.call(vertical_pipe)}"
+
+        output = TTY::Markdown.parse(annotation.body.text)
+        output = CGI.unescape_html(output)
+
+        output.each_line do |line|
+          io.puts "  #{color.call(vertical_pipe)}  #{line}"
+        end
+
+        io.string
+      end
+    end
+  end
+end

data/lib/bk/color.rb

@@ -0,0 +1,32 @@
+module Bk
+  module Color
+    def success_color
+      @success_color ||= pastel.green.detach
+    end
+
+    def error_color
+      @error_color ||= pastel.red.detach
+    end
+
+    def warning_color
+      @warning_color ||= pastel.yellow.detach
+    end
+
+    def info_color
+      @info_color ||= pastel.blue.detach
+    end
+
+    def default_color
+      @default_color ||= pastel.white.detach
+    end
+
+    def colorize(text, color)
+      is_tty? ? color.call(text) : text
+    end
+
+    def create_color_hash(mappings = {})
+      hash = Hash.new(default_color)
+      hash.merge!(mappings)
+    end
+  end
+end

data/lib/bk/commands/annotations.rb

@@ -0,0 +1,73 @@
+module Bk
+  module Commands
+    class Annotations < Base
+      desc "Show Annotations for a Build"
+      argument :url_or_slug, type: :string, required: false, desc: "Build URL or Build slug"
+
+      BuildAnnotationsQuery = Client.parse <<-GRAPHQL
+          query($slug: ID!) {
+            build(slug: $slug) {
+              number
+
+              pipeline {
+                slug
+              }
+
+              branch
+              message
+
+              url
+              pullRequest {
+                id
+              }
+              state
+              startedAt
+              finishedAt
+              canceledAt
+
+              annotations(first: 200) {
+                edges {
+                  node {
+                    context
+                    style
+                    body {
+                      text
+                    }
+                  }
+                }
+              }
+            }
+          }
+      GRAPHQL
+
+      def call(args: {}, url_or_slug: nil)
+        slug = determine_slug(url_or_slug)
+        unless slug
+          raise ArgumentError, "Unable to figure out slug to use"
+        end
+
+        result = query(BuildAnnotationsQuery, variables: {slug: slug})
+
+        build = result.data.build
+
+        $stdout.puts build_header(build)
+        $stdout.puts ""
+
+        annotation_edges = build.annotations.edges
+        annotations = annotation_edges.map { |edge| edge.node }
+
+        format = AnnotationFormatter::Markdown.new
+        # indent each annotation to separate it from the build status
+        annotations.each_with_index do |annotation, index|
+          $stdout.puts format.call(annotation)
+          # horizontal separator between each
+          unless index == annotations.length - 1
+            $stdout.puts ""
+            $stdout.puts "  #{HORIZONTAL_PIPE * (TTY::Screen.width - 4)}  "
+            $stdout.puts ""
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bk/commands/artifacts.rb

@@ -0,0 +1,148 @@
+module Bk
+  module Commands
+    class Artifacts < Base
+      desc "Show Artifacts for a Build"
+      argument :url_or_slug, type: :string, required: false, desc: "Build URL or Build slug"
+
+      option :glob, required: false, desc: "Glob of artifacts to list"
+      option :download, type: :boolean, required: false, desc: "Should or should not download"
+
+      BuildArtifactsQuery = Client.parse <<-GRAPHQL
+          query($slug: ID!, $jobs_after: String) {
+            build(slug: $slug) {
+              number
+              message
+              uuid
+
+              branch
+              pipeline {
+                slug
+              }
+
+              url
+              pullRequest {
+                id
+              }
+
+              state
+              scheduledAt
+              startedAt
+              finishedAt
+              canceledAt
+
+              jobs(first: 500, after: $jobs_after) {
+                pageInfo {
+                  endCursor
+                  hasNextPage
+                }
+                edges {
+                  node {
+                    __typename
+                    ... on JobTypeWait {
+                      uuid
+                      label
+                    }
+                    ... on JobTypeTrigger {
+                      uuid
+                      label
+                    }
+
+                    ... on JobTypeCommand {
+                      uuid
+                      label
+
+                      url
+                      exitStatus
+
+                      parallelGroupIndex
+                      parallelGroupTotal
+
+                      artifacts(first: 500) {
+                        edges {
+                          node {
+                            state
+                            path
+                            downloadURL
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+
+      GRAPHQL
+
+      def call(args: {}, url_or_slug: nil, **options)
+        slug = determine_slug(url_or_slug)
+        unless slug
+          raise ArgumentError, "Unable to figure out slug to use"
+        end
+
+        glob = options[:glob]
+        download = options[:download]
+
+        jobs_after = nil
+        has_next_page = true
+
+        while has_next_page
+          result = query(BuildArtifactsQuery, variables: {slug: slug, jobs_after: jobs_after})
+
+          build = result.data.build
+          # only show the first time
+          if jobs_after.nil?
+            puts build_header(build)
+            puts ""
+          end
+
+          jobs_after = build.jobs.page_info.end_cursor
+          has_next_page = build.jobs.page_info.has_next_page
+
+          jobs = build.jobs.edges.map(&:node)
+          jobs.each do |job|
+            next unless job.respond_to?(:exit_status)
+
+            artifacts = job.artifacts.edges.map(&:node).select { |artifact| glob_matches?(glob, artifact.path) }
+            next unless artifacts.any?
+
+            color = job_colors[job.exit_status]
+            header = color.call(job.label)
+            if job.parallel_group_index && job.parallel_group_total
+              header = "#{header} (#{job.parallel_group_index + 1}/#{job.parallel_group_total})"
+            end
+
+            puts header
+
+            artifacts.each do |artifact|
+              if download
+                puts "  - #{artifact.path} (downloading to tmp/bk/[filename])"
+                download_artifact(artifact)
+              else
+                puts "  - #{artifact.path}"
+              end
+            end
+          end
+        end
+      end
+
+      def glob_matches?(glob, path)
+        if glob
+          File.fnmatch?(glob, path, File::FNM_PATHNAME)
+        else
+          true
+        end
+      end
+
+      def download_artifact(artifact)
+        download_url = artifact.to_h["downloadURL"]
+        redirected_response_from_aws = Net::HTTP.get_response(URI(download_url))
+        artifact_response = Net::HTTP.get_response(URI(redirected_response_from_aws["location"]))
+        path = Pathname.new("tmp/bk/#{artifact.path}")
+        FileUtils.mkdir_p(path.dirname)
+        path.write(artifact_response.body)
+      end
+    end
+  end
+end

data/lib/bk/commands.rb

@@ -0,0 +1,54 @@
+module Bk
+  module Commands
+    extend Dry::CLI::Registry
+
+    class Base < Dry::CLI::Command
+      include Color
+      include Format
+
+      attr_reader :spinner
+
+      def initialize(buildkite_api_token: nil)
+        @spinner = TTY::Spinner.new("Talking to Buildkite API... :spinner", clear: true, format: :dots)
+      end
+
+      private
+
+      def parse_slug_from_url(url)
+        # https://buildkite.com/my-org/my-pipeline/builds/1234 => my-org/my-pipeline/1234
+        url.delete_prefix("https://buildkite.com/").gsub("/builds", "")
+      end
+
+      def determine_slug(url_or_slug = nil)
+        if url_or_slug
+          if url_or_slug.start_with?("https:")
+            parse_slug_from_url(url_or_slug)
+          else
+            url_or_slug
+          end
+        else
+          output = `gh pr checks`
+          output.lines.each do |line|
+            if line =~ %r{https://buildkite.com/([^/]+)/([^/]+)/builds/(\d+)}
+              return "#{$1}/#{$2}/#{$3}"
+            end
+          end
+
+          nil
+        end
+      end
+
+      def query(graphql_query, **kwargs)
+        result = nil
+        spinner.run("Done") do |spinner|
+          result = Client.query(graphql_query, **kwargs)
+        end
+
+        result
+      end
+    end
+
+    register "annotations", Annotations
+    register "artifacts", Artifacts
+  end
+end