mobile_metrics 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ed2b68c154f8901ce362daf0dd744ce7b0d325fa88dc9294af55b4b0bfa7e1
-  data.tar.gz: a2993af8b7d748b55d40a9478b37628e75126fdfdc4f1a082c50b43580f131ea
+  metadata.gz: 71fab7bc92efcbd6f73f826acb238b1f9a8176ce0a25abc5e8e7a0f80772ee7f
+  data.tar.gz: 43d17ec1681e016bcc0123d516497a6754f696d67964908a824f5a2bff71d532
 SHA512:
-  metadata.gz: 0bed566a44e5080bb5b18a649c90c193dd785a54720c940e1a0ec3ce7e661523eadc7f1f4c6815bed24808d728f1b317597539d9b47bcaea1ff588bb94d6523d
-  data.tar.gz: df938aec687c837a8b7ded3dfb193f6738b95083dc89a2f2e40890e2ed9a02ebaa337dab3e0812ad3951aec540148be68f55410d009f7eb0eb8a46d3a50bd1ce
+  metadata.gz: f0f94715c4f0039f8f96780b9c3b85f58806c57acdefb02c2e9b0dbdfab1545e4b4e58677a5763436dac765fbb7eda5ee4b78dda503fe3e0b27b93ccd29ca2e9
+  data.tar.gz: 9a85990eeda3eee10fe92a4b5660697c7b1385749b235a4d99e5af4da718cb94b7a1b5fbfccca1e4272e55d10e0cf307e309d8124d4d1d224cfbd8cf9911a30e

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    mobile_metrics (0.0.2)
+    mobile_metrics (0.1.0)
       ox (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    ox (2.5.0)
+    ox (2.13.4)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -34,4 +34,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/lib/mobile_metrics.rb

@@ -1,5 +1,5 @@
-require "mobile_metrics/version"
-require "mobile_metrics/junit"
+require 'mobile_metrics/version'
+require 'mobile_metrics/junit'
 
 require 'time'
 require 'json'
@@ -8,18 +8,18 @@ require 'fileutils'
 require 'pathname'
 
 # Metric types
-METRIC_TIMER    = 'x.mobile_metric.timer'
-METRIC_COUNTER  = 'x.mobile_metric.counter'
-METRIC_RATIO    = 'x.mobile_metric.ratio'
-METRIC_SIZE     = 'x.mobile_metric.size'
+METRIC_TIMER    = 'x.mobile_metric.timer'.freeze
+METRIC_COUNTER  = 'x.mobile_metric.counter'.freeze
+METRIC_RATIO    = 'x.mobile_metric.ratio'.freeze
+METRIC_SIZE     = 'x.mobile_metric.size'.freeze
 
 # Misc Constants
-UNKNOWN = 'UNKNOWN'
-LOG_PREFIX = 'CI-METRICS:'
-LOGGING_DIR = '/tmp/cimetricslogs' 
-UPLOAD_ENV_VAR = 'MOBILE_METRICS_UPLOAD_LOCATION'
+UNKNOWN = 'UNKNOWN'.freeze
+LOG_PREFIX = 'CI-METRICS:'.freeze
+LOGGING_DIR = '/tmp/cimetricslogs'.freeze
+UPLOAD_ENV_VAR = 'MOBILE_METRICS_UPLOAD_LOCATION'.freeze
 
-module MobileMetrics 
+module MobileMetrics
   class Log
 
     @@in_progress_timers = {}
@@ -27,63 +27,63 @@ module MobileMetrics
     @@env_values = nil
     @@verbose = false
     @@upload_location = nil
-    
+
     #========================================
     # Configuration
     #=========================================
-    
+
     # Named params, with ability to override / leave out stuff we don't care about.
     def self.set_default_values(
       # Required params
       project:,
       # These params either aren't required, or have sensible defaults.
-      level: "info", 
-      platform: "iOS", 
-      buildUrl: ENV['BUILD_URL'], 
-      gitUrl: ENV['GIT_URL'], 
-      gitBranch: ENV['DOTCI_BRANCH'], 
-      gitSha: ENV['DOTCI_SHA'], 
+      level: "info",
+      platform: "iOS",
+      buildUrl: ENV['BUILD_URL'],
+      gitUrl: ENV['GIT_URL'],
+      gitBranch: ENV['BRANCH'],
+      gitSha: ENV['SHA'],
       # no sensible defaults for these, we'll strip them later
-      buildType: UNKNOWN, 
+      buildType: UNKNOWN,
       brand: UNKNOWN,
       # Controls log levels within this class
       verbose: false,
       # Upload location for logs
       upload_location: nil
-      ) 
-      
+      )
+
       #TODO: May be able to support overridding these at some point in the future.
       # It won't be threadsafe, but our builds aren't parallelized at the build script level anyway.
       if @@env_values
         print 'Can only override default values once! Aborting!'
         return
       end
