openstudio_measure_tester 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 115113315811da74ef6a2d39bf2ed2f617d091c4
-  data.tar.gz: d0b4058a1a1751da72781357e0325f3a0acf53d7
+  metadata.gz: aea59476a002df673244b9df077b9ec4c8064c5c
+  data.tar.gz: e33c1970119627924736028e691a7f90daea3d49
 SHA512:
-  metadata.gz: 64bffbc0f06b6e17c9616c2eeeb7daf4bc010962637eb7f50c527d48964048a78266f9c25858f0797026032f5618280086503aff85e91c216e7138630601b285
-  data.tar.gz: 32b3638d6c38aab842e68c4dda5d2d0e44f53661a9238a1db7b8ed11405a498b973ec3f02c7548aba66368d2d989f664a06ac97ae6ee87f4babbec5d35ea5f1d
+  metadata.gz: 85dae18b77ea9a3f4888a9083f0deb6a52d21b25439066abf61d1224da062541cbdb2e2f4e771e52521f2bfff0ee7c8e360a1008ab680775041e1141cc48064f
+  data.tar.gz: 761c6012b9305cfa2b18fe4525ec6b0ef2623e34f51b8b4199396603af15d08e4a11a36286174abbf7c8dfdd00a113e4dff9257288a61fb76512606ed88cd445

data/.travis.yml

@@ -12,4 +12,3 @@ before_script:
   - sudo ./install_openstudio.sh $OPENSTUDIO_VERSION $OPENSTUDIO_SHA
 script:
   - rake
-

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# Version 0.1.3
+
+* Catch when infoExtractor is unable to parse measure arguments
+* Allow a measure name to include "test"
+* Lock down versions of dependencies
+* Add a broken measure to the test
+
 # Version 0.1.2
 
 * Do not crash when the current measure is not in a Git repository

data/Gemfile

@@ -4,5 +4,3 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in openstudio_measure_tester.gemspec
 gemspec
-
-gem 'rake'

data/README.md

@@ -11,13 +11,13 @@ The OpenStudio Measure Tester is a rubygem that exposes rake tasks for testing O
 
     * Gemfile
         ```ruby
-        gem 'openstudio_measure_tester', '~> 0.1'
+        source 'https://rubygems.org'
+        gem 'openstudio_measure_tester'
         
-        # or 
-        gem 'openstudio_measure_tester', github: 'NREL/openstudio_measure_tester_gem'
-        
-        # or
+        # or for release on Github
+        gem 'openstudio_measure_tester', github: 'NREL/openstudio_measure_tester_gem', branch: 'develop'
         
+        # or for local development
         gem 'openstudio_measure_tester', path: '../<path-to-checkout>'
         ```
     
@@ -30,22 +30,17 @@ The OpenStudio Measure Tester is a rubygem that exposes rake tasks for testing O
     
 * Run `bundle update`
 * run `bundle exec rake -T` to see the new tests that are available.
-* In existing measure directory, run `bundle exec rake openstudio:test`
+* In existing measure directory, run `bundle exec rake openstudio:all`
+* Minitest, Coverage, Rubocop, and OpenStudio Style will run. The last message that appears to the screen is the location of the dashboard.
+
+    ```
+    Open ./test_results/dashboard/index.html to view measure testing dashboard.
+    ```
 
 ## Disclaimer
 
 This project is under active development and will be changing significantly.
 
-## Potential Issues
-
-Currently, the project downloads the rubocops from the OpenStudio-resources Github repo and saves them to the gem's installation location. This may be write protected on some machines.
-
-
-# TODOS
-
-* Callbacks to gather results
-* MiniTest results to JSON (currently only stdout) 
-
 # Testing in Docker
 
 ```bash
@@ -58,5 +53,4 @@ chmod +x install_openstudio.sh
 ./install_ruby.sh 2.2.4 b6eff568b48e0fda76e5a36333175df049b204e91217aa32a65153cc0cdcb761
 ./install_openstudio.sh 2.4.0 f58a3e1808
 export RUBYLIB=/usr/Ruby
-
 ```

data/lib/openstudio_measure_tester/coverage.rb

@@ -45,10 +45,27 @@ module OpenStudioMeasureTester
       @total_missed_lines = 0
 
       @measure_coverages = {}
