terraspace_plugin_azurerm 0.0.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5558017d6143d6bfda510f1aab5508130506d1a9de81bc75582b145ee2867d3b
-  data.tar.gz: ec7ece5847e2cb02ba991d00ceb7d91e60b4d1886a2c1d7c23333e3fd4369a2d
+  metadata.gz: b3ff4bc13ad8e73d40b985420c107ef791d652bde858092271a239715ec6b824
+  data.tar.gz: cdbc5ddac31c0c4fad5676ea802810fd9982f02a59f3347bf72d4e407f7abec7
 SHA512:
-  metadata.gz: 33461605e1ff3b16b2eb0d7b4b0230805dc34542181aa51a48a2d6e41a8b1940951673452cc1d9e06a642b47e6b427403edd9265edebffa3a26f190eba081ee3
-  data.tar.gz: '004158f2120660455a6450b581ceda03ce91bacd45b32b836149672fa0b5f800e79b58563c754c65d69d90556a56c900039e4a71caccf3687f138bc5b34f50c1'
+  metadata.gz: 878dc0469567622cd0bf3ef0c378ae5ba9962035511110fdb057892873d0d4e67cf0e00c2173cc52904ea9d2a58d7c2062b1bac8673a8dd45c03bb946e220149
+  data.tar.gz: f9f776fc7ad11500b9f29c57a141012b883295f59e25c67d7393d07a6dde2aadaf71f7e2322848bdf67ba5feaebce3553c49a4004632e83f9fc5026b965278bf

data/CHANGELOG.md

@@ -1,8 +1,19 @@
-# 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.0]
-- item 1
+## [0.2.2]
+- #3 fix test template
 
+## [0.2.1]
+- set prefix to @folder for performance improvement
+
+## [0.2.0]
+- #1 include layer interface, update template to use expansion method, add region method
+
+## [0.1.1]
+- update generator init terraform state path
+
+## [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/lib/templates/hcl/module/main.tf

@@ -1,7 +1,8 @@
 resource "azurerm_storage_account" "this" {
-  name                     = var.name
-  resource_group_name      = var.resource_group_name
-  location                 = var.location
-  account_tier             = "Standard"
-  account_replication_type = "GRS"
+  name                      = var.name
+  resource_group_name       = var.resource_group_name
+  location                  = var.location
+  account_tier              = "Standard"
+  account_replication_type  = "GRS"
+  enable_https_traffic_only = var.enable_https_traffic_only
 }

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

@@ -12,3 +12,9 @@ variable "location" {
   description = "The name of the storage location"
   type        = string
 }
+
+variable "enable_https_traffic_only" {
+  description = "forces HTTPS if enabled"
+  type        = string
+  default     = true
+}

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

@@ -1,10 +1,10 @@
 # SUBSCRIPTION_HASH is a short 4-char consistent hash of the longer subscription id.
-# This is useful because azure storage accounts not allowed special characters and can only be 24 chars long.
+# This is useful because azure storage account names are not allowed special characters and are limited to 24 chars.
 terraform {
   backend "azurerm" {
-    resource_group_name  = "<%= backend_expand('azurerm', 'terraform-resources-:LOCATION') %>"
-    storage_account_name = "<%= backend_expand('azurerm', 'ts:SUBSCRIPTION_HASH:LOCATION:ENV') %>"
+    resource_group_name  = "<%= expansion('terraform-resources-:LOCATION') %>"
+    storage_account_name = "<%= expansion('ts:SUBSCRIPTION_HASH:LOCATION:ENV') %>"
     container_name       = "terraform-state"
-    key                  = "<%= backend_expand('azurerm', ':LOCATION/:ENV/:BUILD_DIR') %>"
+    key                  = "<%= expansion(':LOCATION/:ENV/:BUILD_DIR/terraform.tfstate') %>"
   }
 }

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

