termcity 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc6bd575a30f6f6645b4b570814226738ac30c94
+  data.tar.gz: 8a17bd4fcbe547978d0fe25cf950ac157f251c8f
+SHA512:
+  metadata.gz: feb982a06dfe3285d17df91e688758bf17928f2186f325d59ac3e8e394f0336c6e34ce7159c99c485f6f6888fef93f7aba0d5391dcf625552641310a007ff4bb
+  data.tar.gz: 58a7a64dfb71260546b71d4b6dae2d3b81c5732cd456f963eedf09a6755a32ebef7345a8ad6a31c23a9cf98bb599bd1d133fde1fd1f2c72f8bd93137d1fb5367

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in termcity.gemspec
+gemspec
+
+gem "pry"

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "termcity"
+
+# 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

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/exe/termcity

@@ -0,0 +1,126 @@
+#! /usr/bin/env ruby
+require 'base64'
+require 'yaml'
+require "termcity/cli"
+require "optparse"
+require "uri"
+
+HELP = <<~TXT
+  Run termcity to see your test results on TeamCity:
+
+  termcity --branch myBranchName --project MyProjectId
+
+  [Options]
+
+  -b, --branch: defaults to current repo branch
+  -p, --project: defaults to camelcasing repo directory
+  -r, --revision: defaults to latest revision known to CI
+
+  [CREDENTIALS]:
+
+  The backend uses your Github organization memberships to verify your
+  access to the data. You must configure the CLI with a token granting
+  it access to read your org memberships:
+
+  1. Visit https://github.com/settings/tokens/new
+  2. Generate a new token
+  3. Only grant the `read:org` permission (leave all others unchecked)
+  4. Paste the token in the configuration file as specified below.
+
+  [CONFIGURATION]
+  Put a json formatted file at ~/.termcity with the following data:
+
+    {
+      "host":  "https://my.termcity.api.com",
+      "token": "your github auth token"
+    }
+
+  [OUTPUT]
+
+  Builds are listed in alphabetical order. Builds that have a result for
+  the latest revision but are also re-enqueued have a ",q" next to them.
+  For example, "failed,q" means the latest build on the branch has
+  failed, but it is enqueued to run again.
+TXT
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: termcity [options]"
+
+  opts.on("-b BRANCH", "--branch BRANCH", "git branch (defaults to current repo branch)") do |b|
+    options[:branch] = b
+  end
+
+  opts.on("-p PROJECT_ID", "--project PROJECT_ID", "The project id (defaults to camelCasing on repo directory)") do |p|
+    options[:project_id] = p
+  end
+
+  opts.on("-r REVISION", "--revision REVISION", "The git revision to look for (defaults to revision of latest test run)") do |r|
+    options[:revision] = r
+
+    if !r.match(/\h{40}/)
+      warn("#{r} is not a full/valid git revision")
+      exit(1)
+    end
+  end
+
+  opts.on("-h", "--help", "See help") do
+    puts HELP
+    exit(0)
+  end
+
+end.parse!
+
+if ARGV.any?
+  puts HELP
+  exit(1)
+end
+
+if !options[:branch]
+  options[:branch] = `git rev-parse --abbrev-ref @`.chomp
+  if $? != 0
+    warn "Could not identify branch. Please specify one"
+    exit(1)
+  end
+end
+
+if !options[:project_id]
+  root_dir =
+    `git rev-parse --show-toplevel`
+      .chomp
+      .tap { raise "detecting root dir failed" unless $?==0}
+
+  camelcase_root_dir =
+    File
+    .basename(root_dir)
+    .sub(/^[a-z\d]*/) { $&.capitalize }
+    .gsub(/(?:_|(\/))([a-z\d]*)/) { $2.capitalize }
+
+  options[:project_id] = camelcase_root_dir
+end
+
+creds_file = File.expand_path("~/.termcity")
+if !File.exist?(creds_file)
+  warn "Could not find a credentials file. See --help for info."
+  exit(1)
+end
+
+yaml = YAML.load_file(creds_file)
+
+if yaml["host"].nil?
+  warn "Could not find `host` in credentials file. See --help for more info"
+  exit(1)
+end
+
+if yaml["token"].nil?
+  warn "Could not find `token` in credentials file. See --help for more info"
+  exit(1)
+end
+
+Termcity::CLI.simple_format(
+  token: yaml["token"],
+  host: yaml["host"],
+  branch: options[:branch],
+  revision: options[:revision],
+  project_id: options[:project_id]
+)

data/lib/termcity.rb

@@ -0,0 +1,5 @@
+require "termcity/version"
+
+module Termcity
+
+end

data/lib/termcity/api.rb

