Merge pull request #16 from mlibrary/remove-repeated-script-type

fix: sets script_type earlier

Author: niquerio

lib/process_ldap.rb

@@ -71,11 +71,13 @@ def filter
   end
 
   def write_to_output(&block)
-    File.open("#{@file_base}.xml", "w") do |output|
-      output.write "<?xml version=\"1.0\"?>\n"
-      output.write "<users>\n"
-      block.call(output)
-      output.write "</users>"
+    Yabeda.with_tags(script_type: script_type) do
+      File.open("#{@file_base}.xml", "w") do |output|
+        output.write "<?xml version=\"1.0\"?>\n"
+        output.write "<users>\n"
+        block.call(output)
+        output.write "</users>"
+      end
     end
   end
 
@@ -106,7 +108,7 @@ def process
     start = Time.now
     S.logger.info("start")
     S.logger.info("open files", file_base: @file_base) if @file_base
-    Report.open(file_base: @file_base, script_type: script_type) do |report|
+    Report.open(@file_base) do |report|
       write_to_output do |output|
         S.logger.info("begin ldap search")
         search do |data|

lib/report.rb

@@ -14,18 +14,19 @@ class Report
   ]
   def self.configure_yabeda!
     Yabeda.configure do
+      default_tag :script_type, "test"
       group :aim_patron_load do
-        gauge :loaded, comment: "Number of loaded patrons", tags: [:script_type]
-        gauge :skipped, comment: "Number of skipped patrons", tags: [:script_type]
-        gauge :found, comment: "Number of found patrons", tags: [:script_type]
-        gauge :patron_kind, comment: "Number of patrons in a given major category", tags: [:script_type, :name]
-        gauge :campus, comment: "Number of patrons in a given campus", tags: [:script_type, :name]
-        gauge :user_group, comment: "Number of patrons in a given Alma User Group", tags: [:script_type, :name]
-        gauge :statistic_category, comment: "Number of loaded patrons in a statistic category", tags: [:script_type, :name]
-        gauge :sponsor_reason, comment: "Number of loaded Sponsored Affiliates with a given sponsor reason", tags: [:script_type, :name]
-        gauge :exclude_reason, comment: "Number of patrons skipped for a given reason", tags: [:script_type, :name]
-        gauge :error, comment: "Number of errors encountered while running the patron load", tags: [:script_type]
-        gauge :job_duration_seconds, comment: "Number of seconds it took to run the patron load job", tags: [:script_type]
+        gauge :loaded, comment: "Number of loaded patrons"
+        gauge :skipped, comment: "Number of skipped patrons"
+        gauge :found, comment: "Number of found patrons"
+        gauge :patron_kind, comment: "Number of patrons in a given major category", tags: [:name]
+        gauge :campus, comment: "Number of patrons in a given campus", tags: [:name]
+        gauge :user_group, comment: "Number of patrons in a given Alma User Group", tags: [:name]
+        gauge :statistic_category, comment: "Number of loaded patrons in a statistic category", tags: [:name]
+        gauge :sponsor_reason, comment: "Number of loaded Sponsored Affiliates with a given sponsor reason", tags: [:name]
+        gauge :exclude_reason, comment: "Number of patrons skipped for a given reason", tags: [:name]
+        gauge :error, comment: "Number of errors encountered while running the patron load"
+        gauge :job_duration_seconds, comment: "Number of seconds it took to run the patron load job"
       end
     end
     Yabeda.configure!
@@ -53,22 +54,26 @@ def self.push_metrics
     end
   end
 
-  def self.open(file_base:, script_type:, &block)
+  def self.open(file_base, script_type: "whatever", &block)
     if file_base
       File.open("#{file_base}.tsv", "w") do |fh|
-        report = Report.new(fh: fh, script_type: script_type)
+        report = Report.new(fh)
         block.call(report)
       end
     else
-      report = Report.new(fh: $stdout, script_type: script_type)
-      block.call(report)
+      StringIO.open do |fh|
+        report = Report.new(fh)
+        block.call(report)
+        puts "\n"
+        puts fh.string
+        puts "\n"
+      end
     end
   end
 
-  def initialize(fh:, script_type:)
+  def initialize(fh)
     @fh = fh
     @fh.write self.class.column_names.join("\t") + "\n"
-    @script_type = script_type
   end
 
   def metrics
@@ -78,8 +83,8 @@ def metrics
   def load(patron)
     patron = Patron.new(patron: patron, action: "load")
     @fh.write patron.report_string
-    metrics.found.increment({script_type: @script_type})
-    metrics.loaded.increment({script_type: @script_type})
+    metrics.found.increment
+    metrics.loaded.increment
     ["patron_kind", "statistic_category", "user_group", "campus", "sponsor_reason"].each do |metric|
       increment_metric(metric, patron)
     end
@@ -88,8 +93,8 @@ def load(patron)
   def skip(patron)
     patron = Patron.new(patron: patron, action: "skip")
     @fh.write patron.report_string
-    metrics.found.increment({script_type: @script_type})
-    metrics.skipped.increment({script_type: @script_type})
+    metrics.found.increment
+    metrics.skipped.increment
   end
 
   def report_string(kind:, patron:)
@@ -105,7 +110,7 @@ def report_string(kind:, patron:)
   end
 
   def increment_metric(metric, patron)
-    metrics.public_send(metric).increment({script_type: @script_type, name: patron.public_send(metric)}) if patron.public_send(metric)
+    metrics.public_send(metric).increment({name: patron.public_send(metric)}) if patron.public_send(metric)
   end
 
   class Patron

spec/report_spec.rb

@@ -21,7 +21,7 @@
     Yabeda.reset!
   end
   subject do
-    described_class.new(fh: @file_handle, script_type: "test")
+    described_class.new(@file_handle)
   end
 
   it "includes a header with all of the column names" do
@@ -79,16 +79,12 @@
     it "is incremeneted when user a user is a test user" do
       test_user = staff_data
       test_user["uid"] = ["ststv"]
-      Yabeda.with_tags(script_type: "test") do
-        Patron.for(test_user)
-      end
+      Patron.for(test_user)
       expect(Report.metrics.exclude_reason.get(name: "test_user", script_type: "test")).to eq(1)
     end
     it "is incremented when a user is skipped for some other reason" do
       staff_data["umichhr"][0].sub!("jobCategory=Staff", "jobCateogry=INVALID")
-      Yabeda.with_tags(script_type: "test") do
-        Patron.for(staff_data)
-      end
+      Patron.for(staff_data)
       expect(Report.metrics.exclude_reason.get(name: "job_category_not_staff", script_type: "test")).to eq(1)
     end
   end