buildkite_graphql_ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60011358ae2bd0da0340216a969928e3064f3aa3
+  data.tar.gz: 42724f7d4f9adc116ea9bb7175541822007d146a
+SHA512:
+  metadata.gz: 1632a5a1b97a1aa6144e024ce1b1289b493d269856169443a40f950c752245c759079a0f370b501d8f36c1e6bba89dcb59887e29e165fc52490686999f50a3e5
+  data.tar.gz: 6f3f90034ef75e47242b32b64ff0d31cf3d353e364d22fb914e7ee02ab4b36a5620b3de35cebebae430adf4ee9f113aa4b37440778f6f4ea58d5ce17ba02a51c

data/bin/buildkite_graphql_ruby

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require "buildkite_graphql_ruby/cli"
+require "buildkite_graphql_ruby/query_builder"
+require "buildkite_graphql_ruby/query_runner"
+require "buildkite_graphql_ruby/commands/command_map"
+require 'pry'
+
+options = BuildkiteGraphqlRuby::CLI.parse(args: ARGV)
+command = BuildkiteGraphqlRuby::Commands::CommandMap.get_command(command_string: options.command)
+result = command.run!(options: options)
+command.report_result(result: result, options: options)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "buildkite_graphql_ruby"
+
+# 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/lib/buildkite_graphql_ruby/cli.rb

@@ -0,0 +1,66 @@
+module BuildkiteGraphqlRuby
+  class CLI
+    require 'optparse'
+    require 'optparse/time'
+    require 'ostruct'
+    require 'pp'
+
+    #
+    # Return a structure describing the options.
+    #
+    def self.parse(args:)
+      # The options specified on the command line will be collected in *options*.
+      # We set default values here.
+      options = OpenStruct.new
+      options.branch = `git rev-parse --abbrev-ref HEAD`.chomp # TODO: move this into git helper
+      options.command =  'branch_status'
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: buildkite_graphql_ruby [options]"
+
+        opts.separator ""
+        opts.separator "Specific options:"
+
+        opts.on("-b", "--branch BRANCH",
+                "Git branch to get stats on (default: current)") do |branch|
+          options.branch = branch.chomp
+        end
+
+        opts.on("-C", "--command COMMAND",
+                "What type of query to run (default and only option: branch_status") do |command|
+          # TODO: Error on unaccepted query types
+          options.command = command
+        end
+
+        opts.on("-a", "--api-token API TOKEN",
+                "Git branch to get stats on (default: current)") do |api_token|
+          options.api_token = api_token.chomp
+        end
+
+        # # Boolean switch.
+        # opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        #   options.verbose = v
+        # end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+
+        # Another typical switch to print the version.
+        opts.on_tail("--version", "Show version") do
+          puts ::Version.join('.')
+          exit
+        end
+      end
+
+      opt_parser.parse!(args)
+      options
+    end
+  end
+end

data/lib/buildkite_graphql_ruby/commands/branch_status.rb

@@ -0,0 +1,106 @@
+module BuildkiteGraphqlRuby
+  module Commands
+    require 'rainbow'
+    require "buildkite_graphql_ruby/results_parsers/build"
+    require "buildkite_graphql_ruby/results_parsers/rspec_results"
+
+    class BranchStatus
+      def run!(options:)
+        query = BuildkiteGraphqlRuby::QueryBuilder.new.branch_status(branch: options.branch)
+        query_runner = BuildkiteGraphqlRuby::QueryRunner.new.run_query(query: query, options: options)
+      end
+
+      def report_result(result:, options:)
+        builds_for_branch = result['data']['viewer']['user']['builds']
+        total_builds = builds_for_branch['count']
+
+        return if report_if_no_builds(total_builds, options)
+
+        builds = builds_for_branch["edges"].map{|build_response| ResultsParsers::Build.from_response(build_response) }
+        
+        return if report_if_no_finished_builds(builds, options)
+
+        latest_build = builds.select(&:finished?).sort_by(&:finished_at).last
+
+        return if report_if_latest_build_passed(latest_build, options)
+
+        # For each failing job, print out the label of the job and its status
+        puts border
+        puts Rainbow("Branch #{options.branch.inspect} has a failing build").red
+        puts Rainbow("URL: #{latest_build.url}").red
+        puts ""
+
+        failing_jobs = latest_build.jobs.reject(&:passed)
+        failing_jobs.each do |failing_job|
+          puts Rainbow("Failing Job: #{failing_job.label}").red
+          # This only works if rspec is configured to upload a file called `tmp/rspec_json_results.json` for
+          # rspec output.
+          artifacts_with_results = failing_job.artifacts.select{|a| a.path == 'tmp/rspec_json_results.json'}
+
+          artifacts_with_results.each do |artifact|
+            rspec_result = ResultsParsers::RspecResults.from_response(artifact.download)
+            puts rspec_result['summary_line']
+            puts "Failing tests:"
+            rspec_result.examples.reject(&:passed?).each do |e|
+              puts e.file_path
+            end
+          end
+        end
+
+        puts border
+      end
+
+      private
+
+      def border
+        Rainbow("=" * 80).blue
+      end
+
+      def report_if_no_builds(total_builds, options)
+        if total_builds == 0
+          report = [
+            border,
+            Rainbow("There are no builds for the branch #{options.branch.inspect}").lightblue,
+            border
+          ]
+
+          puts report
+          true
+        else
+          false
+        end
+      end
+
+      def report_if_no_finished_builds(builds, options)
+        if builds.select(&:finished?).none?
+          report = [
+            border,
+            Rainbow("None of the  builds for branch #{options.branch.inspect} have finished").lightblue,
+            border,
+          ]
+
+          puts report
+          true
+        else
+          false
+        end
+      end
+
+      def report_if_latest_build_passed(latest_build, options)
+        if latest_build.passed?
+          report = [
+            border,
+            Rainbow("Branch #{options.branch.inspect} has a passing build").green,
+            Rainbow("URL: #{latest_build.url}").green,
+            border,
+          ]
+
+          puts report
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/buildkite_graphql_ruby/commands/command_map.rb

