cloudspin-stack 0.1.31 → 0.1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678301e9078d489fdeb291e89c89b211d00331c49602667ff731ed8b4e890854
-  data.tar.gz: a08a9749c18e6a6ad20f12c4bbb229c32d2c6b6fab8453fd9f078377ccdab2cc
+  metadata.gz: 5068a21e5f23f92d3b1b193e2b7c7f59f95488643a3c3720508501f2fb473172
+  data.tar.gz: 549543ec361272038346e41cf139b4f94f5d9dc044c3b039c978dff116654e26
 SHA512:
-  metadata.gz: 76f814c40a4775c4018ea824c56ace5a39711c336fcd26cf04c9d992f320ea059c5f44cdd5f868fd13086bfe52168b15f4a2c728f48b5e8785f1be156252bd54
-  data.tar.gz: 3942f2712d44d275b154c2f234132e56e124e3cd0583b3693132669aefd9873eee9eed5d4b76a94b7b7ba9690e10f86c89318bb0ea556eb1f73f3ada80ff5965
+  metadata.gz: ff1b4c4f407821ab6529a63af72e5947160ae91a62978a7558ddc85c63b5a219fa62ec02885188fcac04a95c7fb4586e2456074f18318b3195771370ce13f53d
+  data.tar.gz: f482061aed3d5b2daab47ceeabf20f80eb0fca74a8ff2950693313b0fa7ed515a143a94977d2d36af7c3f8cb39a692743cc02c871fee427007120f3b9f464a93

data/lib/cloudspin/cli.rb

@@ -27,32 +27,46 @@ module Cloudspin
     option :plan, :type => :boolean, :default => false
     option :'show-init', :type => :boolean, :default => true
     def up
-      puts instance.init_dry if options[:'show-init']
+      puts terraform_runner.init_dry if options[:'show-init']
       if options[:plan] && options[:dry]
-        puts instance.plan_dry
+        puts terraform_runner.plan_dry
       elsif options[:plan] && ! options[:dry]
-        puts instance.plan
+        instance.prepare
+        puts terraform_runner.plan
       elsif ! options[:plan] && options[:dry]
-        puts instance.up_dry
+        puts terraform_runner.up_dry
       else
-        instance.up
+        instance.prepare
+        terraform_runner.up
       end
     end
 
+    desc 'prepare', 'Prepare the working folder and backend for the stack instance'
+    option :'show-init', :type => :boolean, :default => true
+    def prepare
+      instance.prepare
+      puts terraform_runner.init_dry if options[:'show-init']
+      puts terraform_runner.init
+      puts "Working folder prepared: #{instance.working_folder}"
+      puts "Ready:\ncd #{instance.working_folder} && terraform apply"
+    end
+
     desc 'down', 'Destroy the stack instance'
     option :dry, :type => :boolean, :default => false
     option :plan, :type => :boolean, :default => false
     option :'show-init', :type => :boolean, :default => true
     def down
-      puts instance.init_dry if options[:'show-init']
+      puts terraform_runner.init_dry if options[:'show-init']
       if options[:plan] && options[:dry]
-        puts instance.plan_dry(plan_destroy: true)
+        puts terraform_runner.plan_dry(plan_destroy: true)
       elsif options[:plan] && ! options[:dry]
-        puts instance.plan(plan_destroy: true)
+        instance.prepare
+        puts terraform_runner.plan(plan_destroy: true)
       elsif ! options[:plan] && options[:dry]
-        puts instance.down_dry
+        puts terraform_runner.down_dry
       else
-        instance.down
+        instance.prepare
+        terraform_runner.down
       end
     end
 
@@ -77,6 +91,14 @@ module Cloudspin
         )
       end
 
+      def terraform_runner
+        Cloudspin::Stack::Terraform.new(
+          working_folder: instance.working_folder,
+          terraform_variables: instance.terraform_variables,
+          terraform_init_arguments: instance.terraform_init_arguments
+        )
+      end
+
       def instance_configuration_files
         file_list = options[:file]
         if options[:environment]

data/lib/cloudspin/stack.rb

@@ -4,3 +4,4 @@ require 'cloudspin/stack/definition'
 require 'cloudspin/stack/backend_configuration'
 require 'cloudspin/stack/instance_configuration'
 require 'cloudspin/stack/instance'
+require 'cloudspin/stack/terraform'

data/lib/cloudspin/stack/backend_configuration.rb

@@ -19,24 +19,37 @@ module Cloudspin
         @stack_name           = stack_name
         @base_folder          = base_folder
 
