terradactyl 0.15.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bc592a89bdefefae6460b67cf305a20c9a204f7960d8f7adc060e6b45352d20
-  data.tar.gz: c2f4083336586251254b15970c97c00f63dd0d07c5354e14f00b2c9ee6fb840c
+  metadata.gz: 49fe1966595f9b6757978cdb175659deb41290b3f24ef7c410a03c03c72172d2
+  data.tar.gz: 232ab09501fe09d0f8ac3163065269f43f9200dcb7ea3d68c0b0dfff057fafdc
 SHA512:
-  metadata.gz: 48283e55d2f375e71b4aef40e831cb4f973f98a42382972db7a2b099735725f633348995fd1cc8e4a9075799add4a1ce8ac0b41ad755fee08e5bcdd6e709499a
-  data.tar.gz: 3eb7984c57b37fc6a72dd350a8deeed2b77b228cf5f7e0ace79cde86b5c3004fb4bc9f78d651a059b0a769ba2572a06db93a58b2c75ace1c7140b3091a930f95
+  metadata.gz: 6e22c6c6159ba55bafcc83e0a919b2730647568f158853e9047e3ce08574047f5dcfd539fb3eadfffddc8f94d6c3476d61a892b7875181f40b54e32f0a407521
+  data.tar.gz: 5ca0d7097d609e041c974a6067829e564731e155dbb3cfdbc67a8965f47292f1d89067932285cdfd4d581b84e0da4d30e282cf1307f5521e25ff9e00fe2dfbda

data/.rubocop.yml

@@ -10,6 +10,8 @@ Metrics/CyclomaticComplexity:
   Max: 10
 Metrics/ClassLength:
   Max: 115
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
 Naming/UncommunicativeMethodParamName:
   MinNameLength: 2
 Style/IfUnlessModifier:

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # CHANGELOG
 
+## 1.1.0 (2021-12-09)
+
+NEW FEATURES:
+
+* add support for Terraform version '~> 1.1.0`
+
+DEPENDENCIES:
+
+* update depends on terradactyl-terraform to '>= 1.1.0'
+
+UPGRADEABLE:
+
+* set '~> 1.0.0` as upgradeable
+
+## 1.0.0 (2021-06-09)
+
+NEW FEATURES:
+
+* add support for Terraform version `~> 1.0.0`
+
+BUG FIXES:
+
+* fix bad test matrix
+
+## 0.15.3 (2021-05-14)
+
+BUG FIXES:
+
+* fix `auto-approve` on `destroy` subcommand for Terraform version 0.15
+* update all tests to use latest minor rev
+
+## 0.15.2 (2021-05-02)
+
+NEW FEATURES:
+
+* make all stacks upgradeable, regardless of binary version
+* add warning after upgrading to Terrafrom version 0.13
+* expanded testing
+
+BUG FIXES:
+
+* do not init backend during upgrade
+* fix edge case on stacks with no `versions.tf` file
+
 ## 0.15.1 (2021-04-28)
 
 BUG FIXES:

data/README.md

@@ -189,7 +189,7 @@ Installs supporting components, namely Terraform itself...
 
 #### upgrade
 
-Upgrade abstracts the various Terraform subcommands related to upgrading individual stacks (`0.12upgrade` and `0.13upgrade`).
+Upgrade abstracts the various Terraform subcommands related to upgrading individual stacks.
 
     terradactyl upgrade <stack>
 

data/lib/terradactyl/cli.rb

@@ -76,8 +76,9 @@ module Terradactyl
         else
           Stacks.error!(@stack)
           print_crit "Failed to upgrade: #{@stack.name}"
+          throw :error
         end
-      rescue Terradactyl::Terraform::Commands::UnsupportedCommandError => e
+      rescue Terradactyl::Terraform::VersionManager::VersionManagerError => e
         print_crit "Error: #{e.message}"
         exit 1
       end
@@ -170,7 +171,7 @@ module Terradactyl
     desc 'upgrade NAME', 'Cleans, inits, upgrades and formats an individual stack, by name'
     def upgrade(name)
       clean(name)
-      init(name)
+      init(name, backend: false)
       upgrade_stack(name)
       fmt(name)
     end
