openstudio-aws 0.7.0.alpha0 → 0.7.0

data/lib/openstudio/lib/openstudio_aws_instance.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2016, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2019, 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:
@@ -156,12 +156,12 @@ class OpenStudioAwsInstance
       t = tag.split('=')
       if t.size != 2
         logger.error "Tag '#{t}' not defined or does not have an equal sign"
-        fail "Tag '#{t}' not defined or does not have an equal sign"
+        raise "Tag '#{t}' not defined or does not have an equal sign"
         next
       end
-      if %w(Name GroupUUID NumberOfProcessors Purpose UserID).include? t[0]
+      if ['Name', 'GroupUUID', 'NumberOfProcessors', 'Purpose', 'UserID'].include? t[0]
         logger.error "Tag name '#{t[0]}' is a reserved tag"
-        fail "Tag name '#{t[0]}' is a reserved tag"
+        raise "Tag name '#{t[0]}' is a reserved tag"
         next
       end
 
@@ -238,7 +238,7 @@ class OpenStudioAwsInstance
         }
       }
     else
-      fail 'do not know how to convert :worker instance to_os_hash. Use the os_aws.to_worker_hash method'
+      raise 'do not know how to convert :worker instance to_os_hash. Use the os_aws.to_worker_hash method'
     end
 
     logger.info("server info #{h}")
@@ -258,6 +258,10 @@ class OpenStudioAwsInstance
     @data.procs
   end
 
