terraspace 2.2.8 → 2.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5477cf33cd5e864e5b7117cdc129d4aaa96a9f6ff9255093e9499180e67068f8
-  data.tar.gz: 3dc0b9113b44f7e0d10019aeb22898b8045f8de0be3c60a756d9bda588847184
+  metadata.gz: 868708d6fa642b4d3d594202aeadff28af0e2ec106628a0e7853f83b0ad27824
+  data.tar.gz: b03c9dff474ed98d929a54ef85598df335870c1e668aa39004ebada3e7115cfc
 SHA512:
-  metadata.gz: 15da8006c07825c64446444c58e2efa4c22baeeda85da0abcf5d2d54e16e35e9929c6a636885a969fc12a9918ff74df90b34f88147141f0bc53c170061be0964
-  data.tar.gz: 499ebbabe6e904e6d3800c7d18b8b830c1130aee5faf07a317159d63e63eeeb96bf9483416efcf59a9d8753f5b0f09648b1595da56591751ce389d6d7710c3d7
+  metadata.gz: 66d7030cc8995f2524f651bc5d0a8e3a3a42cbbde5c14e869f5f49b7a86dfb157c2ba7f6d81f3515f1a151252f62edc9f206b66303b3d30eb0d76d683dd4ee28
+  data.tar.gz: '0910ebbc15e648c59682af6b014e73a3e54f54daac34c5975bebf4878f3751f43f9f3085b04e9aa6810307f69b290fe14d970b69295f4b54452795ffd43db7f4'

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 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.
 
