openstudio_measure_tester 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6d3ffe474ac0b1753ef5c49ef7ee7e959826291
-  data.tar.gz: f611d397387097b16f4e972d2cdf6fa940e811be
+  metadata.gz: 3c701b7ee1c908a30adce739d1ef8e30a1b804b1
+  data.tar.gz: 2520f8964fdeb8ea55df34d743676c56732dca46
 SHA512:
-  metadata.gz: 6cfb89cf542468159aedfeda87cd1814a33a87ab5ae91cb71147e1a474beb549e50b5250a9c2e0c24de775adbffe19a38f509258a977e31763d7ee50e2a5b02a
-  data.tar.gz: 4cbac4111f187421793eebaae9c65599487991daa2e602009aa1f4a1bd23606f53989e237b4c0135e7253546dfda596ac3da6bc53cdceecd3e515b6b3b923ecd
+  metadata.gz: c419ccadea649d88baef183cb66780178dfb3b3a70be6077c08c7f1d7ca8a95657105f1a6a9ae4444e1ffc189df5c9d74ce0d3abc1f03f01783849476dde7369
+  data.tar.gz: 7ec95e37072d0f1af63b8435d1eb283a2a9eb387a02ba0b0e544fc9f460a1ad4c177e618754caedf12d89975966766f046eb3c299f38c21cb7ab1ca6a506db81

data/.gitignore

@@ -1,3 +1,4 @@
+/.idea/
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -15,10 +16,12 @@
 # rspec failure tracking
 .rspec_status
 rspec.html
-.idea/
 Gemfile.lock
-.rubocop-https*
+**/.rubocop-http*
 rubocop-results.xml
+!spec/files/rubocop-results.xml
+spec/files/rubocop/rubocop.json
+spec/**/.rubocop.yml
 
 # mac and rbenv stuff
 .DS_Store

data/.rubocop.yml

@@ -2,4 +2,4 @@ AllCops:
   Exclude:
     - 'spec/test_measures/**/*'
 inherit_from:
-  - https://raw.githubusercontent.com/NREL/OpenStudio-resources/develop/styles/rubocop.yml
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml

data/.travis.yml

@@ -1,14 +1,21 @@
 sudo: true
 language: ruby
 rvm:
-  - 2.2.4
+- 2.2.4
 matrix:
   include:
-    - env: OPENSTUDIO_VERSION=2.4.0 && OPENSTUDIO_SHA=f58a3e1808 && RUBYLIB=/usr/Ruby
-before_install: gem install bundler -v 1.16.1
+  - env: OPENSTUDIO_VERSION=2.4.0 && OPENSTUDIO_SHA=f58a3e1808 && RUBYLIB=/usr/Ruby
+  - env: OPENSTUDIO_VERSION=2.5.1 && OPENSTUDIO_SHA=4f268e2854 && RUBYLIB=/usr/Ruby
+before_install: gem install bundler -v 1.16.2
 before_script:
-  - curl -sLO https://raw.githubusercontent.com/NREL/OpenStudio-server/develop/docker/deployment/scripts/install_openstudio.sh
-  - chmod +x install_openstudio.sh
-  - sudo ./install_openstudio.sh $OPENSTUDIO_VERSION $OPENSTUDIO_SHA
+- curl -sLO https://raw.githubusercontent.com/NREL/OpenStudio-server/develop/docker/deployment/scripts/install_openstudio.sh
+- chmod +x install_openstudio.sh
+- sudo ./install_openstudio.sh $OPENSTUDIO_VERSION $OPENSTUDIO_SHA
 script:
