terraspace_hooks 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c8425e565615e04f849ac80b7b5ef892fe9b8b517d5f49c768ba951cbeeafa0
-  data.tar.gz: 16e2cdc8ea72c276caa1bdd58d0ff736e80b6b2505d0e124470467027f169395
+  metadata.gz: 88a091069723549e82176aec851e7796e97757a3e05c466b5700af981e4b4b3e
+  data.tar.gz: 7c92d6e9a25961c6247cb9ef895cd69d96c9c7c4139ef4c56787a8894157858e
 SHA512:
-  metadata.gz: b8c48cbcc411d5c8528cbc82106b4e3a848ed96d6ac7131a7a0db2431ab35fbe57d3560828efe7eef9b2be61f9ce808ff140951a4315c8362eb1b1b19f95d67b
-  data.tar.gz: d82ccce566a807540c22c3adc3dab2d024741fa95989f4bd11f09e430b90c6ec51213a7f963fe826b88ac8c6adafce1c03ad101f9529766c681acf4b4ed7825b
+  metadata.gz: 41dea204776e26e5e3f95fcd1f4af172066866caafe376a59d0ab646390eea6e7ffcc43ca74d7fdc68dde9b0738ff0d94c316623068e325663ea8c1069128a2e
+  data.tar.gz: ae9cc8efa4fe98b87ef1dcc8297bd574bca10fa8de961ac70afe3eb75106600dc7f281d97702da5d767edea9b11d23745aeeda16261e4cde1cc25e4cb5ad0c3f

data/.rubocop.yml

@@ -1,13 +1,3 @@
-AllCops:
-  TargetRubyVersion: 2.6
+inherit_from: .rubocop_todo.yml
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
+require: rubocop-rake

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-03-23 23:34:39 UTC using RuboCop version 1.44.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/Gemfile

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in terraspace_hooks.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "minitest", "~> 5.0"
+gem 'minitest', '~> 5.0'
 
-gem "rubocop", "~> 1.21"
+gem 'standard'
+
+gem 'rubocop-rake'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    terraspace_hooks (0.1.0)
+    terraspace_hooks (0.2.1)
       zeitwerk (~> 2.6.7)
 
 GEM
@@ -9,6 +9,7 @@ GEM
   specs:
     ast (2.4.2)
     json (2.6.3)
+    language_server-protocol (3.17.0.3)
     minitest (5.17.0)
     parallel (1.22.1)
     parser (3.2.1.0)
@@ -17,30 +18,41 @@ GEM
     rake (13.0.6)
     regexp_parser (2.7.0)
     rexml (3.2.5)
-    rubocop (1.46.0)
+    rubocop (1.44.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.26.0)
       parser (>= 3.2.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
+    standard (1.24.3)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.44.1)
+      rubocop-performance (= 1.15.2)
     unicode-display_width (2.4.2)
     zeitwerk (2.6.7)
 
 PLATFORMS
   arm64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
-  rubocop (~> 1.21)
+  rubocop-rake
+  standard
   terraspace_hooks!
 
 BUNDLED WITH
-   2.4.7
+   2.4.8

data/README.md

@@ -15,15 +15,49 @@ Install the gem and add to the application's Gemfile by executing:
 ```ruby
 
 # inside config/hooks/terraform.rb
+
+# run `tflint` before # terraform plan
 before("plan", execute: TerraspaceHooks::TflintValidator)
+
+# run `terraform validate` before terraform plan
 before("plan", execute: TerraspaceHooks::TfValidator)
+
+# generate infracost output after terraform plan
 after("plan", execute: TerraspaceHooks::InfracostGenerator)
+```
 
+```ruby
 # inside config/hooks/terraspace.rb
+
+# Run `terraform fmt` after terraspace build
 after("build", execute: TerraspaceHooks::TfFmtValidator)
+
+# Run `tfsec` after terraspace build
 after("build", execute: TerraspaceHooks::TfsecValidator)
 ```
 