@@ -0,0 +1,15 @@
+module BuildkiteGraphqlRuby
+  module Commands
+    class CommandMap
+      require "buildkite_graphql_ruby/commands/branch_status"
+
+      COMMAND_MAP = {
+        'branch_status' => BranchStatus
+      }
+
+      def self.get_command(command_string:)
+        COMMAND_MAP.fetch(command_string).new
+      end
+    end
+  end
+end

data/lib/buildkite_graphql_ruby/query_builder.rb

@@ -0,0 +1,58 @@
+module BuildkiteGraphqlRuby
+  class QueryBuilder
+    def branch_status(branch:)
+      query = <<~EOS
+        {
+          viewer {
+            user {
+              name
+              builds(branch:"#{branch}") {
+                count
+                edges {
+                  node{
+                    branch
+                    state
+                    url
+                    uuid
+                    scheduledAt
+                    startedAt
+                    finishedAt
+                    pullRequest {
+                      id
+                    }
+                    jobs(last: 20) {
+                      edges {
+                        node {
+                          \.\.\. on JobTypeCommand {
+                            agent {
+                              id
+                            }
+                            passed
+                            label
+                            artifacts(first: 100) {
+                              edges {
+                                node {
+                                  id
+                                  path
+                                  
+                                  state
+                                  downloadURL
+                                }
+                              }
+                            }
+                            command
+                            url
+                          }
+                        }
+                      }
+                    }
+                  } 
+                }
+              }
+            }
+          }
+        }
+        EOS
+    end
+  end
+end

data/lib/buildkite_graphql_ruby/query_runner.rb

@@ -0,0 +1,34 @@
+module BuildkiteGraphqlRuby
+  class QueryRunner
+
+    class ResponseError < StandardError; end
+
+    require 'net/http'
+    require 'uri'
+    require 'json'
+
+    def run_query(query:, options:)
+      request_from_api(query, options)
+    end
+
+    private
+
+    def request_from_api(query, options)
+      payload = {
+        query: query,
+      }.to_json
+
+      uri = URI.parse("https://graphql.buildkite.com/v1")
+      https = Net::HTTP.new(uri.host,uri.port)
+      https.use_ssl = true
+      https.read_timeout = 500
+      req = Net::HTTP::Post.new(uri.path, initheader = {'Authorization' =>"Bearer #{options.api_token}"})
+      req.body = payload
+      res = https.request(req)
+
+      raise ResponseError, res.message if res.code_type != Net::HTTPOK
+
+      JSON.parse(res.body)
+    end
+  end
+end

data/lib/buildkite_graphql_ruby/results_parsers/artifact.rb

@@ -0,0 +1,25 @@
+module BuildkiteGraphqlRuby
+  module ResultsParsers
+    class Artifact < OpenStruct
+      def self.from_response(response)
+        node = response['node']
+        # node.keys ["id", "path", "state", "downloadURL"]
+        
+        new(
+          id: node['id'],
+          path: node['path'],
+          state: node['state'],
+          download_url: node['downloadURL'],
+        )
+      end
+
+      private_class_method :new
+
+      def download
+        require 'open-uri'
+        file_contents = open(self.download_url) { |f| f.read }
+        file_contents
+      end
+    end
+  end
+end