@@ -0,0 +1,42 @@
+require "json"
+require "net/http"
+require "uri"
+
+module Termcity
+  class Api
+    ALLOWED_BUILD_FILTERS = [
+      :branch,
+      :count,
+      :defaultFilter,
+      :failedtoStart,
+      :project,
+      :revision,
+      :state,
+    ]
+
+    def initialize(token:, host:)
+      @token = token
+      @host = host
+    end
+
+    def summary(branch:, project_id:, revision:)
+      path = "/builds?branch=#{branch}&project_id=#{project_id}"
+      path = "#{path}&revision=#{revision}" if revision
+      url = URI.join(@host, path).to_s
+      get(url)
+    end
+
+    private
+
+    def get(url)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request["authorization"] = @token
+      http.use_ssl = true
+      response = http.request(request)
+      raise "request failure:\n\n#{response.body}" unless response.code == "200"
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/termcity/cli.rb

@@ -0,0 +1,49 @@
+require "termcity/api"
+require "termcity/version"
+require "termcity/formatters/simple"
+require "termcity/formatters/iterm2"
+require "termcity/summary"
+
+module Termcity
+  class CLI
+    def self.simple_format(**args)
+      new(**args).simple_format
+    end
+
+    def initialize(branch:, token:, host:, project_id:, revision:)
+      @branch = branch
+      @token = token
+      @host = host
+      @project_id = project_id
+      @revision = revision
+    end
+
+    def simple_format
+      api = Termcity::Api.new(
+        token: @token,
+        host: @host,
+      )
+
+      summary = Termcity::Summary.new(
+        api: api,
+        branch: @branch,
+        revision: @revision,
+        project_id: @project_id,
+      )
+
+      formatter =
+        if using_iterm?
+          Termcity::Formatters::Iterm2
+        else
+          Termcity::Formatters::Simple
+        end
+
+      formatter.new($stdout).format(summary)
+    end
+
+    def using_iterm?
+      ENV["TERM_PROGRAM"] == "iTerm.app" &&
+        ENV.fetch("TERM_PROGRAM_VERSION", "").match(/3.[23456789].[123456789]/)
+    end
+  end
+end

data/lib/termcity/formatters/iterm2.rb

@@ -0,0 +1,30 @@
+require "termcity/formatters/simple"
+
+module Termcity
+  module Formatters
+    class Iterm2
+
+      attr_reader :io, :simple_formatter
+      def initialize(io)
+        @io = io
+        @simple_formatter = Simple.new(io)
+      end
+
+      def format(summary)
+        rows = summary.builds.map do |raw:, status:|
+          cols = []
+          cols << simple_formatter.status_string(status)
+          cols << linkify(raw.fetch("web_url"))
+          cols << raw.fetch("build_type")
+          cols.join(" ")
+        end
+
+        @io.puts(simple_formatter.summarize(summary, rows))
+      end
+
+      def linkify(url)
+        "\e]8;;#{url}\aLink\e]8;;\a"
+      end
+    end
+  end
+end

data/lib/termcity/formatters/simple.rb

@@ -0,0 +1,83 @@
+require "termcity/formatters/util/color"
+
+module Termcity
+  module Formatters
+    class Simple
+      include Utils::Color
+
+      STATUSES = {
+        queued: "queued",
+        failing: "failing",
+        running: "running",
+        failed_to_start: "failstrt",
+        failed: "failed",
+        success: "success"
+      }
+
+      COLORS = {
+        failing: :red,
+        queued: :yellow,
+        running: :blue,
+        failed_to_start: :default,
+        failed: :red,
+        success: :green
+      }
+
+      attr_reader :io
+      def initialize(io)
+        @io = io
+      end
+
+      def format(summary)
+        rows = summary.builds.map do |raw:, status:|
+          cols = []
+          cols << status_string(status)
+          cols << raw.fetch("build_type")
+          cols << raw.fetch("web_url")
+
+          cols.join(" : ")
+        end
+
+        @io.puts(summarize(summary, rows))
+      end
+
+      def status_string(type:, re_enqueued:)
+        name = STATUSES.fetch(type)
+        name = "#{name},q" if re_enqueued
+        color = COLORS[type]
+
+        colorize(name.ljust(10), color)
+      end
+
+      def summarize(summary, rows)
+        if summary.builds.empty?
+          "No builds found"
+        elsif summary.counts[:queued] == summary.counts[:total]
+          "This revision may still be in the queue (or may be unkown/old)"
+        else
+          [
+            rows,
+            "",
+            "Revision: #{summary.builds.first.dig(:raw, "sha")}",
+            "Overview: #{summary.overview_link}",
+            counts(summary),
+          ].join("\n")
+        end
+      end
+
+      def counts(summary)
+        [
+          ["Total", summary.counts[:total]],
+          ["Success", summary.counts[:success]],
+          ["Failure", summary.counts[:failure]],
+          ["Running", summary.counts[:running]],
+          ["FailedToStart", summary.counts[:failed_to_start]],
+          ["Queued", summary.counts[:queued]],
+          ["Re-Queued", summary.counts[:re_enqueued]]
+        ]
+          .map {|name, count| "#{name}: #{count}"}
+          .join(", ")
+      end
+    end
+  end
+end