+## [2.2.10] - 2023-08-23
+- [#324](https://github.com/boltops-tools/terraspace/pull/324) terraspace check
+
+## [2.2.9] - 2023-08-23
+- [#323](https://github.com/boltops-tools/terraspace/pull/323) Restrict terraform version due to terraform BSL license change
+- send terraform version to all terraspace cloud requests
+
 ## [2.2.8] - 2023-06-27
 - Fix exit status for fmt
 

data/lib/terraspace/builder.rb

@@ -23,7 +23,7 @@ module Terraspace
 
     def run
       return if @options[:build] == false
-      Terraspace::CLI::Setup::Check.check!
+      Terraspace::Check.check!
       check_allow!
       @mod.root_module = true
       clean

data/lib/terraspace/check.rb

@@ -0,0 +1,142 @@
+module Terraspace
+  class Check
+    extend Memoist
+
+    attr_reader :min_terraform_version, :max_terraform_version
+    def initialize(options={})
+      @options = options
+      # Terraspace requires this terraform version or a fork
+      @min_terraform_version = "0.12"
+      @max_terraform_version = "1.5.5"
+    end
+
+    # Used for the CLI
+    def run
+      puts "terraspace version: #{Terraspace::VERSION}"
+      if terraform_bin
+        puts "#{terraform_bin_name} bin: #{terraform_bin}"
+        puts "#{terraform_bin_name} version: #{terraform_version}"
+        # check for allowed version of terraform
+        if allowed_terraform_version?
+          puts "You're all set!".color(:green)
+        else
+          puts "terraspace requires terraform between v#{@min_terraform_version}.x and #{@max_terraform_version}".color(:red)
+          puts <<~EOL
+            This is because newer versions of terraform has a BSL license
+            If your usage is allowed by the license, you can bypass this check with:
+
+                export TS_VERSION_CHECK=0
+
+            Note: If you're using Terraspace Cloud, you won't be able to bypass this check.
+            See: https://terraspace.cloud/docs/terraform/license/
+          EOL
+          exit 1
+        end
+      else
+        puts terraform_is_not_installed
+        exit 1
+      end
+    end
+    alias ok! run
+
+    # aliased with ok?
+    def allowed_terraform_version?
+      return true if ENV['TS_VERSION_CHECK'] == '0' && Terraspace.cloud?
+      return false unless terraform_bin
+      return true if !terraform_bin.include?("terraform") # IE: allow any version of terraform forks
+
+      major, minor, patch = terraform_version.split('.').map(&:to_i)
+      min_major, min_minor, _ = @min_terraform_version.split('.').map(&:to_i)
+      max_major, max_minor, max_patch = @max_terraform_version.split('.').map(&:to_i)
+
+      # must be between min and max
+      min_ok = major > min_major ||
+              (major == min_major && minor >= min_minor)
+      max_ok = major < max_major ||
+              (major == max_major && minor == max_minor && patch <= max_patch)
+
+      min_ok && max_ok
+    end
+    alias ok? allowed_terraform_version?
+
+    def terraform_is_not_installed
+      <<~EOL
+        Terraform not installed. Unable to detect a terraform command.
+        Please double check that an allowed version of terraform is installed.
+        See: https://terraspace.cloud/docs/install/terraform/
+      EOL
+    end
+
+    # Note opentf is not an official fork yet. Mocked it out for testing.
+    # Should be ready to swap out the official fork name when it is ready.
+    BINS = %w[opentf terraform]
+    @@terraform_bin = nil
+    def terraform_bin
+      return @@terraform_bin if @@terraform_bin.present?
+      BINS.each do |bin|
+        if Gem.win_platform?
+          out = "is #{bin}.exe".strip
+        else
+          out = `type #{bin} 2>&1`.strip
+          next unless $?.success?
+        end
+        md = out.match(/is (.*)/)
+        if md
+          @@terraform_bin = md[1]
+          break
+        end
+      end
+      @@terraform_bin
+    end
+    memoize :terraform_bin
+
+    def terraform_bin_name
+      terraform_bin ? File.basename(terraform_bin) : "terraform"
+    end
+
+    # Sometimes Terraform shows the version info on the first line and sometimes on the bottom line.
+    # Account for that by finding the line.
+    #
+    #     $ terraform --version
+    #     Terraform v0.12.24
+    #
+    #     Your version of Terraform is out of date! The latest version
+    #     is 0.12.26. You can update by downloading from https://www.terraform.io/downloads.html
+    #
+    # Another example
+    #
+    #     $ opentf --version
+    #     OpenTF v0.12.24
+    #
+    # Note: The -json option is only available in v0.13+
+    def terraform_version
+      out = `#{terraform_bin} --version`
+      regexp = /(\d+\.\d+\.\d+)/
+      line = out.split("\n").find { |l| l =~ regexp }
+      version = line.match(regexp)[1] if line
+    end
+    memoize :terraform_version
+
+    def terraspace_version
+      Terraspace::VERSION
+    end
+
+    def versions
+      {
+        terraspace_version: terraspace_version,
+        terraform_version: terraform_version,
+        terraform_command: terraform_bin_name,
+      }
+    end
+
+    class << self
+      # Used as library call
+      def check!
+        setup = new
+        return if setup.ok?
+        # run meth designed for CLI and will puts out informative messages about installed version and exit 1 when version is not ok
+        setup.run
+      end
+    end
+  end
+end

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

@@ -32,7 +32,7 @@ class Terraspace::CLI::Fmt
     end
 
     def terraform_fmt
-      sh "terraform fmt"
+      sh "#{Terraspace.terraform_bin} fmt"
     end
 
     def sh(command)

data/lib/terraspace/cli/setup.rb

@@ -3,7 +3,13 @@ class Terraspace::CLI
     desc "check", "Check setup is ok"
     long_desc Help.text("setup/check")
     def check
-      Check.new(options).run
+      puts <<~EOL
+        DEPRECATED: The terraspace setup check command is deprecated. Instead use:
+
+            terraspace check
+
+      EOL
+      Terraspace::Check.new(options).run
     end
   end
 end

data/lib/terraspace/cli.rb

@@ -66,16 +66,22 @@ module Terraspace
       Bundle.new(options.merge(args: args)).run
     end
 
+    desc "check", "Check setup.", hide: true
+    long_desc Help.text(:check_setup)
+    def check
+      Check.new(options).run
+    end
+
     desc "check_setup", "Check setup.", hide: true
     long_desc Help.text(:check_setup)
     def check_setup
       puts <<~EOL
         DEPRECATED: The terraspace check_setup command is deprecated. Instead use:
 
-            terraspace setup check
+            terraspace check
 
       EOL
-      Setup::Check.new(options).run
+      Check.new(options).run
     end
 
     desc "console STACK", "Run console in built terraform project."

data/lib/terraspace/cloud/api/http_methods.rb

@@ -7,6 +7,11 @@ class Terraspace::Cloud::Api
     def request(klass, path, data={})
       exit_on_error = data.delete(:exit_on_error) # for cani logic
       url = url(path)
+      unless check.ok?
+        puts "ERROR: terraspace cloud requires terraform between v#{check.min_terraform_version}.x and #{check.max_terraform_version}".color(:red)
+        exit 1
+      end
+      data = data.merge(versions: check.versions)
       req = build_request(klass, url, data)
       retries = 0
       begin
@@ -117,5 +122,10 @@ class Terraspace::Cloud::Api
     def delete(path, data={})
       request(Net::HTTP::Delete, path, data)
     end
+
+    def check
+      Terraspace::Check.new
+    end
+    memoize :check
   end
 end

data/lib/terraspace/cloud/api.rb

@@ -1,5 +1,6 @@
 module Terraspace::Cloud
   class Api
+    extend Memoist
     include Context
     include HttpMethods
 

data/lib/terraspace/cloud/base.rb

@@ -18,8 +18,6 @@ module Terraspace::Cloud
       attrs = {
         status: status,
         kind: @kind,
-        terraspace_version: check.terraspace_version,
-        terraform_version: check.terraform_version,
       }
       attrs.merge!(@vcs_vars)
       attrs
@@ -38,11 +36,6 @@ module Terraspace::Cloud
       end
     end
 
-    def check
-      Terraspace::CLI::Setup::Check.new
-    end
-    memoize :check
-
     def sh(command, exit_on_fail: true)
       logger.debug "=> #{command}"
       system command

data/lib/terraspace/cloud/cost.rb

@@ -26,8 +26,6 @@ module Terraspace::Cloud
       {
         provider: provider.name, # IE: infracost
         provider_version: provider.version,
-        terraspace_version: check.terraspace_version,
-        terraform_version: check.terraform_version,
       }
     end
 

data/lib/terraspace/cloud/plan.rb

@@ -53,7 +53,7 @@ module Terraspace::Cloud
         FileUtils.cp(out_option_root_path, plan_path)
 
         json = plan_path.sub('.binary','.json')
-        sh "terraform show -json #{plan_path} > #{json}"
+        sh "#{Terraspace.terraform_bin} show -json #{plan_path} > #{json}"
       end
     end
 

data/lib/terraspace/cloud/update.rb

@@ -24,8 +24,8 @@ module Terraspace::Cloud
         IO.write("#{cache2_path}/update.log", Terraspace::Logger.logs)
         return unless success
 
-        sh "terraform state pull > #{cache2_path}/state.json"
-        sh "terraform output -json > #{cache2_path}/output.json"
+        sh "#{Terraspace.terraform_bin} state pull > #{cache2_path}/state.json"
+        sh "#{Terraspace.terraform_bin} output -json > #{cache2_path}/output.json"
       end
     end
 

data/lib/terraspace/core.rb

@@ -2,6 +2,11 @@ module Terraspace
   module Core
     extend Memoist
 
+    def terraform_bin
+      # basename so command shows up as a prettier short name in the output
+      File.basename(Terraspace::Check.new.terraform_bin)
+    end
+
     def app
       ENV['TS_APP'] unless ENV['TS_APP'].blank?
     end

data/lib/terraspace/terraform/runner.rb

@@ -45,7 +45,7 @@ module Terraspace::Terraform
       current_dir_message # only show once
 
       params = args.flatten.join(' ')
-      command = "terraform #{name} #{params}".squish
+      command = "#{Terraspace.terraform_bin} #{name} #{params}".squish
       @shell_exception = nil
       run_hooks("terraform.rb", name) do
         Backend.new(@mod).create

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "2.2.8"
+  VERSION = "2.2.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 2.2.8
+  version: 2.2.10
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -528,6 +528,7 @@ files:
 - lib/terraspace/builder/allow/stack.rb
 - lib/terraspace/builder/children.rb
 - lib/terraspace/bundle.rb
+- lib/terraspace/check.rb
 - lib/terraspace/cli.rb
 - lib/terraspace/cli/all.rb
 - lib/terraspace/cli/base.rb
@@ -636,7 +637,6 @@ files:
 - lib/terraspace/cli/plan.rb
 - lib/terraspace/cli/seed.rb
 - lib/terraspace/cli/setup.rb
-- lib/terraspace/cli/setup/check.rb
 - lib/terraspace/cli/state.rb
 - lib/terraspace/cli/summary.rb
 - lib/terraspace/cli/test.rb
@@ -965,7 +965,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: 'Terraspace: The Terraspace Framework'

data/lib/terraspace/cli/setup/check.rb

@@ -1,114 +0,0 @@
-class Terraspace::CLI::Setup
-  class Check
-    extend Memoist
-
-    # Terraspace requires at least this version of terraform
-    REQUIRED_TERRAFORM_VERSION = "0.12"
-
-    def initialize(options={})
-      @options = options
-    end
-
-    # Used for the CLI
-    def run
-      puts "Detected Terraspace version: #{Terraspace::VERSION}"
-      if terraform_bin
-        puts "Detected Terraform bin: #{terraform_bin}"
-        puts "Detected #{terraform_version_message}"
-        check_required_version!
-      else
-        puts terraform_is_not_installed
-        exit 1
-      end
-    end
-
-    def check_required_version!
-      puts "Terraspace requires Terraform v#{REQUIRED_TERRAFORM_VERSION}.x and above"
-      if ok?
-        puts "You're all set!"
-      else
-        puts "The installed version of terraform may not work with terraspace."
-        puts "Recommend using at least terraform v#{REQUIRED_TERRAFORM_VERSION}.x"
-        puts "If you would like to bypass this check. Use TS_VERSION_CHECK=0" unless check_command?
-        exit 1 unless ENV['TS_VERSION_CHECK'] == '0'
-      end
-    end
-
-    def check_command?
-      Terraspace.argv[0] == "check_setup"
-    end
-
-    def terraform_is_not_installed
-      <<~EOL
-        Terraform not installed. Unable to detect a terraform command. Please double check that terraform is installed.
-        See: https://terraspace.cloud/docs/install/terraform/
-      EOL
-    end
-
-    def ok?
-      unless terraform_bin
-        puts terraform_is_not_installed
-        exit 1
-      end
-
-      version = terraform_version_message.sub(/.*v/,'') # => 0.12.24
-      unless version.match(/\d+\.\d+\.\d+/) # just parse did not find the version number
-        puts "WARN: Unable to get the terraform version".color(:yellow)
-        return true
-      end
-      major, minor, _ = version.split('.')
-      required_major, required_minor = REQUIRED_TERRAFORM_VERSION.split('.')
-      return true if major.to_i > required_major.to_i
-      x = major.to_i >= required_major.to_i
-      y = minor.to_i >= required_minor.to_i
-      x && y
-    end
-
-    def terraform_bin
-      if Gem.win_platform?
-        out = "is terraform.exe".strip
-      else
-        out = `type terraform 2>&1`.strip
-        return unless $?.success?
-      end
-      md = out.match(/is (.*)/)
-      md[1] if md
-    end
-    memoize :terraform_bin
-
-    # Sometimes Terraform shows the version info on the first line and sometimes on the bottom line.
-    # Account for that by finding the line.
-    #
-    #     $ terraform --version
-    #     Terraform v0.12.24
-    #
-    #     Your version of Terraform is out of date! The latest version
-    #     is 0.12.26. You can update by downloading from https://www.terraform.io/downloads.html
-    #
-    # Note: The -json option is only available in v0.13+
-    def terraform_version_message
-      out = `terraform --version`
-      version = out.split("\n").find { |l| l =~ /^Terraform / }
-      version.strip if version
-    end
-    memoize :terraform_version_message
-
-    def terraform_version
-      terraform_version_message.sub(/.*v/,'')
-    end
-
-    def terraspace_version
-      Terraspace::VERSION
-    end
-
-    class << self
-      # Used as library call
-      def check!
-        setup = new
-        return if setup.ok?
-        # run meth designed for CLI and will puts out informative messages about installed version and exit 1 when version is not ok
-        setup.run
-      end
-    end
-  end
-end