openstudio_measure_tester 0.1.0

data/lib/openstudio_measure_tester/openstudio_testing_result.rb

@@ -0,0 +1,167 @@
+########################################################################################################################
+#  OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC. All rights reserved.
+#
+#  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+#  following conditions are met:
+#
+#  (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+#  disclaimer.
+#
+#  (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
+#  following disclaimer in the documentation and/or other materials provided with the distribution.
+#
+#  (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote
+#  products derived from this software without specific prior written permission from the respective party.
+#
+#  (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative
+#  works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar designation without
+#  specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+#  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+#  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT, OR ANY CONTRIBUTORS BE LIABLE FOR
+#  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+#  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+########################################################################################################################
+
+module OpenStudioMeasureTester
+  class OpenStudioTestingResult
+    attr_reader :results
+
+    # Pass in the results_dir where all the results are stored
+    # @param results_dir [String]: Directory where the results are scattered. Typically the root dir or where rake was executed
+    # @param test_results_dir [String]: Where the final results are to be stored
+    def initialize(results_dir, test_results_dir)
+      @results_dir = results_dir
+      @test_results_dir = test_results_dir
+      @results = {}
+
+      # get the repository info
+      g = Git.open(Dir.pwd)
+      config = g.config
+      repo_name = config['remote.origin.url'].split('/')[1].split('.')[0]
+      current_branch = g.branch.name
+      @results['repo_name'] = repo_name
+      @results['current_branch'] = current_branch
+      # TODO add failsafe
+
+      # check if the results data already exist, and if so, then load the file now to keep the results
+      load_results
+      aggregate_results
+    end
+
+    def aggregate_results
+      # TODO: check if we need this check of directories
+      if @test_results_dir != @results_dir
+        # coverage
+        if Dir.exist? "#{@results_dir}/coverage"
+          FileUtils.rm_rf "#{@test_results_dir}/coverage" if Dir.exist? "#{@test_results_dir}/coverage"
+          FileUtils.mv "#{@results_dir}/coverage", "#{@test_results_dir}/."
+
+          cov = OpenStudioMeasureTester::Coverage.new("#{@test_results_dir}/coverage")
+          @results["coverage"] = cov.to_hash
+        end
+
+        # minitest
+        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"
+
+          # Delete the test folder if it is empty
+          FileUtils.rm_rf "#{@results_dir}/test" if Dir.entries("#{@results_dir}/test").size == 2
+
+          # Load in the data into the minitest object
+          mr = OpenStudioMeasureTester::MinitestResult.new("#{@test_results_dir}/minitest")
+          @results['minitest'] = mr.summary
+        end
+
+        # rubocop
+        if Dir.exist? "#{@results_dir}/rubocop"
+          FileUtils.rm_rf "#{@test_results_dir}/rubocop" if Dir.exist? "#{@test_results_dir}/rubocop"
+          FileUtils.mv "#{@results_dir}/rubocop", "#{@test_results_dir}/rubocop"
+
+          # need to create parser here!
+          # trying!!! &^&%##%@((@*&()))!!
+          rc = OpenStudioMeasureTester::RubocopResult.new("#{@test_results_dir}/rubocop")
+          @results['rubocop'] = rc.summary
+
+        end
+
+        # openstudio style
+        if Dir.exist? "#{@results_dir}/openstudio_style"
+          FileUtils.rm_rf "#{@test_results_dir}/openstudio_style" if Dir.exist? "#{@test_results_dir}/openstudio_style"
+          FileUtils.mv "#{@results_dir}/openstudio_style", "#{@test_results_dir}/openstudio_style"
+
+          # OpenStudio Style will have already run, so just grab the results out of the directory and jam into
+          # the @results hash
+          filename = "#{@test_results_dir}/openstudio_style/openstudio_style.json"
+          if File.exist? filename
+            @results['openstudio_style'] = JSON.parse(File.read(filename))
+          end
+        end
+      end
+    end
+
+    def load_results
+      filename = "#{@test_results_dir}/combined_results.json"
+      begin
+        @results = JSON.parse(File.read(filename)) if File.exist? filename
+      rescue
+        @results = {}
+      end
+    end
+
+    def save_results
+      File.open("#{@test_results_dir}/combined_results.json", 'w') do |file|
+        file << JSON.pretty_generate(@results)
+      end
+    end
+
+    # Return the exit code based on some arbitrary limit across all the tests
+    def exit_code
+      # there must be no unit test failures
+      # pp @results
+      final_exit_code = 0
+      if @results['rubocop']
+        if @results['rubocop']['total_errors'] > 0
+          puts 'RuboCop errors found.'
+          final_exit_code = 1
+        end
+      end
+
+      if @results['openstudio_style']
+        if @results['openstudio_style']['total_errors'] > 0
+          puts 'OpenStudio Style errors found.'
+          final_exit_code = 1
+        end
+        if @results['openstudio_style']['total_warnings'] > 10
+          puts 'More than 10 OpenStudio Style warnings found, reporting as error'
+          final_exit_code = 1
+        end
+      end
+
+      if @results['minitest']
+        if @results['minitest']['total_errors'] > 0 || @results['minitest']['total_failures'] > 0
+          puts 'Unit Test (MiniTest) errors/failures found.'
+          final_exit_code = 1
+        end
+      end
+
+      if @results['coverage']
+        if @results['coverage']['total_percent_coverage'] < 70
+          puts 'Code coverage is less than 70%, raising error.'
+          final_exit_code = 1
+        end
+      end
+
+      puts 'Open ./test_results/dashboard/index.html to view measure testing dashboard.'
+
+      return final_exit_code
+    end
+  end
+end
+

data/lib/openstudio_measure_tester/rake_task.rb

@@ -0,0 +1,258 @@
+########################################################################################################################
+#  OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC. All rights reserved.
+#
+#  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+#  following conditions are met:
+#
+#  (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+#  disclaimer.
+#
+#  (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
+#  following disclaimer in the documentation and/or other materials provided with the distribution.
+#
+#  (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote
+#  products derived from this software without specific prior written permission from the respective party.
+#
+#  (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative
+#  works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar designation without
+#  specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+#  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+#  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT, OR ANY CONTRIBUTORS BE LIABLE FOR
+#  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+#  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+########################################################################################################################
+
+require 'rake'
+require 'rake/tasklib'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+require_relative '../openstudio_measure_tester'
+
+module OpenStudioMeasureTester
+  class RakeTask < Rake::TaskLib
+    attr_accessor :name
+
+    def initialize(*args, &task_block)
+      @name = args.shift || :openstudio
+
+      setup_subtasks(@name)
+    end
+
+    private
+
+    # Prepare the current directory and the root directory to remove old test results before running
+    # the new tests
+    def pre_process_minitest(base_dir)
+      current_dir = Dir.pwd
+      test_results_dir = "#{base_dir}/test_results"
+
+      puts "Current directory is #{current_dir}"
+      puts "Pre-processing tests run in #{base_dir}"
+      puts "Test results will be stored in: #{test_results_dir}"
+
+      FileUtils.rm_rf "#{test_results_dir}/coverage" if Dir.exist? "#{test_results_dir}/coverage"
+      FileUtils.rm_rf "#{test_results_dir}/test/html_reports" if Dir.exist? "#{test_results_dir}/test/html_reports"
+      FileUtils.rm_rf "#{test_results_dir}/test/reports" if Dir.exist? "#{test_results_dir}/test/reports"
+      # remove the test directory if it is empty (size == 2 for . and ..)
+      if Dir.exist?("#{test_results_dir}/test") && Dir.entries("#{test_results_dir}/test").size == 2
+        FileUtils.rm_rf "#{test_results_dir}/test"
+      end
+      FileUtils.rm_rf "#{test_results_dir}/minitest" if Dir.exist? "#{test_results_dir}/minitest"
+      FileUtils.rm_rf "#{base_dir}/coverage" if Dir.exist? "#{base_dir}/coverage"
+      FileUtils.rm_rf "#{base_dir}/test" if Dir.exist? "#{base_dir}/test"
+      FileUtils.rm_rf "#{base_dir}/minitest" if Dir.exist? "#{base_dir}/minitest"
+      FileUtils.rm_rf "#{current_dir}/coverage" if Dir.exist? "#{current_dir}/coverage"
+      FileUtils.rm_rf "#{current_dir}/test" if Dir.exist? "#{current_dir}/test"
+      FileUtils.rm_rf "#{current_dir}/minitest" if Dir.exist? "#{current_dir}/minitest"
+
+      # Create the test_results directory to store all the results
+      FileUtils.mkdir_p "#{base_dir}/test_results"
+    end
+
+    # Rubocop stores the results (for now) in the test_results directory
+    def pre_process_rubocop(base_dir)
+      current_dir = Dir.pwd
+      test_results_dir = "#{base_dir}/test_results"
+
+      puts "Current directory is #{current_dir}"
+      puts "Pre-processing tests run in #{base_dir}"
+      puts "Test results will be stored in: #{test_results_dir}"
+
+      FileUtils.rm_rf "#{test_results_dir}/rubocop" if Dir.exist? "#{test_results_dir}/rubocop"
+      FileUtils.rm_rf "#{base_dir}/rubocop" if Dir.exist? "#{base_dir}/rubocop"
+      FileUtils.rm_rf "#{current_dir}/rubocop" if Dir.exist? "#{current_dir}/rubocop"
+
+      # Create the test_results directory to store all the results
+      FileUtils.mkdir_p "#{base_dir}/test_results"
+    end
+
+    # OpenStudio style check preparation
+    def pre_process_style(base_dir)
+      current_dir = Dir.pwd
+      test_results_dir = "#{base_dir}/test_results"
+
+      puts "Current directory is #{current_dir}"
+      puts "Pre-processing tests run in #{base_dir}"
+      puts "Test results will be stored in: #{test_results_dir}"
+
+      FileUtils.rm_rf "#{test_results_dir}/openstudio_style" if Dir.exist? "#{test_results_dir}/openstudio_style"
+      FileUtils.rm_rf "#{base_dir}/openstudio_style" if Dir.exist? "#{base_dir}/openstudio_style"
+      FileUtils.rm_rf "#{current_dir}/openstudio_style" if Dir.exist? "#{current_dir}/openstudio_style"
+
+      # Create the test_results directory to store all the results
+      FileUtils.mkdir_p "#{base_dir}/test_results"
+    end
+
+    def run_style(base_dir)
+      style = OpenStudioMeasureTester::OpenStudioStyle.new("#{base_dir}/**/measure.rb")
+      style.save_results
+    end
+
+    # Post process the various results and save them into the base_dir
+    def post_process_results(base_dir)
+      current_dir = Dir.pwd
+      test_results_dir = "#{base_dir}/test_results"
+
+      puts "Current directory: #{current_dir}"
+      puts "Post-processing tests run in: #{base_dir}"
+      puts "Test results will be stored in: #{test_results_dir}"
+
+      FileUtils.mkdir_p test_results_dir
+
+      results = OpenStudioMeasureTester::OpenStudioTestingResult.new(current_dir, test_results_dir)
+      results.save_results # one single file for dashboard
+
+      # call the create dashboard command now that we have results
+      dashboard(base_dir)
+
+      # return the results exit code
+      return results.exit_code
+    end
+
+    # Run ERB to create the dashboard
+    def dashboard(base_dir)
+      template = OpenStudioMeasureTester::Dashboard.new(base_dir)
+      template.render
+    end
+
+    def setup_subtasks(name)
+      namespace name do
+        task :prepare_minitest do
+          pre_process_minitest(Rake.application.original_dir)
+        end
+
+        task :prepare_rubocop do
+          # copy over the .rubocop.yml file
+          shared_rubocop_file = File.expand_path('../../.rubocop.yml', File.dirname(__FILE__))
+          dest_file = "#{Dir.pwd}/.rubocop.yml"
+          if shared_rubocop_file != dest_file
+            FileUtils.copy(shared_rubocop_file, dest_file)
+          end
+          pre_process_rubocop(Rake.application.original_dir)
+        end
+
+        task :prepare_style do
+          pre_process_style(Rake.application.original_dir)
+        end
+
+        task style_core: [] do
+          run_style(Rake.application.original_dir)
+        end
+
+        task :post_process_core do
+          post_process_results(Rake.application.original_dir)
+        end
+
+        Rake::TestTask.new(:test_core_command) do |task|
+          task.options = '--ci-reporter'
+          task.description = 'Run measures tests recursively from current directory'
+          task.pattern = [
+            "#{Rake.application.original_dir}/**/*_test.rb",
+            "#{Rake.application.original_dir}/**/*_Test.rb"
+          ]
+          task.verbose = true
+        end
+
+        task :test_core do
+          begin
+            Rake.application['openstudio:test_core_command'].invoke
+          rescue StandardError
+            puts 'Test failures in openstudio:test. Will continue to post-processing.'
+          ensure
+            Rake.application['openstudio:test_core_command'].reenable
+          end
+        end
+
+        # The .rubocop.yml file downloads the RuboCop rules from the OpenStudio-resources repo.
+        # This may cause an issue if the Gem directory does not have write access.
+        RuboCop::RakeTask.new(:rubocop_core) do |task|
+          task.options = ['--no-color', '--out=rubocop/rubocop-results.xml', '--format=simple']
+          task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
+          task.requires = ['rubocop/formatter/checkstyle_formatter']
+          # Run the rake at the original root directory
+          task.patterns = ["#{Rake.application.original_dir}/**/*.rb"]
+          # don't abort rake on failure
+          task.fail_on_error = false
+        end
+
+        desc 'Run OpenStudio Measure Unit Tests'
+        task test: ['openstudio:prepare_minitest', 'openstudio:test_core'] do
+          exit_status = post_process_results(Rake.application.original_dir)
+          exit exit_status
+        end
+
+        # Need to create a namespace so that we can have openstudio:rubocop and openstudio:rubocop:auto_correct.
+        namespace :rubocop do
+          task check: ['openstudio:prepare_rubocop', 'openstudio:rubocop_core'] do
+            exit_status = post_process_results(Rake.application.original_dir)
+            exit exit_status
+          end
+
+          desc 'Run RuboCop Auto Correct on Measures'
+          task auto_correct: 'openstudio:rubocop_core:auto_correct'
+        end
+
+        desc 'Run RuboCop on Measures'
+        task rubocop: 'openstudio:rubocop:check'
+
+        desc 'Run OpenStudio Style Checks'
+        task style: ['openstudio:prepare_style', 'openstudio:style_core'] do
+          exit_status = post_process_results(Rake.application.original_dir)
+          exit exit_status
+        end
+
+        desc 'Post process results into one directory'
+        task :post_process do
+          exit_status = post_process_results(Rake.application.original_dir)
+          exit exit_status
+        end
+
+        desc 'Generate dashboard'
+        task :dashboard do
+          dashboard(Rake.application.original_dir)
+        end
+
+        desc 'Run MiniTest, Coverage, RuboCop, and Style on measures, then dashboard results'
+        task all: ['openstudio:prepare_minitest',
+                   'openstudio:test_core',
+                   'openstudio:prepare_rubocop',
+                   'openstudio:rubocop_core',
+                   'openstudio:prepare_style',
+                   'openstudio:style_core'] do
+          exit_status = post_process_results(Rake.application.original_dir)
+          exit exit_status
+        end
+
+        # Hide the core tasks from being displayed when calling rake -T
+        Rake::Task['openstudio:rubocop_core'].clear_comments
+        Rake::Task['openstudio:test_core_command'].clear_comments
+        Rake::Task['openstudio:rubocop_core:auto_correct'].clear_comments
+      end
+    end
+  end
+end

