git-recommend 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a08b5114f7450afd35cb3e24cd592da94a3931ef
-  data.tar.gz: fcbdb9fb1d757847639364de4536d01faa5e71dc
+  metadata.gz: b73d571a58194483a14486ea7254d14473701d08
+  data.tar.gz: fbac66cc87250b307dc314e83a218d5818086afe
 SHA512:
-  metadata.gz: bbba31cefdf670c38a2730338bb6e2d14863852ec00141d2eaf3322a4576cd21742df36db071b8cb24f1f99d5715fe61732fa2dcdb88c7ffc4d90cf331a82857
-  data.tar.gz: 71dc4d3545de9f08bda722379e02f6dff7651017e877b2f1146f53e0e417a19d4a8883f5521a20d61fad52f7e4b93c6a7c5fbf0c1c18bcf124f986c02eeb31b2
+  metadata.gz: 44f08a73639231b50ca8d20f1f871be6fced27f33ae392efcaa25ae2813bd1862f5438bcb8c612e2a1cd0338c7486314f2c6db687af2e443da119fb546262813
+  data.tar.gz: 2edcb0a49a7b2df8aaf0ff1cca792a62f40bba9a369ee0f4d98f1eeacfba7a60517306ab465f91b08d204b073b43fa91c9e255178a87c15f28773a770373060b

data/lib/git_test.rb

@@ -1,57 +1,96 @@
 require 'helper'
 
 class GitTest < Thor
-  default_task :test
+
+  method_option :change_recommendation, aliases: '-c', type: :string, required: true, desc: "Path to test augmented change recommendation"
+  desc "plan", "Generates a prioritized test plan given a test augmented change recommendation (output of 'git-test join')"
+  def plan
+    begin
+      change_rec = CSV.read(options[:change_recommendation], headers: true)
+    rescue CSV::MalformedCSVError, ArgumentError => e
+      $stderr.puts "An error occured when parsing the change recommendation '#{options[:change_recommendation]}':\n #{e}"
+      exit 1
+    end
+
+    test_plan = Hash.new
+    coverage = {"lhs" => Set.new, "rhs" => Set.new}
+
+    change_rec.each do |row|
+      support = row["support"].to_r.to_f
+      # find relevant tests
+      ["lhs","rhs"].each do |side|
+        tests = (row["#{side}_tested_by"].nil? ? [] : row["#{side}_tested_by"].split(","))
+        tests.each do |test|
+          coverage[side] << row[side]
+          if test_plan[test].nil?
+            test_plan[test] = {'cg' => 0, 'lhs' => 0, 'rhs' => 0}
+          end
+          test_plan[test]['cg'] += support
+          test_plan[test][side] += 1
+        end
+      end
+    end
+    # normalize the cumulative gain
+    max_cg = test_plan.map {|_,v| v['cg']}.max
+    test_plan.each {|test,v| test_plan[test]['cg'] = v['cg']/max_cg}
+
+    # print warnings to stderr if any
+    ["lhs","rhs"].each do |side|
+      items_in_plan = change_rec.map {|row| row[side]}.to_set
+      if coverage[side].size < items_in_plan.size
+        uncovered = items_in_plan - coverage[side]
+        type_of_impact = ((side == "lhs") ? "changed" : "impacted")
+        $stderr.puts "#{uncovered.size} #{type_of_impact} items were not covered by at least 1 test. The first 10 were: \n #{uncovered.take(10).join("\n")}"
+      end
+    end
+    # print testplan to stdout
+    $stdout.puts "test,impact,changed_items_covered,impacted_items_covered"
+    test_plan.sort_by {|k,v| [v['lhs'],v['rhs']].max}.each do |test,v|
+      $stdout.puts "#{test},#{v['cg']},#{v['lhs']},#{v['rhs']}"
+    end
+  end
 
   method_option :mapping, aliases: '-m', type: :string, required: true, desc: "Path to test<->code mapping file"
   method_option :change_recommendation, aliases: '-c', type: :string, required: true ,desc: "Path to change recommendation"
-  method_option :output, aliases: '-o', enum: ['csv','dot'], default: 'csv', desc: "The output format of the test recommendation"
-  desc "test", ""
-  def test
+  desc "join", "Adds a column \"tested_by\", which for each potentially impacted item lists the tests which test this item."
+  def join
     begin
       mapping = CSV.read(options[:mapping], headers: true)
+    rescue CSV::MalformedCSVError, ArgumentError => e
+      $stderr.puts "An error occured when parsing the mapping file '#{options[:mapping]}:\n #{e}"
+      exit 1
+    end
+
+    begin
       change_rec = CSV.read(options[:change_recommendation], headers: true)
-    rescue CSV::MalformedCSVError => e
-      $stderr.puts "An error occured when parsing the mapping file:\n #{e}"
+    rescue CSV::MalformedCSVError, ArgumentError => e
+      $stderr.puts "An error occured when parsing the change recommendation '#{options[:change_recommendation]}:\n #{e}"
+      exit 1
     end
 
-    test_plan = Hash.new
-    covered = Set.new
-    uniq_impacted_items = change_rec.map {|row| row["rhs"]}.to_set
 
+    # print header
+    CSV {|r| r << %w(lhs rhs support lhs_tested_by rhs_tested_by)}
     change_rec.each do |row|
       lhs = row["lhs"]
       rhs = row["rhs"]
       support = row["support"].to_r.to_f
+      # find relevant tests
+      lhs_tests = []
+      rhs_tests = []
       mapping.each do |mapping_row|
         pattern = Regexp.new(mapping_row["pattern"], Regexp::IGNORECASE)
         test = mapping_row["test"]
+        if lhs =~ pattern
+          lhs_tests << test
+        end
+
         if rhs =~ pattern
-          covered << rhs
-          if test_plan[test].nil?
-            test_plan[test] = {impact: support, covers: 1}
-          else
-            test_plan[test][:impact] += support
-            test_plan[test][:covers] += 1
-          end
+          rhs_tests << test
         end
       end
+      # print new row
+      CSV {|r| r << [lhs, rhs, support, (lhs_tests.empty? ? nil : lhs_tests.join(",")), (rhs_tests.empty? ? nil : rhs_tests.join(","))]}
     end                          
-    # print warnings to stderr if any
-    if covered.size < uniq_impacted_items.size
-      uncovered = uniq_impacted_items - covered
-      if uncovered.size < 11
-        $stderr.puts "The following potentially impacted items were not covered by at least 1 test:\n #{uncovered.to_a.join("\n")}"
-      else
-        $stderr.puts "#{uncovered.size} potentially impacted items were not covered by at least 1 test. The first 10 were: \n #{uncovered.take(10).join("\n")}"
-      end
-    end
-
-    # print testplan to stdout
-    $stdout.puts "test,impact,covers"
-    test_plan.sort_by {|k,v| -v[:impact]}.each do |test,relevance|
-      $stdout.puts "#{test},#{relevance[:impact]},#{relevance[:covers]}"
-    end
   end
-
 end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Git
   module Recommend
-    VERSION = "0.3.1"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-recommend
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Thomas Rolfsnes