jira_dependency_visualizer 0.1.0

data/jira_dependency_visualizer.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+require 'rake'
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jira_dependency_visualizer/version'
+
+Gem::Specification.new do |s|
+  s.authors               = ['Alejandro Figueroa']
+  s.bindir                = 'bin'
+  s.description           = 'Creates a graphviz file from a JIRA ticket\'s dependencies'
+  s.email                 = ['alejandro@ideasftw.com']
+  s.executables << 'jira_dependency_visualizer'
+  s.files                 = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'spec/**/*'].to_a
+  s.homepage              = 'https://github.com/thejandroman/jira_dependency_visualizer'
+  s.license               = 'MIT'
+  s.name                  = 'jira_dependency_visualizer'
+  s.summary               = 'Creates a graphviz file from a JIRA ticket\'s dependencies'
+  s.required_ruby_version = ['>= 2.1.0', '<= 2.3.0']
+  s.version               = JiraDependencyVisualizer::VERSION
+
+  s.add_dependency 'jira-ruby', '~> 0.1'
+  s.add_dependency 'ruby-graphviz', '~> 1.2'
+  s.add_dependency 'trollop', '~> 2.1'
+
+  s.add_development_dependency 'bundler', '~> 1.11'
+  s.add_development_dependency 'coveralls', '~> 0.8'
+  s.add_development_dependency 'factory_girl', '~> 4.5'
+  s.add_development_dependency 'guard-rspec', '~> 4.6'
+  s.add_development_dependency 'pry', '~> 0.10'
+  s.add_development_dependency 'rake', '~> 10.5'
+  s.add_development_dependency 'rspec', '~> 3.4'
+  s.add_development_dependency 'rubocop', '~> 0.37'
+  s.add_development_dependency 'yard', '~> 0.8'
+end

data/lib/jira_dependency_visualizer.rb

@@ -0,0 +1,7 @@
+require 'jira_dependency_visualizer/graph'
+require 'jira_dependency_visualizer/jira'
+require 'jira_dependency_visualizer/version'
+
+# The gem namespace
+module JiraDependencyVisualizer
+end

data/lib/jira_dependency_visualizer/graph.rb