-        @has_remote_state         = ! @terraform_backend_configuration_values['bucket'].nil?
+        configure_for_remote_backend
+        configure_to_migrate_backend
+        configure_for_local_backend
+      end
 
-        if @has_remote_state
+      def configure_for_remote_backend
+        @has_remote_state = if @terraform_backend_configuration_values['bucket'].nil?
+          false
+        else
           # puts "DEBUG: Using remote state"
           @local_state_folder = nil
           @local_statefile = nil
           @terraform_backend_configuration_values['key'] = default_state_key
-          @migrate_state = initialize_migrate_flag
+          true
+        end
+      end
+
+      def configure_to_migrate_backend
+        @migrate_state = if @terraform_backend_configuration_values['migrate'].nil?
+          false
         else
-          # puts "DEBUG: Not using remote state"
-          @migrate_state = false
+          migrate_value = @terraform_backend_configuration_values.delete('migrate')
+          migrate_value.to_s.downcase == 'true'
         end
+      end
 
+      def configure_for_local_backend
         if !@has_remote_state || @migrate_state
-          @local_state_folder = intialize_state_folder
+          # puts "DEBUG: Not using remote state, or else is migrating state"
+          @local_state_folder = "#{@base_folder}/state/#{@instance_identifier}"
           @local_statefile = "#{@local_state_folder}/#{@instance_identifier}.tfstate"
-          # puts "DEBUG: Local statefile: #{@local_statefile}"
-          # puts "DEBUG: Migrating? #{@migrate_state}"
         end
       end
 
@@ -62,21 +75,34 @@ module Cloudspin
         end
       end
 
-      def intialize_state_folder
-        # TODO: Prefer to not actually create the folder, but seemed necessary to build the full path string.
-        FileUtils.mkdir_p "#{@base_folder}/state"
-        Pathname.new("#{@base_folder}/state/#{@instance_identifier}").realdirpath.to_s
-      end
-
-      def initialize_migrate_flag
-        if @terraform_backend_configuration_values['migrate'].nil?
-          false
+      def prepare(working_folder:)
+        if remote_state?
+          add_backend_terraform_file(working_folder)
+          # puts "DEBUG: Prepare for use of remote state"
         else
-          migrate_value = @terraform_backend_configuration_values.delete('migrate')
-          migrate_value.to_s.downcase == 'true'
+          # puts "DEBUG: Prepare for use of local state"
+          create_local_state_folder
         end
       end
 
+      def add_backend_terraform_file(working_folder)
+        # puts "DEBUG: Creating file #{working_folder}/_cloudspin_backend.tf"
+        File.open("#{working_folder}/_cloudspin_backend.tf", 'w') { |backend_file|
+          backend_file.write(<<~TF_BACKEND_SOURCE
+            terraform {
+              backend "s3" {}
+            }
+          TF_BACKEND_SOURCE
+          )
+        }
+      end
+
+      def create_local_state_folder
+        # puts "DEBUG: backend_configuration.create_local_state_folder: #{@local_state_folder}"
+        FileUtils.mkdir_p @local_state_folder
+        # Pathname.new(@local_state_folder).realdirpath.to_s
+      end
+
       def default_state_key
         "#{@instance_identifier}.tfstate"
       end

data/lib/cloudspin/stack/instance.rb

@@ -1,4 +1,3 @@
-require 'ruby_terraform'
 require 'fileutils'
 
 module Cloudspin
@@ -8,20 +7,25 @@ module Cloudspin
       include FileUtils
 
       attr_reader :id,
-          :working_folder,
-          :configuration
+        :configuration,
+        :working_folder,
+        :backend_configuration,
+        :terraform_command_arguments
 
       def initialize(
             id:,
             stack_definition:,
-            working_folder:,
+            base_working_folder:,
             configuration:
       )
         validate_id(id)
         @id = id
         @stack_definition = stack_definition
-        @working_folder   = working_folder
+        @working_folder   = "#{base_working_folder}/#{id}"
         @configuration    = configuration
+        @backend_configuration = configuration.backend_configuration
+        @terraform_command_arguments = {}
+        # puts "DEBUG: instance working_folder: #{@working_folder}"
       end
 
       def self.from_folder(
@@ -54,35 +58,50 @@ module Cloudspin
           base_folder: base_folder
         )
 
