openstudio-aws 0.1.22 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3df47902801ee1a4dd02804a004a89a2cf5ffd17
-  data.tar.gz: 843eb24cd84488b3c37a79e80b412fae5fea2446
+  metadata.gz: e5c42970e6b71829c0fe5f79e9ae4935a31b535f
+  data.tar.gz: 80093ee71f6360dd8c6fe3592b5e26d77c0f4116
 SHA512:
-  metadata.gz: 158e202c176ba09d3bb394c08503bdecd2b6afaed767c7932889c046f1fe6bb62111eb4c55b8a66cf199caff844c1cf838134bc817fd00341aa705fd0489b91a
-  data.tar.gz: 99b9feebfd8a48bf3858e375aa0ab6c8ea2950a4c14e2fd6cb1c83b502b70e2231ad80aa37cfc487a8acdd4bcba166527c864b4cafe312f19054117d0cb95e8c
+  metadata.gz: 8c9e0eb68f9f89280dddd808af1c7f454e89cb1865b70c60f5843d7ec42c99fbe50bfceb9f0f64d533d7313cd8c2637daa22d8e7974dd4fe48ebc7a33ca1deed
+  data.tar.gz: 5a44b30ed06bf6970834230e2b70f32c20158935f448f5aefec46818212cbd6be3a62a17cf0cb6a129881588e1f5685ba648c56217ea78c4b522003fefd7e3b9

data/lib/openstudio-aws.rb

@@ -10,8 +10,8 @@ require 'semantic/core_ext'
 begin
   require 'aws-sdk-core'
 rescue LoadError
-  puts "Failed to load AWS-SDK-CORE gem"
-  puts "  try running: gem install aws-sdk-core"
+  puts 'Failed to load AWS-SDK-CORE gem'
+  puts '  try running: gem install aws-sdk-core'
   exit
 end
 
@@ -21,4 +21,3 @@ require 'openstudio/aws/version'
 require 'openstudio/lib/openstudio_aws_instance'
 require 'openstudio/lib/openstudio_aws_wrapper'
 require 'openstudio/lib/ami_list'
-

data/lib/openstudio/aws/aws.rb

@@ -2,8 +2,8 @@
 module OpenStudio
   module Aws
     VALID_OPTIONS = [
-        :proxy, :credentials, :ami_lookup_version, :openstudio_version, 
-        :openstudio_server_version, :region, :ssl_verify_peer, :host, :url
+      :proxy, :credentials, :ami_lookup_version, :openstudio_version,
+      :openstudio_server_version, :region, :ssl_verify_peer, :host, :url
     ]
 
     class Aws
@@ -17,31 +17,30 @@ module OpenStudio
       def initialize(options = {})
         invalid_options = options.keys - VALID_OPTIONS
         if invalid_options.any?
-          raise ArgumentError, "invalid option(s): #{invalid_options.join(', ')}"
+          fail ArgumentError, "invalid option(s): #{invalid_options.join(', ')}"
         end
 
         # merge in some defaults
         defaults = {
-            :ami_lookup_version => 1,
-            :region => 'us-east-1',
-            :ssl_verify_peer => false,
-            :host => 'developer.nrel.gov',
-            :url => '/downloads/buildings/openstudio/rsrc'
+          ami_lookup_version: 1,
+          region: 'us-east-1',
+          ssl_verify_peer: false,
+          host: 'developer.nrel.gov',
+          url: '/downloads/buildings/openstudio/api'
         }
         options = defaults.merge(options)
 
-
         # read in the config.yml file to get the secret/private key
         if !options[:credentials]
-          config_file = OpenStudio::Aws::Config.new()
+          config_file = OpenStudio::Aws::Config.new
 
           # populate the credentials
           options[:credentials] =
               {
-                  :access_key_id => config_file.access_key,
-                  :secret_access_key => config_file.secret_key,
-                  :region => options[:region],
-                  :ssl_verify_peer => options[:ssl_verify_peer]
+                access_key_id: config_file.access_key,
+                secret_access_key: config_file.secret_key,
+                region: options[:region],
+                ssl_verify_peer: options[:ssl_verify_peer]
               }
         else
           options[:credentials][:region] = options[:region]
@@ -58,12 +57,12 @@ module OpenStudio
           # todo: remove this proxy_uri and make a method to format correctly
           options[:proxy_uri] = proxy_uri
 
-          #todo: do we need to escape a couple of the argument of username and password
+          # todo: do we need to escape a couple of the argument of username and password
 