data/lib/termcity/formatters/util/color.rb

@@ -0,0 +1,33 @@
+module Termcity
+  module Formatters
+    module Utils
+      module Color
+        CODES = {
+          red: 31,
+          green: 32,
+          yellow: 33,
+          blue: 34,
+          pink: 35,
+        }.freeze
+
+        CODES.each do |color, code|
+          define_method(color) do |string|
+            colorize_code(string, code)
+          end
+        end
+
+        def colorize(string, color_name)
+          return string unless CODES.key?(color_name)
+          colorize_code(string, CODES[color_name])
+        end
+
+        private
+
+        # colorization
+        def colorize_code(string, color_code)
+          "\e[#{color_code}m#{string}\e[0m"
+        end
+      end
+    end
+  end
+end

data/lib/termcity/summary.rb

@@ -0,0 +1,91 @@
+module Termcity
+  class Summary
+    def initialize(revision:, api:, branch:, project_id:)
+      @branch = branch
+      @project_id = project_id
+      @api = api
+      @revision = revision
+    end
+
+    def builds
+      data[:builds]
+    end
+
+    def counts
+      data[:counts]
+    end
+
+    def overview_link
+      data.dig(:links, :overview)
+    end
+
+    def data
+      # this is messy but allows for a single pass
+      @data ||= begin
+        counts = {
+          total: 0,
+          success: 0,
+          failure: 0,
+          running: 0,
+          queued: 0,
+          failed_to_start: 0,
+          re_enqueued: 0,
+        }
+
+        summary = @api.summary(branch: @branch, project_id: @project_id, revision: @revision)
+
+        builds = summary.fetch("builds")
+          .sort_by {|b| b.fetch("build_type")}
+          .map {|b| summarize(b, counts) }
+
+        {
+          links: {overview: summary.dig("links", "overview")},
+          builds: builds,
+          counts: counts
+        }
+      end
+    end
+
+    def summarize(build, counts)
+      status = status(build)
+
+      count_type =
+        if [:failing, :failed].include?(status[:type])
+          :failure
+        else
+          status[:type]
+        end
+      counts[count_type] += 1
+      counts[:total] += 1
+      counts[:re_enqueued] +=1 if status[:re_enqueued]
+
+      {
+        raw: build,
+        status: status
+      }
+    end
+
+    def status(build)
+      re_enqueued = build.fetch("re_enqueued")
+
+      if build.fetch("state") == "queued"
+        {type: :queued, re_enqueued: false}
+      elsif build.fetch("state") == "running"
+        if build.fetch("status") == "FAILURE"
+          {type: :failing, re_enqueued: re_enqueued}
+        else
+          {type: :running, re_enqueued: re_enqueued}
+        end
+      else
+        if build.fetch("failed_to_start", false)
+          {type: :failed_to_start, re_enqueued: re_enqueued}
+        elsif build.fetch("status") == "FAILURE"
+          {type: :failed, re_enqueued: re_enqueued}
+        else
+          {type: :success, re_enqueued: re_enqueued}
+        end
+      end
+    end
+  end
+end
+

data/lib/termcity/version.rb

@@ -0,0 +1,3 @@
+module Termcity
+  VERSION = "0.4.0"
+end

data/termcity.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "termcity/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "termcity"
+  spec.version       = Termcity::VERSION
+  spec.authors       = ["Pete Kinnecom"]
+  spec.email         = ["git@k7u7.com"]
+
+  spec.summary       = %q{Terminal view of TeamCity}
+  spec.description   = %q{See TeamCity build status for a branch in your terminal. Pipe it to grep or whatever. Get nicely formatted links if you use iTerm2.}
+  # spec.homepage      = "none"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.files         = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: termcity
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Pete Kinnecom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-24 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'
+description: See TeamCity build status for a branch in your terminal. Pipe it to grep
+  or whatever. Get nicely formatted links if you use iTerm2.
+email:
+- git@k7u7.com
+executables:
+- termcity
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Rakefile
+- bin/console
+- bin/setup
+- exe/termcity
+- lib/termcity.rb
+- lib/termcity/api.rb
+- lib/termcity/cli.rb
+- lib/termcity/formatters/iterm2.rb
+- lib/termcity/formatters/simple.rb
+- lib/termcity/formatters/util/color.rb
+- lib/termcity/summary.rb
+- lib/termcity/version.rb
+- termcity.gemspec
+homepage: 
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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
+signing_key: 
+specification_version: 4
+summary: Terminal view of TeamCity
+test_files: []