-      
-      if project.nil? 
+
+      if project.nil?
         print 'Project value for logging MUST be non-nil, failing build.'
         exit 14
         return
       end
-      
+
       @@verbose = verbose
-      
+
       # Upload location
       @@upload_location = (upload_location || ENV[UPLOAD_ENV_VAR])
-      if @@upload_location.nil? 
+      if @@upload_location.nil?
         print 'Upload location value for logging MUST not be nil, exiting.'
         exit 15
         return
       end
-      
+
       # Create the logging dir + filename
       FileUtils.mkdir_p(LOGGING_DIR)
       filename = "metrics_#{project}_#{build_number}.log"
       @@log_file = Pathname.new(LOGGING_DIR) + filename
       print @@log_file if @@verbose
-      
+
       # Populate our env values
       @@env_values = {}
-      
+
       # Required
       @@env_values[:project] = project
       # Optional
@@ -93,131 +93,155 @@ module MobileMetrics
       @@env_values[:gitBranch] = gitBranch
       @@env_values[:gitSha] = gitSha
       @@env_values[:buildUrl] = buildUrl
-      
+
       #TODO: Should any of these be required? 
       @@env_values[:buildType] = buildType if buildType != UNKNOWN
       @@env_values[:brand] = brand if brand != UNKNOWN
     end
-    
-  # =begin
-  #   # Sample timer metric
-  #   {
-  #   "time": "<yyyy-MM-ddThh:mm:ss[.sss]Z>",
-  #   "name": "x.mobile_metric.<metric_type>",
-  #   "level": "info",
-  #   "data": {
-  #      "name": "<metric_name>",
-  #      … // additional data per metric type
-  #   }
-  #   "context": {
-  #     "platform": "<ios_or_android>",
-  #     "project": "<project_name>",
-  #     "gitUrl": "<git_url>",
-  #     "gitBranch": "<git_branch>",
-  #     "gitSha": "<git_sha>",
-  #     "buildType": "<build_type>",
-  #     "brand": "<brand>",
-  #     "host": "<machine_dns_name_or_device_name>",
-  #     "processId": "<process_id_or_build_number>"
-  #   }
-  # }
-  # =end
+
+    # =begin
+    #   # Sample timer metric
+    #   {
+    #   "time": "<yyyy-MM-ddThh:mm:ss[.sss]Z>",
+    #   "name": "x.mobile_metric.<metric_type>",
+    #   "level": "info",
+    #   "data": {
+    #      "name": "<metric_name>",
+    #      … // additional data per metric type
+    #   }
+    #   "context": {
+    #     "platform": "<ios_or_android>",
+    #     "project": "<project_name>",
+    #     "gitUrl": "<git_url>",
+    #     "gitBranch": "<git_branch>",
+    #     "gitSha": "<git_sha>",
+    #     "buildType": "<build_type>",
+    #     "brand": "<brand>",
+    #     "host": "<machine_dns_name_or_device_name>",
+    #     "processId": "<process_id_or_build_number>"
+    #   }
+    # }
+    # =end
 
     #=========================================
     # Public Logging Methods
     #=========================================
