jira_reporting 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96f28872982653389eae5e488073432a7817c47997cd6256ff4f566bdfe4eab4
+  data.tar.gz: 9c79b7de84d007aa6f1d526ffdcb920f74659d09ae297bf0215455350fc41115
+SHA512:
+  metadata.gz: 4a647d10943dad71c2942c2f501714102e9b905966742abde7845c5c2b1028957898fc22879c20c834541ea9c2d57aa16fe3436b84ff938b0f02949e2ce35d8d
+  data.tar.gz: 13ee60cf5e54864d8724dc3f73d124601f2b0453a0716739be7cb092402d5039cb3820e623073eb61a862bd9a4df96a0d01e252b9069f30a03d5d678f11b6a6c

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+auth.yml
+.DS_Store
+.byebug_history
+_issues.select(&:bug?)

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jira_reporting.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joshua Szmajda
+
+MIT License
+
+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,52 @@
+# JiraReporting
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+```
+    gem 'jira_reporting'
+```
+And then execute:
+```
+    $ bundle
+```
+Or install it yourself as:
+```
+    $ gem install jira_reporting
+```
+## Additional Usage
+
+If the right fields are created within Jira, this gem can be used to set and track Jira issue SLA due times, SLA overdue statuses, and SLA warnings for issues that are almost due.
+
+#TODO - add walkthrough for the above
+
+A cron job can be made for the bin/sla_warning script to be run in order to achieve this. On an OSX laptop with rbenv managing ruby versions, the crontab job looks like this:
+
+   ``` 
+   */5 * * * * bash -lc "cd /Users/gabo/Documents/code/on_production/jira_reporting && bin/sla_warning" 
+   ```
+The environment setup for the bin/sla_warning script to run as a crontab job on Ubuntu using RVM looks like this:
+```
+    #sm start rvm
+    PATH="/home/gabo/.rvm/gems/ruby-2.3.0/bin:/home/gabo/.rvm/gems/ruby-2.3.0@global/bin:/usr/share/rvm/rubies/ru$
+    GEM_HOME='/home/gabo/.rvm/gems/ruby-2.3.0'
+    GEM_PATH='/home/gabo/.rvm/gems/ruby-2.3.0:/home/gabo/.rvm/gems/ruby-2.3.0@global'
+    MY_RUBY_HOME='/usr/share/rvm/rubies/ruby-2.3.0'
+    IRBRC='/usr/share/rvm/rubies/ruby-2.3.0/.irbrc'
+    RUBY_VERSION='ruby-2.3.0'
+    
+    */5 * * * * ~/Documents/code/on_production/jira_reporting/bin/sla_warning
+```
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/jira_reporting/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/auth.yml.example

@@ -0,0 +1,10 @@
+jira:
+  username: xxx
+  password: xxx
+
+code_climate:
+  api_token: xxx
+
+github:
+  api_token: xxx
+

data/bin/jira_reporting

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'thor/group'
+require 'jira_reporting'
+
+def connect_to_jira!
+  user = ENV['jira_user']
+  pass = ENV['jira_pass']
+  unless user && pass
+    STDERR.puts "ENV needs jira_user and jira_pass!"
+    exit 1
+  end
+  JiraReporting.connect!(user, pass)
+end
+
+module CLI
+  class ThorSubCommandTemplate < Thor
+    class << self
+      def subcommand_setup(name, usage, desc)
+        namespace :"#{name}"
+        @subcommand_usage = usage
+        @subcommand_desc = desc
+      end
+
+      def banner(task, namespace = nil, subcommand = false)
+        "#{basename} #{task.formatted_usage(self, true, true)}"
+      end
+
+      def register_to(klass)
+        klass.register(self, @namespace, @subcommand_usage, @subcommand_desc)
+      end
+    end
+  end
+
+  class Reporting < ThorSubCommandTemplate
+    subcommand_setup "reporting", "reporting [TASK]", "Execute a reporting task"
+    desc "sla", "Shows the SLA report"
+    def sla
+      connect_to_jira!
+      JiraReporting::SLAReport.show_report
+    end
+  end
+
+  class CLI < Thor
+    Reporting.register_to self
+  end
+end
+
+CLI::CLI.start