-          #todo: set some environment variables for system based proxy
+          # todo: set some environment variables for system based proxy
         end
 
-        #puts "Final options are: #{options.inspect}"
+        # puts "Final options are: #{options.inspect}"
 
         @os_aws = OpenStudioAwsWrapper.new(options)
         @local_key_file_name = nil
@@ -75,35 +74,35 @@ module OpenStudio
         ami_options[:openstudio_version] = options[:openstudio_version] if options[:openstudio_version]
         ami_options[:host] = options[:host] if options[:host]
         ami_options[:url] = options[:url] if options[:url]
-        
+
         @default_amis = OpenStudioAmis.new(options[:ami_lookup_version], ami_options).get_amis
       end
 
       # command line call to create a new instance.  This should be more tightly integrated with teh os-aws.rb gem
-      def create_server(instance_data = {}, server_json_filename = "server_data.json", user_id="unknown_user")
-        defaults = {instance_type: "m2.xlarge", image_id: @default_amis[:server]}
+      def create_server(instance_data = {}, server_json_filename = 'server_data.json', user_id = 'unknown_user')
+        defaults = { instance_type: 'm2.xlarge', image_id: @default_amis[:server] }
         instance_data = defaults.merge(instance_data)
 
-        @os_aws.create_or_retrieve_security_group("openstudio-worker-sg-v1")
+        @os_aws.create_or_retrieve_security_group('openstudio-worker-sg-v1')
         @os_aws.create_or_retrieve_key_pair
 
-        @local_key_file_name = "ec2_server_key.pem"
+        @local_key_file_name = 'ec2_server_key.pem'
         @os_aws.save_private_key(@local_key_file_name)
-        @os_aws.launch_server(instance_data[:image_id], instance_data[:instance_type], {:user_id => user_id})
+        @os_aws.launch_server(instance_data[:image_id], instance_data[:instance_type], user_id: user_id)
 
         puts @os_aws.server.to_os_hash.to_json
 
-        File.open(server_json_filename, "w") { |f| f << JSON.pretty_generate(@os_aws.server.to_os_hash) }
+        File.open(server_json_filename, 'w') { |f| f << JSON.pretty_generate(@os_aws.server.to_os_hash) }
 
         # Print out some debugging commands (probably work on mac/linux only)
-        puts ""
-        puts "Server SSH Command:"
+        puts ''
+        puts 'Server SSH Command:'
 
         puts "ssh -i #{@local_key_file_name} ubuntu@#{@os_aws.server.data[:dns]}"
       end
 
-      def create_workers(number_of_instances, instance_data = {}, user_id="unknown_user")
-        defaults = {instance_type: "m2.4xlarge"}
+      def create_workers(number_of_instances, instance_data = {}, user_id = 'unknown_user')
+        defaults = { instance_type: 'm2.4xlarge' }
         instance_data = defaults.merge(instance_data)
 
         if instance_data[:image_id].nil?
@@ -114,35 +113,35 @@ module OpenStudio
           end
         end
 
-        raise "Can't create workers without a server instance running" if @os_aws.server.nil?
+        fail "Can't create workers without a server instance running" if @os_aws.server.nil?
 
-        @os_aws.launch_workers(instance_data[:image_id], instance_data[:instance_type], number_of_instances, {:user_id => user_id})
+        @os_aws.launch_workers(instance_data[:image_id], instance_data[:instance_type], number_of_instances, user_id: user_id)
 
         ## append the information to the server_data hash that already exists
-        #@server_data[:instance_type] = instance_data[:instance_type]
-        #@server_data[:num] = number_of_instances
-        #server_string = @server_data.to_json.gsub("\"", "\\\\\"")
+        # @server_data[:instance_type] = instance_data[:instance_type]
+        # @server_data[:num] = number_of_instances
+        # server_string = @server_data.to_json.gsub("\"", "\\\\\"")
         #
-        #start_string = "ruby #{os_aws_file_location} #{@config.access_key} #{@config.secret_key} us-east-1 EC2 launch_workers \"#{server_string}\""
-        #puts "Worker Command: #{start_string}"
-        #worker_data_string = `#{start_string}`
-        #@worker_data = JSON.parse(worker_data_string, :symbolize_names => true)
-        #File.open("worker_data.json", "w") { |f| f << JSON.pretty_generate(worker_data) }
+        # start_string = "ruby #{os_aws_file_location} #{@config.access_key} #{@config.secret_key} us-east-1 EC2 launch_workers \"#{server_string}\""
+        # puts "Worker Command: #{start_string}"
+        # worker_data_string = `#{start_string}`
+        # @worker_data = JSON.parse(worker_data_string, :symbolize_names => true)
+        # File.open("worker_data.json", "w") { |f| f << JSON.pretty_generate(worker_data) }
         #
         ## Print out some debugging commands (probably work on mac/linux only)