-    
+
     def self.log_ratio_metric(name:, ratio:)
-      overrides = {name: METRIC_RATIO, data: {name: name, ratio: ratio.to_f }}
+      overrides = { name: METRIC_RATIO, data: { name: name, ratio: ratio.to_f } }
       log_partial_metric(overrides)
     end
-    
+
     def self.log_counter_metric(name:, count:)
-      overrides = {name: METRIC_COUNTER, data: {name: name, count: count.to_i }}
+      overrides = { name: METRIC_COUNTER, data: {name: name, count: count.to_i } }
       log_partial_metric(overrides)
     end
-    
+
     def self.log_size_metric(name:, sizeInBytes:, filename:, artifactUrl:)
-      overrides = {name: METRIC_SIZE, data: {name: name, filename: filename, sizeInBytes: sizeInBytes, artifactUrl: artifactUrl }}
+      overrides = { name: METRIC_SIZE, data: { name: name, filename: filename, size: sizeInBytes, artifactUrl: artifactUrl } }
       log_partial_metric(overrides)
     end
-    
+
+    def self.log_timer(name:, delta_in_ms:)
+      overrides = {name: METRIC_TIMER, data: {name: name, duration: delta_in_ms }}
+      log_partial_metric(overrides)
+    end
+
     def self.start_timer_metric(name:)
-      if @@in_progress_timers.has_key?(name) 
+      if @@in_progress_timers.has_key?(name)
         print "WARNING: #{name} already has a running timer, refusing to start a new timer"
         return
       end
       @@in_progress_timers[name] = monotonic_timestamp
     end
-    
+
     def self.end_timer_metric(name:)
       if !@@in_progress_timers.has_key?(name)
         print "WARNING: #{name} does not have a running timer, the end_timer_metric call has no effect"
         return
       end
-      
+
       # Calculate delta
       start = @@in_progress_timers[name]
       now = monotonic_timestamp
       delta_in_ms = ((now - start) * 1000).to_i
-      
+
       # remove existing timer
       @@in_progress_timers.delete(name)
-      
+
       # log to file
       overrides = {name: METRIC_TIMER, data: {name: name, duration: delta_in_ms }}
       log_partial_metric(overrides)
     end
-    
+
     # Block based timer. This is the recommended way to timer operations.
-    def self.time(name:, &block)
+    def self.time(name:, &_block)
       self.start_timer_metric(name: name)
       yield
       self.end_timer_metric(name: name)
     end
-    
-    def self.upload_logs()
-      # Already called upload logs before, second time is a no-op 
-      if @@log_file.nil? || !@@log_file.file? 
-        print "WARN: Log file is empty or doesn't exist. Was upload_logs called previously?"
-        return 
+
+    def self.log_unit_test_count_from_file(junit_file:, fail_build_on_file_not_found: false)
+      if !File.exist?(junit_file)
+        print "WARN: JUnit file #{junit_file} does not exist on disk"
+        exit 16 if fail_build_on_file_not_found
+        return if !fail_build_on_file_not_found
       end
-      
+
+      parser = MobileMetrics::JunitParser.new
+      parser.parse(junit_file)
+      unit_test_count = parser.tests.count
+
+      # Only log values > 0 to avoid any parser issues.
+      if unit_test_count == 0
+        print 'WARN: Parsed unit test count is zero, avoiding logging.'
+      else
+        self.log_counter_metric(name: 'unit_tests_count', count: unit_test_count)
+      end
+    end
+
+    def self.upload_logs
+      # Already called upload logs before, second time is a no-op
+      if @@log_file.nil? || !@@log_file.file?
+        print 'WARN: Log file is empty or doesn\'t exist. Was upload_logs called previously?'
+        return
+      end
+
       # Skip uploads for local dev machines
-      if !should_upload_logs() 
+      if !should_upload_logs
         print 'Detected local machine, refusing to upload build metrics. Removing intermediate log file'
-        remove_log_file()
+        remove_log_file
         return
       end
-      
+
       # Warn for any open timers
