cody 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1523d8ce4c22cf41cecba80623b9c473e49ff97d4b981972d5e277dde195da05
-  data.tar.gz: 6deb1ea47229b7471c0f7de73f5d7f21d40aabb64560297b6e320e4a3e85fe9b
+  metadata.gz: d8ae54a008252e6ce83388bea8b82a78b6f3fff32724fc822b63d02baa39fdee
+  data.tar.gz: 717b8030c9046966f909eef2b64487482e1a8e1819d6e12d43747520499de642
 SHA512:
-  metadata.gz: 6051044570a30f31b94ce57bd6a2a514ffd669cf0371ef30c8e14e4b50f57a6f6cc02d126a74d34a0aa2048b43f11f4370419fbaed93ee955cc61a973200227c
-  data.tar.gz: a45a69611e76dd64d4dd9aac1c11598c1629c666a403f630f095f49cf6d84d407d556d32bf57912d4d487e2b2d58894cc1452b2b1b9976bc22f4bb90fd76d7ce
+  metadata.gz: 6a340b073735c12b2166ef78a43d79851c047780074a46f638021c7a0d7c60d8f380e4674ae2be09587f6b00400ced580391af72970cc96236869c108539fafe
+  data.tar.gz: 503328e1e3feb629877eb1dc901da9e2e3a52ed1a450b2da299ed662bb3cf38d9506d09ede8a8fccbb470186ebddaceeb4110ce37554d69a3146dc0b7dc17433

data/.cody/project.rb

@@ -1,4 +1,7 @@
 github_url("https://github.com/tongueroo/cody")
 linux_image("aws/codebuild/ruby:2.5.3-1.7.0")
-triggers(webhook: true)
+triggers(
+  webhook: true,
+  filter_groups: [[{type: "EVENT", pattern: "PUSH"}]]
+)
 local_cache(false)

data/.cody/role.rb

@@ -0,0 +1,14 @@
+iam_policy(
+  action: [
+    "logs:CreateLogGroup",
+    "logs:CreateLogStream",
+    "logs:PutLogEvents",
+    "ssm:DescribeDocumentParameters",
+    "ssm:DescribeParameters",
+    "ssm:GetParameter*",
+  ],
+  effect: "Allow",
+  resource: "*"
+)
+
+managed_iam_policy("AWSCloudFormationReadOnlyAccess")

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.8.0]
+- #7 add cody logs command and automatically tail logs after a cody start
+
 ## [0.7.3]
 - cleanup starter buildspec.yml
 

data/README.md

