yle_tf 1.0.0 → 1.1.0.rc1

data/lib/yle_tf/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'yaml'
 
@@ -10,16 +12,23 @@ class YleTf
   class Config
     NotFoundError = Class.new(Error)
 
-    attr_reader :config, :tf_env, :module_dir
+    # Loads the configuration based on the environment
+    def self.load(tf_env)
+      opts = {
+        tf_env:     tf_env,
+        module_dir: Pathname.pwd
+      }
 
-    def initialize(tf_env)
-      Logger.debug("Initializing configuration for the #{tf_env.inspect} environment")
+      config = Loader.new(opts).load
+      new(config, opts)
+    end
 
-      @tf_env = tf_env
-      @module_dir = Pathname.pwd
-      @config = Loader.new(tf_env: tf_env, module_dir: module_dir).load
+    attr_reader :config, :tf_env, :module_dir
 
-      Logger.debug(inspect)
+    def initialize(config, **opts)
+      @config = config
+      @tf_env = opts[:tf_env]
+      @module_dir = opts[:module_dir]
     end
 
     def to_s
@@ -33,8 +42,15 @@ class YleTf
       block ||= DEFAULT_NOT_FOUND_BLOCK
 
       keys.inject(config) do |conf, key|
-        break block.call(keys) if !conf || !conf.key?(key)
-        conf[key]
+        next conf[key] if conf.is_a?(Hash) && conf.key?(key)
+
+        if !conf.nil? && !conf.is_a?(Hash)
+          Logger.warn(
+            "Configuration [#{keys.join(' > ')}] includes non-hash element #{conf.inspect}"
+          )
+        end
+
+        break block.call(keys)
       end
     end
 

data/lib/yle_tf/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class YleTf
   # Base class for yle_tf errors
   Error = Class.new(StandardError)

data/lib/yle_tf/helpers/hash.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../../../vendor/hash_deep_merge'
+
+class YleTf
+  module Helpers
+    module Hash
+      module_function
+
+      # Returns deep merged new Hash
+      def deep_merge(target, source)
+        target.deep_merge(source)
+      end
+
+      # Returns deep copy of a Hash.
+      # `dup` and `clone` only return shallow copies.
+      def deep_copy(hash)
+        Marshal.load(Marshal.dump(hash))
+      end
+    end
+  end
+end

data/lib/yle_tf/logger/colorize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class YleTf
   module Logger
     module Colorize

data/lib/yle_tf/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'logger'
 require 'rubygems'

data/lib/yle_tf/plugin/action_hook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class YleTf
   class Plugin
     class ActionHook

data/lib/yle_tf/plugin/loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf/logger'
 
 class YleTf
@@ -13,7 +15,7 @@ class YleTf
 
       def self.load_core_plugins
         core_plugins.each do |plugin_file|
-          Logger.debug("Loading core plugin: #{File.basename(plugin_file, '.rb')}")
+          Logger.debug { "Loading core plugin: #{core_plugin_name(plugin_file)}" }
           load(plugin_file)
         end
       end
@@ -36,6 +38,11 @@ class YleTf
         Dir.glob(File.expand_path('../../yle_tf_plugins/**/plugin.rb', __dir__))
       end
 
+      def self.core_plugin_name(path)
+        m = %r{.*/yle_tf_plugins/(?<name>.+?)/plugin\.rb$}.match(path)
+        m ? m[:name] : path
+      end
+
       def self.bundler_plugins
         plugins = Bundler.definition.current_dependencies.select do |dep|
           dep.groups.include?(BUNDLER_PLUGIN_GROUP)

data/lib/yle_tf/plugin/manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf/logger'
 
 class YleTf
@@ -42,6 +44,7 @@ class YleTf
           registered.each do |plugin|
             backends.merge!(plugin.backends)
           end
+          backends.default = backends.delete(DEFAULT_BACKEND)
         end
       end
     end

data/lib/yle_tf/plugin.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 class YleTf
   class Plugin
     autoload :ActionHook, 'yle_tf/plugin/action_hook'
     autoload :Loader, 'yle_tf/plugin/loader'
     autoload :Manager, 'yle_tf/plugin/manager'
 
+    DEFAULT_BACKEND = Object.new.freeze
     DEFAULT_COMMAND = Object.new.freeze
 
     def self.manager
@@ -30,7 +33,7 @@ class YleTf
       name = name.to_s if name.is_a?(Symbol)
       commands[name] = {
         synopsis: synopsis,
-        proc: block
+        proc:     block
       }
     end
 
@@ -49,7 +52,8 @@ class YleTf
     end
 
     def self.backend(type, &block)
-      backends[type.to_sym] = block
+      type = type.to_s if type.is_a?(Symbol)
+      backends[type] = block
     end
   end
 end

data/lib/yle_tf/system/io_handlers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf/error'
 require 'yle_tf/logger'
 require 'yle_tf/system/output_logger'
@@ -22,6 +24,7 @@ class YleTf
           if !handler.respond_to?(:call)
             raise YleTf::Error, "Unknown input handler #{handler.inspect}"
           end
+
           handler
         end
       end
