terraspace-bundler 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b65082aa14ea1fb025bf7578584d9ee307e88107fff02c14ccad67fbcdf49ce
-  data.tar.gz: d6a597993b5e20c4de5384dae7751091dad02a85e7190d0d127589cc164cdf70
+  metadata.gz: c8245c4a3b7fd5b149298bdf0084bddeee9153ff1cd7016e7e13facb0f3bede2
+  data.tar.gz: 761d564519e6958842cc5386e7b84f4a2b2cc90e3801fc2c3845f752983241b2
 SHA512:
-  metadata.gz: 3ee15d36d396afa262f2b2e8a7765d6665ffc6d1559ee2b37f1465a35703637240b1689110a81454c6ccb56fa74618d6ac0c78d01a001636b1310e09226034fd
-  data.tar.gz: 6843a2efc05ec4b08df20e276bb1247c9b0638f9534afcbf37ead78f815f99dfbad754535e8854459b7dab0cd320a0ddc6b459850171170471bb5dd73f426bb2
+  metadata.gz: d23b49ddabd983bf1927c62aabc2a9bf4165970a32b7325e41965bc804267297cf269741677582e4c0c4f7603e15dc21fef9d5370200b18adb2f369733b653ae
+  data.tar.gz: 38bf841d2c9d721b34930786c46567a47e881e3951153272eb7f9dea66e23e974994071e5514a4e92091db0fb19d787ce22893bfb514464ae967fcc04bb34959

data/CHANGELOG.md

@@ -3,6 +3,22 @@
 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.4.0] - 2021-08-10