+  # Return the total number of processors that available to run simulations. Note that this method reduces
+  # the number of processors on the server node by a prespecified number.
+  # @param instance [string], AWS instance type string
+  # @return [int], total number of available processors
   def find_processors(instance)
     lookup = {
       'm3.medium' => 1,
@@ -296,11 +300,13 @@ class OpenStudioAwsInstance
     end
 
     if @openstudio_instance_type == :server
-      # take out 4 of the processors for doing work with a max of 1 to work
-      # 1 for server
+      # take out 5 of the processors for known processors.
+      # 1 for server/web
+      # 1 for queue (redis)
       # 1 for mongodb
-      # 1 for child processes to download files
-      processors = [processors - 4, 1].max # this is 2 for now because the current server decrements by 1 (which will be removed if 2.0-pre6)
+      # 1 for web-background
+      # 1 for rserve
+      processors = [processors - 5, 1].max
     end
 
     processors
@@ -321,19 +327,26 @@ class OpenStudioAwsInstance
 
   def upload_file(local_path, remote_path)
     retries = 0
+    ssh_options = {
+      proxy: get_proxy,
+      key_data: [@private_key]
+    }
+    ssh_options.delete_if { |_k, v| v.nil? }
     begin
-      Net::SCP.start(@data.ip, @user, proxy: get_proxy, key_data: [@private_key]) do |scp|
+      Net::SCP.start(@data.ip, @user, ssh_options) do |scp|
         scp.upload! local_path, remote_path
       end
     rescue SystemCallError, Timeout::Error => e
       # port 22 might not be available immediately after the instance finishes launching
       return if retries == 5
+
       retries += 1
       sleep 2
       retry
-    rescue
+    rescue StandardError
       # Unknown upload error, retry
       return if retries == 5
+
       retries += 1
       sleep 2
       retry
@@ -345,22 +358,30 @@ class OpenStudioAwsInstance
   def shell_command(command, load_env = true)
     logger.info("ssh_command #{command} with load environment #{load_env}")
     command = "source /etc/profile; source ~/.bash_profile; #{command}" if load_env
-    Net::SSH.start(@data.ip, @user, proxy: get_proxy, key_data: [@private_key]) do |ssh|
+    ssh_options = {
+      proxy: get_proxy,
+      key_data: [@private_key]
+    }
+    ssh_options.delete_if { |_k, v| v.nil? }
+    Net::SSH.start(@data.ip, @user, ssh_options) do |ssh|
       channel = ssh.open_channel do |ch|
-        ch.exec "#{command}" do |ch, success|
-          fail "could not execute #{command}" unless success
+        ch.exec command.to_s do |ch, success|
+          raise "could not execute #{command}" unless success
+
           # "on_data" is called when the process wr_ites something to stdout
           ch.on_data do |_c, data|
             # $stdout.print data
-            logger.info("#{data.inspect}")
+            logger.info(data.inspect.to_s)
           end
           # "on_extended_data" is called when the process writes something to s_tde_rr
           ch.on_extended_data do |_c, _type, data|
             # $stderr.print data
-            logger.info("#{data.inspect}")
+            logger.info(data.inspect.to_s)
           end
         end
       end
+      ssh.loop
+      channel.wait
     end
   rescue Net::SSH::HostKeyMismatch => e
     e.remember_host!
@@ -378,13 +399,19 @@ class OpenStudioAwsInstance
     flag = 0
     while flag == 0
       logger.info("wait_command #{command}")
-      Net::SSH.start(@data.ip, @user, proxy: get_proxy, key_data: [@private_key]) do |ssh|
+      ssh_options = {
+        proxy: get_proxy,
+        key_data: [@private_key]
+      }
+      ssh_options.delete_if { |_k, v| v.nil? }
+      Net::SSH.start(@data.ip, @user, ssh_options) do |ssh|
         channel = ssh.open_channel do |ch|
-          ch.exec "#{command}" do |ch, success|
-            fail "could not execute #{command}" unless success
+          ch.exec command.to_s do |ch, success|
+            raise "could not execute #{command}" unless success
+
             # "on_data" is called_ when the process writes something to stdout
             ch.on_data do |_c, data|
-              logger.info("#{data.inspect}")
+              logger.info(data.inspect.to_s)
               if data.chomp == 'true'
                 logger.info("wait_command #{command} is true")
                 flag = 1
@@ -394,7 +421,7 @@ class OpenStudioAwsInstance
             end
             # "on_extended_data" is called when the process writes some_thi_ng to stderr
             ch.on_extended_data do |_c, _type, data|
-              logger.info("#{data.inspect}")
+              logger.info(data.inspect.to_s)
               if data == 'true'
                 logger.info("wait_command #{command} is true")
                 flag = 1
@@ -404,6 +431,8 @@ class OpenStudioAwsInstance
             end
           end
         end
+        channel.wait
+        ssh.loop
       end
     end
   rescue Net::SSH::HostKeyMismatch => e
@@ -420,18 +449,25 @@ class OpenStudioAwsInstance
 
   def download_file(remote_path, local_path)
     retries = 0
+    ssh_options = {
+      proxy: get_proxy,
+      key_data: [@private_key]
+    }
+    ssh_options.delete_if { |_k, v| v.nil? }
     begin
-      Net::SCP.start(@data.ip, @user, proxy: get_proxy, key_data: [@private_key]) do |scp|
+      Net::SCP.start(@data.ip, @user, ssh_options) do |scp|
         scp.download! remote_path, local_path
       end
     rescue SystemCallError, Timeout::Error => e
       # port 22 might not be available immediately after the instance finishes launching
       return if retries == 5
+
       retries += 1
       sleep 2
       retry
-    rescue
+    rescue StandardError
       return if retries == 5
+
       retries += 1
       sleep 2
       retry

data/lib/openstudio/lib/openstudio_aws_logger.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2016, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2019, 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:
@@ -35,7 +35,7 @@
 
 require 'logger'
 
-# module for logging
+# module for logging. The AWS log will be stored in the user's home directory under .aws.log.
 module Logging
   def logger
     @logger ||= Logging.logger_for(self.class.name)

data/lib/openstudio/lib/openstudio_aws_wrapper.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2016, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2019, 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:
@@ -48,10 +48,10 @@ class OpenStudioAwsWrapper
   attr_accessor :private_key_file_name
   attr_accessor :security_groups
 
-  VALID_OPTIONS = [:proxy, :credentials]
+  VALID_OPTIONS = [:proxy, :credentials].freeze
 
   def initialize(options = {}, group_uuid = nil)
-    @group_uuid = group_uuid || (SecureRandom.uuid).delete('-')
+    @group_uuid = group_uuid || SecureRandom.uuid.delete('-')
 
     @security_groups = []
     @key_pair_name = nil
@@ -75,20 +75,36 @@ class OpenStudioAwsWrapper
     @workers = []
 
     # store an instance variable with the proxy for passing to instances for use in scp/ssh
-    @proxy = options[:proxy] ? options[:proxy] : nil
+    @proxy = options[:proxy] || nil
 
     # need to remove the prxoy information here
     @aws = Aws::EC2::Client.new(options[:credentials])
   end
 
+  # Calculate the number of processors for the server and workers. This is used to scale the docker stack
+  # appropriately.
+  # @param total_procs [int] Total number of processors that are available
+  def calculate_processors(total_procs)
+    max_requests = ((total_procs + 10) * 1.2).round
+    mongo_cores = (total_procs / 64.0).ceil
+    web_cores = (total_procs / 32.0).ceil
+    max_pool = 16 * web_cores
+    rez_mem = 512 * max_pool
+    # what is this +2 doing here
+    total_procs = total_procs - mongo_cores - web_cores + 2
+
+    [total_procs, max_requests, mongo_cores, web_cores, max_pool, rez_mem]
+  end
+
   def create_or_retrieve_default_security_group(tmp_name = 'openstudio-server-sg-v2.2', vpc_id = nil)
     group = @aws.describe_security_groups(filters: [{ name: 'group-name', values: [tmp_name] }])
     logger.info "Length of the security group is: #{group.data.security_groups.length}"
-    if group.data.security_groups.length == 0
+    if group.data.security_groups.empty?
       logger.info 'security group not found --- will create a new one'
       if vpc_id
-        r = @aws.create_security_group(group_name: tmp_name, description: "group dynamically created by #{__FILE__}",
-                                   vpc_id: vpc_id)
+        r = @aws.create_security_group(
+          group_name: tmp_name, description: "group dynamically created by #{__FILE__}", vpc_id: vpc_id
+        )
       else
         r = @aws.create_security_group(group_name: tmp_name, description: "group dynamically created by #{__FILE__}")
       end
@@ -134,7 +150,7 @@ class OpenStudioAwsWrapper
   def total_instances_count
     resp = @aws.describe_instance_status
 
-    availability_zone = resp.instance_statuses.length > 0 ? resp.instance_statuses.first.availability_zone : 'no_instances'
+    availability_zone = !resp.instance_statuses.empty? ? resp.instance_statuses.first.availability_zone : 'no_instances'
 
     { total_instances: resp.instance_statuses.length, region: @region, availability_zone: availability_zone }
   end
@@ -289,12 +305,12 @@ class OpenStudioAwsWrapper
     resp = nil
     begin
       resp = @aws.describe_key_pairs(key_names: [tmp_name]).data
-      fail 'looks like there are 2 key pairs with the same name' if resp.key_pairs.size >= 2
-    rescue
+      raise 'looks like there are 2 key pairs with the same name' if resp.key_pairs.size >= 2
+    rescue StandardError
       logger.info "could not find key pair '#{tmp_name}'"
     end
 
-    if resp.nil? || resp.key_pairs.size == 0
+    if resp.nil? || resp.key_pairs.empty?
       # create the new key_pair
       # check if the key pair name exists
       # create a new key pair everytime
@@ -320,7 +336,7 @@ class OpenStudioAwsWrapper
     begin
       logger.info "Trying to delete key pair #{tmp_name}"
       resp = @aws.delete_key_pair(key_name: tmp_name)
-    rescue
+    rescue StandardError
       logger.info "could not delete the key pair '#{tmp_name}'"
     end
 
@@ -335,7 +351,7 @@ class OpenStudioAwsWrapper
         logger.info "Found key of same name in user's home ssh folder #{filename}"
         # using the key in your home directory
       else
-        fail "Could not find private key #{filename}" unless File.exist? filename
+        raise "Could not find private key #{filename}" unless File.exist? filename
       end
     end
 
@@ -360,9 +376,9 @@ class OpenStudioAwsWrapper
       logger.info "Saving server private key in #{@private_key_file_name}"
       File.open(@private_key_file_name, 'w') { |f| f << @private_key }
       logger.info 'Setting permissions of server private key to 0600'
-      File.chmod(0600, @private_key_file_name)
+      File.chmod(0o600, @private_key_file_name)
     else
-      fail "No private key found in which to persist with filename #{filename}"
+      raise "No private key found in which to persist with filename #{filename}"
     end
   end
 
@@ -372,7 +388,7 @@ class OpenStudioAwsWrapper
     logger.info "Saving worker private key in #{@worker_keys_filename}"
     File.open(@worker_keys_filename, 'w') { |f| f << @worker_keys.private_key }
     logger.info 'Setting permissions of worker private key to 0600'
-    File.chmod(0600, @worker_keys_filename)
+    File.chmod(0o600, @worker_keys_filename)
 
     wk = "#{directory}/ec2_worker_key.pub"
     logger.info "Saving worker public key in #{wk}"
@@ -390,7 +406,7 @@ class OpenStudioAwsWrapper
 
     # replace the server_script.sh.template with the keys to add
 
-    user_data = File.read(File.join(File.expand_path(File.dirname(__FILE__)), launch_options[:user_data_file]))
+    user_data = File.read(File.join(__dir__, launch_options[:user_data_file]))
     user_data.gsub!(/SERVER_HOSTNAME/, 'openstudio.server')
     user_data.gsub!(/WORKER_PRIVATE_KEY_TEMPLATE/, worker_keys.private_key.gsub("\n", '\\n'))
     user_data.gsub!(/WORKER_PUBLIC_KEY_TEMPLATE/, worker_keys.ssh_public_key)
@@ -400,8 +416,9 @@ class OpenStudioAwsWrapper
 
     # TODO: create the EBS volumes instead of the ephemeral storage - needed especially for the m3 instances (SSD)
 
-    fail 'image_id is nil' unless image_id
-    fail 'instance type is nil' unless instance_type
+    raise 'image_id is nil' unless image_id
+    raise 'instance type is nil' unless instance_type
+
     @server.launch_instance(image_id, instance_type, user_data, launch_options[:user_id], launch_options)
   end
 
@@ -415,7 +432,7 @@ class OpenStudioAwsWrapper
     }
     launch_options = defaults.merge(launch_options)
 
