openstudio-extension 0.2.1 → 0.3.0

data/lib/openstudio/extension/core/os_lib_model_simplification.rb

@@ -148,7 +148,7 @@ module OsLib_ModelSimplification
     # loop through building type hash to create multiple blends
     space_type_hash.each do |collection_name, space_types|
       if collection_name == 'Building'
-        space_array = model.getSpaces # use all space types, not just space types passed in
+        space_array = model.getSpaces.sort # use all space types, not just space types passed in
       else
         space_array = []
         space_types.each do |space_type|
@@ -229,7 +229,7 @@ module OsLib_ModelSimplification
       if collection_name == 'Building'
         # count area of spaces that have no space type
         no_space_type_area_counter = 0
-        model.getSpaces.each do |space|
+        model.getSpaces.sort.each do |space|
           if space.spaceType.empty?
             next if !space.partofTotalFloorArea
             no_space_type_area_counter += space.floorArea * space.multiplier
@@ -400,7 +400,7 @@ module OsLib_ModelSimplification
       end
     end
 
-    return model.getSpaceTypes
+    return model.getSpaceTypes.sort
   end
 
   # blend internal loads used when working from existing model
@@ -788,10 +788,10 @@ module OsLib_ModelSimplification
   def sort_building_stories_and_get_min_multiplier(model)
     sorted_building_stories = {}
     # loop through stories
-    model.getBuildingStorys.each do |story|
+    model.getBuildingStorys.sort.each do |story|
       story_min_z = nil
       # loop through spaces in story.
-      story.spaces.each do |space|
+      story.spaces.sort.each do |space|
         space_z_min = OsLib_Geometry.getSurfaceZValues(space.surfaces.to_a).min + space.zOrigin
         if story_min_z.nil? || (story_min_z > space_z_min)
           story_min_z = space_z_min
@@ -829,8 +829,8 @@ module OsLib_ModelSimplification
 
     # get bounding_box
     bounding_box = OpenStudio::BoundingBox.new
-    model.getSpaces.each do |space|
-      space.surfaces.each do |spaceSurface|
+    model.getSpaces.sort.each do |space|
+      space.surfaces.sort.each do |spaceSurface|
         bounding_box.addPoints(space.transformation * spaceSurface.vertices)
       end
     end
@@ -844,7 +844,7 @@ module OsLib_ModelSimplification
     envelope_data_hash[:building_max_xyz] = [max_x, max_y, max_z]
 
     # add orientation specific wwr
-    ext_surfaces_hash = OsLib_Geometry.getExteriorWindowAndWllAreaByOrientation(model, model.getSpaces.to_a)
+    ext_surfaces_hash = OsLib_Geometry.getExteriorWindowAndWllAreaByOrientation(model, model.getSpaces.sort.to_a)
     envelope_data_hash[:building_wwr_n] = ext_surfaces_hash['northWindow'] / ext_surfaces_hash['northWall']
     envelope_data_hash[:building_wwr_s] = ext_surfaces_hash['southWindow'] / ext_surfaces_hash['southWall']
     envelope_data_hash[:building_wwr_e] = ext_surfaces_hash['eastWindow'] / ext_surfaces_hash['eastWall']
@@ -1038,7 +1038,7 @@ module OsLib_ModelSimplification
     envelope_data_hash[:building_overhang_proj_factor_w] = building_overhang_area_w / ext_surfaces_hash['westWindow']
 
     # warn for spaces that are not on a story (in future could infer stories for these)
-    model.getSpaces.each do |space|
+    model.getSpaces.sort.each do |space|
       if !space.buildingStory.is_initialized
         runner.registerWarning("#{space.name} is not on a building story, may have unexpected results.")
       end

data/lib/openstudio/extension/core/os_lib_outdoorair_and_infiltration.rb

@@ -37,7 +37,7 @@ module OsLib_OutdoorAirAndInfiltration
   # delete any infiltration objects used in the model.
   def self.eraseInfiltrationUsedInModel(model, runner)
     # get space infiltration objects.
-    space_infiltration_objects = model.getSpaceInfiltrationDesignFlowRates
+    space_infiltration_objects = model.getSpaceInfiltrationDesignFlowRates.sort
 
     # hash to hold schedules used for infiltration objects in the model
     @infiltrationSchedulesHardAssigned = {}
@@ -126,7 +126,7 @@ module OsLib_OutdoorAirAndInfiltration
 
       # change objects to be all space types used in the model
       objects = []
-      space_types = model.getSpaceTypes
+      space_types = model.getSpaceTypes.sort
       space_types.each do |space_type|
         if !space_type.spaces.empty?
           objects << space_type

data/lib/openstudio/extension/rake_task.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -51,14 +49,17 @@ module OpenStudio
         setup_subtasks(@name)
       end
 
-      def set_extension_class(extension_class)
+      def set_extension_class(extension_class, github_repo = '')
         @extension_class = extension_class
         @extension = extension_class.new
         @root_dir = @extension.root_dir