+- [#10](https://github.com/boltops-tools/terraspace-bundler/pull/10) terraspace bundle info: warning when no lockfile
+- [#12](https://github.com/boltops-tools/terraspace-bundler/pull/12) support for: private registry, s3, gcs, local
+
+## [0.3.4] - 2021-04-15
+- [#11](https://github.com/boltops-tools/terraspace-bundler/pull/11) improve registry dectection and gitlab repository support
+
+## [0.3.3] - 2021-02-24
+- [#8](https://github.com/boltops-tools/terraspace-bundler/pull/8) fix https sources
+- [#9](https://github.com/boltops-tools/terraspace-bundler/pull/9) Git checkout retry with v
+
+## [0.3.2]
+- #4 only purge and export explicit mods
+- are you sure prompt for purge_cache
+- clean up update mode
+
 ## [0.3.1]
 - #3 all_stacks: only consider dirs
 

data/lib/terraspace_bundler.rb

@@ -7,6 +7,7 @@ require "dsl_evaluator"
 require "fileutils"
 require "memoist"
 require "rainbow/ext/string"
+require "singleton"
 require "terraspace_bundler/version"
 require "yaml"
 

data/lib/terraspace_bundler/cli/bundle.rb

@@ -27,6 +27,7 @@ class TerraspaceBundler::CLI
 
     desc "purge_cache", "Purge cache."
     long_desc Help.text("bundle/purge_cache")
+    option :yes, aliases: :y, type: :boolean, desc: "bypass are you sure prompt"
     def purge_cache
       PurgeCache.new(options).run
     end
@@ -35,7 +36,8 @@ class TerraspaceBundler::CLI
     long_desc Help.text("bundle/update")
     terrafile_option.call
     def update(*mods)
-      TB::Runner.new(options.merge(mods: mods, mode: "update")).run
+      TB.update_mode = true
+      TB::Runner.new(options.merge(mods: mods)).run
     end
   end
 end

data/lib/terraspace_bundler/cli/purge_cache.rb

@@ -1,11 +1,29 @@
 class TerraspaceBundler::CLI
   class PurgeCache < Base
-    include TB::Mod::PathConcern
+    include TB::Mod::Concerns::PathConcern
     include TB::Util::Logging
+    include TB::Util::Sure
 
     def run
-      FileUtils.rm_rf(tmp_root)
-      logger.info "Removed #{tmp_root}"
+      paths = [tmp_root]
+      are_you_sure?(paths)
+      paths.each do |path|
+        FileUtils.rm_rf(path)
+        logger.info "Removed #{path}"
+      end
+
+    end
+
+    def are_you_sure?(paths)
+      pretty_paths = paths.map { |p| "    #{p}" }.join("\n")
+      message = <<~EOL.chomp
+        Will remove these folders and all their files:
+
+        #{pretty_paths}
+
+        Are you sure?
+      EOL
+      sure?(message) # from Util::Sure
     end
   end
 end

data/lib/terraspace_bundler/core.rb

@@ -22,5 +22,15 @@ module TerraspaceBundler
       dsl
     end
     memoize :dsl
+
+    @@update_mode = false
+    def update_mode
+      @@update_mode
+    end
+    alias_method :update_mode?, :update_mode
+
+    def update_mode=(v)
+      @@update_mode = v
+    end
   end
 end

data/lib/terraspace_bundler/dsl/syntax.rb

@@ -21,6 +21,10 @@ class TerraspaceBundler::Dsl
       config.stack_options.merge!(value)
     end
 
+    def clone_with(value)
+      config.clone_with = value
+    end
+
     def config
       TB.config
     end

data/lib/terraspace_bundler/exporter.rb

@@ -1,5 +1,6 @@
 module TerraspaceBundler
   class Exporter
+    include TB::Mod::Concerns::PathConcern
     include TB::Util::Logging
 
     def initialize(options={})
@@ -7,17 +8,26 @@ module TerraspaceBundler
     end
 
     def run
-      purge
-      lockfile.mods.each do |mod|
+      purge_all
+      mods.each do |mod|
         logger.info "Exporting #{mod.name}"
+        purge(mod)
         export(mod)
       end
     end
 
+    def mods
+      mods = lockfile.mods
+      if TB.update_mode? && !@options[:mods].empty?
+        mods.select! { |mod| @options[:mods].include?(mod.name) }
+      end
+      mods
+    end
+
     def export(mod)
-      downloader = Mod::Downloader.new(mod)
-      downloader.run
-      downloader.switch_version(mod.sha)
+      fetcher = Mod::Fetcher.new(mod).instance
+      fetcher.run
+      fetcher.switch_version(mod.sha)
       copy = Copy.new(mod)
       copy.mod
       copy.stacks
@@ -25,11 +35,17 @@ module TerraspaceBundler
     end
 
   private
-    def purge
+    def purge_all
+      return if TB.update_mode?
       return unless TB.config.export_purge
       FileUtils.rm_rf(TB.config.export_to)
     end
 
+    def purge(mod)
+      mod_path = get_mod_path(mod)
+      FileUtils.rm_rf(mod_path)
+    end
+
     def lockfile
       Lockfile.instance
     end

data/lib/terraspace_bundler/exporter/base.rb

@@ -1,6 +1,6 @@
 class TerraspaceBundler::Exporter
   class Base
-    include TB::Mod::PathConcern
+    include TB::Mod::Concerns::PathConcern
     include TB::Util::Logging
   end
 end

data/lib/terraspace_bundler/exporter/copy.rb

@@ -7,6 +7,7 @@ class TerraspaceBundler::Exporter
     def mod
       FileUtils.rm_rf(mod_path)
       FileUtils.mkdir_p(File.dirname(mod_path))
+      logger.debug "Copy: cp -r #{src_path} #{mod_path}"
       FileUtils.cp_r(src_path, mod_path)
       FileUtils.rm_rf("#{mod_path}/.git")
     end
@@ -17,7 +18,7 @@ class TerraspaceBundler::Exporter
 
     # src path is from the stage area
     def src_path
-      path = stage_path(@mod.full_repo) # from PathConcern
+      path = stage_path(rel_dest_dir)
       path = "#{path}/#{@mod.subfolder}" if @mod.subfolder
       path
     end

data/lib/terraspace_bundler/extract.rb

@@ -0,0 +1,21 @@
+module TerraspaceBundler
+  class Extract
+    def self.extract(archive, dest)
+      FileUtils.rm_rf(dest)
+      FileUtils.mkdir_p(File.dirname(dest))
+
+      if archive.ends_with?('.tgz') || archive.ends_with?('.tar.gz')
+        Tar.extract(archive, dest)
+      elsif archive.ends_with?('.zip')
+        Zip.extract(archive, dest)
+      else
+        puts <<~EOL.color(:red)
+          ERROR: Unable to extract. Unsupported archive extension for:
+
+              #{archive}
+        EOL
+        exit 1
+      end
+    end
+  end
+end

data/lib/terraspace_bundler/extract/tar.rb

@@ -0,0 +1,34 @@
+require 'rubygems/package'
+require 'zlib'
+require 'fileutils'
+
+# Thanks: https://gist.github.com/ForeverZer0/2adbba36fd452738e7cca6a63aee2f30
+class TerraspaceBundler::Extract
+  class Tar
+    # tar_gz_archive = '/tmp/terraspace/bundler/stage/s3-us-west-2.amazonaws.com/demo-terraform-test/modules/example-module.tgz'
+    # destination = '/tmp/terraspace/where/extract/to'
+    def self.extract(tar_gz_archive, destination)
+      reader = Zlib::GzipReader.open(tar_gz_archive)
+      Gem::Package::TarReader.new(reader) do |tar|
+        dest = nil
+        tar.each do |entry|
+          dest ||= File.join destination, entry.full_name
+          if entry.directory?
+            FileUtils.rm_rf dest unless File.directory? dest
+            FileUtils.mkdir_p dest, :mode => entry.header.mode, :verbose => false
+          elsif entry.file?
+            FileUtils.rm_rf dest unless File.file? dest
+            File.open dest, "wb" do |f|
+              f.print entry.read
+            end
+            FileUtils.chmod entry.header.mode, dest, :verbose => false
+          elsif entry.header.typeflag == '2' #Symlink!
+            File.symlink entry.header.linkname, dest
+          end
+          dest = nil
+        end
+      end
+    end
+  end
+end
+

data/lib/terraspace_bundler/extract/zip.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'zip'
+
+class TerraspaceBundler::Extract
+  class Zip
+    def self.extract(file, dest)
+      ::Zip::File.open(file) { |zip_file|
+        zip_file.each { |f|
+          f_path=File.join(dest, f.name)
+          FileUtils.mkdir_p(File.dirname(f_path))
+          zip_file.extract(f, f_path) unless File.exist?(f_path)
+        }
+      }
+    end
+  end
+end

data/lib/terraspace_bundler/info.rb

@@ -1,6 +1,13 @@
 module TerraspaceBundler
   class Info < TB::CLI::Base
     def run
+      file = TB.config.lockfile
+      unless File.exist?(file)
+        logger.info "No #{file} found".color(:red)
+        logger.info "Maybe run: terraspace bundle"
+        return
+      end
+      
       name = @options[:mod]
       found = lockfile.mods.find { |m| m.name == @options[:mod] }
       if found

data/lib/terraspace_bundler/lockfile/version_comparer.rb

@@ -40,7 +40,7 @@ class TerraspaceBundler::Lockfile
       # Only check when set.
       # Also in update mode then always check it.
       @changed = @current.sha && !@locked.sha.include?(@current.sha) ||
-                 update_mode? && !@current.latest_sha.include?(@locked.sha)
+                 TB.update_mode? && !@current.latest_sha.include?(@locked.sha)
       if @changed
         @reason = reason_message("sha")
         return @changed
@@ -52,11 +52,5 @@ class TerraspaceBundler::Lockfile
     def reason_message(version)
       "Replacing mod #{@current.name} because #{version} is different in Terrafile and Terrafile.lock"
     end
-
-    def update_mode?
-      self.class.update_mode
-    end
-
-    class_attribute :update_mode
   end
 end

data/lib/terraspace_bundler/mod.rb

@@ -1,9 +1,10 @@
 module TerraspaceBundler
   class Mod
-    extend PropsExtension
-    props :export_to, :name, :sha, :source, :subfolder, :type, :url
+    extend Props::Extension
+    props :export_to, :name, :sha, :source, :subfolder, :type, :url, :clone_with
 
-    include StackConcern
+    include Concerns::StackConcern
+    include Concerns::LocalConcern
 
     attr_reader :props, :version, :ref, :tag, :branch
     def initialize(props={})
@@ -12,19 +13,21 @@ module TerraspaceBundler
       @version, @ref, @tag, @branch = @props[:version], @props[:ref], @props[:tag], @props[:branch]
     end
 
+    # support variety of options, prefer version
     def checkout_version
-      v = detected_version
-      v = "v#{v}" if type == "registry" && @version && !v.starts_with?("v")
-      v
+      @version || @ref || @tag || @branch
     end
 
     # use url instead of source because for registry modules, the repo name is different
     def repo
-      url_words[-1]
+      url_words[-1].sub(/\.git$/,'')
     end
 
+    # https://github.com/tongueroo/pet - 2nd to last word
+    # git@github.com:tongueroo/pet - 2nd to last word without chars before :
     def org
-      url_words[-2] # second to last word
+      s = url_words[-2] # second to last word
+      s.split(':').last # in case of git@github.com:tongueroo/pet form
     end
 
     def full_repo
@@ -32,17 +35,22 @@ module TerraspaceBundler
     end
 
     def latest_sha
-      downloader = Downloader.new(self)
-      downloader.run
-      downloader.sha
+      fetcher = Fetcher.new(self).instance
+      fetcher.run
+      fetcher.sha
     end
 
-  private
-    # support variety of options, prefer version
-    def detected_version
-      @version || @ref || @tag || @branch
+    def vcs_provider
+      if url.include?('http')
+        # "https://github.com/org/repo"  => github.com
+        url.match(%r{http[s]?://(.*?)/})[1]
+      else # git@
+        # "git@github.com:org/repo"      => github.com
+        url.match(%r{git@(.*?):})[1]
+      end
     end
 
+  private
     def url_words
       url.split('/')
     end

data/lib/terraspace_bundler/mod/concerns/local_concern.rb

@@ -0,0 +1,10 @@
+module TerraspaceBundler::Mod::Concerns
+  module LocalConcern
+    def local?
+      source.starts_with?("/")  ||
+      source.starts_with?(".")  ||
+      source.starts_with?("..") ||
+      source.starts_with?("~")
+    end
+  end
+end

data/lib/terraspace_bundler/mod/concerns/notation_concern.rb

@@ -0,0 +1,42 @@
+require 'uri'
+
+module TerraspaceBundler::Mod::Concerns
+  module NotationConcern
+    def remove_notations(source)
+      remove_subfolder_notation(remove_ref_notation(source))
+    end
+
+    def remove_ref_notation(source)
+      source.sub(/\?.*/,'')
+    end
+
+    def remove_subfolder_notation(source)
+      parts = clean_notation(source).split('//')
+      if parts.size == 2 # has subfolder
+        source.split('//')[0..-2].join('//') # remove only subfolder, keep rest of original source
+      else
+        source
+      end
+    end
+
+    def subfolder(source)
+      parts = clean_notation(source).split('//')
+      if parts.size == 2 # has subfolder
+        remove_ref_notation(parts.last)
+      end
+    end
+
+    def ref(source)
+      url = clean_notation(source)
+      uri = URI(url)
+      if uri.query
+        params = URI::decode_www_form(uri.query).to_h # if you are in 2.1 or later version of Ruby
+        params['ref']
+      end
+    end
+
+    def clean_notation(source)
+      source.sub(/.*::/,'').sub(%r{http[s?]://},'').sub(%r{git@(.*?):},'') # also remove git@ notation
+    end
+  end
+end