+    end
+
+    def parse_class_name(measure_file)
+      # grab the class name out of the parts
+      unless File.exist? measure_file
+        # magically try to find the path name by dropping the first element of array. This is
+        # mainly needed for the testing framework as we are committing the .resultset.json which may
+        # have been generated by any user, esp since the file names are fully qualified in the .resultsset.json,
+        puts "Trying to determine the file path of unknown measure #{measure_file}"
+        measure_file = measure_file.split('/')[1..-1].join('/') until File.exist?(measure_file) || measure_file.split('/').empty?
+      end
 
-      parse_results
+      # file should exist now. Read from the class name
+      File.readlines(measure_file).each do |line|
+        if (line.include? 'class') && line.split(' ')[0] == 'class'
+          return line.match(/class\s(.*)\s</)[1]
+        end
+      end
     end
 
+    # Call this method to parse the results of the Coverage runs
     def parse_results
       file = "#{@path_to_results}/.resultset.json"
 
@@ -60,24 +77,44 @@ module OpenStudioMeasureTester
 
       # Sometimes the coverage is RSpec, sometimes MiniTest. Depends if running
       # tests in this Gem, or using this gem where MiniTest is already loaded.
-      k, coverage_results = hash.first
-      puts "Coverage results are of type #{k}"
-
-      # find all measure names
-      measure_names = []
-      coverage_results['coverage'].each do |key, data|
+      _, coverage_results = hash.first
+      # puts "Coverage results are of type #{k}"
+
+      # Find all measure names. Currently this is hardcoded to be the second to last element
+      # of the file path name of the measure.rb. For example the key in the resultset.json file is
+      # typically of the form:
+      #     OpenStudio-measure-tester-gem/spec/test_measures/AddOverhangsByProjectionFactor/measure.rb"
+      # which results in the measure name being 'AddOverhangsByProjectionFactor'
+      # The measure names stores the mapping of the measure names to the key in the resultset.json
+      # This requires two passes through the list of files, the first to grab the measure.rb files, which has
+      # the classname, then to go through and grab all the other files that exist for the same measure class name.
+      # Two passes because the order of the files in .resultset.json is not guaranteed to have measure.rb first.
+      measure_maps = {}
+      coverage_results['coverage'].keys.each do |key|
         parts = key.split('/')
         if parts.last == 'measure.rb'
-          name = parts[-2]
-          pp name
-          measure_names << name
+          class_name = parse_class_name(key)
+          measure_maps[class_name] = {
+              class_name: class_name,
+              root_path: File.dirname(key),
+              files: [key]
+          }
         end
       end
 
-      measure_names.each do |measure_name|
-        cn = ''
-        results = coverage_results['coverage'].select { |key, _data| key.include? measure_name }
+      # second pass, add other files.
+      coverage_results['coverage'].keys.each do |key|
+        next if key.split('/').last == 'measure.rb'
 
+        measure_maps.each do |m_key, m_value|
+          if key.include? m_value[:root_path]
+            measure_maps[m_key][:files] << key
+          end
+        end
+      end
+
+      # remap all this data to another format... seems like we could do this another way
+      measure_maps.each do |class_name, measure_map|
         mhash = {}
         mhash['total_lines'] = 0
         mhash['relevant_lines'] = 0
@@ -86,53 +123,40 @@ module OpenStudioMeasureTester
         mhash['percent_coverage'] = 0
         mhash['files'] = []
 
-        results.each do |key, data|
+        measure_map[:files].each do |test_file|
+          cov_results_by_line = coverage_results['coverage'][test_file]
           fhash = {}
-          fhash['name'] = key.partition(measure_name + '/').last
-          fhash['total_lines'] = data.size
-
-          # get the class name
-          if fhash['name'] == 'measure.rb'
-            unless File.exist? key
-              # magically try to find the path name by dropping the first element of array
-              puts "Trying to determine the file path of unknown measure #{key}"
-              key = key.split('/')[1..-1].join('/') until File.exist?(key) || key.split('/').empty?
-            end
-
-            # file should exist now
-            File.readlines(key).each do |line|
-              if (line.include? 'class') && line.split(' ')[0] == 'class'
-                cn = line.split(' ')[1].gsub /_?[tT]est\z/, ''
-                break
-              end
-            end
-          end
+          # get the relative file path
 
+          fhash['name'] = test_file.gsub("#{measure_map[:root_path]}/", '')
+          fhash['total_lines'] = cov_results_by_line.size
           mhash['total_lines'] += fhash['total_lines']
+
           # remove nils from array
-          data.delete(nil)
+          cov_results_by_line.delete(nil)
 
-          cov = data.count { |x| x > 0 }
-          fhash['percent_coverage'] = ((cov.to_f / data.size.to_f) * 100).round(2)
-          fhash['missed_lines'] = data.size - cov
-          fhash['relevant_lines'] = data.size
+          cov = cov_results_by_line.count {|x| x > 0}
+          fhash['percent_coverage'] = ((cov.to_f / cov_results_by_line.size.to_f) * 100).round(2)
+          fhash['missed_lines'] = cov_results_by_line.size - cov
+          fhash['relevant_lines'] = cov_results_by_line.size
           fhash['covered_lines'] = cov
 
           # measure-level totals
           mhash['relevant_lines'] += fhash['relevant_lines']
           mhash['covered_lines'] += fhash['covered_lines']
           mhash['missed_lines'] += fhash['missed_lines']
-
           mhash['files'] << fhash
         end
+
         mhash['percent_coverage'] = (mhash['covered_lines'].to_f / mhash['relevant_lines'].to_f * 100).round(2)
-        @measure_coverages[cn] = mhash
+        @measure_coverages[class_name] = mhash
         @total_lines += mhash['total_lines']
         @total_relevant_lines += mhash['relevant_lines']
         @total_covered_lines += mhash['covered_lines']
         @total_missed_lines += mhash['missed_lines']
       end
 
+
       # pp @measure_coverages
       lines = @total_relevant_lines # unnecessary but breaks formatting otherwise
       # lines can be zero if coverage doesn't run correctly

data/lib/openstudio_measure_tester/openstudio_style.rb

@@ -74,13 +74,13 @@ module OpenStudioMeasureTester
         type: :deprecated,
         severity: :error,
         file_type: :measure