@@ -1,5 +1,6 @@
 resource "random_pet" "this" {
-  length = 1 # using 1, since default separator is '-', also account name can only be 24 characters, and lowercase letters
+  length = 2 # using 2, since default separator is '-', also account name can only be 24 characters, and lowercase letters
+  separator = ""# a blank string separator because azure storage accounts dont support - characters
 }
 
 resource "azurerm_resource_group" "this" {
@@ -8,8 +9,9 @@ resource "azurerm_resource_group" "this" {
 }
 
 module "storage_account" {
-  source               = "../../modules/example"
-  name                 =  "sa${random_pet.this.id}"
-  resource_group_name  = azurerm_resource_group.this.name
-  location             = azurerm_resource_group.this.location
+  source                    = "../../modules/example"
+  name                      =  "sa${random_pet.this.id}"
+  resource_group_name       = azurerm_resource_group.this.name
+  location                  = azurerm_resource_group.this.location
+  enable_https_traffic_only = var.enable_https_traffic_only
 }

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

@@ -1 +1,5 @@
-# This is where you put an example
+variable "enable_https_traffic_only" {
+  description = "forces HTTPS if enabled"
+  type        = string
+  default     = true
+}

data/lib/templates/ruby/project/config/terraform/backend.rb

@@ -1,8 +1,8 @@
 # SUBSCRIPTION_HASH is a short 4-char consistent hash of the longer subscription id.
-# This is useful because azure storage accounts not allowed special characters and can only be 24 chars long.
+# This is useful because azure storage account names are not allowed special characters and are limited to 24 chars.
 backend("azurerm",
   resource_group_name:  "terraform-resources-:LOCATION",
   storage_account_name: "ts:SUBSCRIPTION_HASH:LOCATION:ENV",
   container_name:       "terraform-state",
-  key:                  ":LOCATION/:ENV/:BUILD_DIR",
+  key:                  ":LOCATION/:ENV/:BUILD_DIR/terraform.tfstate",
 )

data/lib/templates/test/rspec/project/spec/fixtures/config/app.rb

@@ -0,0 +1,4 @@
+Terraspace.configure do |config|
+  config.logger.level = :info
+  config.test_framework = "rspec"
+end

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

@@ -8,6 +8,7 @@ describe "main" do
       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
+      # need for azure
       tfvars:  {demo: "spec/fixtures/tfvars/demo.tfvars"},
       config: "spec/fixtures/config",
     )
@@ -18,9 +19,6 @@ describe "main" do
   end
 
   it "successful deploy" do
-    # Replace with your actual test
-    expect(true).to be true
-    # Example
     storage_account_id = terraspace.output("demo", "storage_account_id")
     expect(storage_account_id).to include("sa") # starts with sa
   end

data/lib/terraspace_plugin_azurerm.rb

@@ -18,6 +18,11 @@ module TerraspacePluginAzurerm
   def configure(&block)
     Interfaces::Config.instance.configure(&block)
   end
+
+  def config
+    Interfaces::Config.instance.config
+  end
+
   extend self
 end
 

data/lib/terraspace_plugin_azurerm/interfaces/backend/base.rb

@@ -17,5 +17,9 @@ class TerraspacePluginAzurerm::Interfaces::Backend
       AzureInfo
     end
     memoize :azure_info
+
+    def logger
+      Terraspace.logger
+    end
   end
 end

data/lib/terraspace_plugin_azurerm/interfaces/backend/resource_group_creator.rb

@@ -5,7 +5,7 @@ class TerraspacePluginAzurerm::Interfaces::Backend
 
     def create
       if exist?
-        puts "Resource Group #{@resource_group_name} already exists" if ENV['TS_LOUD']
+        logger.debug "Resource Group #{@resource_group_name} already exists"
       else
         create_resource_group
       end
@@ -16,7 +16,7 @@ class TerraspacePluginAzurerm::Interfaces::Backend
     end
 
     def create_resource_group
-      puts "Creating Resource Group #{@resource_group_name}..."
+      logger.info "Creating Resource Group #{@resource_group_name}..."
       resource_group = ResourceGroup.new
       resource_group.name = @resource_group_name
       resource_group.location = config.location || AzureInfo.location

data/lib/terraspace_plugin_azurerm/interfaces/backend/storage_account.rb

@@ -5,7 +5,7 @@ class TerraspacePluginAzurerm::Interfaces::Backend
 
     def create
       if exist?
-        puts "Storage Account #{@storage_account_name} already exists" if ENV['TS_LOUD']
+        logger.debug "Storage Account #{@storage_account_name} already exists"
       else
         create_storage_account
       end
@@ -24,8 +24,8 @@ class TerraspacePluginAzurerm::Interfaces::Backend
 
       case result.reason
       when "AccountNameInvalid"
-        puts "ERROR: Failed to create storage account, reason: #{result.reason}".color(:red)
-        puts "Provided storage_account_name: #{@storage_account_name}"
+        logger.error "ERROR: Failed to create storage account, reason: #{result.reason}".color(:red)
+        logger.error "Provided storage_account_name: #{@storage_account_name}"
         exit 1
       else
         false