-    user_data = File.read(File.join(File.expand_path(File.dirname(__FILE__)), launch_options[:user_data_file]))
+    user_data = File.read(File.join(__dir__, launch_options[:user_data_file]))
     user_data.gsub!(/SERVER_IP/, @server.data.private_ip_address)
     user_data.gsub!(/SERVER_HOSTNAME/, 'openstudio.server')
     user_data.gsub!(/WORKER_PUBLIC_KEY_TEMPLATE/, worker_keys.ssh_public_key)
@@ -460,7 +477,7 @@ class OpenStudioAwsWrapper
     logger.info("ips #{ips}")
     @server.shell_command('chmod 664 /home/ubuntu/ip_addresses')
 
-    mongoid = File.read(File.expand_path(File.dirname(__FILE__)) + '/mongoid.yml.template')
+    mongoid = File.read(__dir__ + '/mongoid.yml.template')
     mongoid.gsub!(/SERVER_IP/, @server.data.private_ip_address)
     file = Tempfile.new('mongoid.yml')
     file.write(mongoid)
@@ -494,14 +511,20 @@ class OpenStudioAwsWrapper
     worker_join_cmd = "#{File.read(swarm_file).strip} && echo \"true\""
     @workers.each { |worker| worker.wait_command(worker_join_cmd) }
     logger.info('All worker nodes have been added to the swarm. Setting environment variables and starting the cluster')