data/lib/buildkite_graphql_ruby/results_parsers/build.rb

@@ -0,0 +1,61 @@
+module BuildkiteGraphqlRuby
+  module ResultsParsers
+    class Build < OpenStruct
+      require "buildkite_graphql_ruby/results_parsers/job"
+
+      # Potential build states (from graphQL docs)
+      # SKIPPED
+      # The build was skipped
+
+      # SCHEDULED
+      # The build has yet to start running jobs
+
+      # RUNNING
+      # The build is currently running jobs
+
+      # PASSED
+      # The build passed
+
+      # FAILED
+      # The build failed
+
+      # CANCELING
+      # The build is currently being canceled
+
+      # CANCELED
+      # The build was canceled
+
+      # BLOCKED
+      # The build is blocked
+
+      # NOT_RUN
+      # The build wasn't run
+
+      def self.from_response(response)
+        node = response['node']
+
+        jobs = node['jobs']["edges"].select{|j| j['node'].keys.count > 0 }.map{|build_response| ResultsParsers::Job.from_response(build_response) }
+ 
+        new(
+          branch: node['branch'],
+          state: node['state'],
+          url: node['url'],
+          started_at: node['startedAt'] && Time.parse(node['startedAt']),
+          finished_at: node['finishedAt'] && Time.parse(node['finishedAt']),
+          pull_request: node['pullRequest'],
+          jobs: jobs,
+        )
+      end
+
+      private_class_method :new
+
+      def finished?
+        !self.finished_at.nil?
+      end
+
+      def passed?
+        self.state == 'PASSED'
+      end
+    end
+  end
+end

data/lib/buildkite_graphql_ruby/results_parsers/job.rb

@@ -0,0 +1,25 @@
+module BuildkiteGraphqlRuby
+  module ResultsParsers
+    class Job < OpenStruct
+      require "buildkite_graphql_ruby/results_parsers/artifact"
+
+      def self.from_response(response)
+        node = response['node']
+
+        # node.keys: ["agent", "passed", "label", "artifacts", "command", "url"]
+        artifacts = node['artifacts']["edges"].map{|build_response| ResultsParsers::Artifact.from_response(build_response) }
+
+        new(
+          agent: node['agent'],
+          passed: node['passed'],
+          label: node['label'],
+          command: node['command'],
+          url: node['url'],
+          artifacts: artifacts,
+        )
+      end
+
+      private_class_method :new
+    end
+  end
+end

data/lib/buildkite_graphql_ruby/results_parsers/rspec_results.rb

@@ -0,0 +1,36 @@
+module BuildkiteGraphqlRuby
+  module ResultsParsers
+    class RspecResults < OpenStruct
+
+      class Example < OpenStruct
+        def self.from_response(response)
+          keys = ["id", "description", "full_description", "status", "file_path", "line_number", "run_time", "pending_message", "screenshot", "exception"]
+          example_data = keys.map do |key|
+            [key, response[key]]
+          end
+          
+          new(example_data.to_h)
+        end
+
+        private_class_method :new
+
+        def passed?
+          self.status == 'passed'
+        end
+      end
+
+      def self.from_response(raw_response)
+        response = JSON.parse(raw_response)
+        examples = response['examples'].map{|e| Example.from_response(e)}
+
+        new(
+          summary: response['summary'],
+          summary_line: response['summary_line'],
+          examples: examples,
+        )
+      end
+
+      private_class_method :new
+    end
+  end
+end

data/lib/buildkite_graphql_ruby/version.rb

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

data/lib/buildkite_graphql_ruby.rb

@@ -0,0 +1,4 @@
+require "buildkite_graphql_ruby/version"
+
+module BuildkiteGraphqlRuby
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: buildkite_graphql_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alex Evanczuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- alexevanczuk@gmail.com
+executables:
+- buildkite_graphql_ruby
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/buildkite_graphql_ruby
+- bin/console
+- bin/setup
+- lib/buildkite_graphql_ruby.rb
+- lib/buildkite_graphql_ruby/cli.rb
+- lib/buildkite_graphql_ruby/commands/branch_status.rb
+- lib/buildkite_graphql_ruby/commands/command_map.rb
+- lib/buildkite_graphql_ruby/query_builder.rb
+- lib/buildkite_graphql_ruby/query_runner.rb
+- lib/buildkite_graphql_ruby/results_parsers/artifact.rb
+- lib/buildkite_graphql_ruby/results_parsers/build.rb
+- lib/buildkite_graphql_ruby/results_parsers/job.rb
+- lib/buildkite_graphql_ruby/results_parsers/rspec_results.rb
+- lib/buildkite_graphql_ruby/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Wrapper for buildkite graphql library
+test_files: []