-        puts ""
-        puts "Worker SSH Command:"
+        puts ''
+        puts 'Worker SSH Command:'
         @os_aws.workers.each do |worker|
           puts "ssh -i #{@local_key_file_name} ubuntu@#{worker.data[:dns]}"
         end
 
-        puts ""
-        puts "Waiting for server/worker configurations"
+        puts ''
+        puts 'Waiting for server/worker configurations'
 
         @os_aws.configure_server_and_workers
       end
 
-      def kill_instances()
+      def kill_instances
         # Add this method to kill all the running instances
       end
 
@@ -150,12 +149,11 @@ module OpenStudio
 
       def os_aws_file_location
         # Get the location of the os-aws.rb file.  Use the relative path from where this file exists
-        os_aws_file = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "os-aws.rb"))
-        raise "os_aws_file does not exist where it is expected: #{os_aws_file}" unless File.exists?(os_aws_file)
+        os_aws_file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'os-aws.rb'))
+        fail "os_aws_file does not exist where it is expected: #{os_aws_file}" unless File.exist?(os_aws_file)
 
         os_aws_file
       end
-
     end
   end
 end

data/lib/openstudio/aws/config.rb

@@ -8,10 +8,10 @@ module OpenStudio
         @yml_config_file = yml_config_file
         @config = nil
         if @yml_config_file.nil?
-          @yml_config_file = File.join(File.expand_path("~"), "aws_config.yml")
-          if !File.exists?(@yml_config_file)
+          @yml_config_file = File.join(File.expand_path('~'), 'aws_config.yml')
+          unless File.exist?(@yml_config_file)
             write_config_file
-            raise "No Config File in user home directory. A template has been added, please edit and save: #{@yml_config_file}"
+            fail "No Config File in user home directory. A template has been added, please edit and save: #{@yml_config_file}"
             exit 1
           end
         end

data/lib/openstudio/aws/version.rb

@@ -1,5 +1,5 @@
 module OpenStudio
   module Aws
-    VERSION = "0.1.22"
+    VERSION = '0.1.23'
   end
 end

data/lib/openstudio/lib/ami_list.rb

@@ -1,18 +1,18 @@
 # NOTE: Do not modify this file as it is copied over. Modify the source file and rerun rake import_files
 ######################################################################
-#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.  
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
 #  All rights reserved.
-#  
+#
 #  This library is free software; you can redistribute it and/or
 #  modify it under the terms of the GNU Lesser General Public
 #  License as published by the Free Software Foundation; either
 #  version 2.1 of the License, or (at your option) any later version.
-#  
+#
 #  This library is distributed in the hope that it will be useful,
 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 #  Lesser General Public License for more details.
-#  
+#
 #  You should have received a copy of the GNU Lesser General Public
 #  License along with this library; if not, write to the Free Software
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
@@ -20,24 +20,23 @@
 
 # Class for managing the AMI ids based on the openstudio version and the openstudio-server version
 
-
 class OpenStudioAmis
   VALID_OPTIONS = [
-      :openstudio_version, :openstudio_server_version, :host, :url
+    :openstudio_version, :openstudio_server_version, :host, :url
   ]
-  
+
   def initialize(version = 1, options = {})
     invalid_options = options.keys - VALID_OPTIONS
     if invalid_options.any?
-      raise ArgumentError, "invalid option(s): #{invalid_options.join(', ')}"
+      fail ArgumentError, "invalid option(s): #{invalid_options.join(', ')}"
     end
 
     # merge in some defaults
     defaults = {
-        :openstudio_version => 'default', 
-        :openstudio_server_version => 'default',
-        :host => 'developer.nrel.gov',
-        :url => '/downloads/buildings/openstudio/rsrc'
+      openstudio_version: 'default',
+      openstudio_server_version: 'default',
+      host: 'developer.nrel.gov',
+      url: '/downloads/buildings/openstudio/api'
     }
     @version = version
     @options = defaults.merge(options)
@@ -49,7 +48,7 @@ class OpenStudioAmis
     if OpenStudioAmis.method_defined?(command)
       json = send(command)
     else
-      raise "Unknown api version command #{command}"
+      fail "Unknown api version command #{command}"
     end
 
     json