data/bin/jira_sla_update

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+PROJECT_ROOT = "#{File.dirname(__FILE__)}/../"
+
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'jira_reporting'
+require 'pry-byebug'
+require 'active_support'
+require 'yaml'
+
+auth = YAML.load_file(File.join(PROJECT_ROOT,'auth.yml'))
+jira_username = auth["jira"]["username"]
+jira_password = auth["jira"]["password"]
+JiraReporting.connect! jira_username, jira_password
+
+# Closed TS issues
+start_date = (ARGV[0] && Date.parse(ARGV[0]))
+end_date = (ARGV[1] && Date.parse(ARGV[1]))
+
+start_date = start_date.strftime("%Y-%m-%d")
+end_date = end_date.strftime("%Y-%m-%d")
+
+puts "Updating SLA due time and SLA status on all TS issues from: #{start_date} to: #{end_date}"
+
+query = %Q{
+  project = "Tech Support"
+  AND created >= '#{start_date}'
+  AND created < '#{end_date}'
+  AND status not in ("Not Accepted", "Can't Reproduce")
+  AND type != Epic
+}
+
+ts_issues = JiraIssue.find(query)
+
+total_ts_issues = ts_issues.count
+
+update_start_time = Time.now
+
+puts "The time is #{update_start_time}. There are #{total_ts_issues} issues in the query. Each issue takes about five seconds to update. The estimated amount of time this update will take is #{total_ts_issues*5/60} minutes to complete -- expected end time: #{update_start_time+total_ts_issues*5}"
+
+ts_issues.each do |issue|
+  issue.set_sla_due_time!        if issue.sla_due_time.nil?
+  issue.set_sla_triaged_at!      if issue.sla_triaged_at.nil?
+  issue.set_over_triage_sla!     if issue.over_triage_sla.nil?
+  issue.set_sla_closed_at!       if issue.sla_closed_at.nil?
+  issue.set_sla_due_warning!     if issue.sla_due_warning.nil?
+  issue.set_over_sla!            if issue.over_sla.nil?
+  # issue.set_total_time_over_sla! if issue.total_time_over_sla.nil?
+
+  puts "#{issue.over_sla?} #{issue.sla_target} 
+        #{issue.priority} #{issue.key} #{issue.summary}"
+end
+
+puts "SLA update completed at #{Time.now}."

data/bin/kpi_report