@@ -33,7 +33,7 @@ class TerraspacePluginAzurerm::Interfaces::Backend
     end
 
     def create_storage_account
-      puts "Creating Storage Account #{@storage_account_name}..."
+      logger.info "Creating Storage Account #{@storage_account_name}..."
       storage_accounts.create(@resource_group_name, @storage_account_name, storage_account_params)
     end
 

data/lib/terraspace_plugin_azurerm/interfaces/backend/storage_container.rb

@@ -5,7 +5,7 @@ class TerraspacePluginAzurerm::Interfaces::Backend
 
     def create
       if exist?
-        puts "Storage Container #{@container_name} already exists" if ENV['TS_LOUD']
+        logger.debug "Storage Container #{@container_name} already exists"
       else
         create_storage_container
       end
@@ -21,7 +21,7 @@ class TerraspacePluginAzurerm::Interfaces::Backend
     end
 
     def create_storage_container
-      puts "Creating Storage Container #{@container_name}..."
+      logger.info "Creating Storage Container #{@container_name}..."
       blob_container = BlobContainer.new
       blob_container.name = @container_name
       blob_containers.create(@resource_group_name, @storage_account_name, @container_name, blob_container)

data/lib/terraspace_plugin_azurerm/interfaces/config.rb

@@ -3,6 +3,8 @@ module TerraspacePluginAzurerm::Interfaces
     include Terraspace::Plugin::Config::Interface
     include Singleton # Config class must be a Singleton with the class .instance method
 
+    # interface method
+    # load_project_config: config/plugins/azurerm.rb
     def provider
       "azurerm"
     end

data/lib/terraspace_plugin_azurerm/interfaces/expander.rb

@@ -16,21 +16,18 @@ module TerraspacePluginAzurerm::Interfaces
 
     delegate :subscription_id, :subscription, :tenant_id, :tenant_id, :group, :location, to: :azure_info
     alias_method :namespace, :subscription
+    alias_method :region, :location
 
     def azure_info
       AzureInfo
     end
 
     # subscription_hash is a short 4-char consistent hash of the longer subscription id.
-    # This is useful because azure storage accounts not allowed special characters and can only be 24 chars long.
+    # This is useful because azure storage account names are not allowed special characters and are limited to 24 chars.
     # NOTE: be careful to not change this! or else state path will change
     def subscription_hash
       Digest::SHA1.hexdigest(subscription)[0..3]
     end
-
-    # NOTE: be careful to not change this! or else state path will change
-    def namespace_hash
-      Digest::SHA1.hexdigest(subscription)[0..3]
-    end
+    alias_method :namespace_hash, :subscription_hash
   end
 end

data/lib/terraspace_plugin_azurerm/interfaces/layer.rb

@@ -1,6 +1,7 @@
 module TerraspacePluginAzurerm::Interfaces
   class Layer
     extend Memoist
+    include Terraspace::Plugin::Layer::Interface
 
     # interface method
     def namespace
@@ -11,10 +12,5 @@ module TerraspacePluginAzurerm::Interfaces
     def region
       AzureInfo.location
     end
-
-    # interface method
-    def provider
-      "azurerm"
-    end
   end
 end

data/lib/terraspace_plugin_azurerm/interfaces/summary.rb