+    # e.g. 356 CPUs
+    # mongo cores = 6
+    # web cores = 12
+    # total procs = 340 (but should be 336)
     total_procs = @server.procs
     @workers.each { |worker| total_procs += worker.procs }
-    max_requests = ((total_procs + 10) * 1.2).round
-    mongo_cores = (total_procs / 64.0).ceil
-    web_cores = (total_procs / 32.0).ceil
-    max_pool = 16 * web_cores
-    rez_mem = 512 * max_pool
-    total_procs = total_procs - mongo_cores - web_cores + 2
+    total_procs, max_requests, mongo_cores, web_cores, max_pool, rez_mem = calculate_processors(total_procs)
+    logger.info('Processors allocations are:')
+    logger.info("   total_procs: #{total_procs}")
+    logger.info("   max_requests: #{max_requests}")
+    logger.info("   mongo_cores: #{mongo_cores}")
+    logger.info("   web_cores: #{web_cores}")
+    logger.info("   max_pool: #{max_pool}")
+    logger.info("   rez_mem: #{rez_mem}")
     @server.shell_command("sed -i -e 's/AWS_MAX_REQUESTS/#{max_requests}/g' /home/ubuntu/docker-compose.yml && echo \"true\"")
     @server.shell_command("sed -i -e 's/AWS_MONGO_CORES/#{mongo_cores}/g' /home/ubuntu/docker-compose.yml && echo \"true\"")
     @server.shell_command("sed -i -e 's/AWS_WEB_CORES/#{web_cores}/g' /home/ubuntu/docker-compose.yml && echo \"true\"")