-      }, {
-        regex: /require .openstudio_measure_tester\/test_helper./,
-        check_type: :if_missing,
-        message: "Must include 'require 'openstudio_measure_tester/test_helper'' in Test file to report coverage correctly.",
-        type: :syntax,
-        severity: :error,
-        file_type: :test
+        # }, {
+        #   regex: /require .openstudio_measure_tester\/test_helper./,
+        #   check_type: :if_missing,
+        #   message: "Must include 'require 'openstudio_measure_tester/test_helper'' in Test file to report coverage correctly.",
+        #   type: :syntax,
+        #   severity: :error,
+        #   file_type: :test
       }, {
         regex: /MiniTest::Unit::TestCase/,
         check_type: :if_exists,
@@ -149,14 +149,17 @@ module OpenStudioMeasureTester
         log_message("Could not find LICENSE.md in '#{measure_dir}'.", :general, :warning)
       end
 
-
       unless measure_missing
         measure = OpenStudio::BCLMeasure.load(measure_dir)
         if measure.empty?
           log_message("Failed to load measure '#{measure_dir}'", :general, :error)
         else
           measure = measure.get
-          measure_info = infoExtractor(measure, OpenStudio::Model::OptionalModel.new, OpenStudio::OptionalWorkspace.new)
+          begin
+            measure_info = infoExtractor(measure, OpenStudio::Model::OptionalModel.new, OpenStudio::OptionalWorkspace.new)
+          rescue NameError => error
+            log_message("Unable to parse info from measure. Error: '#{error}'", :general, :error)
+          end
 
           measure_hash = generate_measure_hash(measure_dir, measure, measure_info)
           measure_hash.merge!(get_attributes_from_measure(measure_dir, measure_hash[:class_name]))
@@ -173,8 +176,6 @@ module OpenStudioMeasureTester
 
       # pp @measure_messages
 
-
-
       # calculate the info, warnings, errors and return the measure data
       # TODO: break out the issues by file
       return {

data/lib/openstudio_measure_tester/openstudio_testing_result.rb

@@ -52,8 +52,8 @@ module OpenStudioMeasureTester
         if !logs.empty?
           sha = logs.first.sha
         end
-      rescue StandardError => error 
-        puts "Could not find .git for measure(s), will not be able to report git information"
+      rescue StandardError => error
+        puts 'Could not find .git for measure(s), will not be able to report git information'
       end
 
       # check if the results data already exist, and if so, then load the file now to keep the results
@@ -76,6 +76,7 @@ module OpenStudioMeasureTester
           FileUtils.mv "#{@results_dir}/coverage", "#{@test_results_dir}/."
 
           cov = OpenStudioMeasureTester::Coverage.new("#{@test_results_dir}/coverage")
+          cov.parse_results
           @results['coverage'] = cov.to_hash
         end
 
@@ -83,8 +84,14 @@ module OpenStudioMeasureTester
         if Dir.exist?("#{@results_dir}/test/html_reports") || Dir.exist?("#{@results_dir}/test/reports")
           FileUtils.rm_rf "#{@test_results_dir}/minitest" if Dir.exist? "#{@test_results_dir}/minitest"
           FileUtils.mkdir_p "#{@test_results_dir}/minitest"
-          FileUtils.mv "#{@results_dir}/test/html_reports", "#{@test_results_dir}/minitest/html_reports"
-          FileUtils.mv "#{@results_dir}/test/reports", "#{@test_results_dir}/minitest/reports"
+
+          if Dir.exist?("#{@results_dir}/test/html_reports")
+            FileUtils.mv "#{@results_dir}/test/html_reports", "#{@test_results_dir}/minitest/html_reports"
+          end
+
+          if Dir.exist?("#{@results_dir}/test/reports")
+            FileUtils.mv "#{@results_dir}/test/reports", "#{@test_results_dir}/minitest/reports"
+          end
 
           # Delete the test folder if it is empty
           FileUtils.rm_rf "#{@results_dir}/test" if Dir.entries("#{@results_dir}/test").size == 2

data/lib/openstudio_measure_tester/rake_task.rb

@@ -214,7 +214,7 @@ module OpenStudioMeasureTester
           end
 
           desc 'Run RuboCop Auto Correct on Measures'
-          task auto_correct: 'openstudio:rubocop_core:auto_correct'
+          task auto_correct: ['openstudio:prepare_rubocop', 'openstudio:rubocop_core:auto_correct']
         end
 
         desc 'Run RuboCop on Measures'

data/lib/openstudio_measure_tester/test_helper.rb

@@ -28,7 +28,6 @@
 
 $coverage_started = false
 unless $coverage_started
-  puts 'Coverage starting'
   require 'simplecov'
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
     [

data/lib/openstudio_measure_tester/version.rb

@@ -27,5 +27,5 @@
 ########################################################################################################################
 
 module OpenStudioMeasureTester
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/openstudio_measure_tester.gemspec

@@ -20,16 +20,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler', '1.16.1'
+  spec.add_development_dependency 'rspec', '3.7.0'
 
-  spec.add_dependency 'activesupport', '~> 5.1.4'
-  spec.add_dependency 'ci_reporter_minitest', '~> 1.0.0'
-  spec.add_dependency 'git', '~> 1.3.0'
-  spec.add_dependency 'minitest', '~> 5.4.0'
-  spec.add_dependency 'minitest-reporters', '~> 1.1'
-  spec.add_dependency 'rake', '~> 12.3'
-  spec.add_dependency 'rubocop', '~> 0.52'
-  spec.add_dependency 'rubocop-checkstyle_formatter', '~> 0.4'
-  spec.add_dependency 'simplecov', '~> 0.15'
+  spec.add_dependency 'activesupport', '5.1.5'
+  spec.add_dependency 'ci_reporter_minitest', '1.0.0'
+  spec.add_dependency 'git', '1.3.0'
+  spec.add_dependency 'minitest', '5.4.3'
+  spec.add_dependency 'minitest-reporters', '1.1.19'
+  spec.add_dependency 'rake', '12.3'
+  spec.add_dependency 'rubocop', '0.53.0'
+  spec.add_dependency 'rubocop-checkstyle_formatter', '0.4'
+  spec.add_dependency 'simplecov', '0.16'
 end

metadata

@@ -1,169 +1,169 @@
 --- !ruby/object:Gem::Specification
 name: openstudio_measure_tester
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nicholas Long
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.16.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: 5.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: 5.1.5
 - !ruby/object:Gem::Dependency
   name: ci_reporter_minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 5.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 5.4.3
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.1.19
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.1.19
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '12.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 0.53.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 0.53.0
 - !ruby/object:Gem::Dependency
   name: rubocop-checkstyle_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.16'
 description: Testing framework for OpenStudio measures
 email:
 - nicholas.long@nrel.gov