+To use InfracostGenerator, you need to add this line in
+`config/args/terraform.rb`
+
+```ruby
+command("plan", args: ["-out tfplan.binary"])
+```
+
+Setting this each environment_variable below will skip the correspondent hook.
+
+```bash
+SKIP_TERRASPACE_HOOKS_TFSEC_VALIDATOR=1
+SKIP_TERRASPACE_HOOKS_TFLINT_VALIDATOR=1
+SKIP_TERRASPACE_HOOKS_TF_VALIDATOR=1
+SKIP_TERRASPACE_HOOKS_TF_FMT_VALIDATOR=1
+SKIP_TERRASPACE_HOOKS_INFRACOST_GENERATOR=1
+
+# or
+
+SKIP_TERRASPACE_HOOKS_ALL=1
+# to skip all the hooks
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'standard/rake'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]
+task default: %i[test standard:fix]

data/lib/terraspace_hooks/infracost_generator.rb

@@ -1,33 +1,39 @@
+# frozen_string_literal: true
+
 module TerraspaceHooks
+  # generate infracost breakdown
   class InfracostGenerator
+    # rubocop:disable Metrics/MethodLength
     def call(runner)
-      raise "Infracost not available" unless infracost_available?
-      raise "Terraform not available" unless terraform_available?
+      raise 'Infracost not available' unless infracost_available?
+      raise 'Terraform not available' unless terraform_available?
 
       mod = runner.mod
-      command = <<-EOF
-      YELLOW='\033[0;33m'
-      NC='\033[0m'
-      cd #{mod.cache_dir} && \
-      echo "${YELLOW}[INFO #{mod.name}]${NC} Convert to plan.json..." && \
-      terraform show -json tfplan.binary > plan.json && \
+      command = <<-COMMAND
+        YELLOW='\033[0;33m'
+        NC='\033[0m'
+        cd #{mod.cache_dir} && \
+        echo "${YELLOW}[INFO #{mod.name}]${NC} Convert to plan.json..." && \
+        terraform show -json tfplan.binary > plan.json && \
 
-      echo "${YELLOW}[INFO #{mod.name}]${NC} Infracost breakdown for #{mod.name}..." && \
-      infracost breakdown --project-name #{mod.name} --path plan.json --format json --out-file infracost_breakdown.json && \
-      infracost output --path infracost_breakdown.json --format table --show-skipped
-      EOF
+        echo "${YELLOW}[INFO #{mod.name}]${NC} Infracost breakdown for #{mod.name}..." && \
+        infracost breakdown --project-name #{mod.name} --path plan.json --format json --out-file infracost_breakdown.json && \
+        infracost output --path infracost_breakdown.json --format table --show-skipped
+      COMMAND
 
-      return if ENV["SKIP_TERRASPACE_HOOKS_INFRACOST_GENERATOR"]
+      return if ENV['SKIP_TERRASPACE_HOOKS_ALL']
+      return if ENV['SKIP_TERRASPACE_HOOKS_INFRACOST_GENERATOR']
 
-      system(command)
+      system(command, exception: true)
     end
+    # rubocop:enable Metrics/MethodLength
 
     def infracost_available?
-      system("which infracost")
+      system('which infracost')
     end
 
     def terraform_available?
-      system("which terraform")
+      system('which terraform')
     end
   end
 end

data/lib/terraspace_hooks/tf_fmt_validator.rb

@@ -1,24 +1,30 @@
+# frozen_string_literal: true
+
 module TerraspaceHooks
+  # validate the terraform code with terraform fmt
   class TfFmtValidator
+    # rubocop:disable Metrics/MethodLength
     def call(runner)
-      raise "Terraform not available" unless terraform_available?
+      raise 'Terraform not available' unless terraform_available?
 
       mod = runner.mod
-      command = <<-EOF
-      YELLOW='\033[0;33m'
-      NC='\033[0m'
-      cd #{mod.cache_dir} && \
-      echo "${YELLOW}[INFO #{mod.name}]${NC} Run terraform fmt for #{mod.name}..." && \
-      terraform fmt
-      EOF
+      command = <<-COMMAND
+        YELLOW='\033[0;33m'
+        NC='\033[0m'
+        cd #{mod.cache_dir} && \
+        echo "${YELLOW}[INFO #{mod.name}]${NC} Run terraform fmt for #{mod.name}..." && \
+        terraform fmt
+      COMMAND
 
-      return if ENV["SKIP_TERRASPACE_HOOKS_TF_FMT_VALIDATOR"]
+      return if ENV['SKIP_TERRASPACE_HOOKS_ALL']
+      return if ENV['SKIP_TERRASPACE_HOOKS_TF_FMT_VALIDATOR']
 
-      system(command)
+      system(command, exception: true)
     end
+    # rubocop:enable Metrics/MethodLength
 
     def terraform_available?
-      system("which terraform")
+      system('which terraform')
     end
   end
 end

data/lib/terraspace_hooks/tf_validator.rb

@@ -1,24 +1,30 @@
+# frozen_string_literal: true
+
 module TerraspaceHooks
+  # validate the terraform code with terraform validate
   class TfValidator
+    # rubocop:disable Metrics/MethodLength
     def call(runner)
-      raise "Terraform not available" unless terraform_available?
+      raise 'Terraform not available' unless terraform_available?
 
       mod = runner.mod
-      command = <<-EOF
-      YELLOW='\033[0;33m'
-      NC='\033[0m'
-      cd #{mod.cache_dir} && \
-      echo "${YELLOW}[INFO #{mod.name}]${NC} Run terraform validate for #{mod.name}..." && \
-      terraform validate
-      EOF
+      command = <<-COMMAND
+        YELLOW='\033[0;33m'
+        NC='\033[0m'
+        cd #{mod.cache_dir} && \
+        echo "${YELLOW}[INFO #{mod.name}]${NC} Run terraform validate for #{mod.name}..." && \
+        terraform validate
+      COMMAND
 
-      return if ENV["SKIP_TERRASPACE_HOOKS_TF_VALIDATOR"]
+      return if ENV['SKIP_TERRASPACE_HOOKS_ALL']
+      return if ENV['SKIP_TERRASPACE_HOOKS_TF_VALIDATOR']
 
-      system(command)
+      system(command, exception: true)
     end
+    # rubocop:enable Metrics/MethodLength
 
     def terraform_available?
-      system("which terraform")
+      system('which terraform')
     end
   end
 end

data/lib/terraspace_hooks/tflint_validator.rb

@@ -1,24 +1,30 @@
+# frozen_string_literal: true
+
 module TerraspaceHooks
+  # validate the terraform code with tflint
   class TflintValidator
+    # rubocop:disable Metrics/MethodLength
     def call(runner)
-      raise "Tflint not available" unless tflint_available?
+      raise 'Tflint not available' unless tflint_available?
 
       mod = runner.mod
-      command = <<-EOF
-      YELLOW='\033[0;33m'
-      NC='\033[0m'
-      cd #{mod.cache_dir} && \
-      echo "${YELLOW}[INFO #{mod.name}]${NC} Run tflint for #{mod.name}..." && \
-      tflint . --disable-rule=terraform_required_version --module
-      EOF
+      command = <<-COMMAND
+        YELLOW='\033[0;33m'
+        NC='\033[0m'
+        cd #{mod.cache_dir} && \
+        echo "${YELLOW}[INFO #{mod.name}]${NC} Run tflint for #{mod.name}..." && \
+        tflint . --disable-rule=terraform_required_version --module
+      COMMAND
 
-      return if ENV["SKIP_TERRASPACE_HOOKS_TFLINT_VALIDATOR"]
+      return if ENV['SKIP_TERRASPACE_HOOKS_ALL']
+      return if ENV['SKIP_TERRASPACE_HOOKS_TFLINT_VALIDATOR']
 
-      system(command)
+      system(command, exception: true)
     end
+    # rubocop:enable Metrics/MethodLength
 
     def tflint_available?
-      system("which tflint")
+      system('which tflint')
     end
   end
 end

data/lib/terraspace_hooks/tfsec_validator.rb

@@ -1,24 +1,30 @@
+# frozen_string_literal: true
+
 module TerraspaceHooks
+  # validate the terraform code with tfsec
   class TfsecValidator
+    # rubocop:disable Metrics/MethodLength
     def call(runner)
-      raise "Tfsec not available" unless tfsec_available?
+      raise 'Tfsec not available' unless tfsec_available?
 
       mod = runner.mod
-      command = <<-EOF
-      YELLOW='\033[0;33m'
-      NC='\033[0m'
-      cd #{mod.cache_dir} && \
-      echo "${YELLOW}[INFO #{mod.name}]${NC} Run tfsec for #{mod.name}..." && \
-      tfsec --concise-output
-      EOF
+      command = <<-COMMAND
+        YELLOW='\033[0;33m'
+        NC='\033[0m'
+        cd #{mod.cache_dir} && \
+        echo "${YELLOW}[INFO #{mod.name}]${NC} Run tfsec for #{mod.name}..." && \
+        tfsec --concise-output
+      COMMAND
 
-      return if ENV["SKIP_TERRASPACE_HOOKS_TFSEC_VALIDATOR"]
+      return if ENV['SKIP_TERRASPACE_HOOKS_ALL']
+      return if ENV['SKIP_TERRASPACE_HOOKS_TFSEC_VALIDATOR']
 
-      system(command)
+      system(command, exception: true)
     end
+    # rubocop:enable Metrics/MethodLength
 
     def tfsec_available?
-      system("which tfsec")
+      system('which tfsec')
     end
   end
 end

data/lib/terraspace_hooks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TerraspaceHooks
-  VERSION = "0.1.1"
+  VERSION = '0.2.2'
 end

data/lib/terraspace_hooks.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require "zeitwerk"
+require 'zeitwerk'
 loader = Zeitwerk::Loader.for_gem
 loader.setup
 
+# TerraspaceHooks is the namespace for all Terraspace Hooks
 module TerraspaceHooks
 end
 

data/terraspace_hooks.gemspec

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-require_relative "lib/terraspace_hooks/version"
+require_relative 'lib/terraspace_hooks/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "terraspace_hooks"
+  spec.name = 'terraspace_hooks'
   spec.version = TerraspaceHooks::VERSION
-  spec.authors = ["slamet kristanto"]
-  spec.email = ["botoksgonzales@gmail.com"]
+  spec.authors = ['slamet kristanto']
+  spec.email = ['botoksgonzales@gmail.com']
 
-  spec.summary = "Useful terraspace hook collection (infracost generator, tflint, tf validate)"
-  spec.description = "Useful terraspace hook collection (infracost generator, tflint, tf validate)"
-  spec.homepage = "https://github.com/drselump14/terraspace_hooks"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = 'Useful terraspace hook collection (infracost generator, tflint, tf validate)'
+  spec.description = 'Useful terraspace hook collection (infracost generator, tflint, tf validate)'
+  spec.homepage = 'https://github.com/drselump14/terraspace_hooks'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/drselump14/terraspace_hooks"
-  spec.metadata["changelog_uri"] = "https://github.com/drselump14/terraspace_hooks"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/drselump14/terraspace_hooks'
+  spec.metadata['changelog_uri'] = 'https://github.com/drselump14/terraspace_hooks'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,12 +25,12 @@ Gem::Specification.new do |spec|
       (File.expand_path(f) == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "zeitwerk", "~> 2.6.7"
+  spec.add_dependency 'zeitwerk', '~> 2.6.7'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace_hooks
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - slamet kristanto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-27 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -70,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Useful terraspace hook collection (infracost generator, tflint, tf validate)