terraspace 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9b4a9918ee0ab0e10c6c4d2d0ed1a88851fda09b7a6b1475db084c6f7cb1699
-  data.tar.gz: 2b66a6e8be57c94aaf24334a073943c28e11fbcd77f1d7853cf0885e9e87ec9e
+  metadata.gz: 56392f488a05d42760586d379da36022589979733b654ea3f5f3d5fcb879de26
+  data.tar.gz: 690b3d0fa3e192aee02fd34ae187ab4628caccd335a1733ce10040ff2ef55b32
 SHA512:
-  metadata.gz: dcabae82c7a30ddcc364a13ce85f73ce461307cde54ab95fd2fb1d2c21558c03123058c8d282e339ae4f47f0fd927061eee12d74ba71f403cc6b7cb9f7fd8e3e
-  data.tar.gz: f8c625671745fccdb13139efcd13c737b6f4a2ee0161badc75677bdedc544a94566c0eb8e865c2c68635bab7c648232d7275b88f20d0f9a8677d74b74c95c75f
+  metadata.gz: 4dcc7b6c1d1f2d21be6115d02cc34bbeb9f773e6ece16e8549ac3a8e6a4167fb6392a2917399399a0ba0ddde4ff880c9dff8de2ee5261def5250fc2525527ce1
+  data.tar.gz: 476d2c10897c2915a3cd601b556e783a639cb29a97c11505b5e34f32d8079c311e5ad8f6efeeee6cf9a143a2f63b9b46b76a9b6741d78802fd53baf8de319b29

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.6.4] - 2021-03-22
+- [#94](https://github.com/boltops-tools/terraspace/pull/94) terraspace fmt command
+
 ## [0.6.3] - 2021-03-12
 - [#91](https://github.com/boltops-tools/terraspace/pull/91) Camelcase
 - [#92](https://github.com/boltops-tools/terraspace/pull/92) disable terraform.plugin_cache by default

data/lib/terraspace/cli.rb

@@ -82,6 +82,12 @@ module Terraspace
       Down.new(options.merge(mod: mod)).run
     end
 
+    desc "fmt", "Run terraform fmt"
+    long_desc Help.text(:fmt)
+    def fmt
+      Fmt.new(options).run
+    end
+
     desc "info STACK", "Get info about stack."
     long_desc Help.text(:info)
     instance_option.call

data/lib/terraspace/cli/concerns/source_dirs.rb

@@ -0,0 +1,13 @@
+module Terraspace::CLI::Concerns
+  module SourceDirs
+    # used by list
+    def source_dirs
+      Dir.glob("{app,vendor}/{modules,stacks}/*").select { |p| File.directory?(p) }.sort
+    end
+
+    # dont include vendor: used by fmt
+    def app_source_dirs
+      Dir.glob("{app}/{modules,stacks}/*").select { |p| File.directory?(p) }.sort
+    end
+  end
+end

data/lib/terraspace/cli/fmt.rb

@@ -0,0 +1,21 @@
+class Terraspace::CLI
+  class Fmt
+    include Concerns::SourceDirs
+    include Terraspace::Util::Logging
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def run
+      logger.info "Formating terraform files"
+      app_source_dirs.each do |dir|
+        format(dir)
+      end
+    end
+
+    def format(dir)
+      Runner.new(dir).format!
+    end
+  end
+end

data/lib/terraspace/cli/fmt/runner.rb

@@ -0,0 +1,64 @@
+class Terraspace::CLI::Fmt
+  class Runner
+    include Terraspace::CLI::Concerns::SourceDirs
+    include Terraspace::Util::Logging
+    SKIP_PATTERN = /\.skip$/
+
+    def initialize(dir)
+      @dir = dir
+    end
+
+    def format!
+      logger.info @dir.color(:green)
+      Dir.chdir(@dir) do
+        skip_rename
+        begin
+          terraform_fmt
+        ensure
+          restore_rename
+        end
+      end
+    end
+
+    def skip_rename
+      tf_files.each do |path|
+        if !skip?(path) && erb?(path)
+          FileUtils.mv(path, "#{path}.skip")
+        end
+      end
+    end
+
+    def terraform_fmt
+      sh "terraform fmt"
+    end
+
+    def sh(command)
+      logger.debug("=> #{command}")
+      success = system(command)
+      return if success
+      logger.info "WARN: There were some errors running terraform fmt for files in #{@dir}:".color(:yellow)
+      logger.info "The errors are shown above"
+    end
+
+    def restore_rename
+      tf_files.each do |path|
+        if skip?(path) && erb?(path)
+          FileUtils.mv(path, path.sub(SKIP_PATTERN, '')) # original name
+        end
+      end
+    end
+
+  private
+    def skip?(path)
+      !!(path =~ SKIP_PATTERN)
+    end
+
+    def erb?(path)
+      IO.readlines(path).detect { |l| l.include?('<%') }
+    end
+
+    def tf_files
+      Dir.glob("#{Terraspace.root}/#{@dir}/**/*.{tf,skip}").select { |p| File.file?(p) }
+    end
+  end
+end

data/lib/terraspace/cli/help/fmt.md

@@ -0,0 +1,10 @@
+## Example
+
+    $ terraspace fmt
+    Formating terraform files
+    app/modules/example
+    main.tf
+    outputs.tf
+    variables.tf
+    app/stacks/demo
+    main.tf

data/lib/terraspace/cli/list.rb

@@ -1,13 +1,14 @@
 class Terraspace::CLI
   class List
+    include Concerns::SourceDirs
+
     def initialize(options={})
       @options = options
       @type_dir = normalized_type
     end
 
     def run
-      dirs = Dir.glob("{app,vendor}/{modules,stacks}/*").select { |p| File.directory?(p) }
-      dirs.sort.each do |path|
+      source_dirs.each do |path|
         if @type_dir
           puts path if path.include?("/#{@type_dir}/")
         else

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -482,7 +482,10 @@ files:
 - lib/terraspace/cli/completer.rb
 - lib/terraspace/cli/completer/script.rb
 - lib/terraspace/cli/completer/script.sh
+- lib/terraspace/cli/concerns/source_dirs.rb
 - lib/terraspace/cli/down.rb
+- lib/terraspace/cli/fmt.rb
+- lib/terraspace/cli/fmt/runner.rb
 - lib/terraspace/cli/help.rb
 - lib/terraspace/cli/help/all/down.md
 - lib/terraspace/cli/help/all/graph.md
@@ -504,6 +507,7 @@ files:
 - lib/terraspace/cli/help/completion_script.md
 - lib/terraspace/cli/help/console.md
 - lib/terraspace/cli/help/down.md
+- lib/terraspace/cli/help/fmt.md
 - lib/terraspace/cli/help/info.md
 - lib/terraspace/cli/help/init.md
 - lib/terraspace/cli/help/list.md