@@ -42,6 +45,7 @@ class YleTf
           if !handler.respond_to?(:call)
             raise YleTf::Error, "Unknown output handler #{handler.inspect}"
           end
+
           handler
         end
       end

data/lib/yle_tf/system/output_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf/logger'
 
 class YleTf

data/lib/yle_tf/system/tf_hook_output_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf/logger'
 require 'yle_tf/system/output_logger'
 

data/lib/yle_tf/system.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'English'
 require 'open3'
 require 'shellwords'
@@ -14,7 +16,7 @@ class YleTf
     DEFAULT_ERROR_HANDLER = ->(_exit_code, error) { raise error }.freeze
 
     DEFAULT_IO_HANDLERS = {
-      stdin: :dev_null,
+      stdin:  :dev_null,
       stdout: :info,
       stderr: :error
     }.freeze

data/lib/yle_tf/tf_hook/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf/logger'
 require 'yle_tf/tf_hook'
 

data/lib/yle_tf/tf_hook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'tmpdir'
 
@@ -14,8 +16,8 @@ class YleTf
     def self.from_config(config, tf_env)
       TfHook.new(
         description: config['description'],
-        source: config['source'],
-        vars: merge_vars(config['vars'], tf_env)
+        source:      config['source'],
+        vars:        merge_vars(config['vars'], tf_env)
       )
     end
 
@@ -23,7 +25,7 @@ class YleTf
     def self.from_file(path)
       TfHook.new(
         description: File.basename(path),
-        path: path
+        path:        path
       )
     end
 
@@ -43,10 +45,10 @@ class YleTf
       Logger.info("Running hook '#{description}'")
       YleTf::System.cmd(
         path,
-        env: vars.merge(tf_vars),
+        env:      vars.merge(tf_vars),
         progname: File.basename(path),
-        stdout: System::TfHookOutputLogger.new(:info),
-        stderr: System::TfHookOutputLogger.new(:error)
+        stdout:   System::TfHookOutputLogger.new(:info),
+        stderr:   System::TfHookOutputLogger.new(:error)
       )
     ensure
       delete_tmpdir
@@ -57,9 +59,9 @@ class YleTf
       raise Error, "Invalid or missing `source` for hook '#{description}'" if !m
 
       {
-        uri: m[:uri],
+        uri:  m[:uri],
         path: m[:path],
-        ref: m[:ref] || 'master'
+        ref:  m[:ref] || 'master'
       }
     end
 
@@ -83,7 +85,7 @@ class YleTf
     end
 
     def delete_tmpdir
-      FileUtils.rm_r(@tmpdir) if @tmpdir && Dir.exist?(@tmpdir)
+      FileUtils.rm_rf(@tmpdir, secure: true) if @tmpdir && Dir.exist?(@tmpdir)
       @tmpdir = nil
     end
 

data/lib/yle_tf/vars_file.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 class YleTf
   class VarsFile
-    ENV_DIR = 'envs'.freeze
+    ENV_DIR = 'envs'
 
     # Returns the env specific tfvars file path if it exists
     def self.find_env_vars_file(config)
@@ -10,7 +12,7 @@ class YleTf
 
     # Returns all envs that have tfvars files
     def self.list_all_envs(config)
-      Dir.glob("#{config.module_dir}/#{ENV_DIR}/*.tfvars").map do |path|
+      Dir.glob("#{config.module_dir}/#{ENV_DIR}/*.tfvars").sort.map do |path|
         File.basename(path, '.tfvars')
       end
     end
@@ -36,9 +38,20 @@ class YleTf
       File.open(path, 'a') do |file|
         file.puts # ensure we don't append to an existing line
         vars.each do |key, value|
-          file.puts %(#{key} = "#{value}")
+          file.puts "#{key} = #{eval_value(value)}"
         end
       end
     end
+
+    def eval_value(value)
+      case value
+      when Hash
+        %({ #{value.map { |k, v| "#{k} = #{eval_value(v)}" }.join(', ')} })
+      when Array
+        %([ #{value.map { |item| eval_value(item) }.join(', ')} ])
+      else
+        %("#{value}")
+      end
+    end
   end
 end

data/lib/yle_tf/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class YleTf
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0.rc1'
 end

data/lib/yle_tf/version_requirement.rb

@@ -1,13 +1,10 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 
 class YleTf
   # Helper class for comparing versions
   class VersionRequirement
-    # Checks if the specified Terrform version is older than 0.9
-    def self.pre_0_9?(terraform_version)
-      new('< 0.9.0-beta').satisfied_by?(terraform_version)
-    end
-
     attr_reader :requirement
 
     def initialize(requirement)

data/lib/yle_tf.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'yle_tf/logger'
 require 'yle_tf/version'
 
 class YleTf
+  TERRAFORM_VERSION_REQUIREMENT = '>= 0.9'
+
   autoload :Action,  'yle_tf/action'
   autoload :Error,   'yle_tf/error'
   autoload :Plugin,  'yle_tf/plugin'

data/lib/yle_tf_plugins/backends/{s3 → __default}/plugin.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'yle_tf'
+require 'yle_tf/backend'
 
 module YleTfPlugins
   module Backends
-    module S3
+    module Default
       class Plugin < YleTf::Plugin
         register
 
-        backend('s3') do
-          require_relative 'command'
-          Command
+        backend(DEFAULT_BACKEND) do
+          YleTf::Backend
         end
       end
     end

data/lib/yle_tf_plugins/backends/file/{command.rb → backend.rb}

@@ -1,25 +1,24 @@
-require_relative 'config'
+# frozen_string_literal: true
+
+require 'pathname'
+require 'yle_tf/backend'
+require 'yle_tf/logger'
 
 module YleTfPlugins
   module Backends
     module File
-      class Command
-        def backend_config(config)
-          local_path = Pathname.pwd.join('terraform.tfstate')
-          tfstate_path = tfstate_path(config)
-
+      class Backend < YleTf::Backend
+        # Symlinks local "terraform.tfstate" to the specified path
+        def configure
           YleTf::Logger.info("Symlinking state to '#{tfstate_path}'")
+          local_path = Pathname.pwd.join('terraform.tfstate')
           local_path.make_symlink(tfstate_path)
-          tfstate_path.write(tfstate_template, perm: 0o644) if !tfstate_path.exist?
 
-          Config.new(
-            'file',
-            'file' => tfstate_path.to_s
-          )
+          tfstate_path.write(tfstate_template, perm: 0o644) if !tfstate_path.exist?
         end
 
-        def tfstate_path(config)
-          config.module_dir.join(config.fetch('backend', 'file'))
+        def tfstate_path
+          @tfstate_path ||= config.module_dir.join(config.fetch('backend', 'file', 'path'))
         end
 
         def tfstate_template

data/lib/yle_tf_plugins/backends/file/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf'
 
 module YleTfPlugins
@@ -7,8 +9,8 @@ module YleTfPlugins
         register
 
         backend('file') do
-          require_relative 'command'
-          Command
+          require_relative 'backend'
+          Backend
         end
       end
     end

data/lib/yle_tf_plugins/commands/__default/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf/logger'
 require 'yle_tf/system'
 

data/lib/yle_tf_plugins/commands/__default/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf'
 
 module YleTfPlugins

data/lib/yle_tf_plugins/commands/_config/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf/logger'
 
 module YleTfPlugins

data/lib/yle_tf_plugins/commands/_config/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf'
 
 module YleTfPlugins

data/lib/yle_tf_plugins/commands/_shell/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module YleTfPlugins
   module CommandShell
     class Command

data/lib/yle_tf_plugins/commands/_shell/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf'
 
 module YleTfPlugins

data/lib/yle_tf_plugins/commands/help/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 require 'yle_tf/system'

data/lib/yle_tf_plugins/commands/help/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf'
 
 module YleTfPlugins

data/lib/yle_tf_plugins/commands/version/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf/system'
 require 'yle_tf/version'
 

data/lib/yle_tf_plugins/commands/version/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yle_tf'
 
 module YleTfPlugins

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yle_tf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.rc1
 platform: ruby
 authors:
 - Yleisradio
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2019-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -26,6 +26,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -46,14 +60,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.41'
 description: Tooling for Terraform to support environments, hooks, etc.
 email:
 - devops@yle.fi
@@ -78,14 +106,16 @@ files:
 - lib/yle_tf/action/verify_terraform_version.rb
 - lib/yle_tf/action/verify_tf_env.rb
 - lib/yle_tf/action/write_terraformrc_defaults.rb
-- lib/yle_tf/backend_config.rb
+- lib/yle_tf/backend.rb
 - lib/yle_tf/cli.rb
 - lib/yle_tf/config.rb
 - lib/yle_tf/config/defaults.rb
 - lib/yle_tf/config/erb.rb
 - lib/yle_tf/config/file.rb
 - lib/yle_tf/config/loader.rb
+- lib/yle_tf/config/migration.rb
 - lib/yle_tf/error.rb
+- lib/yle_tf/helpers/hash.rb
 - lib/yle_tf/logger.rb
 - lib/yle_tf/logger/colorize.rb
 - lib/yle_tf/plugin.rb
@@ -101,13 +131,9 @@ files:
 - lib/yle_tf/vars_file.rb
 - lib/yle_tf/version.rb
 - lib/yle_tf/version_requirement.rb
-- lib/yle_tf_plugins/backends/file/command.rb
-- lib/yle_tf_plugins/backends/file/config.rb
+- lib/yle_tf_plugins/backends/__default/plugin.rb
+- lib/yle_tf_plugins/backends/file/backend.rb
 - lib/yle_tf_plugins/backends/file/plugin.rb
-- lib/yle_tf_plugins/backends/s3/command.rb
-- lib/yle_tf_plugins/backends/s3/plugin.rb
-- lib/yle_tf_plugins/backends/swift/command.rb
-- lib/yle_tf_plugins/backends/swift/plugin.rb
 - lib/yle_tf_plugins/commands/__default/command.rb
 - lib/yle_tf_plugins/commands/__default/plugin.rb
 - lib/yle_tf_plugins/commands/_config/command.rb
@@ -135,15 +161,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Tooling for Terraform