terraspace-bundler 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 631c34ce3db2daed84f18ba29202a80f774f4b109667f7b45782e8650e78a546
-  data.tar.gz: 86eecdcc7707f0b69dc1119f8998d26db27f379c6e7e8ca40fb57bdcd06f7fc2
+  metadata.gz: 500271ff2f8e5799a55febd3ec25261bcf4126bff456b83360ae0e2a96bb6357
+  data.tar.gz: ee45f81805b893d5287fdea6777c9b28ac39936273806c3d97275f6c314a8cd1
 SHA512:
-  metadata.gz: 66db99a20990496644bac73075aa9e5cb8d5e998cfdfce7b15efc65ea497d8d01bfd21502e91ea914965b7400f8e278d4ce41994a5e7c0fcbba401841f9be083
-  data.tar.gz: 8f6d8295f23d9521440584ee6ed84b1d7568900211a89b4bcfd67e5b5a5238c2b629f9d161dd540770c705b8eebc05f9a7ecbe70618399e4c070abcaff6a7e04
+  metadata.gz: 94af4d341ed3e43445bf2eb0eae1e3383fe064a6df708c449658b8eb5a958163a225be2ddae121356573ae7e099e87669c5cb9c54808423b9db685faf27d7837
+  data.tar.gz: d68d1825f89b91ac4d9ad7525a4b4b95cc709ce1e2f3c10d83aa6ad5c6b27a89b3c6ae1ad9bc1ee3179b08345ac73fc551d1467769f702cc43d69b6f3b38b577

data/CHANGELOG.md

@@ -3,5 +3,18 @@
 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.2.0]
+- #1 Rework implementation. Better Terrafile syncing
+- clearer implementation: Terrafile and Lockfile classes build standard mods object.
+- add commands: info, list
+- sync of Terrafile with vendor/modules
+- rename command: terraspace bundle purge_cache
+- rename option to relative_root for modules within a subfolder within a repo
+- prune exported modules by default
+- export_prune option
+- Allow configuring the logger formatter
+- validate org is set if used
+- mod export_to option
+
 ## [0.1.0]
 - Initial release.

data/README.md

@@ -1,12 +1,6 @@
 # terraspace-bundler
 
