terraspace_plugin_google 0.0.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10ba87e72c39cdfc8032d3c12f859fd6d442bd2c7cf9c093cca723b32df4e4c5
-  data.tar.gz: 15d820fbb4ce87d09ead970b12c9a2266b9cb34d68c8a928ad819cf7af5aba22
+  metadata.gz: f481b6c88c1de06a78da5d9a3097517202c3e17ceae6f81434bcb66abfd9468f
+  data.tar.gz: db7d7abd653cd1e0c7b780b69228645d840909a242fb920f44707fbdd19423db
 SHA512:
-  metadata.gz: eec0abc226f2cbbcad26d3e9d33c1689887818f2f8182224c639838d8ccc9a9e31708b5d16793482e832719c4a1de46f8eead150b3e27acb507e714a41e0a688
-  data.tar.gz: 3350a30114e280ccbb024de1ce07e9a9fa2423e62f097ae4e49b270e9d65659d2515277686914632c950e4314ce67f4c36d6eb25da6ce44acb6d61d9cf9d4d46
+  metadata.gz: f0d816df268ff24c79488afa29105ff493c75f602fcf3a066befe8fbb9824d54ad8ef8c3d3ea8c57fa4be691ed057291e9ca061cf54eb5e4b86c49fa13f408f1
+  data.tar.gz: f960ab4f7c2488112b6d954b6f0b747f3fb2e6999be626d0ebe8d2ec634154b56c8e3cea4cdfe2d900f6395d45ffe4abca61a0880ac5f42742745a428a67c3d4

data/CHANGELOG.md

@@ -1,8 +1,20 @@
-# Change Log
+# Changelog
 
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
-## [0.0.1]
-- terraspace dep for dev only
+## [0.2.2]
+- #4 fix test template: folder rename to stacks
 
+## [0.2.1]
+- #3 update starter example template: bucket_policy_only deprecated for uniform_bucket_level_access
+- edge case: graceful error when bucket doesnt exist yet
+
+## [0.2.0]
+- #2 include layer interface, update template to use expansion method
+
+## [0.1.1]
+- summary command: fix edge case when files are deleted mid-loop
+
+## [0.1.0]
+- Initial release

data/Gemfile

@@ -7,6 +7,5 @@ gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 
 group :development, :test do
-  base = ENV['TS_EDGE_ROOT'] || "#{ENV['HOME']}/environment/terraspace-edge"
-  gem "terraspace", path: "#{base}/terraspace"
+  gem "terraspace"
 end

data/README.md

@@ -18,17 +18,17 @@ config/plugins/google.rb
 
 ```ruby
 TerraspacePluginGoogle.configure do |config|
+  config.auto_create = true # set to false to completely disable auto creation
   config.gcs.versioning = true
 end
 ```
 
 By default:
 
-* GCS Buckets have versioning enabled.
+* GCS Buckets have [versioning](https://cloud.google.com/storage/docs/object-versioning) enabled.
 
 The settings generally only apply if the gcs bucket does not yet exist yet and is created for the first time.
 
-
 ## Versioning
 
 To confirm that the GCS bucket has versioning enabled:

data/git st

@@ -0,0 +1,25 @@
+diff --git a/CHANGELOG.md b/CHANGELOG.md
+index 7e94c34..2fdf029 100644
+--- a/CHANGELOG.md
++++ b/CHANGELOG.md
+@@ -1,8 +1,7 @@
+-# Change Log
++# Changelog
+ 
+ All notable changes to this project will be documented in this file.
+ This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
+ 
+-## [0.0.1]
+-- terraspace dep for dev only
+-
++## [0.1.0]
++- Initial release
+diff --git a/lib/terraspace_plugin_google/version.rb b/lib/terraspace_plugin_google/version.rb
+index b771e2b..75e5bdc 100644
+--- a/lib/terraspace_plugin_google/version.rb
++++ b/lib/terraspace_plugin_google/version.rb
+@@ -1,3 +1,3 @@
+ module TerraspacePluginGoogle
+-  VERSION = "0.0.0"
++  VERSION = "0.1.0"
+ end

data/lib/templates/hcl/module/main.tf

@@ -1,4 +1,4 @@
 resource "google_storage_bucket" "this" {
-  name               = var.name
-  bucket_policy_only = var.bucket_policy_only
+  name                        = var.name
+  uniform_bucket_level_access = var.uniform_bucket_level_access
 }

data/lib/templates/hcl/module/variables.tf

@@ -3,8 +3,8 @@ variable "name" {
   type        = string
 }
 
-variable "bucket_policy_only" {
-  description = "bucket_policy_only"
+variable "uniform_bucket_level_access" {
+  description = "uniform_bucket_level_access"
   type        = bool
   default     = false
 }

data/lib/templates/hcl/project/config/terraform/backend.tf.tt

@@ -0,0 +1,6 @@
+terraform {
+  backend "gcs" {
+    bucket = "<%%= expansion('terraform-state-:PROJECT-:REGION-:ENV') %>" # expanded by terraspace IE: terraform-state-project-us-central1-dev
+    prefix = "<%%= expansion(':REGION/:ENV/:BUILD_DIR') %>" # expanded by terraspace IE: us-central1/dev/modules/vm
+  }
+}

data/lib/templates/hcl/stack/main.tf

@@ -1,10 +1,10 @@
-resource "random_pet" "bucket" {
+resource "random_pet" "this" {
   length = 2
 }
 
 module "bucket" {
   source = "../../modules/example"
 
-  name               = "bucket-${random_pet.bucket.id}"
-  bucket_policy_only = var.bucket_policy_only
+  name                        = "bucket-${random_pet.this.id}"
+  uniform_bucket_level_access = var.uniform_bucket_level_access
 }

data/lib/templates/hcl/stack/variables.tf

@@ -1,5 +1,5 @@
-variable "bucket_policy_only" {
-  description = "bucket_policy_only"
+variable "uniform_bucket_level_access" {
+  description = "uniform_bucket_level_access"
   type        = bool
   default     = false
 }

data/lib/templates/ruby/module/main.rb

@@ -1,4 +1,4 @@
 resource("google_storage_bucket", "this",
-  name:              var.name,
-  bucket_policy_only:var.bucket_policy_only,
+  name:                         var.name,
+  uniform_bucket_level_access: var.uniform_bucket_level_access,
 )

data/lib/templates/ruby/module/variables.rb

@@ -3,8 +3,8 @@ variable("name",
   type:        "string",
 )
 
-variable("bucket_policy_only",
-  description: "bucket_policy_only",
+variable("uniform_bucket_level_access",
+  description: "uniform_bucket_level_access",
   type:        "bool",
   default:     false,
 )

data/lib/templates/ruby/stack/variables.rb

@@ -1,5 +1,5 @@
-variable("bucket_policy_only",
-  description: "bucket_policy_only",
+variable("uniform_bucket_level_access",
+  description: "uniform_bucket_level_access",
   type:        "bool",
   default:     false,
 )

data/lib/templates/test/rspec/module/test/spec/fixtures/stack/main.tf

@@ -1,10 +1,10 @@
-resource "random_pet" "bucket" {
+resource "random_pet" "this" {
   length = 2
 }
 
 module "bucket" {
   source = "../../modules/example"
 
-  name               = "bucket-${random_pet.bucket.id}"
-  bucket_policy_only = var.bucket_policy_only
+  name                        = "bucket-${random_pet.this.id}"
+  uniform_bucket_level_access = var.uniform_bucket_level_access
 }

data/lib/templates/test/rspec/module/test/spec/fixtures/stack/variables.tf

@@ -1,5 +1,5 @@
-variable "bucket_policy_only" {
-  description = "bucket_policy_only"
+variable "uniform_bucket_level_access" {
+  description = "uniform_bucket_level_access"
   type        = bool
   default     = false
 }

data/lib/templates/test/rspec/module/test/spec/main_spec.rb.tt

@@ -1,7 +1,7 @@
 # This starter example of a spec that creates a test harness and provisions a real s3 bucket.
 # The test harness will be created at:
 #
-#    /tmp/terraspace-test-harnesses/<%= @name %>
+#    /tmp/terraspace-test-harnesses/<%= @name %>-harness
 #
 # It's recommended to run this on a test AWS account.
 #
@@ -9,7 +9,7 @@ describe "main" do
   before(:all) do
     mod_path = File.expand_path("../..", __dir__)
     terraspace.build_test_harness(
-      name: "<%= @name %>",
+      name: "<%= @name %>-harness",
       modules: {example: mod_path},
       stacks:  {example: "#{mod_path}/test/spec/fixtures/stack"},
     )

data/lib/templates/test/rspec/project/spec/stacks/demo/main_spec.rb

@@ -0,0 +1,26 @@
+describe "main" do
+  before(:all) do
+    # Build terraspace project to use as a test harness
+    # Will be located at: /tmp/terraspace/test-harnesses/demo-harness
+    terraspace.build_test_harness(
+      name:    "demo-harness",
+      modules: "app/modules",          # include all modules in this folder
+      stacks:  "app/stacks",           # include all stacks in this folder
+      # override demo stack tfvars for testing
+      # copied over to test harness' app/stacks/demo/tfvars/test.tfvars
+      tfvars:  {demo: "spec/fixtures/tfvars/demo.tfvars"},
+      # create config if needed. The folder will be copied over
+      # config:  "spec/fixtures/config",
+    )
+    terraspace.up("demo") # provision real resources
+  end
+  after(:all) do
+    terraspace.down("demo") # destroy real resources
+  end
+
+  it "successful deploy" do
+    # Example
+    bucket_url = terraspace.output("demo", "bucket_url") # IE: gs://bucket-free-coyote
+    expect(bucket_url).to include("gs://bucket-")
+  end
+end

data/lib/terraspace_plugin_google.rb

@@ -1,6 +1,3 @@
-lib = File.expand_path("../../../", __FILE__)
-$:.unshift(lib)
-
 require "memoist"
 require "terraspace" # for interface
 
@@ -20,12 +17,17 @@ module TerraspacePluginGoogle
   def configure(&block)
     Interfaces::Config.instance.configure(&block)
   end
+
+  def config
+    Interfaces::Config.instance.config
+  end
+
   extend self
 end
 
 Terraspace::Plugin.register("google",
   backend: "gcs",
-  config_instance: TerraspacePluginGoogle::Interfaces::Config.instance,
+  config_class: TerraspacePluginGoogle::Interfaces::Config,
   layer_class: TerraspacePluginGoogle::Interfaces::Layer,
   root: File.dirname(__dir__),
 )

data/lib/terraspace_plugin_google/interfaces/backend.rb

@@ -4,15 +4,17 @@ module TerraspacePluginGoogle::Interfaces
     include TerraspacePluginGoogle::Clients
 
     def call
+      return unless TerraspacePluginGoogle.config.auto_create
+
       bucket = @info["bucket"]
       unless bucket # not bucket provided
-        puts "ERROR: no bucket value provided in your terraform backend config".color(:red)
+        logger.error "ERROR: no bucket value provided in your terraform backend config"
         exit 1
       end
       if exist?(bucket)
-        # puts "Bucket already exist: #{bucket}"
+        logger.debug "Bucket already exist: #{bucket}"
       else
-        puts "Creating bucket: #{bucket}"
+        logger.info "Creating bucket: #{bucket}"
         create_bucket(bucket)
       end
     end
@@ -27,10 +29,14 @@ module TerraspacePluginGoogle::Interfaces
     def exist?(name)
       !!storage.bucket(name)
     rescue Google::Cloud::PermissionDeniedError => e
-      puts "#{e.class}: #{e.message}"
-      puts "ERROR: Bucket is not available: #{name}".color(:red)
-      puts "Bucket might be owned by someone else or is on another one of your Google accounts."
+      logger.error "#{e.class}: #{e.message}"
+      logger.error "ERROR: Bucket is not available: #{name}".color(:red)
+      logger.error "Bucket might be owned by someone else or is on another one of your Google accounts."
       exit 1
     end
+
+    def logger
+      Terraspace.logger
+    end
   end
 end

data/lib/terraspace_plugin_google/interfaces/config.rb

@@ -3,12 +3,16 @@ module TerraspacePluginGoogle::Interfaces
     include Terraspace::Plugin::Config::Interface
     include Singleton
 
+    # interface method
+    # load_project_config: config/plugins/google.rb
     def provider
       "google"
     end
 
+    # interface method
     def defaults
       c = ActiveSupport::OrderedOptions.new
+      c.auto_create = true
       c.gcs = ActiveSupport::OrderedOptions.new
       c.gcs.versioning = true
       c

data/lib/terraspace_plugin_google/interfaces/expander.rb

@@ -4,6 +4,8 @@ module TerraspacePluginGoogle::Interfaces
   class Expander
     include Terraspace::Plugin::Expander::Interface
     delegate :project, :region, to: :gcp_data
+    alias_method :namespace, :project
+    alias_method :location, :region
 
     def gcp_data
       GcpData

data/lib/terraspace_plugin_google/interfaces/layer.rb

@@ -2,26 +2,17 @@ require "gcp_data"
 
 module TerraspacePluginGoogle::Interfaces
   class Layer
+    include Terraspace::Plugin::Layer::Interface
     extend Memoist
 
     # interface method
-    def region
-      gcp_data.region
-    end
-
-    # interface method
-    # not a typo, mapping project to "account" to confirm to interface
-    def account
-      gcp_data.project
+    def namespace
+      GcpData.project
     end
 
     # interface method
-    def provider
-      "google"
-    end
-
-    def gcp_data
-      GcpData
+    def region
+      GcpData.region
     end
   end
 end

data/lib/terraspace_plugin_google/interfaces/summary.rb

@@ -0,0 +1,35 @@
+module TerraspacePluginGoogle::Interfaces
+  class Summary
+    include Terraspace::Plugin::Summary::Interface
+    include TerraspacePluginGoogle::Clients
+
+    # interface method
+    def key_field
+      'prefix'
+    end
+
+    # interface method
+    def download
+      bucket = storage.bucket(@bucket)
+      unless bucket
+        logger.error "ERROR: bucket #{@bucket} does not exist".color(:red)
+        exit 1
+      end
+      bucket.files(prefix: @folder).all do |f|
+        file = bucket.file(f.name)
+        next if file.nil? # in case file has been removed since .files
+        # Note the f.name already includes the folder
+        local_path = "#{@dest}/#{f.name}"
+        FileUtils.mkdir_p(File.dirname(local_path))
+        file.download(local_path)
+      end
+    end
+
+    # interface method
+    def delete_empty_statefile(key)
+      bucket = storage.bucket(@bucket)
+      file = bucket.file(key)
+      file.delete
+    end
+  end
+end

data/lib/terraspace_plugin_google/version.rb

@@ -1,3 +1,3 @@
 module TerraspacePluginGoogle
-  VERSION = "0.0.0"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace_plugin_google
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-31 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gcp_data
@@ -82,19 +82,20 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- git st
 - lib/templates/hcl/module/main.tf
 - lib/templates/hcl/module/outputs.tf
 - lib/templates/hcl/module/variables.tf
-- lib/templates/hcl/project/config/templates/backend.tf.tt
-- lib/templates/hcl/project/config/templates/provider.tf
+- lib/templates/hcl/project/config/terraform/backend.tf.tt
+- lib/templates/hcl/project/config/terraform/provider.tf
 - lib/templates/hcl/stack/main.tf
 - lib/templates/hcl/stack/outputs.tf
 - lib/templates/hcl/stack/variables.tf
 - lib/templates/ruby/module/main.rb
 - lib/templates/ruby/module/outputs.rb
 - lib/templates/ruby/module/variables.rb
-- lib/templates/ruby/project/config/templates/backend.rb.tt
-- lib/templates/ruby/project/config/templates/provider.rb
+- lib/templates/ruby/project/config/terraform/backend.rb.tt
+- lib/templates/ruby/project/config/terraform/provider.rb
 - lib/templates/ruby/stack/main.rb
 - lib/templates/ruby/stack/outputs.rb
 - lib/templates/ruby/stack/variables.rb
@@ -105,6 +106,8 @@ files:
 - lib/templates/test/rspec/module/test/spec/fixtures/stack/variables.tf
 - lib/templates/test/rspec/module/test/spec/main_spec.rb.tt
 - lib/templates/test/rspec/module/test/spec/spec_helper.rb
+- lib/templates/test/rspec/project/spec/fixtures/tfvars/demo.tfvars
+- lib/templates/test/rspec/project/spec/stacks/demo/main_spec.rb
 - lib/terraspace_plugin_google.rb
 - lib/terraspace_plugin_google/autoloader.rb
 - lib/terraspace_plugin_google/clients.rb
@@ -112,6 +115,7 @@ files:
 - lib/terraspace_plugin_google/interfaces/config.rb
 - lib/terraspace_plugin_google/interfaces/expander.rb
 - lib/terraspace_plugin_google/interfaces/layer.rb
+- lib/terraspace_plugin_google/interfaces/summary.rb
 - lib/terraspace_plugin_google/version.rb
 - terraspace_plugin_google.gemspec
 homepage: https://github.com/boltops-tools/terraspace_plugin_google

data/lib/templates/hcl/project/config/templates/backend.tf.tt

@@ -1,6 +0,0 @@
-terraform {
-  backend "gcs" {
-    bucket = "<%%= backend_expand("gcs", "terraform-state-:PROJECT-:REGION-:ENV") %>" # expanded by terraspace IE: terraform-state-project-us-central1-dev
-    prefix = "<%%= backend_expand("gcs", ":REGION/:ENV/:BUILD_DIR") %>" # expanded by terraspace IE: us-central1/dev/modules/vm
-  }
-}