-      if @@in_progress_timers.size > 0 
-        @@in_progress_timers.each { |k,v| 
+      if @@in_progress_timers.size > 0
+        @@in_progress_timers.each { |k, _v|
           print "WARN: Timer not closed when upload_logs was called: #{k}"
         }
       end
-      
-      # Upload 
-      upload_log_file()
-      
+
+      # Upload
+      upload_log_file
+
       # Remove log file
-      remove_log_file()
+      remove_log_file
     end
-    
-    def self.log_file()
+
+    def self.log_file
       @@log_file
     end
-    
-    def self.upload_location()
+
+    def self.upload_location
       @@upload_location
     end
-    
+
     # Tears down logging instance, removes any intermediate log files.
     # Does not finalize or upload any in-progress logs.
     # To use the logger again, you'll have to call set_default_values before any other methods.
-    def self.reset()
-      if @@log_file 
-        remove_log_file()
+    def self.reset
+      if @@log_file
+        remove_log_file
       end
       @@log_file = nil
       @@env_values = nil
@@ -225,15 +249,15 @@ module MobileMetrics
       @@verbose = false
       @@upload_location = nil
     end
-    
-    def self.remove_all_log_files()
-      FileUtils.rm_rf(LOGGING_DIR) 
+
+    def self.remove_all_log_files
+      FileUtils.rm_rf(LOGGING_DIR)
     end
-    
+
   private
 
     # Creates a stubbed metric with common fields
-    def self.default_metric() 
+    def self.default_metric
       if !@@env_values
         print 'default_metric called before env_values initialized, aborting!'
         exit 12
@@ -251,25 +275,26 @@ module MobileMetrics
         buildUrl: @@env_values[:buildUrl],
         host: hostname(),
         processId: build_number()
-      }.select { |k,v| !v.nil? } 
+      }.select { |k,v| !v.nil? }
       {time: timestamp(), level:@@env_values[:level], context: context}
     end
-    
+
     def self.append_to_log(value)
       # Create the log file if it doesn't exist
       if !@@log_file.file? 
-        FileUtils.touch(@@log_file) 
+        FileUtils.touch(@@log_file)
       end
       File.open(@@log_file, 'a+') { |f| f.puts(value + "\n") }
     end
-    
-    def self.remove_log_file()
+
+    def self.remove_log_file
       FileUtils.rm_rf(@@log_file)
     end
-    
-    def self.upload_log_file()
+
+    def self.upload_log_file
       destination = @@upload_location + "metrics_#{@@env_values[:project]}_#{build_number}.log"
-      command = "scp -v -o StrictHostKeyChecking=no #{@@log_file} #{destination}"
+      verbose_flag = @@verbose ? '-v' : ''
+      command = "scp #{verbose_flag} -o StrictHostKeyChecking=no #{@@log_file} #{destination}"
       # This feels icky
       print `#{command}`
     end
@@ -278,17 +303,17 @@ module MobileMetrics
     # Note: This format doesn't currently add milliseconds.
     # Example: "2018-03-27T21:12:21Z"
     # Note: DO NOT use this for benchmarking / measuring timers, see monotonic_timestamp instead.
-    def self.timestamp() 
+    def self.timestamp
       Time.now.utc.iso8601.to_s
     end
-    
+
     # Returns a floating point monotonic timestamp suitable for timers
     # Monotonic means we won't ever go back for things like leap seconds
     # Unit is a floating point in seconds.
-    def self.monotonic_timestamp()
+    def self.monotonic_timestamp
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end
-    
+
     # Each metric should call this method.
     # This method handles merging the metric hash with the default hash,
     # Generates the JSON with the keys in the right order, then appends to the log.
@@ -299,40 +324,39 @@ module MobileMetrics
       metric = ordered_hash.to_json
       append_to_log(metric)
     end
-    
+
     # Util method for merging the default hash values and overrides recursively as we want them
     def self.merge_hashes(default, overrides)
-      default.merge(overrides) { |key, oldval, newval| 
-        if key == :data || key == :contenxt 
+      default.merge(overrides) { |key, oldval, newval|
+        if key == :data || key == :context 
           oldval.merge(newval)
         else
           newval
         end
       }
     end
-    
+
     # Returns the host name of the machine we are currently running on 
-    def self.hostname() 
+    def self.hostname
       ENV['NODE_NAME'] || 'local-dev'
     end
-    
-    def self.build_number() 
+
+    def self.build_number
       ENV['BUILD_NUMBER']
     end
-    
+
     # This method checks against a bunch of default environment variables available through DOTCI
     # The intent is never to upload timing logs from a local machine, so we make it unlikely that these 
     # env variables are present on a dev's local machine
-    def self.should_upload_logs()
+    def self.should_upload_logs
       have_workspace = ENV['WORKSPACE'] && !ENV['WORKSPACE'].empty?
       have_build_number = ENV['BUILD_NUMBER'] && !ENV['BUILD_NUMBER'].empty?
       have_jenkins_url = ENV['JENKINS_URL'] && !ENV['JENKINS_URL'].empty?
-      have_ci_var = ENV['CI'] && !ENV['CI'].empty?
-      have_workspace && have_build_number && have_jenkins_url && have_ci_var
+      have_workspace && have_build_number && have_jenkins_url
     end
-    
+
     def self.print(val)
       puts("#{LOG_PREFIX} #{val}")
     end
   end
-end
+end

data/lib/mobile_metrics/junit.rb

@@ -1,6 +1,5 @@
 
 module MobileMetrics
-  
   # Adapted from: https://github.com/orta/danger-junit/blob/master/lib/junit/plugin.rb
   class JunitParser
     # All the tests for introspection
@@ -55,23 +54,23 @@ module MobileMetrics
       failed_suites = suite_root.nodes.select { |suite| suite[:failures].to_i > 0 || suite[:errors].to_i > 0 }
       failed_tests = failed_suites.map(&:nodes).flatten.select { |node| node.kind_of?(Ox::Element) && node.value == 'testcase' }
 
-      @failures = failed_tests.select do |test| 
+      @failures = failed_tests.select do |test|
         test.nodes.count > 0
       end.select do |test|
         node = test.nodes.first
         node.kind_of?(Ox::Element) && node.value == 'failure'
       end
 
-      @errors = failed_tests.select do |test| 
+      @errors = failed_tests.select do |test|
         test.nodes.count > 0
-      end.select do |test| 
+      end.select do |test|
         node = test.nodes.first
         node.kind_of?(Ox::Element) && node.value == 'error'
       end
 
-      @skipped = tests.select do |test| 
+      @skipped = tests.select do |test|
         test.nodes.count > 0
-      end.select do |test| 
+      end.select do |test|
         node = test.nodes.first
         node.kind_of?(Ox::Element) && node.value == 'skipped'
       end
@@ -79,4 +78,4 @@ module MobileMetrics
       @passes = tests - @failures - @errors - @skipped
     end
   end
-end
+end

data/lib/mobile_metrics/version.rb

@@ -1,3 +1,3 @@
 module MobileMetrics
-  VERSION = "0.0.3"
+  VERSION = '0.1.0'
 end

data/mobile_metrics.gemspec

@@ -13,12 +13,12 @@ Gem::Specification.new do |spec|
   # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features|README|scripts)/}) || f.match(%r{^(.ci|README.md)})
+    f.match(%r{^(test|spec|features|README|scripts)/}) || f.match(%r{^(.ci|README.md)})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  
+
   spec.add_runtime_dependency 'ox', '~> 2.0'
 
   spec.add_development_dependency "bundler", "~> 1.16"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobile_metrics
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - dbeard
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - dbeard@groupon.com
 executables: []
@@ -75,7 +75,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Rakefile
@@ -85,10 +84,10 @@ files:
 - lib/mobile_metrics/junit.rb
 - lib/mobile_metrics/version.rb
 - mobile_metrics.gemspec
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Mobile logging format library
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.16.1