-  - rake
+- bundle exec rake
+deploy:
+  - provider: rubygems
+    api_key:
+      secure: IOYqPDXgaX5tZgsaeuSs2Q5hUry0l2RHrXDmuEeu7SElLDQSXS2z8c43eHg6GphtIho9NZgonXeCe1QoXb/GdHsyv2Up1XfaTtPkf7LHJo/zYPF7Yjc1mjGpKRPfk1srH8nfb6w9w7zjFlhk73a/Vh26BvdRCXqAA8W72d0ur2p8OTlGSYjcgLihWI13sSKrfHjTRXhOpv6gkziaY2pmvNWeeYdqOD3CpvlMDAMkHY/KptksaqWdBAT9Jr4gIfAGeGbKzye0OmBBrwMV4n/4KZqNNDyjiGYGoSbOhVEsAOHbeJz6IOoC93ICQi/nLuWBw+T8do79X2/GBIj2/N7eaEo4CcYsxMS0JX+dE4yL+OzQOFkDenq0WAEB7JjtBVW3sBHAIRGO2o2Cma6Ga5+86oSD0f5lAvnhiCejA1Fy9X5pnIMsk1zWlPLydPX4TwIm10JBaRLut+MFq0tL5tJunyIwlZnMgVofVdKYZHS7fVOvqSTQhM+iA0Gx5l7bKZQjpO3m91j14pKqdJij0PJ4oxy7ozc38YSUL85NKXnbf2KwnYVxMGz4yBrSalzMjftu6WfCM8liDTb0ACHby56KbPrlVlixJrrJIefZCLqaHtqL2lLlyVV36EtRbNl3It7DrOQ21HK3raOEuSxht3uuTu9FIdTx0TKraJUyToE6gbw=
+    on:
+      tags: true

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# Version 0.1.5
+
+* Run Minitest in foreground
+* Remove ActiveSupport XML parsing and use REXML
+* Enforce UTF-8 encoding on all files read by this package
+* Garbage collection on each Minitest teardown
+* Disable running coverage until access violations are resolved
+* More logging
+
 # Version 0.1.4
 
 * Use simplecov from NREL's fork. Do not rely on JSON.

data/Gemfile

@@ -1,8 +1,8 @@
-source 'https://rubygems.org'
+source 'http://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in openstudio_measure_tester.gemspec
 gemspec
 
-gem "simplecov", github: "NREL/simplecov"
+gem 'simplecov', github: 'NREL/simplecov'

data/README.md

@@ -5,7 +5,9 @@
 
 The OpenStudio Measure Tester is a rubygem that exposes rake tasks for testing OpenStudio measures.
 
-## Installation
+## Installation and Running
+
+### Rake-based
 
 * Add the following code to the Gemfile and Rakefile of a measure repo you desire to test.
 
@@ -35,11 +37,36 @@ The OpenStudio Measure Tester is a rubygem that exposes rake tasks for testing O
 
     ```
     Open ./test_results/dashboard/index.html to view measure testing dashboard.
-    ```
+        ```
 
-## Disclaimer
+### Ruby-based
+
+* Require the OpenStudio-measure-tester gem
+
+```ruby
+require 'openstudio_measure_tester'
+measures_dir = 'spec/test_measures/AddOverhangsByProjectionFactor'
+# all measures (recursively) from measures_dir will be tested
+  
+runner = OpenStudioMeasureTester::Runner.new(measures_dir)
+
+# base_dir is needed for coverage results as they are written to disk on the at_exit calls
+base_dir = Dir.pwd
+ 
+result = runner.run_all(base_dir)
+puts result
+# result will be 0 or 1, 0=success, 1=failure
+
+runner.run_style(false)
 
-This project is under active development and will be changing significantly.
+runner.run_test(false, base_dir)
+
+runner.run_rubocop(false)
+```
+
+* Results will be saved into the run directory (measures_dir from above).    
+
+## Disclaimer
 
 # Testing in Docker
 
@@ -54,3 +81,9 @@ chmod +x install_openstudio.sh
 ./install_openstudio.sh 2.4.0 f58a3e1808
 export RUBYLIB=/usr/Ruby
 ```
+
+
+# Releasing
+
+New versions of the OpenStudio Measure Tester Gem will be automatically released for any tags. Makes sure to increment 
+the version in `/lib/openstudio_measure_tester/version.rb` and tag the release (preferably off the master branch).

data/bin/run_measure_tests

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'openstudio_measure_tester'
+
+measure_dir = File.absolute_path(ARGV[0], Dir.pwd)
+
+if !File.exist?(measure_dir)
+  puts "'#{measure_dir}}' does not exist"
+  exit
+end
+
+begin
+  runner = OpenStudioMeasureTester::Runner.new(measure_dir)
+  runner.run_all(Dir.pwd)
+rescue StandardError => exception
+  puts
+  puts '!!!!!!!!!!!!!!!!!!!!! Error Occurred !!!!!!!!!!!!!!!!!!!!!'
+  puts exception.message
+  puts exception.backtrace
+  puts '!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!'
+  puts
+end

data/lib/openstudio_measure_tester.rb

@@ -29,11 +29,22 @@
 require 'openstudio'
 
 require 'pp'
-require 'active_support'
-require 'active_support/core_ext'
 require 'git'
-require 'openstudio_measure_tester/core_ext'
+require 'rexml/document'
+require 'minitest'
+require 'simplecov'
+
+# override the default at_exit call
+SimpleCov.at_exit do
+end
 
+# Override the minitest autorun, to, well, not autorun
+def Minitest.autorun; end
+
+# Rubocop loads a lot of objects, anyway to minimize would be nice.
+require 'rubocop'
+
+require 'openstudio_measure_tester/core_ext'
 require 'openstudio_measure_tester/version'
 require 'openstudio_measure_tester/openstudio_style'
 require 'openstudio_measure_tester/minitest_result'
@@ -41,9 +52,27 @@ require 'openstudio_measure_tester/coverage'
 require 'openstudio_measure_tester/rubocop_result'
 require 'openstudio_measure_tester/openstudio_testing_result'
 require 'openstudio_measure_tester/dashboard'
+require 'openstudio_measure_tester/runner'
 
 require 'openstudio_measure_tester/rake_task'
 
+# Set the encoding to UTF-8. OpenStudio Docker images do not have this set by default
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
 module OpenStudioMeasureTester
   # No action here. Most of this will be rake_tasks at the moment.
 end
+
+
+class Minitest::Test
+	def teardown
+		before = ObjectSpace.count_objects
+    	GC.start
+    	after = ObjectSpace.count_objects
+    	delta = {}
+    	before.each {|k, v| delta[k] = v - after[k] if after.has_key? k }
+    	puts "GC Delta: #{delta}"
+	end
+end
+

data/lib/openstudio_measure_tester/core_ext.rb

@@ -72,7 +72,7 @@ end
 module Git
   class Log
     def empty?
-      size.zero? # rubocop:disable Style/ZeroLengthPredicate
+      size.zero?
     end
   end
 end

data/lib/openstudio_measure_tester/coverage.rb

@@ -69,6 +69,11 @@ module OpenStudioMeasureTester
     def parse_results
       file = "#{@path_to_results}/.resultset.json"
 
+      unless File.exist? file
+        puts "Could not find the results of coverage in #{file}"
+        return false
+      end
+
       puts 'Parsing coverage results'
       json_data = File.read(file)
       hash = JSON.parse(json_data)
@@ -95,9 +100,9 @@ module OpenStudioMeasureTester
         if parts.last == 'measure.rb'
           class_name = parse_class_name(key)
           measure_maps[class_name] = {
-              class_name: class_name,
-              root_path: File.dirname(key),
-              files: [key]
+            class_name: class_name,
+            root_path: File.dirname(key),
+            files: [key]
           }
         end
       end
@@ -135,7 +140,7 @@ module OpenStudioMeasureTester
           # remove nils from array
           cov_results_by_line.delete(nil)
 
-          cov = cov_results_by_line.count {|x| x > 0}
+          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
@@ -156,7 +161,6 @@ module OpenStudioMeasureTester
         @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
@@ -164,6 +168,8 @@ module OpenStudioMeasureTester
         @total_percent_coverage = (@total_covered_lines.to_f / lines.to_f * 100).round(2)
       end
       pp "Total Coverage: #{@total_percent_coverage}"
+
+      return true
     end
 
     def to_hash

data/lib/openstudio_measure_tester/dashboard.rb

@@ -3,20 +3,20 @@ module OpenStudioMeasureTester
   class Dashboard
     attr_reader :html
 
-    # @param base_dir [String]: The directory from where the rake test was instantiated
-    def initialize(base_dir)
-      @base_dir = base_dir
+    # @param test_results_directory [String]: The directory
+    def initialize(test_results_directory)
+      @test_results_directory = test_results_directory
 
       erb_file = File.expand_path('templates/dashboard.html.erb', File.dirname(__FILE__))
       @template = File.read(erb_file)
-      file = File.read("#{base_dir}/test_results/combined_results.json")
+      file = File.read("#{@test_results_directory}/combined_results.json")
       @data = file
       @hash = JSON.parse(@data)
     end
 
     def render
       rendered = ERB.new(@template, 0, '', '@html').result(binding)
-      save_dir = "#{@base_dir}/test_results/dashboard"
+      save_dir = "#{@test_results_directory}/dashboard"
 
       # Render the dashboard
       FileUtils.mkdir_p save_dir unless Dir.exist? save_dir

data/lib/openstudio_measure_tester/minitest_result.rb

