ufo 4.5.7 → 4.6.0

data/lib/ufo/help/logs.md

@@ -0,0 +1,10 @@
+## Examples
+
+    ufo logs demo-web
+
+If you have a current service name set.
+
+    ufo current --service demo-web
+    ufo logs # follow by default
+    ufo logs --no-follow
+    ufo logs --format detailed # to show stream too

data/lib/ufo/logs.rb

@@ -0,0 +1,55 @@
+require "aws-logs"
+
+module Ufo
+  class Logs < Base
+    include AwsService
+
+    delegate :service, to: :info
+
+    def run
+      log = find_log_group_name
+      puts "Showing logs for log group: #{log["awslogs-group"]} and stream prefix #{log["awslogs-stream-prefix"]}"
+      if log
+        cloudwatch_tail(log)
+      else
+        puts "Unable to find log group for service: #{service.service_name}"
+      end
+    end
+
+    def find_log_group_name
+      resp = ecs.describe_task_definition(task_definition: info.service.task_definition)
+
+      container_definitions = resp.task_definition.container_definitions
+
+      unless container_definitions.size == 1
+        puts "ERROR: ufo logs command only supports 1 container definition in the ECS task definition".color(:red)
+        return
+      end
+
+      definition = container_definitions.first
+      log_conf = definition.log_configuration
+
+      if log_conf && log_conf.log_driver == "awslogs"
+        # options["awslogs-group"]
+        # options["awslogs-region"]
+        # options["awslogs-stream-prefix"]
+        log_conf.options
+      else
+        puts "Only supports awslogs driver. Detected log_driver: #{log_conf.log_driver}"
+        return
+      end
+    end
+
+    def cloudwatch_tail(log={})
+      since = @options[:since] || "10m" # by default, search only 10 mins in the past
+      cw_tail = AwsLogs::Tail.new(
+        log_group_name: log["awslogs-group"],
+        log_stream_name_prefix: log["awslogs-stream-prefix"],
+        since: since,
+        follow: @options[:follow],
+        format: @options[:format],
+      )
+      cw_tail.run
+    end
+  end
+end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "4.5.7"
+  VERSION = "4.6.0"
 end

data/spec/fixtures/mocks/logs/awslogs.json

@@ -0,0 +1,70 @@
+{
+  "task_definition": {
+    "task_definition_arn": "arn:aws:ecs:us-west-2:112233445566:task-definition/demo-web:1",
+    "container_definitions": [
+      {
+        "name": "web",
+        "image": "112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra:ufo-2020-01-16T22-56-26-a28378e80",
+        "cpu": 256,
+        "memory": 1024,
+        "memory_reservation": 1024,
+        "port_mappings": [
+          {
+            "container_port": 4567,
+            "host_port": 4567,
+            "protocol": "tcp"
+          }
+        ],
+        "essential": true,
+        "command": [
+          "bin/web"
+        ],
+        "environment": [],
+        "log_configuration": {
+          "log_driver": "awslogs",
+          "options": {
+            "awslogs-group": "ecs/demo-web",
+            "awslogs-region": "us-west-2",
+            "awslogs-stream-prefix": "demo"
+          }
+        }
+      }
+    ],
+    "family": "demo-web",
+    "task_role_arn": "arn:aws:iam::112233445566:role/demo",
+    "network_mode": "awsvpc",
+    "revision": 1,
+    "volumes": [
+    ],
+    "status": "ACTIVE",
+    "requires_attributes": [
+      {
+        "name": "com.amazonaws.ecs.capability.logging-driver.awslogs"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.ecr-auth"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.task-iam-role"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
+      },
+      {
+        "name": "ecs.capability.task-eni"
+      }
+    ],
+    "placement_constraints": [
+
+    ],
+    "compatibilities": [
+      "EC2"
+    ]
+  }
+}

data/spec/fixtures/mocks/logs/no-awslogs.json

