openstudio_measure_tester 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f5a572a08e1cf50dac9d00cbd082413321ee167bdf987176f0aa57ac8762ffc
-  data.tar.gz: 2d5465eec4d31216ba26a4a4907998bd29fa9650f592b7369474c2c8e5077820
+  metadata.gz: b2154c98870a730a34aec0ea97ae64385c72963384da1486bb4097fd8bcf049e
+  data.tar.gz: 2e4addb622ad23fc056aa3f6e41e654f901b971175c5b1e987e036fd444f93c4
 SHA512:
-  metadata.gz: 4c7ade21a3fe0b0a77395cb0a4c647b000ef34037c50b67202dfb92662d6659e7c9980569b3ba76da67edba2a4f2a60523f8d933871ea4a0058d9485e1a8bc33
-  data.tar.gz: d46a3c20cabc1415ca754c3e9b5bffaf09615ae215674fe4555412319de76e02d5a1b4f97ce2da0e1075f41bb4296d9b989c0837e0a73ef207befca1073ca2d5
+  metadata.gz: 8d559a442f9a549592ee70666227e2e8c89f8ac14ab0c74a421c2f0d40838f2f98518394f00bfab8a1646a091b07aa29ab72d8e563f98e9c91fd5bd0bac8ac6d
+  data.tar.gz: 97a14956b4088ff07b45716864148d78dcdbded3dbe5d27109fbaf490d451efafeeafd8448db278b450093aeafd19a3c14ea65fcc76e4fedb42011fd7ed4955b

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# Version 0.4.0
+
+* Upgrade to Ruby 3.2.2
+* updaring gem versions of rubocop and simplecov
+
 # Version 0.3.3
 
 * Update license

data/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
+OpenStudio(R), Copyright (c) 2008, 2024 Alliance for Sustainable Energy, LLC.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

data/lib/openstudio_measure_tester/dashboard.rb

@@ -22,7 +22,7 @@ module OpenStudioMeasureTester
     end
 
     def render
-      rendered = ERB.new(@template, 0, nil, '@html').result(binding)
+      rendered = ERB.new(@template, trim_mode: nil, eoutvar: '@html').result(binding)
       save_dir = "#{@test_results_directory}/dashboard"
 
       # Render the dashboard

