awshark 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1893ca9f5ab0defd36515f70c621d987d2981c01b8c70bab0735ff422ec7c588
+  data.tar.gz: dd4c8992a1c8c5aec6e978f60e5d8f879f46e4013fe1fe5ea45e274d426f3b81
+SHA512:
+  metadata.gz: 31f09cd910a4b782c4ba1e142d89446fb92259eafbb51cbbdbbc2d0108aa9bce50bd24c9dd5f01740bc5f5ec560fc7703554df347b7b4279bce8a6a38c2ce666
+  data.tar.gz: fd69d7cd781331e6a25d2d1c5615b66bfae57796a8f16bd441888a348951a3e9cb157b5def2df3f4214517c7b5f71b85b2affcb76af78771b995843fbe360236

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+gems.locked

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--format progress
+--profile

data/.rubocop.yml

@@ -0,0 +1,130 @@
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'bin/*'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+    - 'spec/**/*'
+    - 'tmp/*'
+
+
+Layout/BeginEndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: begin
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+Lint/ConstantDefinitionInBlock:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/DuplicateRequire:
+  Enabled: true
+Lint/DuplicateRescueException:
+  Enabled: true
+Lint/EmptyConditionalBody:
+  Enabled: true
+Lint/EmptyFile:
+  Enabled: true
+Lint/FloatComparison:
+  Enabled: true
+Lint/HashCompareByIdentity:
+  Enabled: true
+Lint/IdentityComparison:
+  Enabled: true
+Lint/MissingSuper:
+  Enabled: true
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+Lint/RedundantSafeNavigation:
+  Enabled: true
+Lint/SelfAssignment:
+  Enabled: true
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+Lint/UnreachableLoop:
+  Enabled: true
+Lint/UselessMethodDefinition:
+  Enabled: true
+Lint/UselessTimes:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 20
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: false
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/ClassEqualityComparison:
+  Enabled: true
+Style/CombinableLoops:
+  Enabled: true
+Style/ExplicitBlockArgument:
+  Enabled: true
+Style/GlobalStdStream:
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/KeywordParametersOrder:
+  Enabled: true
+Style/OptionalBooleanParameter:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantSelfAssignment:
+  Enabled: true
+Style/SingleArgumentDig:
+  Enabled: true
+Style/SoleNestedConditional:
+  Enabled: true
+Style/StringConcatenation:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## Changelog
+
+#### 1.0.0
+- initial version

data/README.md