-        if instance_configuration.has_remote_state_configuration? && stack_definition.is_from_remote?
-          # puts "DEBUG: Stack instance is configured to use remote terraform state AND remote stack definition code"
-          add_backend_configuration_source(stack_definition.source_path)
-        # else
-        #   puts "DEBUG: Stack instance is configured to use local terraform state AND/OR local stack definition code"
-        end
-
         self.new(
             id: instance_configuration.instance_identifier,
             stack_definition: stack_definition,
-            working_folder: ensure_folder("#{base_working_folder}/#{instance_configuration.instance_identifier}"),
+            base_working_folder: base_working_folder,
             configuration: instance_configuration
           )
       end
 
-      def self.ensure_folder(folder)
+      def prepare
+        clean_working_folder
+        create_working_folder
+        copy_instance_source
+        prepare_state
+        create_variables_file
+        @working_folder
+      end
+
+      def clean_working_folder
+        FileUtils.rm_rf(working_folder)
+      end
+
+      def create_working_folder
+        mkdir_p File.dirname(working_folder)
+      end
+
+      def copy_instance_source
+        cp_r @stack_definition.source_path, working_folder
+      end
+
+      def ensure_folder(folder)
         FileUtils.mkdir_p folder
         Pathname.new(folder).realdirpath.to_s
       end
 