@@ -9,15 +9,14 @@
 
 [![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
 
-Cody lets you create a AWS CodeBuild projects with a beautiful DSL.
-
-The documentation site is at: [cody.run](https://cody.run/)
+Cody is an AWS CodeBuild Management Tool. Cody lets you create AWS CodeBuild projects with a beautiful DSL. The documentation site is at: [cody.run](https://cody.run/)
 
 ## Quick Start
 
     cody init
     cody deploy
     cody start
+    cody logs
 
 ## Private Repo
 
@@ -66,13 +65,19 @@ For more help:
 
 ### Start
 
-When you are ready to start a codebuild project run, you can use `codebuild start`. Examples:
+When you are ready to start a codebuild project run, you can use [codebuild start](https://cody.run/reference/cody-start/). Examples:
 
     cody start # infers the name from the parent folder
     cody start PROJECT_NAME # looks up project via CodeBuild project name
 
 The `cody start` command understands multiple identifiers. It will look up the codebuild project either via CloudFormation or the CodeBuild project name.
 
+The start command continuously polls the CodeBuild project and prints out the logs until the build completes. To disable this, use the `--no-wait` option.
+
+    cody start PROJECT_NAME --no-wait
+
+The logs from the Phase Details and CloudWatch Logs are both displayed. Because they come from 2 different sources, the logs can interlace.
+
 ## Project DSL
 
 The tool provides a DSL to create a codebuild project.  Here's an example.

data/cody.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport"
+  spec.add_dependency "activesupport", "~> 6.0.0"
+  spec.add_dependency "aws-logs"
   spec.add_dependency "aws-mfa-secure"
   spec.add_dependency "aws-sdk-cloudformation"
   spec.add_dependency "aws-sdk-codebuild"

data/lib/cody/cli.rb

@@ -41,6 +41,15 @@ module Cody
       Start.new(options.merge(project_name: project_name)).run
     end
 
+    desc "logs", "Prints out logs for codebuild project."
+    long_desc Help.text(:logs)
+    option :build_id, desc: "Project build id. Defaults to most recent."
+    option :since, desc: "From what time to begin displaying logs.  By default, logs will be displayed starting from 7 days in the past. The value provided can be an ISO 8601 timestamp or a relative time."
+    common_options.call
+    def logs(project_name=nil)
+      Logs.new(options.merge(project_name: project_name)).run
+    end
+
     desc "completion *PARAMS", "Prints words for auto-completion."
     long_desc Help.text(:completion)
     def completion(*params)

data/lib/cody/help/logs.md

@@ -0,0 +1,62 @@
+## Examples
+
+    cody logs # project name inferred
+    cody logs PROJECT # project name explicit
+
+## Examples with Output
+
+    $ cody logs
+    Showing logs for build demo:ada202f1-6b30-4eb9-8625-7371a9911b7d
+    Phase: SUBMITTED Status: SUCCEEDED Duration: 0
+    Phase: QUEUED Status: SUCCEEDED Duration: 1
+    Phase: PROVISIONING Status: SUCCEEDED Duration: 40
+    Phase: DOWNLOAD_SOURCE Status: SUCCEEDED Duration: 0
+    Phase: INSTALL Status: SUCCEEDED Duration: 20
+    Phase: PRE_BUILD Status: SUCCEEDED Duration: 20
+    Phase: BUILD Status: SUCCEEDED Duration: 20
+    Phase: POST_BUILD Status: SUCCEEDED Duration: 20
+    Phase: UPLOAD_ARTIFACTS Status: SUCCEEDED Duration: 0
+    Phase: FINALIZING Status: SUCCEEDED Duration: 2
+    Phase: COMPLETED Status:  Duration:
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:06 Waiting for agent ping
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Waiting for DOWNLOAD_SOURCE
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Phase is DOWNLOAD_SOURCE
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 CODEBUILD_SRC_DIR=/codebuild/output/src088335237/src/github.com/tongueroo/cody-demo
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 YAML location is /codebuild/output/src088335237/src/github.com/tongueroo/cody-demo/.cody/buildspec.yml
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Processing environment variables
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Moving to directory /codebuild/output/src088335237/src/github.com/tongueroo/cody-demo
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Registering with agent
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Phases found in YAML: 4
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08  PRE_BUILD: 2 commands
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08  BUILD: 2 commands
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08  POST_BUILD: 2 commands
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08  INSTALL: 2 commands
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Phase complete: DOWNLOAD_SOURCE State: SUCCEEDED
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Phase context status code:  Message:
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Entering phase INSTALL
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Running command pwd
+    2019-11-28 05:15:12 UTC /codebuild/output/src088335237/src/github.com/tongueroo/cody-demo
+    2019-11-28 05:15:12 UTC
+    2019-11-28 05:15:12 UTC [Container] 2019/11/28 05:15:08 Running command .cody/sleep.sh install
+    2019-11-28 05:15:12 UTC 0: install
+    2019-11-28 05:15:12 UTC Thu Nov 28 05:15:08 UTC 2019
+    ...
+    19-11-28 05:16:29 UTC [Container] 2019/11/28 05:16:29 Phase complete: POST_BUILD State: SUCCEEDED
+    2019-11-28 05:16:29 UTC [Container] 2019/11/28 05:16:29 Phase context status code:  Message:
+    $
+
+## Since Option
+
+By default, Cody logs searches only 7 days in the past. This is done for speed. If you have an older build and would like to search further in the past.  You can use the `--since option`.  Example:
+
+    cody logs --since 1m # 1 month ago
+
+The since format is from the [aws-logs gem](https://github.com/tongueroo/aws-logs). Since formats:
+
+* s - seconds
+* m - minutes
+* h - hours
+* d - days
+* w - weeks
+
+Since does not support combining the formats. IE: 5m30s.

data/lib/cody/logs.rb

@@ -0,0 +1,27 @@
+module Cody
+  class Logs
+    include AwsServices
+
+    def initialize(options)
+      @options = options
+      @project_name = options[:project_name] || inferred_project_name
+      @full_project_name = project_name_convention(@project_name)
+    end
+
+    def run
+      Tailer.new(@options, build_id).run
+    rescue Aws::CodeBuild::Errors::ResourceNotFoundException => e
+      puts "ERROR: #{e.class}: #{e.message}".color(:red)
+      puts "CodeBuild project #{@full_project_name} not found."
+    rescue Aws::CodeBuild::Errors::InvalidInputException => e
+      puts "ERROR: #{e.class}: #{e.message}".color(:red)
+    end
+
+    def build_id
+      return @options[:build_id] if @options[:build_id]
+
+      resp = codebuild.list_builds_for_project(project_name: @full_project_name)
+      resp.ids.first # most recent build_id
+    end
+  end
+end

data/lib/cody/start.rb

@@ -16,10 +16,15 @@ module Cody
       }
       params[:environment_variables_override] = environment_variables_override if @options[:env_vars]
       resp = codebuild.start_build(params)
+
       puts "Build started for project: #{project_name}"
-      puts "Please check the CodeBuild console for the status."
-      puts "CodeBuild Log Url:"
+      puts "Here's the CodeBuild Console Log url:"
       puts codebuild_log_url(resp.build.id)
+      tail_logs(resp.build.id) if @options[:wait]
+    end
+
+    def tail_logs(build_id)
+      Tailer.new(@options, build_id).run
     end
 
     def environment_variables_override

data/lib/cody/tailer.rb

@@ -0,0 +1,119 @@
+require "aws-logs"
+
+module Cody
+  class Tailer
+    include AwsServices
+
+    def initialize(options, build_id)
+      @options, @build_id = options, build_id
+
+      @output = [] # for specs
+      @shown_phases = []
+      @thread = nil
+      set_trap
+    end
+
+    def find_build
+      resp = codebuild.batch_get_builds(ids: [@build_id])
+      resp.builds.first
+    end
+
+    def run
+      puts "Showing logs for build #{@build_id}"
+      complete = false
+      until complete do
+        build = find_build
+        unless build
+          puts "ERROR: Build id not found: #{@build_id}".color(:red)
+          return
+        end
+        print_phases(build)
+        set_log_group_name(build)
+
+        complete = build.build_complete
+        start_cloudwatch_tail unless ENV["CODY_TEST"]
+        sleep 5 if !@@end_loop_signal && !complete && !ENV["CODY_TEST"]
+      end
+      AwsLogs::Tail.stop_follow!
+      @thread.join if @thread
+    end
+
+    def start_cloudwatch_tail
+      return if @cloudwatch_tail_started
+      return unless @log_group_name && @log_stream_name
+
+      @thread = Thread.new do
+        cloudwatch_tail
+      end
+      @cloudwatch_tail_started = true
+    end
+
+    def cloudwatch_tail
+      since = @options[:since] || "7d" # by default, search only 7 days in the past
+      cw_tail = AwsLogs::Tail.new(
+        log_group_name: @log_group_name,
+        log_stream_names: [@log_stream_name],
+        since: since,
+        follow: true,
+        format: "simple",
+      )
+      cw_tail.run
+    end
+
+    # Setting enables start_cloudwatch_tail
+    def set_log_group_name(build)
+      logs = build.logs
+      @log_group_name = logs.group_name if logs.group_name
+      @log_stream_name = logs.stream_name if logs.stream_name
+    end
+
+    def print_phases(build)
+      build.phases.each do |phase|
+        details = {
+          phase_type: phase.phase_type,
+          phase_status: phase.phase_status,
+          start_time: phase.start_time,
+          duration_in_seconds: phase.duration_in_seconds,
+        }
+        display_phase(details)
+        @shown_phases << details
+      end
+    end
+
+    def display_phase(details)
+      already_shown = @shown_phases.detect do |p|
+        p[:phase_type] == details[:phase_type] &&
+        p[:phase_status] == details[:phase_status] &&
+        p[:start_time] == details[:start_time] &&
+        p[:duration_in_seconds] == details[:duration_in_seconds]
+      end
+      return if already_shown
+
+      status = details[:phase_status]
+      status = status&.include?("FAILED") ? status.color(:red) : status
+      say [
+        "Phase:".color(:green), details[:phase_type],
+        "Status:".color(:purple), status,
+        # "Time: ".color(:purple), details[:start_time],
+        "Duration:".color(:purple), details[:duration_in_seconds],
+      ].join(" ")
+    end
+
+    def say(text)
+      ENV["CODY_TEST"] ? @output << text : puts(text)
+    end
+
+    def output
+      @output.join("\n") + "\n"
+    end
+
+    @@end_loop_signal = false
+    def set_trap
+      Signal.trap("INT") {
+        puts "\nCtrl-C detected. Exiting..."
+        @@end_loop_signal = true  # useful to control loop
+        exit # immediate exit
+      }
+    end
+  end
+end

data/lib/cody/version.rb

@@ -1,3 +1,3 @@
 module Cody
-  VERSION = "0.7.3"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: cody
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2019-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: aws-logs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -230,6 +244,7 @@ extra_rdoc_files: []
 files:
 - ".cody/buildspec.yml"
 - ".cody/project.rb"
+- ".cody/role.rb"
 - ".cody/settings.yml"
 - ".gitignore"
 - ".gitmodules"
@@ -268,8 +283,10 @@ files:
 - lib/cody/help/completion_script.md
 - lib/cody/help/deploy.md
 - lib/cody/help/init.md
+- lib/cody/help/logs.md
 - lib/cody/help/start.md
 - lib/cody/init.rb
+- lib/cody/logs.rb
 - lib/cody/project.rb
 - lib/cody/role.rb
 - lib/cody/schedule.rb
@@ -277,6 +294,7 @@ files:
 - lib/cody/setting.rb
 - lib/cody/stack.rb
 - lib/cody/start.rb
+- lib/cody/tailer.rb
 - lib/cody/update.rb
 - lib/cody/variables.rb
 - lib/cody/version.rb