@@ -271,8 +272,10 @@ module Terradactyl
     end
 
     desc 'init NAME', 'Init an individual stack, by name'
-    def init(name)
+    def init(name, backend: true)
       @stack ||= Stack.new(name)
+      @stack.config.terraform.init.backend = backend
+
       print_ok "Initializing: #{@stack.name}"
       if @stack.init.zero?
         print_ok "Initialized: #{@stack.name}"

data/lib/terradactyl/commands.rb

@@ -19,39 +19,28 @@ module Terradactyl
     end
 
     module Commands
-      class UnsupportedCommandError < RuntimeError
-        def initialize(msg)
-          super(msg)
-        end
-      end
-
       class Upgrade < Base
-        ERROR_UNSUPPORTED = <<~ERROR
-          subcommand `upgrade` is not supported on this stack!
-
-                This stack may already be upgraded. Check the stack's specified
-                Terraform version and consult its builtin help for further
-                details.
-        ERROR
+        def execute
+          VersionManager.install
+          return 0 unless revision.upgradeable?
 
-        class << self
-          def error_unsupported
-            raise UnsupportedCommandError, ERROR_UNSUPPORTED
-          end
+          super
         end
 
-        def version
-          @version ||= calculate_upgrade(super)
+        def next_version
+          @next_version ||= compute_upgrade
         end
 
         private
 
-        def calculate_upgrade(current_version)
-          maj, min, _rev = current_version.split('.')
-          min = min.to_i < 13 ? (min.to_i + 1) : min
-          resolution = VersionManager.resolve("~> #{maj}.#{min}.0")
+        def revision
+          Terradactyl::Stack.revision
+        end
+
+        def compute_upgrade
+          maj, min, _rev = version.split('.')
+          resolution = VersionManager.resolve("~> #{maj}.#{min.to_i + 1}.0")
           VersionManager.version = resolution
-          VersionManager.install
           VersionManager.version
         end
 
@@ -69,9 +58,13 @@ module Terradactyl
     class << self
       def extend_by_revision(tf_version, object)
         anon_module = revision_module
+        revision    = revision_constant(tf_version)
 
         anon_module.include(self)
-        anon_module.prepend(revision_constant(tf_version))
+        anon_module.prepend(revision)
+
+        object.class.define_singleton_method(:revision) { revision }
+        object.define_singleton_method(:revision) { revision }
 
         object.extend(anon_module)
       end
@@ -105,8 +98,8 @@ module Terradactyl
       end
 
       def revision_constant(tf_version)
-        revision_name = ['Rev', *tf_version.split('.').take(2)].join
-        const_get(revision_name)
+        revision = Terradactyl::Terraform.calc_revision(tf_version)
+        const_get(revision)
       end
     end
 
@@ -182,34 +175,69 @@ module Terradactyl
     # rubocop:enable Metrics/AbcSize
 
     def upgrade
-      Upgrade.error_unsupported
+      perform_upgrade
     end
 
     private
 
+    def versions_file
+      'versions.tf'
+    end
+
     def settings_files
-      Terradactyl::ConfigStack::TERRAFORM_SETTINGS_FILES.select do |file|
-        File.exist?(file)
+      Dir.glob('*.tf').each_with_object([]) do |file, memo|
+        File.open(file, 'r').each_line do |line|
+          if line.match(Common.required_versions_re)
+            memo << file
+            break
+          end
+        end
       end
     end
 
-    def update_required_version(upgrade_version)
-      replace_me = /(?<assignment>(?:\n\s)*required_version\s+=\s+)(?<value>".*?")/m
-
+    def sanitize_terraform_settings
       settings_files.each do |file|
-        settings     = File.read(file)
-        substitution = nil.to_s
+        next if file == versions_file
 