-      def self.add_backend_configuration_source(terraform_source_folder)
-        # puts "DEBUG: Creating file #{terraform_source_folder}/_cloudspin_created_backend.tf"
-        File.open("#{terraform_source_folder}/_cloudspin_created_backend.tf", 'w') { |backend_file|
-          backend_file.write(<<~TF_BACKEND_SOURCE
-            terraform {
-              backend "s3" {}
-            }
-          TF_BACKEND_SOURCE
-          )
+      def prepare_state
+        @backend_configuration.prepare(working_folder: working_folder)
+      end
+
+      def create_variables_file
+        # puts "DEBUG: Creating file #{working_folder}/_cloudspin-#{id}.auto.tfvars"
+        File.open("#{working_folder}/_cloudspin-#{id}.auto.tfvars", 'w') { |tfvars_file|
+          tfvars_file.write("# Automatically generated by cloudspin\n")
+          tfvars_file.write(terraform_variables.map { |name,value| "#{name} = \"#{value}\"" }.join("\n"))
+          tfvars_file.write("\n")
         }
       end
 
@@ -100,138 +119,42 @@ module Cloudspin
         configuration.resource_values
       end
 
+      def terraform_variables
+        parameter_values.merge(resource_values) { |key, oldval, newval|
+          raise "Duplicate values for terraform variable '#{key}' ('#{oldval}' and '#{newval}')"
+        }.merge({ 'instance_identifier' => id })
+      end
+
+      def terraform_init_arguments
+        @backend_configuration.terraform_init_parameters
+      end
+
+      def terraform_command_arguments
+        @backend_configuration.terraform_command_parameters
+      end
+
       # def migrate
       #   RubyTerraform.clean(directory: working_folder)
       #   mkdir_p File.dirname(working_folder)
       #   cp_r @stack_definition.source_path, working_folder
       #   Dir.chdir(working_folder) do
-      #   # cp configuration.backend_configuration.local_state_folder
+      #   # cp @backend_configuration.local_state_folder
       #     terraform_init
       #     # terraform_state_push()
       #     RubyTerraform.plan(terraform_command_parameters)
       #   end
       # end
 
-      def plan(plan_destroy: false)
-        RubyTerraform.clean(directory: working_folder)
-        mkdir_p File.dirname(working_folder)
-        cp_r @stack_definition.source_path, working_folder
-        ensure_state_folder
-        Dir.chdir(working_folder) do
-          terraform_init
-          RubyTerraform.plan(terraform_command_parameters(destroy: plan_destroy))
-        end
-      end
-
-      def plan_dry(plan_destroy: false)
-        plan_command = RubyTerraform::Commands::Plan.new
-        command_line_builder = plan_command.instantiate_builder
-        configured_command = plan_command.configure_command(
-          command_line_builder,
-          terraform_command_parameters(:destroy => plan_destroy)
-        )
-        built_command = configured_command.build
-        "cd #{working_folder} && #{built_command.to_s}"
-      end
-
-      def up
-        RubyTerraform.clean(directory: working_folder)
-        mkdir_p File.dirname(working_folder)
-        cp_r @stack_definition.source_path, working_folder
-        ensure_state_folder
-        Dir.chdir(working_folder) do
-          terraform_init
-          RubyTerraform.apply(terraform_command_parameters(auto_approve: true))
-        end
-      end
-
-      def up_dry
-        up_command = RubyTerraform::Commands::Apply.new
-        command_line_builder = up_command.instantiate_builder
-        configured_command = up_command.configure_command(command_line_builder, terraform_command_parameters)
-        built_command = configured_command.build
-        "cd #{working_folder} && #{built_command.to_s}"
-      end
-
-      def down
-        RubyTerraform.clean(directory: working_folder)
-        mkdir_p File.dirname(working_folder)
-        cp_r @stack_definition.source_path, working_folder
-        ensure_state_folder
-        Dir.chdir(working_folder) do
-          terraform_init
-          RubyTerraform.destroy(terraform_command_parameters(force: true))
-        end
-      end
-
-      def down_dry
-        down_command = RubyTerraform::Commands::Destroy.new
-        command_line_builder = down_command.instantiate_builder
-        configured_command = down_command.configure_command(command_line_builder, terraform_command_parameters)
-        built_command = configured_command.build
-        "cd #{working_folder} && #{built_command.to_s}"
-      end
-
-      def refresh
-        RubyTerraform.clean(directory: working_folder)
-        mkdir_p File.dirname(working_folder)
-        cp_r @stack_definition.source_path, working_folder
-        ensure_state_folder
-        Dir.chdir(working_folder) do
-          terraform_init
-          RubyTerraform.refresh(terraform_command_parameters(force: true))
-        end
-      end
-
-      def terraform_init
-        if configuration.backend_configuration.migrate_state?
-          prepare_state_for_migration
-        end
-        RubyTerraform.init(terraform_init_params)
-      end
-
-      def prepare_state_for_migration
-        # puts "DEBUG: Preparing to migrate state from #{configuration.backend_configuration.local_statefile}"
-        cp configuration.backend_configuration.local_statefile, "#{working_folder}/terraform.tfstate"
-      end
-
-      def init_dry
-        if configuration.backend_configuration.migrate_state?
-          "cp #{configuration.backend_configuration.local_statefile} -> #{working_folder}/terraform.tfstate"
-        end
-        init_command = RubyTerraform::Commands::Init.new
-        command_line_builder = init_command.instantiate_builder
-        configured_command = init_command.configure_command(
-          command_line_builder,
-          terraform_init_params
-        )
-        built_command = configured_command.build
-        "cd #{working_folder} && #{built_command.to_s}"
-      end
-
-      def terraform_init_params
-        configuration.backend_configuration.terraform_init_parameters
-      end
-
-      # TODO: Redundant? The folder is created in the BackendConfiguration class ...
-      def ensure_state_folder
-        if configuration.has_local_state_configuration?
-          Instance.ensure_folder(configuration.backend_configuration.local_state_folder)
-        end
-      end
-
-      def terraform_command_parameters(added_parameters = {})
-        {
-          vars: terraform_variables
-        }.merge(configuration.backend_configuration.terraform_command_parameters)
-          .merge(added_parameters)
-      end
+      # def init
+        # if @backend_configuration.migrate_state?
+        #   prepare_state_for_migration
+        # end
+      # end
 
-      def terraform_variables
-        parameter_values.merge(resource_values) { |key, oldval, newval|
-          raise "Duplicate values for terraform variable '#{key}' ('#{oldval}' and '#{newval}')"
-        }.merge({ 'instance_identifier' => id })
-      end
+      # def prepare_state_for_migration
+      #   # puts "DEBUG: Preparing to migrate state from #{@backend_configuration.local_statefile}"
+      #   cp @backend_configuration.local_statefile, "#{working_folder}/terraform.tfstate"
+      # end
 
     end
   end

data/lib/cloudspin/stack/instance_configuration.rb

@@ -17,9 +17,6 @@ module Cloudspin
       attr_reader :instance_identifier
       attr_reader :backend_configuration
 
-
-      attr_reader :Xterraform_backend
-
       def initialize(
           configuration_values: {},
           stack_definition:,

data/lib/cloudspin/stack/terraform.rb

@@ -0,0 +1,128 @@
+require 'ruby_terraform'
+require 'fileutils'
+
+module Cloudspin
+  module Stack
+    class Terraform
+
+      # KSM: Maybe this should be a static class - pass in the working directory and
+      # the arguments, and call them. All the logic of assembling the command line
+      # arguments should be in the caller?? Since I want the caller to be able to
+      # spit out the things in a variables file, for instance.
+      def initialize(
+        working_folder: '.',
+        terraform_variables: {},
+        terraform_init_arguments: {}
+      )
+        @working_folder = working_folder
+        # @terraform_variables = terraform_variables
+        @terraform_variables = {}
+        @terraform_init_arguments = terraform_init_arguments
+      end
+
+      def plan(plan_destroy: false)
+        Dir.chdir(@working_folder) do
+          terraform_init
+          RubyTerraform.plan(terraform_command_parameters(destroy: plan_destroy))
+        end
+      end
+
+      def plan_dry(plan_destroy: false)
+        plan_command = RubyTerraform::Commands::Plan.new
+        command_line_builder = plan_command.instantiate_builder
+        configured_command = plan_command.configure_command(
+          command_line_builder,
+          terraform_command_parameters(:destroy => plan_destroy)
+        )
+        built_command = configured_command.build
+        "cd #{@working_folder} && #{built_command.to_s}"
+      end
+
+      def up
+        # RubyTerraform.clean(directory: @working_folder)
+        # mkdir_p File.dirname(@working_folder)
+        # cp_r @stack_definition.source_path, @working_folder
+        # ensure_state_folder
+        Dir.chdir(@working_folder) do
+          terraform_init
+          RubyTerraform.apply(terraform_command_parameters(auto_approve: true))
+        end
+      end
+
+      def up_dry
+        up_command = RubyTerraform::Commands::Apply.new
+        command_line_builder = up_command.instantiate_builder
+        configured_command = up_command.configure_command(command_line_builder, terraform_command_parameters)
+        built_command = configured_command.build
+        "cd #{@working_folder} && #{built_command.to_s}"
+      end
+
+      def down
+        # RubyTerraform.clean(directory: @working_folder)
+        # mkdir_p File.dirname(@working_folder)
+        # cp_r @stack_definition.source_path, @working_folder
+        # ensure_state_folder
+        Dir.chdir(@working_folder) do
+          terraform_init
+          RubyTerraform.destroy(terraform_command_parameters(force: true))
+        end
+      end
+
+      def down_dry
+        down_command = RubyTerraform::Commands::Destroy.new
+        command_line_builder = down_command.instantiate_builder
+        configured_command = down_command.configure_command(command_line_builder, terraform_command_parameters)
+        built_command = configured_command.build
+        "cd #{@working_folder} && #{built_command.to_s}"
+      end
+
+      def refresh
+        # RubyTerraform.clean(directory: @working_folder)
+        # mkdir_p File.dirname(@working_folder)
+        # cp_r @stack_definition.source_path, @working_folder
+        # ensure_state_folder
+        Dir.chdir(@working_folder) do
+          terraform_init
+          RubyTerraform.refresh(terraform_command_parameters(force: true))
+        end
+      end
+
+      def terraform_init
+        RubyTerraform.init(@terraform_init_arguments)
+      end
+
+      def init
+        Dir.chdir(@working_folder) do
+          terraform_init
+        end
+      end
+
+      def init_dry
+        # if configuration.backend_configuration.migrate_state?
+        #   "cp #{configuration.backend_configuration.local_statefile} -> #{@working_folder}/terraform.tfstate"
+        # end
+        init_command = RubyTerraform::Commands::Init.new
+        command_line_builder = init_command.instantiate_builder
+        configured_command = init_command.configure_command(
+          command_line_builder,
+          @terraform_init_arguments
+        )
+        built_command = configured_command.build
+        "cd #{@working_folder} && #{built_command.to_s}"
+      end
+
+      # KSM: Do we have this here, or do we munge all this up in the calling method and 
+      # just pass in the processed list of arguments?
+      # For that matter, should we just call each of the actions on this class as static
+      # methods? Does this class really need to hold any kind of state?
+
+      def terraform_command_parameters(added_parameters = {})
+        {
+          vars: @terraform_variables
+        }.merge(added_parameters)
+      end
+
+    end
+  end
+end
+

data/lib/cloudspin/stack/version.rb

@@ -1,5 +1,5 @@
 module Cloudspin
   module Stack
-    VERSION = '0.1.31'
+    VERSION = '0.1.32'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudspin-stack
 version: !ruby/object:Gem::Version
-  version: 0.1.31
+  version: 0.1.32
 platform: ruby
 authors:
 - 'kief '
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-19 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-terraform
@@ -136,6 +136,7 @@ files:
 - lib/cloudspin/stack/instance.rb
 - lib/cloudspin/stack/instance_configuration.rb
 - lib/cloudspin/stack/remote_definition.rb
+- lib/cloudspin/stack/terraform.rb
 - lib/cloudspin/stack/version.rb
 homepage: https://github.com/cloudspinners
 licenses: