kitchen-scalr 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8ed1f4e7e3d101bfe6107378dc25ff7fbfbed1e3
-  data.tar.gz: 734761f4cc1be9162f1219a4b10877a09db2c752
+SHA256:
+  metadata.gz: 8d98764d098645a987936f906da189ec83f648837d7682c603bfeffe409ee55f
+  data.tar.gz: 1ef55e6731cf0632791ff32925dfdba73a684d655121de52096225cbd776b5e0
 SHA512:
-  metadata.gz: cc271796f6409665cad6181b940ccb74c11ded4708466878a71722d72cf155133442763eb54821f655490a21473cef8ffeffaf2ae08ebd2b518daa09cc6183a2
-  data.tar.gz: c27b8242b2793201af2cce6d9d9b213d895c280ef965989b7e5e3cc9f8836e7acaa7e19cb55f5c8159fd4a07ba11bfe7459eb24d11538832c43b3f2442930f60
+  metadata.gz: 8c69a8c03da69535edd05389c90b73c3e41b912a023cab35ebf9ba01a35e45d15ddfc9107f74f1d45bd456b32d3eaf6e0178a8d03ec7124aa03caaa7cdc0d1d7
+  data.tar.gz: cc2a824e00bd5f1eed517953a7e2478c66ffeb74b8d604a8f664a1df15d797506cae04f9d88056a7c44c8ac5b7e4df2c329d0c6b8bfb57cb30a8d10cf98d4821

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.7
+* Add scalr_global_variables setting
+
 ## 0.2.6
 * Compatibility with Scalr 7.7.7
 

data/README.md

@@ -8,60 +8,102 @@ A Test Kitchen Driver for Scalr. This driver creates an instance on Scalr by cre
 
 ## <a name="installation"></a> Installation and Setup
 
+In short:
+```
+gem install kitchen-scalr
+```
+
 Please read the [Driver usage][driver_usage] page for more details.
 
 ## <a name="config"></a> Configuration
+
 ### scalr_api_url
 **Required** This is the URL of the Scalr server that will be reached by the driver.
+
 ### scalr_env_id
 **Required** This is a string corresponding to the environment id used by the plugin.
+
 ### scalr_api_key_id and scalr_api_key_secret
 **Required except on macOS and Windows** These are respectively the API KEY ID and API KEY secret used to make the API calls to Scalr. This option **SHOULD NOT** be used on Windows and macOS because kitchen scalr integrates natively with these OSes to ensure secure storage of the Scalr credentials. In this case, Kitchen-Scalr will prompt for credentials at the first use, and memorize them for further calls.
+
 ### scalr_project_id
 **Required** This is a string corresponding to the project identifier used to create the farm in Scalr. This is used in Scalr for accountability and cost management.
+
 ### scalr_use_role
 **Optional** Setting this option to an integer corresponding to a role id will trigger Role mode with the provided role identifier. If this option is not set, the driver will work in Image mode.
+
 ### scalr_server_image
 **Required in Image mode** This is a string corresponding to the image name used to instanciate the server.
+
 ### scalr_server_instanceType
 **Required** This is a string corresponding to the instance type of the VMs in the underlying cloud. Example: 'm3.medium'
+
 ### scalr_platform
 **Required in Role mode** This is the identifier of the underlying cloud platform. Examples: "ec2", "gce", "openstack".
+
 ### scalr_location
 **Required in Role mode** This is a string corresponding to the cloud location used to create the instance. Example: "us-east-1"
+
+### scalr_global_variables
+**Optional** This is a dictionary of Scalr Global Variables to set or create. Global Variables in this dictionary are created if they don't exist in Scalr, otherwise their value is set. By default these global variables are set at the Farm Role scope, if you need to set one at the Farm scope, add `scope: Farm` to its description. Additional Global Variable settings corresponding to the definition of a [Global Variable object](https://api-explorer.scalr.com/definitions/G/GlobalVariable.html) in Scalr's APIv2 can be passed for each Global Variable. These settings are used only when the global variable is created, they are ignored if it is only set.
+
 ### scalr_permit_ssh_root_login
 **Optional** This is a boolean, default is 'false', that configures sshd to allow root logins and bounces the service during kitchen create. Useful if your base image does not allow ssh as root by default.
+
 ### scalr_base_farm_role
-**Optional** This is a yaml representation of a Farm Role Object as described in the APIv2 in Scalr. When kitchen-scalr creates a server, it merges this object with the previously-described parameters and creates the corresponding Farm Role. This section can be used to configure Security Groups, Networking etc... You can put the same parameters there as the ones you would get with a `scalr-ctl farm-roles get`.
+**Optional** This is a yaml representation of a [Farm Role Object](https://api-explorer.scalr.com/definitions/F/FarmRole.html) as represented in the APIv2 in Scalr. When kitchen-scalr creates a server, it merges this object with the previously-described parameters and creates the corresponding Farm Role. This section can be used to configure Security Groups, Networking etc... You can put the same parameters there as the ones you would get with a `scalr-ctl farm-roles get`.
+
 ### scalr_use_private_ip
 **Optional** If set to true, kitchen will use Scalr private ips for the instances, otherwise it will use the public one.
+
 ## Configuration example
-    ---
+
+```yaml
+---
+driver:
+  name: scalr
+
+provisioner:
+  name: chef_zero
+
+verifier:
+  name: inspec
+
+platforms:
+  - name: ubuntu-16.04
     driver:
-      name: scalr
-
-    provisioner:
-      name: chef_zero
-    
-    verifier:
-      name: inspec
-
-    platforms:
-      - name: ubuntu-14.04
-        driver:
-          scalr_api_url: 'http://my.scalr.com'
-          scalr_env_id: '2'
-          scalr_project_id: '30c59dba-fc9b-4d0f-83ec-4b5043b12f72'
-          scalr_server_instanceType: 'm3.medium'
-          scalr_use_role: 12345
-          scalr_platform: 'ec2'
-          scalr_location: 'us-east-1'
-          scalr_base_farm_role:
-            security:
-              securityGroups:
-                - id: 'sg-3b3d9153'
-                - id: 'sg-349a765f'
-                - id: 'sg-4a9a7621'
+      scalr_api_url: 'https://my.scalr.com'
+      scalr_env_id: '2'
+      scalr_project_id: '30c59dba-fc9b-4d0f-83ec-4b5043b12f72'
+      scalr_server_instanceType: 'm3.medium'
+      scalr_use_role: 12345
+      scalr_platform: 'ec2'
+      scalr_location: 'us-east-1'
+      scalr_base_farm_role:   # Add platform-specific Farm Role settings
+        cloudFeatures:
+          type: AwsCloudFeatures
+          ebsOptimized: false
+        networking:
+          networks:
+            - id: vpc-xxxxxxxx
+          subnets:
+            - id: subnet-xxxxxxxx
+        security:
+          securityGroups:
+            - id: 'sg-3b3d9153'
+            - id: 'sg-349a765f'
+            - id: 'sg-4a9a7621'
+      scalr_global_variables:
+        My_Global_Variable:   # Set or create a global variable named My_Global_Variable
+          value: Hello World
+        My_Secret_GV:         # Create a Global Variable with additional settings
+          value: access-token
+          category: Monitoring
+          hidden: true
+        My_Farm_Scope_GV:     # Set a Global Variable at the Farm scope
+          value: Farm name
+          scope: Farm
+```
 
 ## <a name="development"></a> Development
 
@@ -80,7 +122,8 @@ example:
 
 ## <a name="thanks"></a> Thanks
 
-- @daxgames for contributing the 'permit_ssh_root_login' setting.
+- [@daxgames](https://github.com/daxgames) for contributing the `permit_ssh_root_login` setting.
+- [@bpezan](https://github.com/bpezan) for contributing the `scalr_global_variables` setting.
 
 ## <a name="authors"></a> Authors
 
@@ -89,7 +132,7 @@ example:
 
 ## <a name="license"></a> License
 
-Apache 2.0 (see [LICENSE][license])
+Apache 2.0 (see [LICENSE][license
 
 
 [author]:           https://github.com/momohawari

data/lib/kitchen/driver/ScalrAPI.rb

@@ -74,10 +74,10 @@ class ScalrAPI
 				:payload  => body
 			)
 		rescue RestClient::ExceptionWithResponse => e
-     		puts "Scalr server returned an error: "
-     		puts e.response
-     		raise e
- 		end
+			puts "Scalr server returned an error: "
+			puts e.response
+			raise e
+		end
 		if response == ""
 			response = "{}"
 		end
@@ -123,4 +123,10 @@ class ScalrAPI
 		return response['data']
 	end
 
-end
+	#Edit items in API via PATCH
+	def edit(url, data)
+		response = self.request('PATCH', url, data)
+		return response['data']
+	end
+
+end

data/lib/kitchen/driver/scalr.rb

@@ -57,7 +57,7 @@ module Kitchen
 
       default_config :scalr_server_status_polling_period, 10
 
-      default_config :scalr_server_status_polling_timeout, 600
+      default_config :scalr_server_status_polling_timeout, 1800
 
       default_config :scalr_server_image, ''
 
@@ -75,6 +75,8 @@ module Kitchen
 
       default_config :scalr_use_private_ip, false
 
+      default_config :scalr_global_variables, Hash.new
+
       def create(state)
       	if config[:scalr_api_key_id]==''
       	  #We have to find some other way of getting the credentials
@@ -109,6 +111,10 @@ module Kitchen
         response = scalr_api.create('/api/v1beta0/user/%s/farms/%d/farm-roles/' % [config[:scalr_env_id], state[:farmId]], farmRoleObject)
         puts "Farm Role created"
         state[:farmRoleId] = response['id']
+        # Creating the configured global variables
+        if !config[:scalr_global_variables].empty?
+          setup_global_vars(config, state, scalr_api)
+        end
         #Start the farm now
         response = scalr_api.post('/api/v1beta0/user/%s/farms/%d/actions/launch/' % [config[:scalr_env_id], state[:farmId]], {})
         state[:farmLaunched] = 1
@@ -274,6 +280,50 @@ module Kitchen
         puts "RoleImage association created"
       end
 
+      def setup_global_vars(config, state, scalr_api)
+        puts 'Listing existing global variables'
+        # Start by listing the GVs at the Farm scope to know which GVs exist
+        gv_list = scalr_api.list('/api/v1beta0/user/%s/farms/%d/global-variables/' % [config[:scalr_env_id], state[:farmId]])
+        existing_gvs = {}
+        gv_list.each do |gv|
+          existing_gvs[gv['name']] = gv
+        end
+        config[:scalr_global_variables].each do |key, val|
+          if existing_gvs.has_key? key.to_s
+            puts 'Global variable "%s" exists, setting value "%s"...' % [key, val[:value]]
+            # set global var value
+            if val[:scope] and val[:scope].downcase == 'farm' then
+              gv_set_url = '/api/v1beta0/user/%s/farms/%d/global-variables/%s' % [config[:scalr_env_id], state[:farmId], key]
+            else
+              gv_set_url = '/api/v1beta0/user/%s/farm-roles/%d/global-variables/%s' % [config[:scalr_env_id], state[:farmRoleId], key]
+            end
+            globalVariableObjectEdit = {
+              'value' => val[:value]
+            }
+            response = scalr_api.edit(gv_set_url, globalVariableObjectEdit)
+          else
+            puts 'Global variable "%s" not found, creating with value: "%s"...' % [key, val[:value]]
+            # create global var
+            if val[:scope] and val[:scope].downcase == 'farm' then
+              gv_create_url = '/api/v1beta0/user/%s/farms/%d/global-variables/' % [config[:scalr_env_id], state[:farmId], key]
+            else
+              gv_create_url = '/api/v1beta0/user/%s/farm-roles/%d/global-variables/' % [config[:scalr_env_id], state[:farmRoleId], key]
+            end
+            val.delete(:scope)
+            globalVariableDefaults = {
+              'category' => '',
+              'name' => key,
+              'description' => '',
+              'hidden' => false,
+              'locked' => false
+            }
+            globalVariableObjectCreate = globalVariableDefaults.deep_merge(val)
+            response = scalr_api.create(gv_create_url, globalVariableObjectCreate)
+          end
+        end
+        puts 'Global variables created/updated'
+      end
+
       def setup_credentials(scalr_api,state)
         response = scalr_api.list('/api/v1beta0/user/%s/farms/%d/servers/' % [config[:scalr_env_id], state[:farmId]])
         state[:serverId] = response[0]['id']
@@ -311,9 +361,9 @@ module Kitchen
         puts "Script created with id %s" % [state[:scriptId]]
         #Now create a script version with the actual body
         puts "Creating a script version"
-        puts "Script content:"
-        puts scriptData
-        puts "End of script content"
+        # puts "Script content:"
+        # puts scriptData
+        # puts "End of script content"
         response = scalr_api.create('/api/v1beta0/user/%s/scripts/%d/script-versions/' % [config[:scalr_env_id], state[:scriptId]],
         {
           'body' => scriptData,

data/lib/kitchen/driver/scalr_version.rb

@@ -21,6 +21,6 @@ module Kitchen
   module Driver
 
     # Version string for Scalr Kitchen driver
-    SCALR_VERSION = "0.2.6"
+    SCALR_VERSION = "0.2.7"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-scalr
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Mohammed HAWARI
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Test Kitchen Driver for Scalr