@@ -509,7 +532,7 @@ class OpenStudioAwsWrapper
     @server.shell_command("sed -i -e 's/AWS_REZ_MEM/#{rez_mem}/g' /home/ubuntu/docker-compose.yml && echo \"true\"")
     @server.shell_command("sed -i -e 's/AWS_OS_SERVER_NUMBER_OF_WORKERS/#{total_procs}/g' /home/ubuntu/docker-compose.yml && echo \"true\"")
     @server.shell_command("echo '' >> /home/ubuntu/.env && echo \"true\"")
-    @server.shell_command("docker stack deploy --compose-file docker-compose.yml osserver && echo \"true\"")
+    @server.shell_command('docker stack deploy --compose-file docker-compose.yml osserver && echo "true"')
     sleep 10
     logger.info('The OpenStudio Server stack has been started. Waiting for the server to become available.')
     @server.wait_command("while ( nc -zv #{@server.ip} 80 3>&1 1>&2- 2>&3- ) | awk -F \":\" '$3 != \" Connection refused\" {exit 1}'; do sleep 5; done && echo \"true\"")
@@ -533,13 +556,14 @@ class OpenStudioAwsWrapper
     load_private_key(server_data_hash[:server][:private_key_file_name])
 
     logger.info "Finding the server for GroupUUID of #{group_uuid}"
-    fail 'no GroupUUID defined either in member variable or method argument' if @group_uuid.nil?
+    raise 'no GroupUUID defined either in member variable or method argument' if @group_uuid.nil?
 
     # This should really just be a single call to describe running instances
     @server = nil
     resp = describe_running_instances(group_uuid, :server)
     if resp
-      fail "more than one server running with group uuid of #{group_uuid} found, expecting only one" if resp.size > 1
+      raise "more than one server running with group uuid of #{group_uuid} found, expecting only one" if resp.size > 1
+
       resp = resp.first
       if !@server
         if resp
@@ -552,7 +576,7 @@ class OpenStudioAwsWrapper
 
           # set the key name from AWS if it isn't yet assigned
           logger.info 'Setting the keyname in the aws wrapper'
-          @key_pair_name = resp[:key_name] unless @key_pair_name
+          @key_pair_name ||= resp[:key_name]
 
           @server = OpenStudioAwsInstance.new(@aws, :server, @key_pair_name, sg, @group_uuid, @private_key, @private_key_file_name, @proxy)
 
@@ -566,7 +590,7 @@ class OpenStudioAwsWrapper
     end
 
     # Find the worker instances.
-    if @workers.size == 0
+    if @workers.empty?
       resp = describe_running_instances(group_uuid, :worker)
       if resp
         resp.each do |r|
@@ -742,7 +766,7 @@ class OpenStudioAwsWrapper
           elsif ami[:virtualization_type] == 'hvm'
             a[:amis][:cc2worker] = ami[:image_id]
           else
-            fail "unknown virtualization_type in #{ami[:name]}"
+            raise "unknown virtualization_type in #{ami[:name]}"
           end
         elsif ami[:name] =~ /Server/
           a[:amis][:server] = ami[:image_id]

data/lib/openstudio/lib/openstudio_cloud_watch.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2016, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2019, 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:
@@ -41,11 +41,11 @@ class OpenStudioCloudWatch
   attr_accessor :private_key_file_name
   attr_accessor :security_groups
 
-  VALID_OPTIONS = [:proxy, :credentials]
+  VALID_OPTIONS = [:proxy, :credentials].freeze
 
   def initialize(options = {})
     # store an instance variable with the proxy for passing to instances for use in scp/ssh
-    @proxy = options[:proxy] ? options[:proxy] : nil
+    @proxy = options[:proxy] || nil
 
     # need to remove the prxoy information here
     @aws = Aws::CloudWatch::Client.new(options[:credentials])
@@ -57,7 +57,8 @@ class OpenStudioCloudWatch
     resp = @aws.get_metric_statistics(
       dimensions: [
         { name: 'ServiceName', value: 'AmazonEC2' },
-        { name: 'Currency', value: 'USD' }],
+        { name: 'Currency', value: 'USD' }
+      ],
       metric_name: 'EstimatedCharges',
       namespace: 'AWS/Billing',
       start_time: start_time.iso8601,

data/lib/openstudio-aws.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2016, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2019, 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:

data/openstudio-aws.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib/', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 
 require 'openstudio/aws/version'
@@ -17,13 +17,13 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
   s.required_rubygems_version = '>= 1.3.6'
 
-  s.add_dependency 'net-scp', '~> 1.1'
+  s.add_dependency 'aws-sdk-core', '= 2.2.37'
+  s.add_dependency 'net-scp', '= 2.0.0'
   s.add_dependency 'net-ssh', '= 4.2.0'
-  s.add_dependency 'aws-sdk-core', '= 2.2.26'
   s.add_dependency 'semantic', '~> 1.4'
-  s.add_dependency 'sshkey', '~> 1.7'
+  s.add_dependency 'sshkey', '~> 2.0'
 
-  s.add_development_dependency 'rake', '~> 10.4'
+  s.add_development_dependency 'rake', '~> 12.3'
 
   s.files         = `git ls-files -z`.split("\x0")
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/aws_instances/aws_spec_api.rb

@@ -1,7 +1,42 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, 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 'spec_helper'
 
-SERVER_AMI = 'ami-e0b38888'
-WORKER_AMI = 'ami-a8bc87c0'
+SERVER_AMI = 'ami-e0b38888'.freeze
+WORKER_AMI = 'ami-a8bc87c0'.freeze
 
 describe OpenStudio::Aws::Aws do
   context 'create a new instance' do
@@ -383,7 +418,7 @@ describe OpenStudio::Aws::Aws do
 
         shell = @aws.server.shell_command('df -h | grep /dev/xvdb.*/mnt')
         expect(shell).not_to be_nil
-        expect(shell).to eq /\/dev\/xvdb.*\/mnt/
+        expect(shell).to eq %r{/dev/xvdb.*/mnt}
       ensure
         @aws.terminate_instances_by_group_id(h[:group_id])
       end

data/spec/openstudio-aws/ami_list_spec.rb

@@ -1,3 +1,38 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, 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 'spec_helper'
 
 describe OpenStudioAmis do
@@ -29,11 +64,20 @@ describe OpenStudioAmis do
   end
 
   context 'version 2' do
-
     it 'should fail when trying to find a stable version for older releases' do
       a = OpenStudioAmis.new(2, openstudio_version: '1.5.0', stable: true)
 
       expect { a.get_amis }.to raise_error(/Could not find a stable version for openstudio version 1.5.0/)
     end
   end
+
+  context 'version 3' do
+    it 'should fail when trying to find a stable version for older releases' do
+      a = OpenStudioAmis.new(3, openstudio_version: '2.8.0', stable: true)
+
+      puts a.inspect
+
+      expect { a.get_amis }.to raise_error(/Currently the openstudio_version lookup is not supported in v3/)
+    end
+  end
 end