@@ -57,23 +57,26 @@ module OpenStudioMeasureTester
     def parse_results
       Dir["#{@path_to_results}/reports/*.xml"].each do |file|
         puts "Parsing minitest report #{file}"
-        hash = Hash.from_xml(File.read(file))
+        doc = REXML::Document.new(File.open(file)).root
 
-        # pp hash
+        # continue if doc is empty
+        next unless doc
 
         measure_name = file.split('/')[-1].split('.')[0].split('-')[1].gsub /-?[tT]est\z/, ''
 
         mhash = {}
-
         mhash['tested_class'] = measure_name
-        mhash['measure_tests'] = hash['testsuite']['tests'].to_i
-        mhash['measure_assertions'] = hash['testsuite']['assertions'].to_i
-        mhash['measure_errors'] = hash['testsuite']['errors'].to_i
-        mhash['measure_failures'] = hash['testsuite']['failures'].to_i
-        mhash['measure_skipped'] = hash['testsuite']['skipped'].to_i
 
         # Note: only 1 failure and 1 error possible per test
-        errors, failures = parse_measure(hash)
+        testsuite_element = doc.elements['testsuite']
+        errors, failures = parse_measure(testsuite_element)
+
+        mhash['measure_tests'] = testsuite_element.attributes['tests'].to_i
+        mhash['measure_assertions'] = testsuite_element.attributes['assertions'].to_i
+        mhash['measure_errors'] = testsuite_element.attributes['errors'].to_i
+        mhash['measure_failures'] = testsuite_element.attributes['failures'].to_i
+        mhash['measure_skipped'] = testsuite_element.attributes['skipped'].to_i
+
         mhash['issues'] = { errors: errors, failures: failures }
 
         @measure_results[measure_name] = mhash
@@ -86,8 +89,6 @@ module OpenStudioMeasureTester
       end
 
       @error_status = true if @total_errors > 0
-
-      # pp measure_results
     end
 
     def to_file
@@ -111,25 +112,15 @@ module OpenStudioMeasureTester
 
     private
 
-    def parse_measure(measure)
+    def parse_measure(testsuite_element)
       errors = []
       failures = []
 
-      # check if testcase is hash or array
-      if measure['testsuite']
-
-        if measure['testsuite']['testcase'].class == Hash
-          # convert to array
-          measure['testsuite']['testcase'] = [measure['testsuite']['testcase']]
-        end
-        measure['testsuite']['testcase'].each do |test|
-          if test['error']
-            errors << test['error']
-          end
-
-          if test['failure']
-            failures << test['failure']
-          end
+      testsuite_element.elements.each('testcase') do |testcase|
+        if testcase.elements['error']
+          errors << testcase.elements['error']
+        elsif testcase.elements['failure']
+          failures << testcase.elements['failure']
         end
       end
 

data/lib/openstudio_measure_tester/openstudio_style.rb

@@ -74,13 +74,6 @@ 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: /MiniTest::Unit::TestCase/,
         check_type: :if_exists,
@@ -99,9 +92,10 @@ module OpenStudioMeasureTester
     ].freeze
 
     # Pass in the measures_glob with the filename (typically measure.rb)
-    def initialize(measures_glob)
+    def initialize(results_dir, measures_glob)
       @measures_glob = measures_glob
       @results = { by_measure: {} }
+      @results_dir = results_dir
 
       # Individual measure messages
       @measure_messages = []
@@ -156,9 +150,12 @@ module OpenStudioMeasureTester
         else
           measure = measure.get
           begin
+            # there seems to be a race condition with the infoExtractor method
             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)
+          rescue => error
+            log_message("Unknown error extracting measure info. Error #{error}", :general, :error)
           end
 
           measure_hash = generate_measure_hash(measure_dir, measure, measure_info)
@@ -213,8 +210,11 @@ module OpenStudioMeasureTester
     end
 
     def save_results
-      FileUtils.mkdir 'openstudio_style' unless Dir.exist? 'openstudio_style'
-      File.open('openstudio_style/openstudio_style.json', 'w') do |file|
+      save_dir = "#{@results_dir}/openstudio_style"
+      save_file = "#{save_dir}/openstudio_style.json"
+      puts "Saving OpenStudio Style results to #{save_file}"
+      FileUtils.mkdir_p save_dir unless Dir.exist? save_dir
+      File.open(save_file, 'w') do |file|
         file << JSON.pretty_generate(@results)
       end
     end