data/lib/openstudio_measure_tester/github_actions_report.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+module OpenStudioMeasureTester
+  class GithubActionsReport
+    attr_reader :minitest_summary_table, :all_annotations
+
+    # @param test_results_directory [String]: The directory
+    def initialize(test_results_directory)
+      @test_results_directory = test_results_directory
+      file = File.read("#{@test_results_directory}/combined_results.json")
+      @hash = JSON.parse(file)
+      @minitest_summary_table = nil
+      @all_annotations = []
+    end
+
+    def write_step_summary(msg)
+      puts msg
+      if !ENV['GITHUB_STEP_SUMMARY'].nil?
+        File.write(ENV['GITHUB_STEP_SUMMARY'], "#{msg}\n", mode: 'a+')
+      end
+    end
+
+    def hash_to_markdown(h, header0, header1)
+      n0 = [h.keys.map(&:to_s).map(&:size).max, header0.size].max
+      n1 = [h.values.map(&:to_s).map(&:size).max, header1.size].max
+
+      content = [
+        "| #{header0.ljust(n0)} | #{header1.ljust(n1)} |",
+        "| " + "-" * n0 + " | " + "-" * n1 + " |",
+      ] + h.map{|k, v| "| #{k.ljust(n0)} | #{v.to_s.ljust(n1)} |"}
+      return content.join("\n")
+    end
+
+    def make_minitest_step_summary_table
+
+      write_step_summary("## Minitest")
+      write_step_summary("")
+
+      total_tests = @hash['minitest']['total_tests']
+      total_assertions = @hash['minitest']['total_assertions']
+      total_errors = @hash['minitest']['total_errors']
+      total_failures = @hash['minitest']['total_failures']
+      total_skipped = @hash['minitest']['total_skipped']
+      total_compatibility_errors = @hash['minitest']['total_compatibility_errors']
+      total_load_errors = @hash['minitest'].fetch('total_load_errors', []).count
+
+      passed = total_tests - (total_failures + total_errors + total_skipped)
+      pct = passed.to_f / (total_tests - total_skipped).to_f
+
+      h = {
+        'Total Tests' => total_tests,
+        'Load Error' => total_load_errors,
+        'Passed' => passed,
+        'Success Rate' => '%.2f%%' % (pct * 100.0),
+        'Failures' => total_failures,
+        'Errors' => total_errors,
+        'Skipped' => total_skipped,
+        'Incompatible' => total_compatibility_errors,
+        'Total Assertions' => total_assertions,
+      }
+
+      @minitest_summary_table = hash_to_markdown(h, "Metric", "Value")
+
+      write_step_summary(@minitest_summary_table)
+      write_step_summary("")
+    end
+
+    def make_minitest_annotations
+      @all_annotations = []
+
+      report_xmls = Dir["#{@test_results_directory}/minitest/reports/TEST-*.xml"]
+      report_xmls.each do |report_xml|
+        doc = REXML::Document.new(File.open(report_xml)).root
+        testsuite_element = doc.elements['testsuite']
+        filepath = testsuite_element.attributes['filepath']
+        testsuite_element.elements.each('testcase') do |testcase|
+          test_name = testcase.attributes['name']
+          line = testcase.attributes['lineno'].to_i
+          tested_class = testcase.attributes['classname']
+
+          testcase.elements.each('failure') do |x|
+            title = x.attributes['type']
+            message = x.attributes['message']
+            annot = "::error file=#{filepath},line=#{line},endLine=#{line + 1},title=#{title}::#{tested_class}.#{test_name}: #{message}"
+            @all_annotations <<  annot
+          end
+          testcase.elements.each('error') do |x|
+            title = x.attributes['type']
+            message = x.attributes['message']
+            annot = "::error file=#{filepath},line=#{line},endLine=#{line + 1},title=#{title}::#{message}"
+            @all_annotations <<  annot
+          end
+          testcase.elements.each('skipped') do |x|
+            title = x.attributes['type']
+            message = x.attributes['message']
+            annot = "::warning file=#{filepath},line=#{line},endLine=#{line + 1},title=#{title}::#{message}"
+            @all_annotations <<  annot
+          end
+        end
+      end
+      @all_annotations.each { |a| puts a}
+      nil
+    end
+  end
+end

data/lib/openstudio_measure_tester/rake_task.rb

@@ -27,7 +27,7 @@ module OpenStudioMeasureTester
     def setup_subtasks(name)
       namespace name do
         ####################################### Minitest and Coverage #######################################
-        desc 'new test task'
+        desc 'Run Minitest and Coverage on Measures'
         task :test do
           runner = OpenStudioMeasureTester::Runner.new(Rake.application.original_dir)
           # Need to pass in the current directory because the results of minitest and coverage end up going into

data/lib/openstudio_measure_tester/rubocop_result.rb

@@ -90,7 +90,8 @@ module OpenStudioMeasureTester
           doc.elements.each('//checkstyle/file') do |rc_file|
             # Allow processing when the file is just the measure.rb
             if rc_file.attributes['name'] != 'measure.rb'
-              if !rc_file.attributes['name'].include? measure_name
+              parts = rc_file.attributes['name'].split(File::SEPARATOR)
+              if !parts.include? measure_name
                 next
               end
             end

data/lib/openstudio_measure_tester/runner.rb

@@ -32,6 +32,12 @@ module OpenStudioMeasureTester
       template.render
     end
 
+    def github_actions_report
+      gha_reporter = OpenStudioMeasureTester::GithubActionsReport.new(test_results_dir)
+      gha_reporter.make_minitest_step_summary_table
+      gha_reporter.make_minitest_annotations
+    end
+
     # Prepare the current directory and the root directory to remove old test results before running
     # the new tests
     #
@@ -67,8 +73,10 @@ module OpenStudioMeasureTester
       # copy over the .rubocop.yml file into the root directory of where this is running.
       shared_rubocop_file = File.expand_path('../../.rubocop.yml', File.dirname(__FILE__))
       dest_file = "#{File.expand_path(@base_dir)}/.rubocop.yml"
-      if shared_rubocop_file != dest_file
+      if !File.exist?(dest_file)
         FileUtils.copy(shared_rubocop_file, dest_file)