@@ -0,0 +1,62 @@
+# Awshark
+
+[![GitHub Actions Test Status](https://github.com/jdahlke/awshark/workflows/Tests/badge.svg?branch=develop)](https://github.com/jdahlke/awshark/actions)
+
+Simple command-line tool for some useful tasks for AWS *EC2*, *S3* and *CloudFormation*.
+
+
+### Installation
+
+```
+gem install awshark
+```
+
+
+### Usage
+
+#### S3 commands
+
+List all S3 buckets
+```
+awshark s3 list --profile=AWS_PROFILE
+```
+
+List all objects in a specific S3 bucket
+```
+awshark s3 objects BUCKET_NAME fonts/ --profile=AWS_PROFILE
+```
+
+#### EC2 commands
+
+List all EC2 instances in a region
+```
+awshark ec2 list --profile=AWS_PROFILE
+```
+
+#### Cloud Formation commands
+
+Update (diff) Cloud Formation stack
+```
+awshark cf deploy TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de --profile=AWS_PROFILE
+
+awshark cf diff TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de --profile=AWS_PROFILE
+```
+
+For a further information visit the [Wiki](https://github.com/jdahlke/awshark/wiki).
+
+
+### Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run
+
+    gem build awshark.gemspec
+    gem install --local awshark-0.1.0.gem
+    rm awshark-0.1.0.gem
+
+
+### Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jdahlke/awshark.

data/awshark.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awshark/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'awshark'
+  spec.version = Awshark::VERSION
+  spec.authors = ['Joergen Dahlke']
+  spec.email = ['joergen.dahlke@infopark.de']
+
+  spec.summary = 'Custom CLI for for AWS related tasks'
+  spec.description = 'Custom CLI for for AWS to simplify common tasks with EC2, S3 and Cloud Formation'
+  spec.homepage = 'https://github.com/jdahlke/awshark'
+  spec.license = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/jdahlke/awshark'
+  spec.metadata['changelog_uri'] = 'https://github.com/jdahlke/awshark/blob/develop/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.github|bin|spec)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6'
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'aws-sdk-cloudformation'
+  spec.add_dependency 'aws-sdk-cloudwatch'
+  spec.add_dependency 'aws-sdk-ec2'
+  spec.add_dependency 'aws-sdk-ecr'
+  spec.add_dependency 'aws-sdk-rds'
+  spec.add_dependency 'aws-sdk-s3'
+  spec.add_dependency 'diffy'
+  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/exe/awshark

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'awshark'
+
+Awshark::Cli.start(ARGV)

data/gems.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in awshark.gemspec
+gemspec

data/lib/awshark.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'logger'
+require 'thor'
+require 'yaml'
+
+require 'awshark/version'
+require 'awshark/configuration'
+
+module Awshark
+  class GracefulFail < StandardError; end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield config
+  end
+
+  def self.logger
+    return @logger if @logger
+
+    @logger = ::Logger.new($stdout)
+    @logger.level = Logger::INFO
+    @logger.formatter = proc do |_severity, _datetime, _progname, msg|
+      "[awshark] #{msg}\n"
+    end
+
+    @logger
+  end
+end
+
+require 'awshark/cli'

data/lib/awshark/cli.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'awshark/profile_resolver'
+
+require 'awshark/subcommands/class_options'
+require 'awshark/subcommands/cloud_formation'
+require 'awshark/subcommands/ec2'
+require 'awshark/subcommands/ecs'
+require 'awshark/subcommands/rds'
+require 'awshark/subcommands/s3'
+
+module Awshark
+  class Cli < Thor
+    package_name 'Awshark'
+
+    map '-v' => :version
+
+    class_option :help, type: :boolean, desc: 'Prints this help'
+    class_option :profile, type: :string, desc: 'Load the AWS credentials profile named PROFILE.'
+    class_option :region, type: :string, desc: 'Sets the AWS region name REGION.'
+
+    desc 'cf COMMAND', 'Run CloudFormation command'
+    subcommand 'cf', Awshark::Subcommands::CloudFormation
+
+    desc 'ec2 COMMAND', 'Run EC2 command'
+    subcommand 'ec2', Awshark::Subcommands::EC2
+
+    desc 'ecs COMMAND', 'Run ECS command'
+    subcommand 'ecs', Awshark::Subcommands::Ecs
+
+    desc 'rds COMMAND', 'Run RDS command'
+    subcommand 'rds', Awshark::Subcommands::Rds
+
+    desc 's3 COMMAND', 'Run CloudFormation command'
+    subcommand 's3', Awshark::Subcommands::S3
+
+    desc 'version', 'Displays current version of AwsShark'
+    long_desc <<-LONGDESC
+        Displays current version of AwsShark.
+    LONGDESC
+    def version
+      puts "AwShark version: #{Awshark::VERSION}"
+    end
+  end
+end

data/lib/awshark/cloud_formation/file_loading.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Awshark
+  module CloudFormation
+    module FileLoading
+      def load_file(filepath, context = nil)
+        return nil if filepath.blank?
+
+        content = File.read(filepath)
+        content = ERB.new(content).result_with_hash(context) if context.present?
+
+        case File.extname(filepath)
+        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}"
+        end
+      end
+    end
+  end
+end

data/lib/awshark/cloud_formation/inferrer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudFormation/Client.html
+#
+module Awshark
+  module CloudFormation
+    class Inferrer
+      attr_reader :path, :stage
+
+      def initialize(path, stage = nil)
+        @path = path
+        @stage = stage
+      end
+
+      def stack_name
+        file_extension = File.extname(path)
+        name = File.basename(path, file_extension)
+
+        [name, stage].compact.join('-').gsub('_', '-')
+      end
+    end
+  end
+end

data/lib/awshark/cloud_formation/manager.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+#
+# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudFormation/Client.html
+#
+module Awshark
+  module CloudFormation
+    class Manager
+      attr_reader :path, :options
+      attr_reader :stack, :stage, :capabilities
+
+      def initialize(path, options = {})
+        @path = path
+        @options = options
+        @stage = options[:stage]
+
+        @capabilities = if options[:iam]
+                          %w[CAPABILITY_IAM CAPABILITY_NAMED_IAM]
+                        else
+                          []
+                        end
+
+        @stack = Stack.new(name: inferrer.stack_name)
+      end
+
+      def diff_stack_template
+        new_template = template.body
+        old_template = stack.template
+        options = { context: 2 }
+
+        diff = Diffy::Diff.new(old_template, new_template, options)
+        diff.to_s(:color)
+      end
+
+      def update_stack
+        stack.create_or_update(
+          capabilities: capabilities,
+          stack_name: stack.name,
+          template_url: template.url,
+          parameters: parameters.stack_parameters
+        )
+      rescue Aws::CloudFormation::Errors::ValidationError => e
+        raise GracefulFail, e.message if e.message.match(/No updates are to be performed/)
+        raise GracefulFail, e.message if e.message.match(/ROLLBACK_COMPLETE state and can not be updated/)
+
+        raise e
+      end
+
+      def tail_stack_events
+        stack.reload
+        stack_events = StackEvents.new(stack)
+
+        loop do
+          events = stack_events.new_events
+          print_stack_events(events)
+
+          break if stack_events.done?
+
+          sleep(event_polling)
+        end
+      end
+
+      private
+
+      def event_polling
+        Awshark.config.cloud_formation.event_polling || 3
+      end
+
+      def inferrer
+        @inferrer ||= Inferrer.new(path, stage)
+      end
+
+      def parameters
+        @parameters ||= Parameters.new(path: path, stage: stage)
+      end
+
+      def template
+        @template ||= Template.new(path, options.merge(name: stack.name))
+      end
+
+      def print_stack_events(events)
+        $stdout.sync
+        events.each do |event|
+          printf "%-50<type>s %-30<logical_id>s %-20<status>s %<reason>s\n",
+                 type: event.resource_type,
+                 logical_id: event.logical_resource_id,
+                 status: event.resource_status,
+                 reason: event.resource_status_reason
+        end
+      end
+    end
+  end
+end