awshark 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbb6b1c8acc6985b27bae79aceffe7e15898e37a975cdef6eac0678ab3d644f2
-  data.tar.gz: 141dde43ded62f04ac26d2fea21f38b5b829a6d755ea42c0d0aa0ccfaeb2d316
+  metadata.gz: d5706c9a35383e578bac90c8f432f2b4d730857556112222ff122ba7f7fba8e0
+  data.tar.gz: 6a3c0ca64b7f017aaea42c7fed255a5e5f44ec33bce1de59a00c875c1023e86e
 SHA512:
-  metadata.gz: 8307e5b068979c55a48f7b87b8aab75b32b8b5f0e4e2c4e42fce39b57b78c6dea08441ebcaaca30a8615b2bf56875ca10fe514da61d574f6e71cec52338d9327
-  data.tar.gz: f8372c0258917758924fadd5aab3f074b17b7dc1ffb2c124af5aba1146dcc560845090d366ce780cfb1f1e4fb6aad4574db0d345a8ed29fb9a6be74a03fd22e8
+  metadata.gz: a18d22c21cda523abfa5bd6369df2855b55eb479a2d43a0fa1bd66de0902e055db4e164bab332338f417fcc010094a168b4d2f92a16e4915a840fcb580608584
+  data.tar.gz: c4e5e7d9a2105ff44c58ce0f08ae742e48f780d18b4f63459d39ec6f670d372b5636e966f90e081fec071f4c56ad0923b3b1cb94549ef10cf819e064a57575ac

data/.rubocop.yml

@@ -7,9 +7,6 @@ AllCops:
   TargetRubyVersion: 2.6
   Exclude:
     - 'bin/*'
-    - 'node_modules/**/*'
-    - 'vendor/**/*'
-    - 'spec/**/*'
     - 'tmp/*'
 
 Layout/BeginEndAlignment:
@@ -17,6 +14,9 @@ Layout/BeginEndAlignment:
   EnforcedStyleAlignWith: begin
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
+Layout/FirstHashElementIndentation:
+  Exclude:
+    - 'spec/**/*'
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 
@@ -70,6 +70,10 @@ Lint/UselessTimes:
 Metrics/AbcSize:
   Enabled: true
   Max: 20
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'
 Metrics/MethodLength:
   Enabled: false
 Metrics/ModuleLength:

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+#### 1.2.0
+- [new] add `awshark ecs list`
+- [break] remove options `--profile` and `--region`; use `AWS_PROFILE` and `AWS_REGION` instead
+
 #### 1.1.0
 - ssm support added `<%= ssm["/#{stage}/app/application/db_host"] %>`
 

data/README.md

@@ -14,32 +14,41 @@ gem install awshark
 
 ### Usage
 
+Use `AWS_PROFILE=PROFILE` and/or `AWS_REGION=REGION` to configure the internal AWS clients.
+
 #### S3 commands
 
 List all S3 buckets
 ```
-awshark s3 list --profile=AWS_PROFILE
+awshark s3 list
 ```
 
 List all objects in a specific S3 bucket
 ```
-awshark s3 objects BUCKET_NAME fonts/ --profile=AWS_PROFILE
+awshark s3 objects BUCKET_NAME fonts/
 ```
 
 #### EC2 commands
 
 List all EC2 instances in a region
 ```
-awshark ec2 list --profile=AWS_PROFILE
+awshark ec2 list
+```
+
+#### ECS commands
+
+List all EC2 instances in a region
+```
+awshark ecs list
 ```
 
 #### 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 deploy TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de
 
-awshark cf diff TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de --profile=AWS_PROFILE
+awshark cf diff TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de
 ```
 
 For a further information visit the [Wiki](https://github.com/jdahlke/awshark/wiki).
@@ -50,12 +59,6 @@ For a further information visit the [Wiki](https://github.com/jdahlke/awshark/wi
 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-1.1.0.gem
-    rm awshark-1.1.0.gem
-
 
 ### Contributing
 

data/awshark.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'aws-sdk-cloudwatch'
   spec.add_dependency 'aws-sdk-ec2'
   spec.add_dependency 'aws-sdk-ecr'
+  spec.add_dependency 'aws-sdk-ecs'
   spec.add_dependency 'aws-sdk-rds'
   spec.add_dependency 'aws-sdk-s3'
   spec.add_dependency 'aws-sdk-ssm', '~> 1.117.0'

data/lib/awshark/cli.rb

@@ -16,8 +16,6 @@ module 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

data/lib/awshark/cloud_formation/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Awshark
+  module CloudFormation
+    class Configuration
+      attr_reader :event_polling
+
+      def initialize
+        @event_polling = 3
+      end
+
+      def client
+        @client ||= begin
+                      region = Aws.config[:region]
+                      Aws::CloudFormation::Client.new(region: region)
+                    end
+      end
+
+      attr_writer :client
+    end
+  end
+end

data/lib/awshark/cloud_formation/stack.rb

@@ -69,10 +69,7 @@ module Awshark
       private
 
       def client
-        return Awshark.config.cloud_formation.client if Awshark.config.cloud_formation.client
-
-        region = Aws.config[:region]
-        @client ||= Aws::CloudFormation::Client.new(region: region)
+        Awshark.config.cloud_formation.client
       end
 
       def get_stack(stack_name)

data/lib/awshark/cloud_formation/template.rb

@@ -35,7 +35,7 @@ module Awshark
 
             {
               context: RecursiveOpenStruct.new(context),
-              aws_account_id: Awshark.config.aws_account_id,
+              aws_account_id: Awshark.config.sts.aws_account_id,
               stage: stage,
               ssm: ssm
             }
@@ -69,13 +69,11 @@ module Awshark
       end
 
       def region
-        Aws.config[:region] || 'eu-central-1'
+        Awshark.config.s3.region
       end
 
       def s3
-        return Awshark.config.s3.client if Awshark.config.s3.client
-
-        @s3 ||= Aws::S3::Client.new(region: region, signature_version: 'v4')
+        Awshark.config.s3.client
       end
 
       def s3_key

data/lib/awshark/ecs/cluster.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Awshark
+  module Ecs
+    class Cluster
+      attr_reader :arn
+
+      def initialize(arn)
+        @arn = arn
+      end
+
+      def name
+        arn.split('/').last
+      end
+
+      def tasks
+        @tasks ||= begin
+                     response = client.list_tasks(cluster: arn)
+                     response = client.describe_tasks(cluster: arn, tasks: response.task_arns)
+                     response.tasks
+                   end
+      end
+
+      def services
+        @services ||= begin
+                        response = client.list_services(cluster: arn)
+                        response = client.describe_services(cluster: arn, services: response.service_arns)
+                        response.services
+                      end
+      end
+
+      private
+
+      def client
+        Awshark.config.ecs.client
+      end
+    end
+  end
+end

data/lib/awshark/ecs/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Awshark
+  module Ecs
+    class Configuration
+      def client
+        @client ||= begin
+                      region = Aws.config[:region]
+                      Aws::ECS::Client.new(region: region)
+                    end
+      end
+
+      attr_writer :client
+    end
+  end
+end

data/lib/awshark/ecs/manager.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Awshark
+  module Ecs
+    class Manager
+      def clusters
+        response = client.list_clusters
+        response.cluster_arns.map { |arn| Ecs::Cluster.new(arn) }
+      end
+
+      def inspect_cluster(cluster)
+        args = { name: cluster.name, services: cluster.services.size, tasks: cluster.tasks.size }
+        format("Cluster: %-20<name>s %<services>s services %<tasks>s tasks\n", args)
+      end
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Types/Container.html
+      #
+      # @param task [Aws::ECS::Types::Container]
+      def inspect_container(container)
+        args = { name: container.name, health: container.health_status, status: container.last_status }
+        format("- %-15<name>s status: %<status>s\n", args)
+      end
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Types/Service.html
+      #
+      # @param task [Aws::ECS::Types::Service]
+      def inspect_service(service)
+        task = task_definition(service.task_definition)
+        lines = []
+
+        args = {
+          name: service.service_name,
+          status: service.status,
+          running: service.running_count,
+          cpu: "#{task.cpu}MB",
+          memory: "#{task.memory}MB"
+        }
+        lines << format('Service: %-30<name>s status: %-8<status>s running: %-4<running>s ' \
+                        "cpu: %-8<cpu>s mem: %<memory>s\n", args)
+        task.container_definitions.each do |c|
+          lines << format("- %-15<name>s\n", name: c.name)
+        end
+
+        lines.join
+      end
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Types/Task.html
+      #
+      # @param task [Aws::ECS::Types::Task]
+      def inspect_task(task)
+        lines = []
+
+        args = { type: task.launch_type, cpu: "#{task.cpu} MB", memory: "#{task.memory} MB" }
+        lines << format("Task: %-20<type>s cpu: %-10<cpu>s memory: %<memory>s\n", args)
+
+        task.containers.each { |c| lines << inspect_container(c) }
+
+        lines.join
+      end
+
+      def task_definition(family)
+        response = client.describe_task_definition(task_definition: family)
+        response.task_definition
+      end
+
+      private
+
+      def client
+        Awshark.config.ecs.client
+      end
+    end
+  end
+end

data/lib/awshark/profile_resolver.rb

@@ -2,15 +2,13 @@
 
 module Awshark
   class ProfileResolver
-    attr_reader :region
-
     def initialize(options)
       @profile = options[:profile] || ENV['AWS_PROFILE']
       @shared_config = ::Aws::SharedConfig.new(
         profile_name: @profile,
         config_enabled: true
       )
-      @region = options[:region] || @shared_config.region || 'eu-central-1'
+      @region = options[:region] || ENV['REGION']
     end
 
     def credentials
@@ -32,6 +30,13 @@ module Awshark
       @shared_config.credentials
     end
 
+    # Returns Aws region from option, env or .aws/config
+    #
+    # @returns [String]
+    def region
+      @region || @shared_config.region || 'eu-central-1'
+    end
+
     # Returns Aws credentials for configuration with
     #  [profile]
     #  role_arn = ROLE_ARN

data/lib/awshark/s3/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Awshark
+  module S3
+    class Configuration
+      def client
+        @client ||= Aws::S3::Client.new(region: region, signature_version: 'v4')
+      end
+
+      def region
+        Aws.config[:region] || 'eu-central-1'
+      end
+
+      attr_writer :client
+    end
+  end
+end

data/lib/awshark/sts/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Awshark
+  module Sts
+    class Configuration
+      def aws_account_id
+        @aws_account_id ||= begin
+                              response = client.get_caller_identity
+                              response.account
+                            end
+      end
+
+      def client
+        @client ||= Aws::STS::Client.new
+      end
+
+      attr_writer :client
+    end
+  end
+end

data/lib/awshark/subcommands/ecs.rb

@@ -1,12 +1,35 @@
 # frozen_string_literal: true
 
 require 'aws-sdk-ecr'
+require 'aws-sdk-ecs'
+
+require 'awshark/ecs/cluster'
+require 'awshark/ecs/manager'
 
 module Awshark
   module Subcommands
     class Ecs < Thor
       include Awshark::Subcommands::ClassOptions
 
+      desc 'list', 'list ECS tasks'
+      long_desc <<-LONGDESC
+        List all running ECS tasks and services.
+
+        Example: `awshark ecs list`
+      LONGDESC
+      def list
+        process_class_options
+
+        manager = Awshark::Ecs::Manager.new
+        manager.clusters.each do |cluster|
+          puts "\n"
+          puts manager.inspect_cluster(cluster)
+          cluster.services.each do |service|
+            puts manager.inspect_service(service)
+          end
+        end
+      end
+
       desc 'login', 'docker login to AWS ECR'
       long_desc <<-LONGDESC
         Use docker login with AWS credentials to Elastic Container Registry
@@ -19,7 +42,7 @@ module Awshark
 
         user_name = token.split(':').first
         password = token.split(':').last
-        url = "https://#{Awshark.config.aws_account_id}.dkr.ecr.eu-central-1.amazonaws.com"
+        url = "https://#{Awshark.config.sts.aws_account_id}.dkr.ecr.eu-central-1.amazonaws.com"
 
         `docker login -u #{user_name} -p #{password} #{url}`
       end

