guard-terraform 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca3ea8a74f9eff42a135900b1365b7ef91ad4d8ab8a8860bb67478e7518be6e2
+  data.tar.gz: a31ec380ad1a26eae1e58a068aa9b9ca36bf65c6f14ab34808cab3bc1ccd9317
+SHA512:
+  metadata.gz: fc02153c09113c7b6c7d6b45c8ad94b3cb2bba8e551ec7178bbcd6f62125ea667e950949735b505c0b9a83d8120ee03a7f56c485490b4d2a91de982fc0b598bb
+  data.tar.gz: 39c791ea2b260282696c1c6495f00df39cf322a8ccf57c89702096e44c53290e755c7e06de003f7bd1148c95a5c2b4a597c6022d903d9608004c1ccf28b1e13f

data/lib/guard/terraform.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'guard/plugin'
+
+require 'guard/terraform/version'
+require 'terraform'
+
+module Guard
+  # Guard plugin for checking Terraform configuration style
+  class Terraform < Plugin
+    # Include the `VERSION` constant
+    include TerraformVersion
+
+    DEFAULT_OPTIONS = {
+      all_on_start: true,   # check all files on start?
+
+      diff:         true,   # show diffs of the changes?
+      write:        false,  # fix the formatting instead of just verifying?
+    }.freeze
+
+    attr_reader :options, :terraform, :tf_flags
+
+    def initialize(**options)
+      super
+
+      options = DEFAULT_OPTIONS.merge(options)
+
+      @options = {
+        all_on_start: options[:all_on_start],
+      }
+
+      # Enforce boolean values as they get passed to CLI
+      @tf_flags = {
+        diff:  !!options[:diff],  # rubocop:disable Style/DoubleNegation
+        write: !!options[:write], # rubocop:disable Style/DoubleNegation
+        check: !options[:write],
+      }
+
+      @terraform = ::Terraform.new
+    end
+
+    def start
+      UI.info "#{self.class} started"
+      UI.info "Terraform version: #{terraform.version}"
+
+      raise(StandardError, 'Terraform not found') if !terraform.version
+
+      run_all if options[:all_on_start]
+    end
+
+    def run_all
+      if terraform.pre_0_12?
+        # Terraform v<0.12 does not check *.tfvars by default,
+        # so collect them to the list, too
+        run(all_tf_files)
+      else
+        run('.', recursive: true)
+      end
+    end
+
+    def run_on_modifications(paths)
+      run(mungle_paths(paths))
+    end
+
+    alias run_on_additions run_on_modifications
+
+    def run(paths, **extra_flags)
+      flags = tf_flags.merge(extra_flags)
+
+      result = terraform.fmt(paths, flags) do |path, cmd|
+        UI.info("#{flags[:write] ? 'Enforcing' : 'Inspecting'} Terraform formatting: #{path}")
+        UI.debug(Shellwords.join(cmd))
+      end
+
+      return if result
+
+      notify_failure
+      throw(:task_has_failed)
+    end
+
+    def notify_failure
+      Notifier.notify(
+        'Terraform format check failed',
+        title: self.class.to_s,
+        image: :failed
+      )
+    end
+
+    # Returns list of all Terraform files
+    def all_tf_files
+      Dir['**/*.{tf,tfvars}']
+    end
+
+    # Terraform 0.12+ only supports checking directories,
+    # older versions accept also files
+    def mungle_paths(paths)
+      return paths if terraform.pre_0_12?
+
+      paths.map do |path|
+        File.directory?(path) ? path : File.dirname(path)
+      end.uniq
+    end
+  end
+end

data/lib/guard/terraform/templates/Guardfile

@@ -0,0 +1,10 @@
+# Options and default values
+#
+#   all_on_start: true  - check all files on start?
+#   diff: true          - show diffs of the changes?
+#   write: false        - fix the formatting instead of just verifying?
+#
+guard :terraform, write: false do
+  watch(/\.tf$/)
+  watch(/\.tfvars$/)
+end

data/lib/guard/terraform/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Guard
+  # Use own namespace to avoid inheriting from `Guard::Plugin`
+  module TerraformVersion
+    VERSION = '1.0.0'
+  end
+end

data/lib/terraform.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'terraform/version_requirement'
+
+# Wrapper for Terraform commands
+class Terraform
+  def fmt(paths, **flags)
+    base_cmd = %w[terraform fmt] + cli_flags(flags)
+
+    Array(paths).inject(true) do |result, path|
+      cmd = base_cmd + [path]
+
+      yield(path, cmd) if block_given?
+
+      system(*cmd) && result # carry on failure
+    end
+  end
+
+  # Find out current Terraform version
+  def version
+    @version ||= begin
+      m = /^Terraform v(?<version>[^\s]+)/.match(`terraform version`)
+      m && m[:version]
+    end
+  rescue Errno::ENOENT
+    nil
+  end
+
+  # Checks if the version is older than 0.12
+  def pre_0_12?
+    VersionRequirement.new('< 0.12.0-alpha').satisfied_by?(version)
+  end
+
+  # Returns `Array` of CLI flags for Terraform
+  # E.g. `{ foo: true, bar: 'baz' }` -> `[ '-foo=true', '-bar=baz' ]`
+  def cli_flags(**flags)
+    flags.map { |k, v| "-#{k}=#{v}" }
+  end
+end

data/lib/terraform/version_requirement.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Terraform
+  # Helper class for checking if versions match requirements
+  class VersionRequirement
+    attr_reader :requirement
+
+    def initialize(requirement)
+      @requirement = requirement && Gem::Requirement.new(*requirement)
+    end
+
+    def satisfied_by?(version)
+      !requirement || requirement.satisfied_by?(Gem::Version.new(version))
+    end
+
+    def to_s
+      requirement.to_s
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: guard-terraform
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Teemu Matilainen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Guard plugin for checking and optionally fixing Terraform configuration
+  formatting and style.
+email:
+- teemu.matilainen@iki.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/guard/terraform.rb
+- lib/guard/terraform/templates/Guardfile
+- lib/guard/terraform/version.rb
+- lib/terraform.rb
+- lib/terraform/version_requirement.rb
+homepage: https://github.com/tmatilai/guard-terraform
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tmatilai/guard-terraform
+  source_code_uri: https://github.com/tmatilai/guard-terraform
+  documentation_uri: https://github.com/tmatilai/guard-terraform#readme
+  changelog_uri: https://github.com/tmatilai/guard-terraform/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/tmatilai/guard-terraform/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Guard plugin for Terraform configuration format
+test_files: []