@@ -0,0 +1,118 @@
+require 'graphviz'
+
+module JiraDependencyVisualizer
+  # Gets Jira issue dependencies and creates a Graphviz graph based on
+  # those dependencies
+  class Graph
+    # @param [String] the initial issue to build the dependency graph
+    #   from
+    # @param [JiraDependencyVisualizer::Jira]
+    # @param [Array] list of issue link types to exclude from the
+    #   graph
+    # @param [Hash] colors for graph; see `./config/colors.yaml`
+    # @param [Graphviz]
+    def initialize(start_issue_key, jira, excludes = [], colors = {}, graph = nil)
+      @start_issue_key = start_issue_key
+      @jira = jira
+      @excludes = excludes
+      @colors = colors
+      @graph = graph || GraphViz.new(start_issue_key.to_sym, type: :digraph)
+      @seen = []
+    end
+
+    # Retrieve a list of all tickets dependent to `@start_issue_key`
+    # and add them to a Graphviz graph.
+    def walk
+      issue_walker(@start_issue_key)
+    end
+
+    # @param [String] filename the output filename
+    # @param [String] format the graphviz output format for the graph
+    def write_graph(filename = './issue_graph.svg', format = 'svg')
+      @graph.output(format.to_sym => filename)
+    end
+
+    private
+
+    def status_color(issue)
+      return {} unless @colors.key?('status')
+      @colors['status'][issue['fields']['status']['name']] || {}
+    end
+
+    def get_key(issue)
+      issue.attrs['key']
+    end
+
+    def process_link(issue_key, link)
+      return unless link.key?('outwardIssue')
+
+      direction        = 'outward'
+      linked_issue_key = link[direction + 'Issue']['key']
+      link_type        = link['type'][direction]
+
+      return linked_issue_key if @excludes.include?(link_type)
+
+      attrs = { label: link_type }
+      attrs[:color] = 'red' if link_type == 'blocks'
+      node_edge_builder(issue_key, linked_issue_key, attrs)
+      # node_attr_builder(linked_issue_key, status_color(link['outwardIssue']))
+
+      linked_issue_key
+    end
+
+    def node_edge_builder(node1_key, node2_key, edge_attrs)
+      @graph.add_edges(node1_key, node2_key, edge_attrs)
+    end
+
+    def node_attr_builder(issue)
+      issue_key = get_key(issue)
+      attrs = status_color(issue.attrs).merge(
+        'URL'     => "#{@jira.base_url}/browse/#{issue_key}",
+        'tooltip' => issue.attrs['fields']['summary']
+      )
+      node = @graph.search_node(issue_key)
+      attrs.each { |k, v| node[k] = v }
+    end
+
+    def epic_walker(issue_key, children)
+      issues = @jira.query("'Epic Link' = '#{issue_key}'")
+      issues.each do |subtask|
+        subtask_key = get_key(subtask)
+        node_edge_builder(issue_key, subtask_key, color: 'orange')
+        node_attr_builder(subtask)
+        children.push(subtask_key)
+      end
+    end
+
+    def issue_walker(issue_key)
+      issue = @jira.get_issue(issue_key)
+      @seen.push(issue_key)
+      fields = issue.attrs['fields']
+      fields.reject! { |_, v| v.nil? || v.empty? if v.is_a? Array }
+      children = []
+
+      epic_walker(issue_key, children) if fields['issuetype']['name'] == 'Epic'
+      subtasks_walker(fields['subtasks'], issue_key, children) if fields.key?('subtasks')
+      issuelinks_walker(fields['issuelinks'], issue_key, children) if fields.key?('issuelinks')
+
+      (children - @seen).each { |child| issue_walker(child) }
+    end
+
+    def issuelinks_walker(issuelinks, issue_key, children)
+      issuelinks.each do |other_link|
+        result = process_link(issue_key, other_link)
+        next if result.nil?
+        children.append(result)
+      end
+    end
+
+    def subtasks_walker(subtasks, issue_key, children)
+      subtasks.each do |subtask|
+        subtask_key = get_key(subtask)
+        node_edge_builder(issue_key, subtask_key, color: 'blue', label: 'subtask')
+        node_attr_builder(subtask)
+        children.append(subtask_key)
+      end
+    end
+  end
+end

data/lib/jira_dependency_visualizer/jira.rb

@@ -0,0 +1,55 @@
+require 'jira'
+
+module JiraDependencyVisualizer
+  # Creates a Jira client and exposes functions to get Jira issues
+  class Jira
+    # @param [Hash] opts the options to create a Jira client
+    # @option opts [String] :context_path The Jira application's
+    #   context path
+    # @option opts [String] :password The Jira user's password
+    # @option opts [String] :proxy_address The proxy address
+    # @option opts [Integer] :proxy_port The proxy port
+    # @option opts [Integer] :read_timeout Number of seconds to wait
+    #   for data to be read
+    # @option opts [String] :rest_base_path The Jira rest API base
+    #   path
+    # @option opts [String] :site URL for Jira
+    # @option opts [Boolean] :use_ssl Whether to use SSL
+    # @option opts [String] :username The Jira user's username
+    def initialize(opts = {})
+      @options = opts
+      client
+    end
+
+    # @param [String] issue the Jira issue ID
+    # @param [JIRA::Client] client a Jira client instance
+    # @return [JIRA::Issue] the matched Jira issue object
+    def get_issue(issue, client = @client)
+      client.Issue.find(issue)
+    end
+
+    # @param [String] query a Jira JQL query string
+    # @param [JIRA::Client] client a Jira client instance
+    # @return [Array[JIRA::Issue]] list of matching Jira issue objects
+    def query(query, client = @client)
+      client.Issue.jql(query)
+    end
+
+    # @return [String] the base Jira URL without a trailing slash
+    def base_url
+      site         = @options[:site].dup
+      context_path = @options[:context_path].dup
+
+      site.chop! if site.ends_with?('/')
+      context_path.chop! if context_path.ends_with?('/')
+
+      URI.join(site, context_path).to_s
+    end
+
+    private
+
+    def client
+      @client ||= JIRA::Client.new(@options)
+    end
+  end
+end