@@ -0,0 +1,204 @@
+#!/usr/bin/env ruby
+PROJECT_ROOT = "#{File.dirname(__FILE__)}/../"
+
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'jira_reporting'
+require 'pry-byebug'
+require 'active_support'
+require 'yaml'
+require 'code_climate'
+require 'auto_hash'
+require 'pull_request'
+require 'os'
+
+report = AutoHash.new
+
+auth = YAML.load_file(File.join(PROJECT_ROOT,'auth.yml'))
+jira_username = auth["jira"]["username"]
+jira_password = auth["jira"]["password"]
+JiraReporting.connect! jira_username, jira_password
+
+github_token  = auth["github"]["api_token"]
+PullRequest.connect(github_token)
+
+end_date = (ARGV[0] && Date.parse(ARGV[0]) - 1.day) || 1.day.ago
+start_date = (ARGV[1] && Date.parse(ARGV[1])) || end_date - 6.days
+
+start_date = start_date.strftime("%Y-%m-%d")
+end_date = end_date.strftime("%Y-%m-%d")
+
+puts "Start: #{start_date} END: #{end_date}"
+
+# All tickets closed last week in all dev projects (not DO?)
+# * TS SLA hit-rates (% completed in SLA)
+# * Sum of story points
+# * % of tickets with story points set (estimated)
+# * Count of active sprints (teams)
+
+# Closed issues that had a status change in the last week
+query = %Q{
+  project in (TS, TECH, OT, BLINQ, DT, BULQ)
+  AND status changed
+  TO ("Not Accepted", "Can't Reproduce", "Requester Review", Deploy, Merged, MERGED_ST, "On Production", Completed, Resolved)
+  DURING ('#{start_date}', '#{end_date}')
+}
+
+issues = JiraIssue.find(query)
+
+ts_issues, non_ts_issues = issues.partition { |issue| issue.project == "TS" }
+
+total_points = non_ts_issues.map{|issue| issue.story_points.to_s.to_f}.sum
+count_pointed = non_ts_issues.count{|issue| issue.story_points}
+
+ts_issue_count = ts_issues.count
+ts_bug_count = ts_issues.select(&:bug?).count
+ts_ops_count = ts_issues.reject(&:bug?).count
+
+non_ts_issue_count = non_ts_issues.count
+total_issue_count = issues.count
+
+ts_bugs = ts_issues.select(&:bug?)
+ts_bugs_triage_hours = ts_bugs.map { |issue| issue.status_ages["Triaged"] }.compact.sum
+
+report[:week] = {
+  issue_count: total_issue_count,
+  ts_count: ts_issue_count,
+  non_ts_count: issues.count - ts_issue_count,
+  story_points: total_points,
+  pointed_rate: (count_pointed.to_f / non_ts_issue_count * 100).round(2),
+  bug_rate: (ts_bug_count.to_f / total_issue_count * 100).round(2),
+  ops_rate: (ts_ops_count.to_f / total_issue_count * 100).round(2),
+  ts_rate: (ts_issue_count.to_f / total_issue_count * 100).round(2),
+  ts_bugs_triage_speed: (ts_bugs_triage_hours / ts_bugs.count).round(2)
+}
+
+prios = ts_issues.group_by(&:priority)
+
+hour = 60 * 60.0
+ideal_times = {
+  p1: 2 * hour,
+  p2: 24 * hour,
+  p3: (24 * hour) * 3, # 3 business days
+  p4: (24 * hour) * 5, # 5 business days
+  p5: (24 * hour) * 30, # 30 business days
+}
+
+[:p1,:p2,:p3,:p4,:p5].each do |priority|
+  closed = prios[priority] || []
+  trend_time = closed.inject(0){|s,t| s + t.sla_diff } / closed.length.to_f
+
+
+  trend_resolution_time = ""
+  if closed.any?
+    mm, ss = trend_time.divmod(60)
+    hh, mm = mm.divmod(60)
+    dd, hh = hh.divmod(24)
+    trend_resolution_time = "#{dd}d #{hh.to_i}h #{mm.to_i}m #{ss.to_i}s"
+  end
+
+  ideal_time = ideal_times[priority]
+  multiple_off_ideal = trend_time.to_f / ideal_time
+
+  trend_hit = 1.0
+  trend_hit = closed.select{|t| t.sla_diff <= 0 }.length / closed.length.to_f if closed.any?
+
+  report[:sla][priority] = {
+    closed_tickets: closed.count,
+    avg_sla_diff: trend_resolution_time,
+    avg_sla_multiple: (multiple_off_ideal || 0).round(2),
+    avg_hit_rate: (trend_hit * 100).round(2),
+  }
+
+  puts "#{priority.to_s.upcase}:"
+  puts "Closed Tickets: #{closed.count}"
+  puts "Avg Diff to SLA: #{trend_resolution_time}"
+  puts "Avg SLA Multiple: #{multiple_off_ideal.round(2)}x" unless priority == :p4
+  puts "Avg Hit Rate: #{(trend_hit * 100).round(2)}%"
+  puts ""
+end
+
+puts ""
+puts "Issues over the SLA:"
+ts_issues.sort_by(&:priority).each do |ts|
+  if ts.sla_diff < 0
+    puts "#{ts.priority}\t#{ts.key}"
+  end
+end
+
+overall_hit = ts_issues.select{|t| t.sla_diff <= 0 }.length / ts_issues.length.to_f
+report[:sla][:overall][:avg_hit_rate] = (overall_hit * 100).round(2)
+puts ""
+puts "Overall Avg Hit Rate: #{(overall_hit * 100).round(2)}%"
+puts
+
+code_climate = CodeClimate.new(auth["code_climate"]["api_token"])
+
+["inventory", "blinq", "bulq"].each do |repo_name|
+  puts "CodeClimate Repo #{repo_name}"
+  cc_snapshot = code_climate.repo_details_by_name(repo_name)["last_snapshot"]
+
+  report[:codeclimate][repo_name.to_sym][:gpa] = cc_snapshot["gpa"]
+  report[:codeclimate][repo_name.to_sym][:coverage] = cc_snapshot["covered_percent"] || 0
+  puts "GPA: #{cc_snapshot["gpa"]}"
+  puts "Coverage: #{cc_snapshot["covered_percent"] || 0}%"
+  puts
+end
+
+report[:codeclimate][:overall][:coverage] = (
+  report[:codeclimate][:inventory][:coverage] + report[:codeclimate][:blinq][:coverage]
+) / 2.0
+
+# # Temporarily disabled to test functionality
+# # Github PR info
+# prs = PullRequest.get_prs('inventory')
+# today = Time.now.to_date
+# pr_ages = prs.map{|pr| (today - pr.created.to_datetime).to_i}
+# report[:pr][:avg_age_days] = (pr_ages.sum.to_f / pr_ages.count).round(2)
+# report[:pr][:open_count] = prs.count
+
+# closed_prs = PullRequest.get_prs('inventory', state: "closed")
+
+def copy_paste_string(report)
+  [
+    report[:sla][:overall][:avg_hit_rate].to_s+'%',         # TS combined SLA
+    report[:sla][:p1][:avg_hit_rate].to_s+'%',              # TS P1 SLA
+    report[:sla][:p2][:avg_hit_rate].to_s+'%',              # TS P2 SLA
+    report[:sla][:p3][:avg_hit_rate].to_s+'%',              # TS P3 SLA
+    report[:sla][:p4][:avg_hit_rate].to_s+'%',              # TS P4 SLA
+    report[:week][:ts_count],                               # Weighted TS tickets closed
+    report[:week][:bug_rate].to_s + '%',                    # Bug / Fires %
+    report[:week][:ops_rate].to_s + '%',                    # Operational Requests %
+    report[:codeclimate][:overall][:coverage].to_s + '%',   # Test Coverage (combined)
+    report[:codeclimate][:inventory][:coverage].to_s + '%', # Test Coverage - OT
+    report[:codeclimate][:blinq][:coverage].to_s + '%',     # Test Coverage - BLINQ
+    report[:codeclimate][:inventory][:gpa],                 # CodeClimage GPA - OT
+    report[:codeclimate][:blinq][:gpa],                     # CodeClimage GPA - BLINQ
+    report[:codeclimate][:bulq][:gpa],                      # CodeClimage GPA - BLINQ
+    report[:pr][:avg_age_days],                             # Average age of PRs
+    report[:week][:ts_bugs_triage_speed],                   # Triage speed
+  ].join("\n")
+end
+
+# puts "Full report:"
+# puts report.inspect
+
+# Copy/pasteable
+puts "Copy/paste:\n----------"
+puts copy_paste_string(report)
+puts "-----------"
+
+# Works on either?
+case
+when OS.linux? == true
+  IO.popen("xclip -selection clipboard", "r+") do |xclip|
+    xclip.puts copy_paste_string(report)
+  end
+when OS.mac? == true
+  IO.popen("pbcopy", "r+") do |pbcopy|
+    pbcopy.puts copy_paste_string(report)
+  end
+else
+  puts "Please manually copy and paste the output into the KPI spreadsheet"
+end
+
+# issues.map{|i| Hash[i.status_changes.group_by{|s| s["fromString"]}.map{|k,v| [k => v.inject(0.0) {|n,x| n + x["age_hours"]}]}]}