-        @measures_dir = @extension.measures_dir
+        # Catch if measures_dir is nil, then just make it an empty string
+        @measures_dir = @extension.measures_dir || ''
+        @staged_path = @measures_dir + '/staged'
         @core_dir = @extension.core_dir
         @doc_templates_dir = @extension.doc_templates_dir
         @files_dir = @extension.files_dir
+        @github_repo = github_repo
       end
 
       private
@@ -67,22 +68,20 @@ module OpenStudio
         namespace name do
           desc 'Run the CLI task to check for measure updates'
           task update_measures: ['measures:add_license', 'measures:add_readme', 'measures:copy_resources', 'update_copyright'] do
-            puts 'updating measures...'
+            puts 'updating measures'
             runner = OpenStudio::Extension::Runner.new(Dir.pwd)
             runner.update_measures(@measures_dir)
           end
 
           desc 'List measures'
           task :list_measures do
-            puts 'Listing measures...'
+            puts 'Listing measures'
             runner = OpenStudio::Extension::Runner.new(Dir.pwd)
             runner.list_measures(@measures_dir)
           end
 
           desc 'Use openstudio system ruby to run tests'
           task :test_with_openstudio do
-            # puts Dir.pwd
-            # puts Rake.original_dir
             puts 'testing with openstudio'
             runner = OpenStudio::Extension::Runner.new(Dir.pwd)
             result = runner.test_measures_with_cli(@measures_dir)
@@ -92,12 +91,6 @@ module OpenStudio
             end
           end
 
-          # TODO: Implement this eventually... comment out for now.
-          # desc 'Use openstudio docker image to run tests'
-          # task :test_with_docker do
-          #   puts 'testing with docker'
-          # end
-
           # namespace for measure operations
           namespace 'measures' do
             desc 'Copy the resources files to individual measures'
@@ -145,14 +138,233 @@ module OpenStudio
             runner.update_copyright(@root_dir, @doc_templates_dir)
           end
 
-          desc 'Copy the measures to a location that can be uploaded to BCL'
-          task :stage_bcl do
-            puts 'Staging measures for BCL'
+          desc 'Print the change log from GitHub. Date format: yyyy-mm-dd'
+          task :change_log, [:start_date, :end_date, :apikey] do |t, args|
+            require 'change_log'
+            cl = ChangeLog.new(@github_repo, *args)
+            cl.process
+            cl.print_issues
           end
 