data/lib/jira_dependency_visualizer/version.rb

@@ -0,0 +1,4 @@
+module JiraDependencyVisualizer
+  # Current version
+  VERSION = '0.1.0'.freeze
+end

data/spec/factories/issue.rb

@@ -0,0 +1,80 @@
+FactoryGirl.define do
+  factory :subtask_issue, class: OpenStruct do
+    attrs do
+      {
+        'key' => 'test3',
+        'fields' => {
+          'issuetype' => {
+            'name' => 'notEpic'
+          },
+          'status' => {
+            'name' => 'To Do'
+          },
+          'subtasks' => [build(:generic_issue)]
+        }
+      }
+    end
+  end
+
+  factory :generic_issue, class: OpenStruct do
+    attrs do
+      { 'key' => 'test5',
+        'fields' => {
+          'status' => {
+            'name' => 'Blocked'
+          }
+        }
+      }
+    end
+  end
+
+  factory :issuelinks_generic_issue, class: Hash do
+    outwardIssue do
+      { 'key' => 'test3',
+        'fields' => {
+          'status' => {
+            'name' => 'Done'
+          }
+        } }
+    end
+
+    type do
+      { 'outward' => 'blocks' }
+    end
+
+    initialize_with { attributes.stringify_keys }
+  end
+
+  factory :issuelinks_issue, class: OpenStruct do
+    attrs do
+      {
+        'key' => 'test4',
+        'fields' => {
+          'issuetype' => {
+            'name' => 'notEpic'
+          },
+          'status' => {
+            'name' => 'To Do'
+          },
+          'issuelinks' => [build(:issuelinks_generic_issue)]
+        }
+      }
+    end
+  end
+
+  factory :epic_issue, class: OpenStruct do
+    attrs do
+      {
+        'key' => 'test',
+        'fields' => {
+          'issuetype' => {
+            'name' => 'Epic'
+          },
+          'status' => {
+            'name' => 'Planning'
+          }
+        }
+      }
+    end
+  end
+end

data/spec/factories/node.rb

@@ -0,0 +1,4 @@
+FactoryGirl.define do
+  factory :node, class: Hash do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'coveralls'
+require 'simplecov'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+  [SimpleCov::Formatter::HTMLFormatter,
+   Coveralls::SimpleCov::Formatter]
+)
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'jira_dependency_visualizer'
+require 'pry'
+require 'factory_girl'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.include FactoryGirl::Syntax::Methods
+  config.before(:suite) do
+    FactoryGirl.find_definitions
+    # FactoryGirl.lint
+  end
+end