-        if (req_version = settings.match(replace_me))
-          if file == 'versions.tf'
-            substitution = %(#{req_version[:assignment]}"~> #{upgrade_version}")
-          end
+        write_stream = Tempfile.new(Common.tag)
+        File.open(file, 'r').each_line do |line|
+          write_stream.puts line unless line.match(Common.required_versions_re)
         end
+        write_stream.close
+        FileUtils.mv(write_stream.path, file)
+      end
+    end
 
-        settings.sub!(replace_me, substitution)
-
-        File.write(file, settings)
+    def update_required_version(upgrade_version)
+      if File.exist?(versions_file)
+        settings = File.read(versions_file)
+        if (req_version = settings.match(Common.required_versions_re))
+          substitution = %(#{req_version[:assignment]}"~> #{upgrade_version}")
+          settings.sub!(Common.required_versions_re, substitution)
+        end
+      else
+        # This is ugly, so let's explain ...
+        #
+        # When the versions.tf is present, but the stack is ~> 0.11.0, the
+        # `terraform 0.12upgrade` subcommand will FAIL because it uses the
+        # presence of this file as the sole gauge as to whether or not
+        # the stack can be upgraded. So, why not just use `-force`? Haha yes ...
+        #
+        # When the `versions.tf` file exists and the `-force` flag is passed,
+        # it will create a `versions-1.tf` file ... FML :facepalm:
+        #
+        # So, make the creation of a de facto versions.tf contingent upon the
+        # Terraform upgrade_version. Yay.
+        unless upgrade_version =~ /0\.12/
+          settings = <<~VERSIONS
+            terraform {
+              required_version = "~> #{upgrade_version}"
+            }
+          VERSIONS
+        end
       end
+
+      File.write(versions_file, settings) if settings
     end
 
     def upgrade_notice
@@ -220,51 +248,75 @@ module Terradactyl
         This stack has been upgraded to version the described below and its
         Terradactly config file (if it existed) has been removed.
 
-         #{insert}
+        #{insert}
 
-         NOTES:
+        NOTES:
 
          • ALL Terraform version constraints are now specified in `versions.tf` using
           the `required_version` directive.
 
-         • If your stack already containedo one or more `required_version` directives,
+         • If your stack already contained one or more `required_version` directives,
           they have been consolidated into a single directive in `versions.tf`.
 
          • Terraform provider version contraints ARE NOT upgraded automatically. You
           will need to edit these MANUALLY.
 
          • Before proceeding. please perform a `terradactyl quickplan` on your stack
-          to ensure the upgraded stack functions.
+          to ensure the upgraded stack functions as intended.
       NOTICE
     end
 
+    def upgrade_notice_rev013
+      <<~NOTICE
+        STOP UPGRADING!
+
+              Upgrading from Terraform 0.12 to 0.13 requires an apply to be performed
+              before continuing ...
+
+              DO NOT attempt to upgrade any further without first committing the existing
+              changes and seeing they are applied.
+
+              See the documentation here if you require more infomation ...
+
+              https://www.terraform.io/upgrade-guides/0-13.html
+      NOTICE
+    end
+
+    # rubocop:disable  Metrics/AbcSize
     def perform_upgrade
       options = command_options.tap { |dat| dat.yes = true }
       upgrade = Upgrade.new(dir_or_plan: nil, options: options)
 
-      update_required_version(upgrade.version)
+      sanitize_terraform_settings
+
+      update_required_version(upgrade.next_version)
 
       if (result = upgrade.execute).zero?
-        update_required_version(upgrade.version)
+        update_required_version(upgrade.next_version)
         FileUtils.rm_rf('terradactyl.yaml') if File.exist?('terradactyl.yaml')
       end
 
-      print_content(upgrade_notice)
+      print_content(upgrade_notice) if result.zero?
+
+      print_crit(upgrade_notice_rev013) if upgrade.next_version =~ /0\.13/
 
       result
     end
+    # rubocop:enable  Metrics/AbcSize
 
     def load_plan_file
       Terraform::PlanFile.new(plan_path: plan_file, parser: parser)
     end
 
     module Rev011
-      include Terraform::Commands
-
-      def upgrade
-        perform_upgrade
+      class << self
+        def upgradeable?
+          true
+        end
       end
 
+      include Terraform::Commands
+
       private
 
       def parser
@@ -273,12 +325,14 @@ module Terradactyl
     end
 
     module Rev012
-      include Terraform::Commands
-
-      def upgrade
-        perform_upgrade
+      class << self
+        def upgradeable?
+          true
+        end
       end
 
+      include Terraform::Commands
+
       private
 
       def parser
@@ -287,12 +341,14 @@ module Terradactyl
     end
 
     module Rev013
-      include Terraform::Commands
-
-      def upgrade
-        perform_upgrade
+      class << self
+        def upgradeable?
+          false
+        end
       end
 
+      include Terraform::Commands
+
       private
 
       def parser
@@ -301,6 +357,12 @@ module Terradactyl
     end
 
     module Rev014
+      class << self
+        def upgradeable?
+          false
+        end
+      end
+
       include Terraform::Commands
 
       private
@@ -311,6 +373,12 @@ module Terradactyl
     end
 
     module Rev015
+      class << self
+        def upgradeable?
+          false
+        end
+      end
+
       include Terraform::Commands
 
       private
@@ -319,6 +387,38 @@ module Terradactyl
         Terraform::Rev015::PlanFileParser
       end
     end
+
+    module Rev1_00
+      class << self
+        def upgradeable?
+          false
+        end
+      end
+
+      include Terraform::Commands
+
+      private
+
+      def parser
+        Terraform::Rev1_00::PlanFileParser
+      end
+    end
+
+    module Rev1_01
+      class << self
+        def upgradeable?
+          false
+        end
+      end
+
+      include Terraform::Commands
+
+      private
+
+      def parser
+        Terraform::Rev1_01::PlanFileParser
+      end
+    end
   end
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/terradactyl/common.rb

@@ -7,6 +7,14 @@ module Terradactyl
 
     module_function
 
+    def required_versions_re
+      /(?<assignment>(?:\n\s)*required_version\s+=\s+)(?<value>".*?")/m
+    end
+
+    def supported_revisions
+      Terradactyl::Commands.constants.select { |c| c =~ /Rev/ }.sort
+    end
+
     def config
       @config ||= ConfigProject.instance
     end

data/lib/terradactyl/config.rb

@@ -26,7 +26,7 @@ module Terradactyl
             input: false
           destroy:
             parallelism: 5
-            force: true
+            auto_approve: true
         environment:
           TF_PLUGIN_CACHE_DIR: ~/.terraform.d/plugins
         misc:
@@ -170,22 +170,32 @@ module Terradactyl
       "#{stack_path}/#{plan_file}"
     end
 
+    def versions_file
+      "#{stack_path}/versions.tf"
+    end
+
     private
 
     def terraform_required_version
-      matches = TERRAFORM_SETTINGS_FILES.map do |file|
+      matches = TERRAFORM_SETTINGS_FILES.each_with_object([]) do |file, memo|
         path = File.join(stack_path, file)
-        if File.exist?(path)
-          File.read(path).match(terraform_required_version_re)
+        next unless File.exist?(path)
+
+        File.readlines(path).each do |line|
+          next if line =~ /(?:\s*#\s*)/
+
+          if (match = line.match(Common.required_versions_re))
+            memo << match
+          end
         end
       end
 
-      return {} unless matches.compact!.any?
+      return {} unless matches.any?
 
       {
         'terradactyl' => {
           'terraform' => {
-            'version' => matches.last[:version]
+            'version' => matches.last[:value].delete('"')
           }
         }
       }
@@ -204,9 +214,5 @@ module Terradactyl
     def overlay_specifies_version?(overlay)
       overlay['terradactyl']&.fetch('terraform', {})&.fetch('version', nil)
     end
-
-    def terraform_required_version_re
-      /(?:\s*terraform\s*{(?:\n|\s)*.+required_version\s*=\s*)"(?<version>.*)"(?:(?:\n|\s)*.+})/m
-    end
   end
 end

data/lib/terradactyl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Terradactyl
-  VERSION = '0.15.1'
+  VERSION = '1.1.0'
 end

data/terradactyl.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'deep_merge', '~> 1.2'
   spec.add_dependency 'bundler', '>= 1.16'
   spec.add_dependency 'rake', '>= 10.0'
-  spec.add_dependency 'terradactyl-terraform', '>= 0.15.0'
+  spec.add_dependency 'terradactyl-terraform', '>= 1.1.0'
 
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry', '~> 0.12'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terradactyl
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Warsing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement