pronto-terraform_format 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdc959164cd3d2df08770f87d939291167e72348c43f79254bbb0d4bdca93455
+  data.tar.gz: 414787306f0bf68e4a454bc0c3c64fd26059702fbbe9c4e6747dfc477c0b8e17
+SHA512:
+  metadata.gz: 2559b22a5b2fec7b72962c5649819c0f0e676400080a36644e43ae452ee5f775148fc2a90b748c8ba3cbc7e3644ecd20b09ba95394885bc2f5c88856fbe1de0d
+  data.tar.gz: 3da9bea69e1b5563ba32dcc7b162461d78ba6feefeb27eb9c09d226498092a53b349d3b79349fdd1980b09467a8af2adcfa9f3d62f861c25ebf4da72efbcf9a8

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Documentation:
+  Enabled: false
+
+SignalException:
+  EnforcedStyle: only_raise
+
+MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+before_install:
+  - curl -fSL "https://releases.hashicorp.com/terraform/0.11.7/terraform_0.11.7_linux_amd64.zip" -o terraform.zip
+  - sudo unzip terraform.zip -d /opt/terraform
+  - sudo ln -s /opt/terraform/terraform /usr/bin/terraform
+  - rm -f terraform.zip
+

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.5-alpine
+
+RUN apk add --no-cache --virtual .builddeps make cmake musl-dev gcc \
+ && gem install --no-document pronto-terraform_format \
+ && apk del .builddeps
+
+ENV TERRAFORM_VERSION=0.11.7
+
+RUN apk --update add ca-certificates curl
+RUN curl -LOs https://releases.hashicorp.com/terraform/${TERRAFORM_VERSION}/terraform_${TERRAFORM_VERSION}_linux_amd64.zip
+RUN unzip terraform_${TERRAFORM_VERSION}_linux_amd64.zip -d /usr/bin/
+RUN rm -rf /var/cache/apk/* terraform_${TERRAFORM_VERSION}_linux_amd64.zip
+
+ENTRYPOINT ["pronto"]

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrius Janauskas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,13 @@
+# Pronto runner for terraform format
+
+[![Build Status](https://travis-ci.org/kjmkznr/pronto-terraform_format.svg?branch=master)](https://travis-ci.org/kjmkznr/pronto-terraform_format)
+
+Pronto runner for [Terraform](https://www.terraform.io) format, a tool to reformat Terraform standard style.
+
+## Prerequisite
+
+You'll need to install terraform cli.
+
+## Configuration
+
+To use an absolute path to your terraform cli, use `PRONTO_TERRAFORM_PATH`.

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/pronto/terraform_format/output_parser.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'unified_diff'
+
+module Pronto
+  module TerraformFormat
+    class OutputParser
+      def parse(file_path, output)
+        begin
+          # skip first line
+          diff = UnifiedDiff.parse(output.lines[3..output.lines.length].join(''))
+        rescue StandardError => e
+          puts "pronto-terraform_format ERROR: failed to parse output. #{e}"
+          return {}
+        end
+
+        result = {}
+        diff.chunks.each do |chunk|
+          file = file_path
+          result[file] ||= []
+          result[file] << {
+            file: file,
+            line: chunk.modified_range.min,
+            message: 'Needs to run terraform fmt'
+          }
+        end
+        result
+      end
+    end
+  end
+end

data/lib/pronto/terraform_format/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pronto
+  module TerraformFormat
+    VERSION = '0.0.1'.freeze
+  end
+end

data/lib/pronto/terraform_format/wrapper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'open3'
+require_relative 'output_parser'
+
+module Pronto
+  module TerraformFormat
+    class Wrapper
+      def initialize
+        @terraform_path = ENV['PRONTO_TERRAFORM_PATH'] || 'terraform'
+      end
+
+      def run(file_path)
+        stdout, stderr, = Open3.capture3("#{@terraform_path} "\
+                                         'fmt '\
+                                         '-write=false '\
+                                         '-list=false '\
+                                         '-diff=true '\
+                                         '-check=false '\
+                                         "#{file_path}")
+        if stderr && !stderr.empty?
+          puts "WARN: pronto-terraform_format: #{file_path}: #{stderr}"
+        end
+        return [] if stdout.nil? || stdout == 0
+        OutputParser.new.parse(file_path, stdout)
+      end
+    end
+  end
+end

data/lib/pronto/terraform_format.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'pronto/terraform_format/version'
+require_relative 'terraform_format_runner'

data/lib/pronto/terraform_format_runner.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'pronto/terraform_format/wrapper'
+require 'pronto'
+
+module Pronto
+  class TerraformFormatRunner < Runner
+    def initialize(patches, commit = nil)
+      super
+      @inspector = ::Pronto::TerraformFormat::Wrapper.new
+      if ENV['PRONTO_TERRAFORM_FORMAT_FILE_EXTS'].nil?
+        @tf_extensions = %w[.tf .tfvars]
+      else
+        comma_separated_exts = ENV['PRONTO_TERRAFORM_FORMAT_FILE_EXTS']
+        @tf_extensions = comma_separated_exts.split(',').map(&:strip)
+      end
+    end
+
+    def run
+      return [] if !@patches || @patches.count.zero?
+      @patches
+        .select { |p| tf_file?(p.new_file_full_path) }
+        .map { |p| inspect(p) }
+        .flatten.compact
+        .uniq(&:line) # generate only one message per line
+    end
+
+    def inspect(patch)
+      messages = []
+
+      file_path = patch.new_file_full_path.to_s
+      offences = @inspector.run(file_path)
+      if not offences[file_path].nil?
+        offences[file_path].each do |offence|
+          messages += patch
+            .added_lines
+            .select { |line| line.new_lineno == offence[:line] }
+            .map { |line| new_message(offence, line) }
+        end
+      end
+
+      messages.compact
+    end
+
+    def tf_file?(file_path)
+      @tf_extensions.include? File.extname(file_path)
+    end
+
+    def new_message(offence, line)
+      Message.new(
+        offence[:file],
+        line,
+        :warning,
+        offence[:message],
+        nil,
+        self.class
+      )
+    end
+  end
+end

data/pronto-terraform_format.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pronto/terraform_format/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pronto-terraform_format'
+  spec.version       = Pronto::TerraformFormat::VERSION
+  spec.authors       = ['Kazunori Kojima']
+  spec.email         = ['kjm.kznr@gmail.com']
+
+  spec.summary       = 'Pronto runner for Terraform'
+  spec.description   = <<-EOF
+    A pronto runner for Terraform.
+  EOF
+  spec.homepage      = 'https://github.com/kjmkznr/pronto-terraform_format'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'pronto', '~> 0.9.0'
+  spec.add_dependency 'unified_diff', '~> 0.3.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'rubocop', '~> 0.57'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: pronto-terraform_format
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kazunori Kojima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: unified_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
+description: "    A pronto runner for Terraform.\n"
+email:
+- kjm.kznr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pronto/terraform_format.rb
+- lib/pronto/terraform_format/output_parser.rb
+- lib/pronto/terraform_format/version.rb
+- lib/pronto/terraform_format/wrapper.rb
+- lib/pronto/terraform_format_runner.rb
+- pronto-terraform_format.gemspec
+homepage: https://github.com/kjmkznr/pronto-terraform_format
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Pronto runner for Terraform
+test_files: []