-          desc 'Upload measures from the specified location.'
-          task :push_bcl do
-            puts 'Push measures to BCL'
+          namespace 'bcl' do
+            desc 'Test BCL login'
+            task :test_login do
+              puts 'test BCL login'
+              bcl = ::BCL::ComponentMethods.new
+              bcl.login
+            end
+
+            # for custom search, populate env var: bcl_search_keyword
+            desc 'Search BCL'
+            task :search_measures do
+              puts 'test search BCL'
+              bcl = ::BCL::ComponentMethods.new
+              bcl.login
+
+              # check for env var specifying keyword first
+              if ENV['bcl_search_keyword']
+                keyword = ENV['bcl_search_keyword']
+              else
+                keyword = 'Space'
+              end
+              num_results = 10
+              # bcl.search params: search_string, filter_string, return_all_results?
+              puts "searching BCL measures for keyword: #{keyword}"
+              results = bcl.search(keyword, "fq[]=bundle:nrel_measure&show_rows=#{num_results}", false)
+              puts "there are #{results[:result].count} results"
+              results[:result].each do |res|
+                puts(res[:measure][:name]).to_s
+              end
+            end
+
+            # to call with argument: "openstudio:bcl:stage[true]" (true = remove existing staged content)
+            desc 'Copy the measures/components to a location that can be uploaded to BCL'
+            task :stage, [:reset] do |t, args|
+              puts 'Staging measures for BCL'
+              # initialize BCL and login
+              bcl = ::BCL::ComponentMethods.new
+              bcl.login
+
+              # process reset options: true to clear out old staged content
+              options = { reset: false }
+              if args[:reset].to_s == 'true'
+                options[:reset] = true
+              end
+
+              # ensure staged dir exists
+              FileUtils.mkdir_p(@staged_path)
+
+              # delete existing tarballs if reset is true
+              if options[:reset]
+                puts 'Deleting existing staged content'
+                FileUtils.rm_rf(Dir.glob("#{@staged_path}/*"))
+              end
+
+              # create new and existing directories
+              FileUtils.mkdir_p(@staged_path.to_s + '/update')
+              FileUtils.mkdir_p(@staged_path.to_s + '/push/component')
+              FileUtils.mkdir_p(@staged_path.to_s + '/push/measure')
+
+              # keep track of noop, update, push
+              noops = 0
+              new_ones = 0
+              updates = 0
+
+              # get all content directories to process
+              dirs = Dir.glob("#{@measures_dir}/*")
+
+              dirs.each do |dir|
+                next if dir.include?('Rakefile') || File.basename(dir) == 'staged'
+                current_d = Dir.pwd
+                content_name = File.basename(dir)
+                puts '', '---'
+                puts "Generating #{content_name}"
+
+                Dir.chdir(dir)
+
+                # figure out whether to upload new or update existing
+                files = Pathname.glob('**/*')
+                uuid = nil
+                vid = nil
+                content_type = 'measure'
+
+                paths = []
+                files.each do |file|
+                  # don't tar tests/outputs directory
+                  next if file.to_s.start_with?('tests/output') # From measure testing process
+                  next if file.to_s.start_with?('tests/test') # From openstudio-measure-tester-gem
+                  next if file.to_s.start_with?('tests/coverage') # From openstudio-measure-tester-gem
+                  next if file.to_s.start_with?('test_results') # From openstudio-measure-tester-gem
+                  paths << file.to_s
+                  if file.to_s =~ /^.{0,2}component.xml$/ || file.to_s =~ /^.{0,2}measure.xml$/
+                    if file.to_s.match?(/^.{0,2}component.xml$/)
+                      content_type = 'component'
+                    end
+                    # extract uuid  and vid
+                    uuid, vid = bcl.uuid_vid_from_xml(file)
+                  end
+                end
+                puts "UUID: #{uuid}, VID: #{vid}"
+
+                # note: if uuid is missing, will assume new content
+                action = bcl.search_by_uuid(uuid, vid)
+                puts "#{content_name} ACTION TO TAKE: #{action}"
+                # new content functionality needs to know if measure or component.  update is agnostic.
+                if action == 'noop' # ignore up-to-date content
+                  puts "  - WARNING: local #{content_name} uuid and vid match BCL... no update will be performed"
+                  noops += 1
+                  next
+                elsif action == 'update'
+                  # puts "#{content_name} labeled as update for BCL"
+                  destination = @staged_path + '/' + action + '/' + "#{content_name}.tar.gz"
+                  updates += 1
+                elsif action == 'push'
+                  # puts "#{content_name} labeled as new content for BCL"
+                  destination = @staged_path + '/' + action + '/' + content_type + "/#{content_name}.tar.gz"
+                  new_ones += 1
+                end
+
+                puts "destination: #{destination}"
+
+                # copy over only if 'reset_receipts' is set to TRUE. otherwise ignore if file exists already
+                if File.exist?(destination)
+                  if options[:reset]
+                    FileUtils.rm(destination)
+                    ::BCL.tarball(destination, paths)
+                  else
+                    puts "*** WARNING: File #{content_name}.tar.gz already exists in staged directory... keeping existing file. To overwrite, set reset_receipts arg to true ***"
+                  end
+                else
+                  ::BCL.tarball(destination, paths)
+                end
+                Dir.chdir(current_d)
+              end
+              puts '', "****STAGING DONE**** #{new_ones} new content, #{updates} updates, #{noops} skipped (already up-to-date on BCL)", ''
+            end
+
+            desc 'Upload measures from the specified location.'
+            task :push do
+              puts 'Push measures to BCL'
+
+              # initialize BCL and login
+              bcl = ::BCL::ComponentMethods.new
+              bcl.login
+              reset = false
+
+              total_count = 0
+              successes = 0
+              errors = 0
+              skipped = 0
+
+              # grab all the new measure and component tar files and push to bcl
+              ['measure', 'component'].each do |content_type|
+                items = []
+                paths = Pathname.glob(@staged_path.to_s + "/push/#{content_type}/*.tar.gz")
+                paths.each do |path|
+                  # puts path
+                  items << path.to_s
+                end
+
+                items.each do |item|
+                  puts item.split('/').last
+                  total_count += 1
+
+                  receipt_file = File.dirname(item) + '/' + File.basename(item, '.tar.gz') + '.receipt'
+                  if !reset && File.exist?(receipt_file)
+                    skipped += 1
+                    puts 'SKIP: receipt file found'
+                    next
+                  end
+
+                  valid, res = bcl.push_content(item, true, "nrel_#{content_type}")
+                  if valid
+                    successes += 1
+                  else
+                    errors += 1
+                    if res.key?(:error)
+                      puts "  ERROR MESSAGE: #{res[:error]}"
+                    else
+                      puts "ERROR: #{res.inspect.chomp}"
+                    end
+                  end
+                  puts '', '---'
+                end
+              end
+
+              # grab all the updated content (measures and components) tar files and push to bcl
+              items = []
+              paths = Pathname.glob(@staged_path.to_s + '/update/*.tar.gz')
+              paths.each do |path|
+                # puts path
+                items << path.to_s
+              end
+              items.each do |item|
+                puts item.split('/').last
+                total_count += 1
+
+                receipt_file = File.dirname(item) + '/' + File.basename(item, '.tar.gz') + '.receipt'
+                if !reset && File.exist?(receipt_file)
+                  skipped += 1
+                  puts 'SKIP: receipt file found'
+                  next
+                end
+
+                valid, res = bcl.update_content(item, true)
+                if valid
+                  successes += 1
+                else
+                  errors += 1
+                  if res.key?(:error)
+                    puts "  ERROR MESSAGE: #{res[:error]}"
+                  else
+                    puts "ERROR MESSAGE: #{res.inspect.chomp}"
+                  end
+                end
+                puts '', '---'
+              end
+
+              puts "****UPLOAD DONE**** #{total_count} total, #{successes} success, #{errors} failures, #{skipped} skipped"
+            end
           end
         end
       end

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