@@ -0,0 +1,70 @@
+{
+  "task_definition": {
+    "task_definition_arn": "arn:aws:ecs:us-west-2:112233445566:task-definition/demo-web:1",
+    "container_definitions": [
+      {
+        "name": "web",
+        "image": "112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra:ufo-2020-01-16T22-56-26-a28378e80",
+        "cpu": 256,
+        "memory": 1024,
+        "memory_reservation": 1024,
+        "port_mappings": [
+          {
+            "container_port": 4567,
+            "host_port": 4567,
+            "protocol": "tcp"
+          }
+        ],
+        "essential": true,
+        "command": [
+          "bin/web"
+        ],
+        "environment": [],
+        "log_configuration": {
+          "log_driver": "whatever",
+          "options": {
+            "awslogs-group": "ecs/demo-web",
+            "awslogs-region": "us-west-2",
+            "awslogs-stream-prefix": "demo"
+          }
+        }
+      }
+    ],
+    "family": "demo-web",
+    "task_role_arn": "arn:aws:iam::112233445566:role/demo",
+    "network_mode": "awsvpc",
+    "revision": 1,
+    "volumes": [
+    ],
+    "status": "ACTIVE",
+    "requires_attributes": [
+      {
+        "name": "com.amazonaws.ecs.capability.logging-driver.awslogs"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.ecr-auth"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.task-iam-role"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
+      },
+      {
+        "name": "ecs.capability.task-eni"
+      }
+    ],
+    "placement_constraints": [
+
+    ],
+    "compatibilities": [
+      "EC2"
+    ]
+  }
+}

data/spec/lib/logs_spec.rb

@@ -0,0 +1,55 @@
+describe Ufo::Logs do
+  let(:logs) do
+    logs = Ufo::Logs.new("test-web", {})
+    allow(logs).to receive(:exit).and_return(null)
+    allow(logs).to receive(:info).and_return(null)
+    allow(logs).to receive(:ecs).and_return(ecs)
+    logs
+  end
+  let(:ecs) do
+    ecs = double(:ecs).as_null_object
+    allow(ecs).to receive(:describe_task_definition).and_return(mock_response(fixture))
+    ecs
+  end
+  let(:null) { double(:null).as_null_object }
+
+  context "awslogs conf" do
+    let(:fixture) { "spec/fixtures/mocks/logs/awslogs.json" }
+    it "find_log_group_name" do
+      log_group_name = logs.find_log_group_name
+      expect(log_group_name).to eq({"awslogs-group" => "ecs/demo-web", "awslogs-region" => "us-west-2", "awslogs-stream-prefix" => "demo" })
+    end
+  end
+
+  context "not a awslogs conf" do
+    let(:fixture) { "spec/fixtures/mocks/logs/no-awslogs.json" }
+    it "find_log_group_name" do
+      log_group_name = logs.find_log_group_name
+      expect(log_group_name).to be nil
+    end
+  end
+
+  def mock_response(file)
+    data = JSON.load(IO.read(file))
+
+    td = data["task_definition"]
+    container_definitions = td["container_definitions"].map do |c|
+      l = c["log_configuration"]
+      log_configuration = Aws::ECS::Types::LogConfiguration.new(
+        log_driver: l["log_driver"],
+        options: l["options"],
+      )
+      Aws::ECS::Types::ContainerDefinition.new(
+        name: c["name"],
+        log_configuration: log_configuration,
+      )
+    end
+    task_definition = Aws::ECS::Types::TaskDefinition.new(
+      task_definition_arn: td["task_definition_arn"],
+      container_definitions: container_definitions,
+    )
+    Aws::ECS::Types::DescribeTaskDefinitionResponse.new(
+      task_definition: task_definition,
+    )
+  end
+end

data/ufo.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "aws-logs"
+  spec.add_dependency "aws-mfa-secure"
   spec.add_dependency "aws-sdk-cloudformation"
   spec.add_dependency "aws-sdk-cloudwatchlogs"
   spec.add_dependency "aws-sdk-ec2"

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 4.5.7
+  version: 4.6.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-logs
+  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-mfa-secure
+  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-cloudformation
   requirement: !ruby/object:Gem::Requirement
@@ -297,7 +325,6 @@ files:
 - README.md
 - Rakefile
 - docs/.gitignore