data/lib/openstudio_measure_tester/rubocop_result.rb

@@ -0,0 +1,213 @@
+########################################################################################################################
+#  OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC. All rights reserved.
+#
+#  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+#  following conditions are met:
+#
+#  (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+#  disclaimer.
+#
+#  (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
+#  following disclaimer in the documentation and/or other materials provided with the distribution.
+#
+#  (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote
+#  products derived from this software without specific prior written permission from the respective party.
+#
+#  (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative
+#  works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar designation without
+#  specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+#  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+#  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT, OR ANY CONTRIBUTORS BE LIABLE FOR
+#  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+#  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+########################################################################################################################
+
+module OpenStudioMeasureTester
+  class RubocopResult
+    attr_reader :error_status
+
+    attr_reader :file_issues
+    attr_reader :file_info
+    attr_reader :file_warnings
+    attr_reader :file_errors
+
+    attr_reader :total_measures
+    attr_reader :total_files
+
+    attr_reader :total_issues
+    attr_reader :total_info
+    attr_reader :total_warnings
+    attr_reader :total_errors
+
+    attr_reader :summary
+    attr_reader :by_measure
+
+    def initialize(path_to_results)
+
+      @path_to_results = path_to_results
+      @error_status = false
+      @total_files = 0
+      @total_issues = 0
+      @total_errors = 0
+      @total_warnings = 0
+      @total_info = 0
+      @total_measures = 0
+
+      @summary = {}
+
+      @by_measure = {}
+
+      parse_results
+      to_file
+
+    end
+
+    def parse_results
+      # needs rescue
+      Dir["#{@path_to_results}/rubocop-results.xml"].each do |file|
+        puts "Parsing Rubocop report #{file}"
+        hash = Hash.from_xml(File.read(file))
+
+        # get measure names
+        measure_names = []
+        #cn= ''
+        hash['checkstyle']['file'].each do |key, data|
+          parts = key['name'].split('/')
+          if parts.last == 'measure.rb'
+           name = parts[-2]
+           measure_names << name
+          end
+        end
+
+        @total_measures = measure_names.length
+        @total_files = hash['checkstyle']['file'].length
+
+        measure_names.each do |measure_name|
+
+          #cn= ''
+          results = hash['checkstyle']['file'].select {|data| data['name'].include? measure_name }
+
+          mhash = {}
+          mhash['measure_issues'] = 0
+          mhash['measure_info'] = 0
+          mhash['measure_warnings'] = 0              
+          mhash['measure_errors'] = 0
+          mhash['files'] = []
+
+          results.each do |key, data|
+            fhash = {}
+            fhash['file_name'] = key['name'].split('/')[-1]
+            fhash['violations'] = []
+
+            # get the class name
+            # if fhash['file_name'] == 'measure.rb'
+            #   File.readlines(key['name']).each do |line|
+            #     if (line.include? 'class') && line.split(' ')[0] == 'class'
+            #         cn = line.split(' ')[1]
+            #         break
+            #     end
+            #   end
+            # end
+
+            if key['error']
+              @file_issues = 0
+              @file_info = 0
+              @file_warnings = 0
+              @file_errors = 0
+
+              violations = []
+
+              if key['error'].class == Array
+                @file_issues = key['error'].length
+                key['error'].each do |s|
+
+                  if s['severity'] === "info"
+                    @file_info += 1
+                  elsif s['severity'] === "warning"
+                    @file_warnings += 1
+                  elsif s['severity'] === "error" #TODO: look up complete list of codes 
+                    @file_errors += 1
+                  end
+                  violations << {line: s['line'], column: s['column'], severity: s['severity'], message: s['message']}
+                end
+              end
+
+              if key['error'].class == Hash
+                @file_issues = 1
+                if key['error']['severity'] === "info"
+                  @file_info += 1
+                elsif key['error']['severity'] === "warning"
+                  @file_warnings += 1
+                elsif key['error']['severity'] === "error"
+                  @file_errors += 1
+                end
+                violations << {line: key['error']['line'], column: key['error']['column'], severity: key['error']['severity'], message: key['error']['message']}
+              end
+
+              fhash['issues'] = @file_issues
+              fhash['info'] = @file_info
+              fhash['warning'] = @file_warnings
+              fhash['error'] = @file_errors
+              fhash['violations'] = violations
+              
+              mhash['measure_issues'] += @file_issues
+              mhash['measure_info'] += @file_info
+              mhash['measure_warnings'] += @file_warnings
+              mhash['measure_errors'] += @file_errors
+
+              @total_issues += @file_issues
+              @total_info += @file_info
+              @total_warnings += @file_warnings 
+              @total_errors += @file_errors
+              
+            end
+            
+            mhash['files'] << fhash
+
+          end
+
+        #@summary << mhash
+        #@by_measure[cn] = mhash
+        @by_measure[measure_name] = mhash
+
+        end
+
+      end
+
+      puts "total files: #{total_files}"
+      puts "total issues: #{@total_issues} (#{@total_info} info, #{@total_warnings} warnings, #{@total_errors} errors)"
+
+      # TODO: still need to get errors ID'd
+      @error_status = true if @total_errors > 0
+
+    end
+
+    def to_hash
+      results = {};
+      results['total_measures'] = @total_measures
+      results['total_files'] = @total_files
+      results['total_issues'] = @total_issues
+      results['total_info'] = @total_info
+      results['total_warnings'] = @total_warnings
+      results['total_errors'] = @total_errors
+      results['by_measure'] = @by_measure
+
+      results
+    end
+
+    def to_file
+      # save as a json and have something else parse it/plot it.
+      res_hash = to_hash
+      @summary = res_hash
+      FileUtils.mkdir_p "#{@path_to_results}/" unless Dir.exist? "#{@path_to_results}/"
+      File.open("#{@path_to_results}/rubocop.json", 'w') do |file|
+        file << JSON.pretty_generate(res_hash)
+      
+      end
+    end
+  end
+end