data/spec/unit/graph_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe JiraDependencyVisualizer::Graph do
+  subject { JiraDependencyVisualizer::Graph.new('issue id', jira, [], colors, graph) }
+
+  let(:epic_issue) { build(:epic_issue) }
+  let(:issues) { build_pair(:subtask_issue) }
+
+  let(:jira) do
+    response = double('jira')
+    allow(response).to receive(:get_issue).and_return(epic_issue)
+    allow(response).to receive(:query).and_return(issues)
+    allow(response).to receive(:base_url).and_return('http://localhost')
+    response
+  end
+
+  let(:node) { build(:node) }
+
+  let(:graph) do
+    response = double('graph')
+    allow(response).to receive(:add_edges).and_return(true)
+    allow(response).to receive(:search_node).and_return(node)
+    allow(response).to receive(:output).and_return(nil)
+    response
+  end
+
+  let(:colors) do
+    { 'status' =>
+      { 'Incoming' =>
+        { 'fillcolor' => 'purple',
+          'style'     => 'filled' },
+        'To Do' =>
+        { 'fillcolor' => 'purple',
+          'style'     => 'filled',
+          'fontcolor' => 'white' }
+      }
+    }
+  end
+
+  context '#new' do
+    it { is_expected.to be_instance_of JiraDependencyVisualizer::Graph }
+  end
+
+  context '#walk subtasks' do
+    let(:issues) { build_pair(:subtask_issue) }
+
+    let(:jira) do
+      response = double('jira')
+      allow(response).to receive(:get_issue).and_return(epic_issue, issues[0])
+      allow(response).to receive(:query).and_return(issues)
+      allow(response).to receive(:base_url).and_return('http://localhost')
+      response
+    end
+
+    it { expect(subject.walk).to eq(%w(test3 test3)) }
+  end
+
+  context '#walk issuelinks' do
+    let(:issues) { build_pair(:issuelinks_issue) }
+
+    let(:jira) do
+      response = double('jira')
+      allow(response).to receive(:get_issue).and_return(epic_issue, issues[0])
+      allow(response).to receive(:query).and_return(issues)
+      allow(response).to receive(:base_url).and_return('http://localhost')
+      response
+    end
+
+    it { expect(subject.walk).to eq(%w(test4 test4)) }
+  end
+
+  context '#write_graph' do
+    it { is_expected.to respond_to(:write_graph) }
+    it 'write a graph' do
+      written_graph = subject.write_graph
+      expect(written_graph).to eq(nil)
+    end
+  end
+end

data/spec/unit/jira_dependency_visualizer_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe JiraDependencyVisualizer do
+  it 'has a version number' do
+    expect(JiraDependencyVisualizer::VERSION).not_to be nil
+  end
+end

data/spec/unit/jira_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe JiraDependencyVisualizer::Jira do
+  context '#new' do
+    it { is_expected.to be_instance_of JiraDependencyVisualizer::Jira }
+  end
+
+  let(:issue_class) do
+    class_double('JIRA::Issue').as_stubbed_const
+  end
+
+  let(:issue) do
+    response = double('issue')
+    allow(response).to receive(:find).and_return(issue_class)
+    allow(response).to receive(:jql).and_return(issue_class)
+    response
+  end
+
+  let(:client) do
+    response = double('client')
+    allow(response).to receive(:Issue).and_return(issue)
+    response
+  end
+
+  context '#get_issue' do
+    it { is_expected.to respond_to(:get_issue) }
+    it 'get an issue' do
+      issue = subject.get_issue('issue id', client)
+      expect(issue).to eq(JIRA::Issue)
+    end
+  end
+
+  context '#query' do
+    it { is_expected.to respond_to(:query) }
+    it 'get a query' do
+      query = subject.query('query', client)
+      expect(query).to eq(JIRA::Issue)
+    end
+  end
+
+  context '#base_url' do
+    subject do
+      JiraDependencyVisualizer::Jira.new(
+        site: site,
+        context_path: context_path
+      )
+    end
+    context 'no trailing slash, no context path' do
+      let(:site) { 'http://localhost' }
+      let(:context_path) { '' }
+      it { expect(subject.base_url).to eq('http://localhost') }
+    end
+    context 'no trailing slash, context path' do
+      let(:site) { 'http://localhost' }
+      let(:context_path) { 'jira' }
+      it { expect(subject.base_url).to eq('http://localhost/jira') }
+    end
+    context 'trailing slash, no context path' do
+      let(:site) { 'http://localhost/' }
+      let(:context_path) { '' }
+      it { expect(subject.base_url).to eq('http://localhost') }
+    end
+    context 'trailing slash, context path' do
+      let(:site) { 'http://localhost/' }
+      let(:context_path) { 'jira' }
+      it { expect(subject.base_url).to eq('http://localhost/jira') }
+    end
+  end
+end