+      elsif File.read(shared_rubocop_file) != File.read(dest_file)
+        puts "Using specific custom .rubocop.yml rather than the OpenStudio-measure-tester-gem's one"
       end
 
       puts "Current directory is #{@base_dir}"
@@ -96,6 +104,8 @@ module OpenStudioMeasureTester
       # call the create dashboard command now that we have results
       dashboard
 
+      github_actions_report if ENV["GITHUB_ACTIONS"]
+
       # return the results exit code
       return results.exit_code
     end
@@ -146,6 +156,9 @@ module OpenStudioMeasureTester
         # output_path: 'junk.xml',
         auto_correct: auto_correct,
         color: false,
+        # cf #76 - Because we pass a glob to the Runner.run, we must pass
+        # force_exclusion to respect the files excluded in the .rubocop.yml
+        force_exclusion: true,
         formatters: ['simple', ['RuboCop::Formatter::CheckstyleFormatter', rubocop_results_file]]
       }
 

data/lib/openstudio_measure_tester/version.rb

@@ -6,5 +6,5 @@
 # *******************************************************************************
 
 module OpenStudioMeasureTester
-  VERSION = '0.3.3'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/openstudio_measure_tester.rb

@@ -11,6 +11,7 @@ require 'pp'
 require 'rexml/document'
 require 'minitest'
 require 'simplecov'
+require 'json'
 
 begin
   require 'git'
@@ -36,6 +37,7 @@ require_relative 'openstudio_measure_tester/coverage'
 require_relative 'openstudio_measure_tester/rubocop_result'
 require_relative 'openstudio_measure_tester/openstudio_testing_result'
 require_relative 'openstudio_measure_tester/dashboard'
+require_relative 'openstudio_measure_tester/github_actions_report'
 require_relative 'openstudio_measure_tester/runner'
 
 require_relative 'openstudio_measure_tester/rake_task'

data/openstudio_measure_tester.gemspec

@@ -27,18 +27,18 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.7.0'
+  spec.required_ruby_version = '~> 3.2.2'
 
   spec.add_dependency 'git', '~> 1.12.0'
   spec.add_dependency 'minitest', '~> 5.14.0'
   spec.add_dependency 'minitest-reporters', '~> 1.4.2'
   spec.add_dependency 'rake', '~> 13.0'
   spec.add_dependency 'parser', '3.2.2.2'
-  spec.add_dependency 'rubocop', '~> 1.15.0'
-  spec.add_dependency 'rubocop-performance', '~> 1.11.3'
-  spec.add_dependency 'rubocop-checkstyle_formatter', '~> 0.4.0'
-  spec.add_dependency 'simplecov', '~> 0.18.2'
+  spec.add_dependency 'rubocop', '1.50'
+  spec.add_dependency 'rubocop-performance', '1.20.0'
+  spec.add_dependency 'rubocop-checkstyle_formatter', '0.6.0'
+  spec.add_dependency 'simplecov', '0.22.0'
 
-  spec.add_development_dependency 'bundler', '>= 2.1.0'
+  spec.add_development_dependency 'bundler', '2.4.10'
   spec.add_development_dependency 'rspec', '~> 3.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio_measure_tester
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Nicholas Long
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -87,72 +87,72 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '1.50'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '1.50'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.3
+        version: 1.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.3
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: rubocop-checkstyle_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.10
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -200,6 +200,7 @@ files:
 - lib/openstudio_measure_tester/core_ext.rb
 - lib/openstudio_measure_tester/coverage.rb
 - lib/openstudio_measure_tester/dashboard.rb
+- lib/openstudio_measure_tester/github_actions_report.rb
 - lib/openstudio_measure_tester/minitest_result.rb
 - lib/openstudio_measure_tester/openstudio_style.rb
 - lib/openstudio_measure_tester/openstudio_testing_result.rb
@@ -214,7 +215,7 @@ licenses: []
 metadata:
   bug_tracker_uri: https://github.com/NREL/OpenStudio-measure-tester-gem/issues
   changelog_uri: https://github.com/NREL/OpenStudio-measure-tester-gem/blob/develop/CHANGELOG.md
-  source_code_uri: https://github.com/NREL/OpenStudio-measure-tester-gem/tree/v0.3.3
+  source_code_uri: https://github.com/NREL/OpenStudio-measure-tester-gem/tree/v0.4.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -223,14 +224,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Testing framework for OpenStudio measures