awshark 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f20abce36658043c8b046859575b969365fd56528b3a786ca71e3009b078909
-  data.tar.gz: 75631cf5ad34c594571a1f46297d3fa23c8da384c4789c43ea857a4ab09b972c
+  metadata.gz: bef9c837050b965232d2ecdb22ee410262cdd4bb204fbeafd5458bd515d5161a
+  data.tar.gz: 87fe084cc741d50679c804bfa7f4e946ff664cbb211ace537b0b17fb8604e325
 SHA512:
-  metadata.gz: e75070ff5ad3295b994b9408edc5e448a205a413278b9dc6d2cae3b891840a976f6f5b0ccd9d8d4b9f6ba85fdf081ad1b3c83727712bea4228cb5248e659019b
-  data.tar.gz: aa0feb28170116e34cab5a60ca8e60cfd6a6b76c9def7aaf78709aaa28a3475d2067bc39e76c9303481304ef11a757f69a54ebd4fdb9a0e1ce9cedf84c98d778
+  metadata.gz: e1ecb73e200abbacb8f9e0d40799e968ab33e801550c6ecf6c8b8400fedc6b0594792b6919653a78f25391be4a90804ffbb224593a8eaed67ed2fd2e0081010c
+  data.tar.gz: dc2f4213c6baa6bfcd14fe06a29e23457f9129f58e932f6d7562b3a5b763651d8ff36741152620f8bce2179331015e2e96fa380e4ed3ccfbfc95fb805a7d2094

data/.rubocop.yml

@@ -4,11 +4,20 @@
 # See https://docs.rubocop.org/rubocop/configuration
 
 AllCops:
-  TargetRubyVersion: 2.7
+  NewCops: enable
+  TargetRubyVersion: 3.1
   Exclude:
     - 'bin/*'
     - 'tmp/*'
 
+Bundler/GemFilename:
+  EnforcedStyle: gems.rb
+
+Gemspec/RequireMFA:
+  Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Layout/BeginEndAlignment:
   Enabled: true
   EnforcedStyleAlignWith: begin
@@ -67,6 +76,7 @@ Lint/UselessMethodDefinition:
 Lint/UselessTimes:
   Enabled: true
 
+
 Metrics/AbcSize:
   Enabled: true
   Max: 25
@@ -85,6 +95,8 @@ Style/ExponentialNotation:
   Enabled: true
 Style/HashEachMethods:
   Enabled: true
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
 Style/HashTransformKeys:
   Enabled: true
 Style/HashTransformValues:
@@ -117,6 +129,8 @@ Style/HashLikeCase:
   Enabled: true
 Style/KeywordParametersOrder:
   Enabled: true
+Style/OpenStructUse:
+  Enabled: false
 Style/OptionalBooleanParameter:
   Enabled: true
 Style/RedundantAssignment:

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Changelog
 
+#### 1.6.0
+- [new] `awshark cf [command] --format` option to export CF template not always as JSON ()
+
+#### 1.5.1
+- [new] `awshark cf [command] --bucket` option allows S3 path prefix
+
 #### 1.5.0
 - [new] add `awshark ssm list` to list AWS Parameter Store secrets
 - [new] add `awshark ssm deploy` to update AWS Parameter Store secrets

data/README.md

@@ -47,12 +47,12 @@ awshark ecs list
 
 Display changes to AWS Cloud Formation stack.
 ```
-awshark cf diff TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de
+awshark cf diff TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de --format=json|yaml
 ```
 
 Update or create AWS Cloud Formation stack.
 ```
-awshark cf deploy TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de
+awshark cf deploy TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de --format=json|yaml
 ```
 
 Save AWS Cloud Formation stack as file `STACK_NAME-STAGE.json`.

data/awshark.gemspec

@@ -42,8 +42,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mini_mime'
   spec.add_dependency 'recursive-open-struct'
   spec.add_dependency 'thor', '~> 1.0'
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rspec', '~> 3.9.0'
-  spec.add_development_dependency 'rubocop', '0.93.1'
 end

data/gems.rb

@@ -4,3 +4,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in awshark.gemspec
 gemspec
+
+gem 'bundler', '~> 2.0'
+gem 'rspec', '~> 3.12.0'
+gem 'rubocop', '~> 1.56.4'

data/lib/awshark/cloud_formation/{file_loading.rb → files.rb}

@@ -2,20 +2,23 @@
 
 module Awshark
   module CloudFormation
-    module FileLoading
-      def load_file(filepath, context = nil)
+    module Files
+      def parse_file(filepath)
         return nil if filepath.blank?
 
         content = File.read(filepath)
-        content = ERB.new(content).result_with_hash(context) if context.present?
 
-        case File.extname(filepath)
+        parse_string(filepath, content)
+      end
+
+      def parse_string(filename, content)
+        case File.extname(filename)
         when '.json'
           JSON.parse(content)
         when '.yml', '.yaml'
           YAML.safe_load(content, permitted_classes: [Date, Time], aliases: true)
         else
-          raise ArgumentError, "Unsupported file extension for #{filepath}"
+          raise ArgumentError, "Unsupported file extension for parsing, #{filepath}"
         end
       end
     end

data/lib/awshark/cloud_formation/manager.rb

