openstudio-extension 0.2.1 → 0.2.6

data/lib/openstudio/extension/runner.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -43,6 +41,7 @@ require 'openstudio'
 require 'yaml'
 require 'fileutils'
 require 'parallel'
+require 'bcl'
 
 module OpenStudio
   module Extension
@@ -57,7 +56,7 @@ module OpenStudio
       # compatible with the OpenStudio CLI.
       ##
       #  @param [String] dirname Directory to run commands in, defaults to Dir.pwd. If directory includes a Gemfile then create a local bundle.
-      #  @param bundle_without [Hash] Hash describing the distribution of the variable.
+      #  @param bundle_without [Array] List of strings of the groups to exclude when running the bundle command
       #  @param options [Hash] Hash describing options for running the simulation. These are the defaults for all runs unless overriden within the run_* methods. Note if options is used, then a local runner.conf file will not be loaded.
       #  @option options [String] :max_datapoints Max number of datapoints to run
       #  @option options [String] :num_parallel Number of simulations to run in parallel at a time
@@ -69,20 +68,29 @@ module OpenStudio
         # in ~/OpenStudio/#{alias} or something like that?
 
         # if the dirname contains a runner.conf file, then use the config file to specify the parameters
+
+        @options = OpenStudio::Extension::RunnerConfig.default_config
+        # ORDER of PRECEDENCE: default config < runner.conf file < options passed in directly
         if File.exist?(File.join(dirname, OpenStudio::Extension::RunnerConfig::FILENAME)) && options.empty?
           puts 'Using runner options from runner.conf file'
           runner_config = OpenStudio::Extension::RunnerConfig.new(dirname)
-          @options = runner_config.options
-        else
-          # use the passed values or defaults overriden by passed options
-          @options = OpenStudio::Extension::RunnerConfig.default_config.merge(options)
+          # use the default values overriden with runner.conf values
+          @options = @options.merge(runner_config.options)
         end
 
+        # use the passed values or defaults overriden by passed options
+        @options = @options.merge(options)
+
         puts "Initializing runner with dirname: '#{dirname}' and options: #{@options}"
         @dirname = File.absolute_path(dirname)
-        @gemfile_path = File.join(@dirname, 'Gemfile')
-        @bundle_install_path = File.join(@dirname, '.bundle/install/')
+
+        # use passed options, otherwise assume @dirname
+        @gemfile_path = !@options.key?(:gemfile_path) || @options[:gemfile_path] === '' ? File.join(@dirname, 'Gemfile') : @options[:gemfile_path]
+        @bundle_install_path = !@options.key?(:bundle_install_path) || @options[:bundle_install_path] === '' ? File.join(@dirname, '.bundle/install/') : @options[:bundle_install_path]
         @original_dir = Dir.pwd
+        # puts "DIRNAME: #{@dirname}"
+        # puts "@gemfile_path set to: #{@gemfile_path}"
+        # puts "@bundle_install_path set to: #{@bundle_install_path}"
 
         @bundle_without = bundle_without || []
         @bundle_without_string = @bundle_without.join(' ')
@@ -156,7 +164,9 @@ module OpenStudio
 
             puts "needs_update = #{needs_update}"
             if needs_update
-              run_command('bundle update', get_clean_env)
+              # run_command('bundle update', get_clean_env)
+              # KAF: updated to include specified gemfile_path...this didn't seem to work before
+              run_command("bundle update --gemfile=#{@gemfile_path}", get_clean_env)
             end
           ensure
             Dir.chdir(@original_dir)
@@ -562,12 +572,12 @@ module OpenStudio
         puts "Encoding.default_internal = #{Encoding.default_internal}"
 
         paths.each do |path|
-          Dir[path[:glob]].each do |file|
-            puts "Updating license in file #{file}"
-            f = File.read(file)
+          Dir[path[:glob]].each do |dir_file|
+            puts "Updating license in file #{dir_file}"
+            f = File.read(dir_file)
             if f.match?(path[:regex])
               puts '  License found -- updating'
-              File.open(file, 'w') { |write| write << f.gsub(path[:regex], path[:license]) }
+              File.open(dir_file, 'w') { |write| write << f.gsub(path[:regex], path[:license]) }
             elsif f =~ /\(C\)/i || f =~ /\(Copyright\)/i
               puts '  File already has copyright -- skipping'
             else
@@ -576,7 +586,7 @@ module OpenStudio
                 puts '  CANNOT add license to file automatically, add it manually and it will update automatically in the future'
                 next
               end
-              File.open(file, 'w') { |write| write << f.insert(0, path[:license] + "\n") }
+              File.open(dir_file, 'w') { |write| write << f.insert(0, path[:license] + "\n") }
             end
           end
         end
@@ -646,7 +656,16 @@ module OpenStudio
           puts 'simulations are not performed, since to the @options[:run_simulations] is set to false'
         end
 
-        # DLM: this does not always return false for failed CLI runs, consider checking for failed.job file as backup test
+        if @options[:run_simulations]
+          # Additional checks for failed CLI
+          if File.exist?(File.join(run_dir, 'failed.job'))
+            result = false
+          end
+
+          if !File.exist?(File.join(run_dir, 'finished.job'))
+            result = false
+          end
+        end
 
         return result
       end

data/lib/openstudio/extension/runner_config.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -40,7 +38,7 @@ require 'json'
 module OpenStudio
   module Extension
     class RunnerConfig
-      FILENAME = 'runner.conf'
+      FILENAME = 'runner.conf'.freeze
 
       ##
       # Class to store configuration of the runner options.
@@ -80,7 +78,9 @@ module OpenStudio
           max_datapoints: 1E9.to_i,
           num_parallel: 2,
           run_simulations: true,
-          verbose: false
+          verbose: false,
+          gemfile_path: '',
+          bundle_install_path: ''
         }
       end
 

data/lib/openstudio/extension/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -37,6 +35,6 @@
 
 module OpenStudio
   module Extension
-    VERSION = '0.2.1'
+    VERSION = '0.2.6'.freeze
   end
 end

data/openstudio-extension.gemspec

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'openstudio/extension/version'
@@ -22,7 +20,7 @@ Gem::Specification.new do |spec|
   }
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|lib.measures.*tests|spec|features)/})
   end
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -30,12 +28,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.5.0'
 
+  spec.add_dependency 'bcl', '~> 0.6.1'
   spec.add_dependency 'bundler', '~> 2.1'
+  spec.add_dependency 'octokit', '~> 4.18.0' # for change logs
   spec.add_dependency 'openstudio-workflow', '~> 2.0.0'
-  spec.add_dependency 'openstudio_measure_tester', '~> 0.2.2'
+  spec.add_dependency 'openstudio_measure_tester', '~> 0.2.3'
   spec.add_dependency 'parallel', '~> 1.19.1'
 
-  spec.add_development_dependency 'github_api', '~> 0.18.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-extension
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 platform: ruby
 authors:
 - Katherine Fleming
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -27,61 +41,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: openstudio-workflow
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 4.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 4.18.0
 - !ruby/object:Gem::Dependency
-  name: openstudio_measure_tester
+  name: openstudio-workflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: parallel
+  name: openstudio_measure_tester
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.1
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.1
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
-  name: github_api
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
-  type: :development
+        version: 1.19.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 1.19.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -154,7 +168,6 @@ files:
 - lib/measures/openstudio_extension_test_measure/measure.rb
 - lib/measures/openstudio_extension_test_measure/measure.xml
 - lib/measures/openstudio_extension_test_measure/resources/os_lib_helper_methods.rb
-- lib/measures/openstudio_extension_test_measure/tests/openstudio_extension_test_measure_test.rb
 - lib/openstudio-extension.rb
 - lib/openstudio/extension.rb
 - lib/openstudio/extension/core/CreateResults.rb
@@ -205,7 +218,7 @@ licenses: []
 metadata:
   bug_tracker_uri: https://github.com/NREL/openstudio-extension-gem/issues
   changelog_uri: https://github.com/NREL/openstudio-extension-gem/blob/develop/CHANGELOG.md
-  source_code_uri: https://github.com/NREL/openstudio-extension-gem/tree/v0.2.1
+  source_code_uri: https://github.com/NREL/openstudio-extension-gem/tree/v0.2.6
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/measures/openstudio_extension_test_measure/tests/openstudio_extension_test_measure_test.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, 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 HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, 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 'openstudio'
-require 'openstudio/measure/ShowRunnerOutput'
-
-require_relative '../measure.rb'
-require 'minitest/autorun'
-
-class OpenStudioExtensionTestMeasureTest < Minitest::Test
-  # def setup
-  # end
-
-  # def teardown
-  # end
-
-  def test_OpenStudioExtensionTestMeasure
-    # create an instance of the measure
-    measure = OpenStudioExtensionTestMeasure.new
-
-    # create an instance of a runner
-    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
-
-    # make an empty model
-    model = OpenStudio::Model::Model.new
-
-    # get arguments and test that they are what we are expecting
-    arguments = measure.arguments(model)
-    assert_equal(0, arguments.size)
-
-    # set argument values to good values and run the measure on model with spaces
-    arguments = measure.arguments(model)
-    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
-
-    measure.run(model, runner, argument_map)
-    result = runner.result
-    # show_output(result)
-    assert(result.value.valueName == 'Success')
-    assert(result.warnings.empty?)
-    assert(result.info.empty?)
-  end
-end