-- docs/.ruby-version
 - docs/CNAME
 - docs/Gemfile
 - docs/LICENSE
@@ -333,6 +360,7 @@ files:
 - docs/_docs/settings/cfn.md
 - docs/_docs/settings/cluster.md
 - docs/_docs/settings/network.md
+- docs/_docs/ssl_errors.md
 - docs/_docs/structure.md
 - docs/_docs/tutorial-ufo-docker-build.md
 - docs/_docs/tutorial-ufo-init.md
@@ -343,6 +371,7 @@ files:
 - docs/_docs/ufo-current.md
 - docs/_docs/ufo-env-extra.md
 - docs/_docs/ufo-env.md
+- docs/_docs/ufo-logs.md
 - docs/_docs/ufo-task-params.md
 - docs/_docs/ufo-tasks-register.md
 - docs/_docs/upgrading.md
@@ -399,6 +428,7 @@ files:
 - docs/_reference/ufo-docker-push.md
 - docs/_reference/ufo-docker.md
 - docs/_reference/ufo-init.md
+- docs/_reference/ufo-logs.md
 - docs/_reference/ufo-network-help.md
 - docs/_reference/ufo-network-init.md
 - docs/_reference/ufo-network.md
@@ -459,6 +489,9 @@ files:
 - docs/quick-start.md
 - docs/reference.md
 - docs/style.css
+- docs/utils/ssl-doctor.rb
+- docs/utils/test-aws-api-access.rb
+- docs/utils/update-cert-chains.sh
 - exe/ufo
 - lib/cfn/stack.yml
 - lib/template/.env
@@ -526,6 +559,7 @@ files:
 - lib/ufo/help/docker/push.md
 - lib/ufo/help/help.md
 - lib/ufo/help/init.md
+- lib/ufo/help/logs.md
 - lib/ufo/help/network/init.md
 - lib/ufo/help/ps.md
 - lib/ufo/help/releases.md
@@ -543,6 +577,7 @@ files:
 - lib/ufo/info.rb
 - lib/ufo/init.rb
 - lib/ufo/log_group.rb
+- lib/ufo/logs.rb
 - lib/ufo/network.rb
 - lib/ufo/network/fetch.rb
 - lib/ufo/network/helper.rb
@@ -586,6 +621,8 @@ files:
 - spec/fixtures/dockerfiles/ecr/Dockerfile
 - spec/fixtures/home_existing/.aws/config
 - spec/fixtures/home_existing/.docker/config.json
+- spec/fixtures/mocks/logs/awslogs.json
+- spec/fixtures/mocks/logs/no-awslogs.json
 - spec/fixtures/ps/describe_tasks.json
 - spec/fixtures/settings.yml
 - spec/lib/apps_spec.rb
@@ -594,6 +631,7 @@ files:
 - spec/lib/completion_spec.rb
 - spec/lib/ecr_auth_spec.rb
 - spec/lib/ecr_cleaner_spec.rb
+- spec/lib/logs_spec.rb
 - spec/lib/ps_spec.rb
 - spec/lib/register_spec.rb
 - spec/lib/setting_spec.rb
@@ -622,7 +660,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: AWS ECS Deploy Tool
@@ -637,6 +675,8 @@ test_files:
 - spec/fixtures/dockerfiles/ecr/Dockerfile
 - spec/fixtures/home_existing/.aws/config
 - spec/fixtures/home_existing/.docker/config.json
+- spec/fixtures/mocks/logs/awslogs.json
+- spec/fixtures/mocks/logs/no-awslogs.json
 - spec/fixtures/ps/describe_tasks.json
 - spec/fixtures/settings.yml
 - spec/lib/apps_spec.rb
@@ -645,6 +685,7 @@ test_files:
 - spec/lib/completion_spec.rb
 - spec/lib/ecr_auth_spec.rb
 - spec/lib/ecr_cleaner_spec.rb
+- spec/lib/logs_spec.rb
 - spec/lib/ps_spec.rb
 - spec/lib/register_spec.rb
 - spec/lib/setting_spec.rb