@@ -48,7 +48,7 @@ module Awshark
 
       def save_stack_template
         filename = "#{stack.name}.json"
-        File.open(filename, 'w') { |f| f.write(template.body) }
+        File.write(filename, template.body)
         filename
       end
 

data/lib/awshark/cloud_formation/parameters.rb

@@ -3,7 +3,7 @@
 module Awshark
   module CloudFormation
     class Parameters
-      include FileLoading
+      include Files
 
       attr_reader :stage
 
@@ -34,7 +34,7 @@ module Awshark
       private
 
       def load_parameters(filepath)
-        data = load_file(filepath) || {}
+        data = parse_file(filepath) || {}
 
         data[stage] || data
       end

data/lib/awshark/cloud_formation/stack.rb

@@ -77,9 +77,10 @@ module Awshark
                      client.describe_stacks(stack_name: stack_name)
                    rescue Aws::CloudFormation::Errors::ValidationError
                      @stack = nil
-                     return
                    end
 
+        return unless response.present?
+
         if response.stacks.length > 1
           raise ArgumentError, "Found too many stacks with name #{stack_name}. There should only be one."
         end

data/lib/awshark/cloud_formation/subcommand.rb

@@ -5,7 +5,7 @@ require 'aws-sdk-ssm'
 require 'diffy'
 require 'recursive-open-struct'
 
-require 'awshark/cloud_formation/file_loading'
+require 'awshark/cloud_formation/files'
 require 'awshark/cloud_formation/inferrer'
 require 'awshark/cloud_formation/manager'
 require 'awshark/cloud_formation/parameters'
@@ -21,6 +21,7 @@ module Awshark
       class_option :bucket, type: :string, desc: 'S3 bucket for template'
       class_option :iam, type: :boolean, desc: 'Needs IAM capabilities'
       class_option :stage, type: :string, desc: 'Stage of the configuration'
+      class_option :format, type: :string, desc: 'Stage of the configuration', default: 'json'
 
       desc 'deploy', 'Updates or creates an AWS CloudFormation stack'
       long_desc <<-LONGDESC

data/lib/awshark/cloud_formation/template.rb

@@ -3,34 +3,41 @@
 module Awshark
   module CloudFormation
     class Template
-      include FileLoading
+      include Files
 
       attr_reader :path
-      attr_reader :bucket, :name, :stage
+      attr_reader :bucket, :name, :stage, :format
 
       def initialize(path, options = {})
         @path = path
 
-        @bucket = options[:bucket]
+        @bucket_and_path = options[:bucket]
+        @bucket = (options[:bucket] || '').split('/')[0]
         @name = options[:name]
         @stage = options[:stage]
+        @format = options[:format] || 'yaml'
       end
 
-      # @returns [Hash]
-      def as_json
-        load_file(template_path, context)
-      end
-
-      # @returns [String]
+      # @returns String
       def body
-        JSON.pretty_generate(as_json)
+        return nil if template_path.blank?
+
+        content = File.read(template_path)
+        content = ERB.new(content).result_with_hash(context)
+
+        if format == 'json'
+          json = parse_string(template_path, content)
+          return JSON.pretty_generate(json)
+        end
+
+        content
       end
 
       # @returns [Hash]
       def context
         @context ||=
           begin
-            context = load_file(context_path) || {}
+            context = parse_file(context_path) || {}
             context = context[stage] if context.key?(stage)
 
             {
@@ -77,8 +84,11 @@ module Awshark
       end
 
       def s3_key
-        # https://apidock.com/ruby/Time/strftime
-        @s3_key ||= "awshark/#{name}/#{Time.now.strftime('%Y-%m-%d')}.json"
+        return @s3_key if defined?(@s3_key)
+
+        _, *tail = @bucket_and_path.split('/')
+        prefix = [*tail, 'awshark', name].join('/')
+        @s3_key = "#{prefix}/#{Time.now.strftime('%Y-%m-%d')}.json"
       end
 
       def upload

data/lib/awshark/profile_resolver.rb

@@ -3,12 +3,12 @@
 module Awshark
   class ProfileResolver
     def initialize(options)
-      @profile = options[:profile] || ENV['AWS_PROFILE']
+      @profile = options[:profile] || ENV.fetch('AWS_PROFILE')
       @shared_config = ::Aws::SharedConfig.new(
         profile_name: @profile,
         config_enabled: true
       )
-      @region = options[:region] || ENV['REGION']
+      @region = options[:region] || ENV.fetch('REGION', nil)
     end
 
     def credentials

data/lib/awshark/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Awshark
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awshark
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Joergen Dahlke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,48 +192,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.93.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.93.1
 description: Custom CLI for for AWS to simplify common tasks with EC2, S3 and Cloud
   Formation
 email:
@@ -255,7 +213,7 @@ files:
 - lib/awshark/class_options.rb
 - lib/awshark/cli.rb
 - lib/awshark/cloud_formation/configuration.rb
-- lib/awshark/cloud_formation/file_loading.rb
+- lib/awshark/cloud_formation/files.rb
 - lib/awshark/cloud_formation/inferrer.rb
 - lib/awshark/cloud_formation/manager.rb
 - lib/awshark/cloud_formation/parameters.rb