@@ -0,0 +1,122 @@
+require 'azure/storage/blob'
+
+module TerraspacePluginAzurerm::Interfaces
+  class Summary
+    include Terraspace::Plugin::Summary::Interface
+    include TerraspacePluginAzurerm::Clients::Storage # for mgmt storage_accounts to get keys only, the azure/storage/blob gem is used to get the objects
+    extend Memoist
+
+    # interface method
+    def bucket_field
+      'storage_account_name'
+    end
+
+    # interface method
+    def download
+      marker = nil
+      loop do
+        blobs = list_blobs(container_name, marker: marker)
+        blobs.each do |blob|
+          blob, content = blob_client.get_blob(container_name, blob.name)
+          local_path = "#{@dest}/#{blob.name}"
+          FileUtils.mkdir_p(File.dirname(local_path))
+          File.open(local_path, 'wb') {|f| f.write(content)}
+        end
+        marker = blobs.continuation_token
+        break unless marker && !marker.empty?
+      end
+    end
+
+    # interface method
+    def delete_empty_statefile(key)
+      delete_blob(key)
+    end
+
+    def delete_blob(key)
+      blob_client.delete_blob(container_name, key)
+    rescue Azure::Core::Http::HTTPError => e
+      case e.message
+      when /BlobNotFound/
+        logger.info "WARN: #{e.class}: #{e.message}"
+        logger.info "Blob item does not exist: #{key}"
+      when /ContainerNotFound/
+        logger.info "WARN: #{e.class}: #{e.message}"
+        logger.info "Container not found: #{container_name}"
+      else
+        raise
+      end
+    end
+
+    def container_name
+      @info['container_name']
+    end
+
+    # Friendly error handling for user
+    def list_blobs(container_name, marker:)
+      blob_client.list_blobs(container_name, marker: marker, prefix: @folder)
+    rescue Azure::Core::Http::HTTPError => e
+      if e.message.include?("AuthenticationFailed")
+        logger.error "e.class #{e.class}: #{e.message}"
+        logger.error "Unable to authenticate to download the statefiles from the storage account.".color(:red)
+        if ENV['AZURE_STORAGE_ACCESS_KEY']
+          logger.error <<~EOL
+            It looks like you have the AZURE_STORAGE_ACCESS_KEY environment variable set.
+            It may be the incorrect key for the storage account: #{@info['storage_account_name']}
+            Try unsetting it:
+
+                unset AZURE_STORAGE_ACCESS_KEY
+
+            When the environment variable is not set, this library will try to fetch the key for you.
+            Or you can try setting the correct key.
+          EOL
+        else
+          logger.error <<~EOL
+            The fetched storage access key did not seem to authenticate successfully.
+            Try setting the AZURE_STORAGE_ACCESS_KEY environment variable with access to the storage account: #{@info['storage_account_name']}
+          EOL
+        end
+        # Common message
+        logger.error <<~EOL
+          One way to get the key is with:
+
+              az storage account keys list --account-name #{@info['storage_account_name']} --resource-group #{@info['resource_group_name']}
+
+          Then you can set it:
+
+              export AZURE_STORAGE_ACCESS_KEY=[replace-with-value]
+        EOL
+        exit 1
+      else
+        raise
+      end
+    end
+
+  private
+    def blob_client
+      # Note per docs: https://github.com/azure/azure-storage-ruby/tree/master/blob#via-environment-variables
+      #
+      #     export AZURE_STORAGE_ACCOUNT = <your azure storage account name>
+      #     export AZURE_STORAGE_ACCESS_KEY = <your azure storage access key>
+      #
+      # Works if zero args are passed to the create method. But set the storage_account_name arg, so we must also set
+      # the storage_access_key explicitly. We'll follow the same env variable convention.
+      #
+      Azure::Storage::Blob::BlobService.create(
+        storage_account_name: @info['storage_account_name'],
+        storage_access_key: storage_access_key
+      )
+    end
+    memoize :blob_client
+
+    def storage_access_key
+      ENV['AZURE_STORAGE_ACCESS_KEY'] || fetch_storage_access_key
+    end
+
+    def fetch_storage_access_key
+      # result is a StorageAccountListKeysResult with a keys reader method
+      # then .value contains the key
+      result = storage_accounts.list_keys(@info['resource_group_name'], @info['storage_account_name'])
+      result.keys.first.value
+    end
+  end
+end

data/lib/terraspace_plugin_azurerm/version.rb

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

data/terraspace_plugin_azurerm.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # spec.add_dependency "azure_info"
+  spec.add_dependency "azure-storage-blob"
+  spec.add_dependency "azure_info"
   spec.add_dependency "azure_mgmt_resources"
   spec.add_dependency "azure_mgmt_storage"
   spec.add_dependency "memoist"

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: terraspace_plugin_azurerm
 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-06-02 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: azure-storage-blob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: azure_info
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_resources
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +134,7 @@ 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/config/app.rb
 - lib/templates/test/rspec/project/spec/fixtures/config/terraform/provider.tf
 - lib/templates/test/rspec/project/spec/fixtures/tfvars/demo.tfvars
 - lib/templates/test/rspec/project/spec/spec_helper.rb
@@ -123,6 +152,7 @@ files:
 - lib/terraspace_plugin_azurerm/interfaces/config.rb
 - lib/terraspace_plugin_azurerm/interfaces/expander.rb
 - lib/terraspace_plugin_azurerm/interfaces/layer.rb
+- lib/terraspace_plugin_azurerm/interfaces/summary.rb
 - lib/terraspace_plugin_azurerm/version.rb
 - terraspace_plugin_azurerm.gemspec
 homepage: https://github.com/boltops-tools/terraspace_plugin_azurerm