data/lib/awshark/version.rb

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

data/lib/awshark.rb

@@ -6,13 +6,28 @@ require 'thor'
 require 'yaml'
 
 require 'awshark/version'
-require 'awshark/configuration'
+require 'awshark/cloud_formation/configuration'
+require 'awshark/ecs/configuration'
+require 'awshark/s3/configuration'
+require 'awshark/sts/configuration'
 
 module Awshark
   class GracefulFail < StandardError; end
 
   def self.config
-    @config ||= Configuration.new
+    @config ||= begin
+                  cf = CloudFormation::Configuration.new
+                  ecs = Ecs::Configuration.new
+                  s3 = S3::Configuration.new
+                  sts = Sts::Configuration.new
+
+                  OpenStruct.new(
+                    cloud_formation: cf,
+                    ecs: ecs,
+                    s3: s3,
+                    sts: sts
+                  )
+                end
   end
 
   def self.configure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awshark
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Joergen Dahlke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-26 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ecs
+  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: aws-sdk-rds
   requirement: !ruby/object:Gem::Requirement
@@ -239,6 +253,7 @@ files:
 - gems.rb
 - lib/awshark.rb
 - lib/awshark/cli.rb
+- lib/awshark/cloud_formation/configuration.rb
 - lib/awshark/cloud_formation/file_loading.rb
 - lib/awshark/cloud_formation/inferrer.rb
 - lib/awshark/cloud_formation/manager.rb