-Bundles terraform modules based on a `Terrafile` to the `vendor/modules` folder.
-
-## Installation
-
-To install:
-
-    gem install terraspace-bundler
+Bundles terraform modules based on a `Terrafile` to the `vendor/modules` folder. Used by the [Terraspace Terraform Framework](https://terraspace.cloud/).
 
 ## Usage
 
@@ -26,56 +20,110 @@ mod "rds", source: "boltopspro/terraform-aws-rds", version: "v0.1.0"
 mod "sg", source: "terraform-aws-modules/security-group/aws", version: "3.10.0"
 ```
 
-Running `terraspace bundle` creates the `Terrafile.lock` file, which locks the downloaded versions.
+## Install
+
+Running `terraspace bundle` creates the `Terrafile.lock` file, which locks the versions.
 
     terraspace bundle
 
 ## Updating
 
-To update all the locked versions in `Terrafile.lock` run `terraspace bundle update`. You can also simply delete the `Terrafile.lock` file.
+To update all the locked versions in `Terrafile.lock` run `terraspace bundle update`. You can also delete the `Terrafile.lock` file first.
 
     terraspace bundle update
 
-You can selectively update only one module:
+You can selectively update multiple modules:
 
-    terraspace bundle update MOD
+    terraspace bundle update MODS
+    terraspace bundle update mod1 mod2
 
-## Removing vendor/modules
+## List & Info
 
-The `terraspace bundle` commands will only update the modules it knows about in `Terrafile`. To clear out old modules, delete them from `vendor/modules`. You can clean them all out like so:
+    terraspace bundle list
+    terraspace bundle info mod1
 
-    rm -rf vendor/modules
-    terraspace bundle update
+## DSL Methods
+
+Some of these are methods that apply globally at the Terrafile level. Some of these are options that apply the at the mod method level.
 
-## base url
+### Terrafile level
+
+Name | Description | Default
+--- |  --- | ---
+base_clone_url | Base clone url to use | git@gihtub.com:
+export_path |  Where the modules get exported to saved to. | vendor/modules
+export_purge | Where or not to clean up all existing exported modules folder first. | true
+
+### Mod Method level
+
+Name | Description | Default
+--- |  --- | ---
+subfolder | The subfolder where the module lives within the repo. | nil
+export_to | Overrides the export_path Terrafile level option. With this one-off option, other modules in this folder will not be purged. | nil
+
+Examples of some of the options are below:
+
+### base url
 
 The base url used for clone is `git@github.com:`. You can change it with `base_url`, example:
 
 ```ruby
-org "boltops-tools" # set default org
 base_url "https://github.com/"  # default base url for git clone
-
-mod "s3", source: "terraform-aws-s3", version: "master"
+# ...
 ```
 
-## export_path
+### export_path
 
 The default export path is `vendor/modules`, you can change it:
 
 ```ruby
-org "boltops-tools" # set default org
 export_path "app/modules"
+# ...
+```
+
+## prune
 
-mod "s3", source: "terraform-aws-s3", version: "master"
+The `terraspace bundle` commands removes all files in the export_path, `vendor/modules`, by default. You can disable this behavior with:
+
+```ruby
+export_purge false
+# ...
 ```
 
+### subfolder
+
+The default export path is `vendor/modules`, you can change it:
+
+```ruby
+# ...
+mod "s3", source: "terraform-aws-s3", subfolder: "path/to/module/s3"
+```
+
+## Config Options
+
+You can also configure some behavior with `TB.config`. IE: `TB.config.terrafile = "/path/to/Terrafile"`
+
+Name | Description | Default
+--- | --- | ---
+base_clone_url | Base git url to use for cloning | git@github.com:
+export_path | Where to export the modules to. Can also be set with the env var TB_EXPORT_PATH | vendor/modules
+export_purge | Whether or not to prune all the modules | true
+logger | Logger instance
+terrafile | The Terrafile path. Can also be set with the env TB_TERRAFILE || "Terrafile"
+
+## Installation
+
+To install:
+
+    gem install terraspace-bundler
+
 ## Notes
 
-* Simple implementation for [Terraspace](https://terraspace.cloud/) use.
+* This is a simple implementation for [Terraspace](https://terraspace.cloud/) use.
 * Handles updating the `Terrafile.lock` based on the `Terrafile`
 * Others running the `terraspace bundle install` will install the exact same module versions based the `Terrafile.lock`.
 * To update `Terraform.lock` run `terraspace bundle update`.
-* The repos are downloaded to `/tmp/terraspace-bundler` area as a cache. Delete the cache by running `terraspace bundle clean`.
+* The repos are downloaded to `/tmp/terraspace-bundler` area as a cache. Delete the cache by running `terraspace bundle purge_cache`.
 
 ## Contributing
 

data/lib/terraspace_bundler.rb

@@ -17,6 +17,7 @@ DslEvaluator.backtrace_reject = "lib/terraspace_bundler"
 
 module TerraspaceBundler
   class Error < StandardError; end
+  class GitError < Error; end
   extend Core
 end
 

data/lib/terraspace_bundler/cli/base.rb

@@ -1,9 +1,17 @@
 class TerraspaceBundler::CLI
   class Base
-    include TB::Logging
+    include TB::Util::Logging
 
     def initialize(options={})
       @options = options
+      set_config!
+    end
+
+    def set_config!
+      return unless @options[:terrafile]
+      TB.config.terrafile = @options[:terrafile]
+      TB.config.lockfile = "#{@options[:terrafile]}.lock"
+      TB.config
     end
   end
 end

data/lib/terraspace_bundler/cli/bundle.rb

@@ -1,27 +1,41 @@
 class TerraspaceBundler::CLI
   class Bundle < TerraspaceBundler::Command
     terrafile_option = Proc.new {
-      option :terrafile, default: "Terrafile", desc: "Terrafile to use"
+      option :terrafile, default: ENV['TB_TERRAFILE'] || "Terrafile", desc: "Terrafile to use"
     }
 
-    desc "install", "install"
-    long_desc Help.text("bundle/install")
+    desc "list", "List bundled modules included by Terrafile."
+    long_desc Help.text("bundle/list")
     terrafile_option.call
-    def install
-      Install.new(options).run
+    def list
+      TB::List.new(options).run
+    end
+
+    desc "info MOD", "Provide info about a bundled module."
+    long_desc Help.text("bundle/info")
+    terrafile_option.call
+    def info(mod)
+      TB::Info.new(options.merge(mod: mod)).run
     end
 
-    desc "update", "update"
+    desc "install", "Install modules from the Terrafile."
     long_desc Help.text("bundle/install")
     terrafile_option.call
-    def update(mod=nil)
-      Update.new(options.merge(mod: mod)).run
+    def install
+      Runner.new(options).run
+    end
+
+    desc "purge_cache", "Purge cache."
+    long_desc Help.text("bundle/purge_cache")
+    def purge_cache
+      PurgeCache.new(options).run
     end
 
-    desc "clean", "clean"
-    long_desc Help.text("bundle/clean")
-    def clean
-      Clean.new(options).run
+    desc "update [MOD]", "Update bundled modules."
+    long_desc Help.text("bundle/update")
+    terrafile_option.call
+    def update(*mods)
+      Runner.new(options.merge(mods: mods, mode: "update")).run
     end
   end
 end

data/lib/terraspace_bundler/cli/help/bundle/info.md

@@ -0,0 +1,8 @@
+## Examples
+
+    $ terraspace bundle info random-pet
+    random-pet:
+        sha: bad676a426f5d3ddb48e674bebd6fd52f063a8b4
+        source: org/terraform-random-pet
+        type: git
+        url: git@github.com:org/terraform-random-pet

data/lib/terraspace_bundler/cli/help/bundle/install.md

@@ -1,3 +1,3 @@
 ## Examples
 
-    terraspace-bundler bundle install
+    terraspace bundle install

data/lib/terraspace_bundler/cli/help/bundle/list.md

@@ -0,0 +1,9 @@
+    $ terraspace bundle list
+    Modules included by Terrafile.lock
+
+        instance
+        random-pet
+        vpc
+
+    Use `terraspace bundle info` to print more detailed information about a module
+    $

data/lib/terraspace_bundler/cli/help/bundle/update.md

@@ -0,0 +1,6 @@
+## Examples
+
+    $ terraspace bundle update gke
+    Bundling with Terrafile...
+    Modules saved to vendor/modules
+    $

data/lib/terraspace_bundler/cli/{clean.rb → purge_cache.rb}

@@ -1,7 +1,7 @@
 class TerraspaceBundler::CLI
-  class Clean < Base
-    include TB::Mod::TmpPaths
-    include TB::Logging
+  class PurgeCache < Base
+    include TB::Mod::PathConcern
+    include TB::Util::Logging
 
     def run
       FileUtils.rm_rf(tmp_root)

data/lib/terraspace_bundler/cli/{install.rb → runner.rb}

@@ -1,5 +1,5 @@
 class TerraspaceBundler::CLI
-  class Install < Base
+  class Runner < Base
     def run
       TB::Installer.new(@options).run
     end

data/lib/terraspace_bundler/config.rb

@@ -5,11 +5,24 @@ module TerraspaceBundler
 
     def config
       config = ActiveSupport::OrderedOptions.new
-      config.export_path = "vendor/modules"
-      config.terrafile = "Terrafile"
+      config.base_clone_url = "git@github.com:"
+      config.export_path = ENV['TB_EXPORT_PATH'] || "vendor/modules"
+      config.export_purge = ENV['TB_EXPORT_PRUNE'] == '0' ? false : true
       config.lockfile = "#{config.terrafile}.lock"
+      config.logger = new_logger
+      config.terrafile = ENV['TB_TERRAFILE'] || "Terrafile"
       config
     end
     memoize :config
+
+    # Note: When using terraspace, Terraspace uses its own logger
+    # So these settings dont affect: terraspace bundle
+    # Instead, set the log level in the terraspace project: config/app.rb
+    def new_logger
+      logger = Logger.new(ENV['TB_LOG_PATH'] || $stderr)
+      logger.level = ENV['TB_LOG_LEVEL'] || :info
+      logger.formatter = Logger::Formatter.new
+      logger
+    end
   end
 end

data/lib/terraspace_bundler/core.rb

@@ -4,10 +4,7 @@ module TerraspaceBundler
 
     @@logger = nil
     def logger
-      return @@logger if @@logger
-      @@logger = Logger.new($stdout)
-      @@logger.level = ENV['TB_LOG_LEVEL'] || 'info'
-      @@logger
+      config.logger
     end
 
     def logger=(v)
@@ -17,5 +14,13 @@ module TerraspaceBundler
     def config
       Config.instance.config
     end
+
+    # DSL is evaluated once lazily when it get used
+    def dsl
+      dsl = Dsl.new
+      dsl.run
+      dsl
+    end
+    memoize :dsl
   end
 end

data/lib/terraspace_bundler/dsl.rb

@@ -3,16 +3,19 @@ module TerraspaceBundler
     include DslEvaluator
     include Syntax
 
-    class_attribute :meta
-    self.meta = {global: {}, mods: []}
+    class_attribute :meta, default: {global: {}, mods: []}
 
     def run
       evaluate_file(TB.config.terrafile)
-      self.class.meta
+      self
     end
 
     def meta
       self.class.meta
     end
+
+    def global
+      meta[:global]
+    end
   end
 end

data/lib/terraspace_bundler/dsl/concern.rb

@@ -0,0 +1,7 @@
+class TerraspaceBundler::Dsl
+  module Concern
+    def dsl
+      TB.dsl
+    end
+  end
+end

data/lib/terraspace_bundler/dsl/syntax.rb

@@ -5,10 +5,18 @@ class TerraspaceBundler::Dsl
     end
     alias_method :user, :org
 
+    def base_clone_url(value)
+      TB.config.base_clone_url = value
+    end
+
     def export_path(path)
       global[:export_path] = path
     end
 
+    def export_purge(value)
+      TB.config.export_purge = value
+    end
+
     def mod(*args, **options)
       meta[:mods] << {args: args, options: options}
     end

data/lib/terraspace_bundler/exporter.rb

@@ -0,0 +1,47 @@
+module TerraspaceBundler
+  class Exporter
+    include TB::Mod::PathConcern
+    include TB::Util::Logging
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def run
+      purge
+      lockfile.mods.each do |mod|
+        export(mod)
+      end
+    end
+
+    def export(mod)
+      downloader = Mod::Downloader.new(mod)
+      downloader.switch_version(mod.sha)
+
+      stage_path = stage_path(mod.full_repo)
+      stage_path = "#{stage_path}/#{mod.subfolder}" if mod.subfolder
+      mod_path = mod_path(mod)
+      FileUtils.rm_rf(mod_path)
+      FileUtils.mkdir_p(File.dirname(mod_path))
+      FileUtils.cp_r(stage_path, mod_path)
+      FileUtils.rm_rf("#{mod_path}/.git")
+      logger.debug "Exported: #{mod_path}"
+    end
+
+    def mod_path(mod)
+      name = mod.name
+      export_to = mod.export_to || TB.config.export_path
+      "#{export_to}/#{name}"
+    end
+
+  private
+    def purge
+      return unless TB.config.export_purge
+      FileUtils.rm_rf(TB.config.export_path)
+    end
+
+    def lockfile
+      Lockfile.instance
+    end
+  end
+end