@@ -61,10 +60,10 @@ class OpenStudioAmis
     if OpenStudioAmis.method_defined?(command)
       amis = send(command)
     else
-      raise "Unknown api version command #{command}"
+      fail "Unknown api version command #{command}"
     end
 
-    raise "Could not find any amis for #{@version}" if amis.nil?
+    fail "Could not find any amis for #{@version}" if amis.nil?
 
     amis
   end
@@ -85,28 +84,27 @@ class OpenStudioAmis
     json
   end
 
-  def get_ami_version_1()
+  def get_ami_version_1
     json = list_amis_version_1
-    version = json.has_key?(@options[:openstudio_version].to_sym) ? @options[:openstudio_version].to_sym : 'default'
+    version = json.key?(@options[:openstudio_version].to_sym) ? @options[:openstudio_version].to_sym : 'default'
 
     json[version]
   end
 
-  def get_ami_version_2()
+  def get_ami_version_2
     json = list_amis_version_2
-    
+
     amis = nil
     if @options[:openstudio_server_version].to_sym == :default
       # just grab the most recent server
       # need to do a sort to get the most recent because we can't promise that they are in order
-      json[:openstudio].each do |k,v|
-        
-        
+      json[:openstudio].each do |k, v|
+
       end
       key, value = json[:openstudio_server].first
-      
+
       amis = value[:amis]
-      #puts json.inspect
+      # puts json.inspect
     else
       value = json[:openstudio_server][@options[:openstudio_server_version].to_sym]
       amis = value[:amis]
@@ -121,9 +119,9 @@ class OpenStudioAmis
     result = nil
     resp = Net::HTTP.get_response(@options[:host], endpoint)
     if resp.code == '200'
-      result = JSON.parse(resp.body, :symbolize_names => true)
+      result = JSON.parse(resp.body, symbolize_names: true)
     else
-      raise "#{resp.code} Unable to download AMI IDs"
+      fail "#{resp.code} Unable to download AMI IDs"
     end
 
     result

data/lib/openstudio/lib/mongoid.yml.template

@@ -16,4 +16,3 @@ production:
       options:
         allow_dynamic_fields: true 
         raise_not_found_error: false
-                

data/lib/openstudio/lib/openstudio_aws_instance.rb

@@ -1,18 +1,18 @@
 # NOTE: Do not modify this file as it is copied over. Modify the source file and rerun rake import_files
 ######################################################################
-#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.  
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
 #  All rights reserved.
-#  
+#
 #  This library is free software; you can redistribute it and/or
 #  modify it under the terms of the GNU Lesser General Public
 #  License as published by the Free Software Foundation; either
 #  version 2.1 of the License, or (at your option) any later version.
-#  
+#
 #  This library is distributed in the hope that it will be useful,
 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 #  Lesser General Public License for more details.
-#  
+#
 #  You should have received a copy of the GNU Lesser General Public
 #  License along with this library; if not, write to the Free Software
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
@@ -22,7 +22,6 @@ require 'securerandom'
 require_relative 'openstudio_aws_logger'
 require_relative 'openstudio_aws_methods'
 
-
 class OpenStudioAwsInstance
   include Logging
   include OpenStudioAwsMethods
@@ -38,103 +37,101 @@ class OpenStudioAwsInstance
     @security_group_name = security_group_name
     @group_uuid = group_uuid.to_s
     @private_key = private_key
-    @proxy = proxy 
+    @proxy = proxy
   end
 
   def launch_instance(image_id, instance_type, user_data, user_id)
-    #logger.info("user_data #{user_data.inspect}")
+    # logger.info("user_data #{user_data.inspect}")
     instance = {
-        :image_id => image_id,
-        :key_name => @key_pair_name,
-        :security_groups => [@security_group_name],
-        :user_data => Base64.encode64(user_data),
-        :instance_type => instance_type,
-        :min_count => 1,
-        :max_count => 1
+      image_id: image_id,
+      key_name: @key_pair_name,
+      security_groups: [@security_group_name],
+      user_data: Base64.encode64(user_data),
+      instance_type: instance_type,
+      min_count: 1,
+      max_count: 1
     }
-    #logger.info instance.inspect
+    # logger.info instance.inspect
     result = @aws.run_instances(instance)
 
     # determine how many processors are suppose to be in this image (lookup for now?)
     processors = find_processors(instance_type)
 
-    # only asked for 1 instance, so therefore it should be the first 
+    # only asked for 1 instance, so therefore it should be the first
     aws_instance = result.data.instances.first
     @aws.create_tags(
-        {
-            :resources => [aws_instance.instance_id],
-            :tags => [
-                {:key => 'Name', :value => "OpenStudio-#{@openstudio_instance_type.capitalize}"}, # todo: abstract out the server and version
-                {:key => 'GroupUUID', :value => @group_uuid},
-                {:key => 'NumberOfProcessors', :value => processors.to_s},
-                {:key => 'Purpose', :value => "OpenStudio#{@openstudio_instance_type.capitalize}"},
-                {:key => 'UserID', :value => user_id}
+
+            resources: [aws_instance.instance_id],
+            tags: [
+              { key: 'Name', value: "OpenStudio-#{@openstudio_instance_type.capitalize}" }, # todo: abstract out the server and version
+              { key: 'GroupUUID', value: @group_uuid },
+              { key: 'NumberOfProcessors', value: processors.to_s },
+              { key: 'Purpose', value: "OpenStudio#{@openstudio_instance_type.capitalize}" },
+              { key: 'UserID', value: user_id }
             ]
-        }
+
     )
 
-    # get the instance information 
-    test_result = @aws.describe_instance_status({:instance_ids => [aws_instance.instance_id]}).data.instance_statuses.first
+    # get the instance information
+    test_result = @aws.describe_instance_status(instance_ids: [aws_instance.instance_id]).data.instance_statuses.first
     begin
-      Timeout::timeout(600) {# 10 minutes
-        while test_result.nil? || test_result.instance_state.name != "running"
+      Timeout.timeout(600) {# 10 minutes
+        while test_result.nil? || test_result.instance_state.name != 'running'
           # refresh the server instance information
 
           sleep 5
-          test_result = @aws.describe_instance_status({:instance_ids => [aws_instance.instance_id]}).data.instance_statuses.first
-          logger.info "... waiting for instance to be running ..."
+          test_result = @aws.describe_instance_status(instance_ids: [aws_instance.instance_id]).data.instance_statuses.first
+          logger.info '... waiting for instance to be running ...'
         end
       }
     rescue TimeoutError
       raise "Intance was unable to launch due to timeout #{aws_instance.instance_id}"
     end
 
-    # now grab information about the instance 
+    # now grab information about the instance
     # todo: check lengths on all of arrays
-    instance_data = @aws.describe_instances({:instance_ids => [aws_instance.instance_id]}).data.reservations.first.instances.first.to_hash
+    instance_data = @aws.describe_instances(instance_ids: [aws_instance.instance_id]).data.reservations.first.instances.first.to_hash
     logger.info "instance description is: #{instance_data}"
 
     @data = create_struct(instance_data, processors)
   end
-  
+
   # if the server already exists, then load the data about the server into the object
-  # instance_data is passed in and in the form of the instance data (as a hash) structured as the 
+  # instance_data is passed in and in the form of the instance data (as a hash) structured as the
   # result of the amazon describe instance
   def load_instance_data(instance_data)
-    @data = create_struct(instance_data, find_processors(instance_data[:instance_type]))     
+    @data = create_struct(instance_data, find_processors(instance_data[:instance_type]))
   end
 
   # Format of the OS JSON that is used for the command line based script
   def to_os_hash
-    h = ""
+    h = ''
     if @openstudio_instance_type == :server
       h = {
-          :timestamp => @group_uuid,
+        timestamp: @group_uuid,
           #:private_key => @private_key, # need to stop printing this out
-          :server => {
-              :id => @data.id,
-              :ip => 'http://' + @data.ip,
-              :dns => @data.dns,
-              :procs => @data.procs
+        server: {
+          id: @data.id,
+          ip: 'http://' + @data.ip,
+          dns: @data.dns,
+          procs: @data.procs
           }
       }
     else
-      raise "do not know how to convert :worker instance to_os_hash. Use the os_aws.to_worker_hash method"
+      fail '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}")
 
     h
   end
-  
+
   private
 
   # store the data into a custom struct.  The instance is the full description.  The remaining fields are
   # just easier accessors to the data in the raw request except for procs which is a custom request.
   def create_struct(instance, procs)
     instance_struct = Struct.new(:instance, :id, :ip, :dns, :procs)
-    return instance_struct.new(instance, instance[:instance_id], instance[:public_ip_address], instance[:public_dns_name], procs)
+    instance_struct.new(instance, instance[:instance_id], instance[:public_ip_address], instance[:public_dns_name], procs)
   end
-
 end