@@ -246,15 +261,19 @@ files:
 - lib/awshark/cloud_formation/stack.rb
 - lib/awshark/cloud_formation/stack_events.rb
 - lib/awshark/cloud_formation/template.rb
-- lib/awshark/configuration.rb
 - lib/awshark/ec2/instance.rb
 - lib/awshark/ec2/manager.rb
+- lib/awshark/ecs/cluster.rb
+- lib/awshark/ecs/configuration.rb
+- lib/awshark/ecs/manager.rb
 - lib/awshark/profile_resolver.rb
 - lib/awshark/rds/check_reservations.rb
 - lib/awshark/rds/manager.rb
 - lib/awshark/s3/artifact.rb
 - lib/awshark/s3/bucket.rb
+- lib/awshark/s3/configuration.rb
 - lib/awshark/s3/manager.rb
+- lib/awshark/sts/configuration.rb
 - lib/awshark/subcommands/class_options.rb
 - lib/awshark/subcommands/cloud_formation.rb
 - lib/awshark/subcommands/ec2.rb

data/lib/awshark/configuration.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Awshark
-  class Configuration
-    attr_accessor :cloud_formation, :s3
-
-    def initialize
-      @cloud_formation = OpenStruct.new(
-        client: nil,
-        event_polling: 3
-      )
-
-      @s3 = OpenStruct.new(
-        client: nil
-      )
-    end
-
-    def aws_account_id
-      return @aws_account_id if defined?(@aws_account_id)
-
-      response = sts_client.get_caller_identity
-
-      @aws_account_id = response.account
-    end
-
-    def sts_client
-      @sts_client ||= Aws::STS::Client.new
-    end
-
-    private
-
-    attr_writer :sts_client
-  end
-end