putpaws 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ba984b5ce0261d5c757b4112e6d849aa0815ded01898ee9a25f42cebbb4254f
-  data.tar.gz: e3b2871eacd65cd2d9904cd09090fce6a8d6fa2e55a227b385a2acbeb11c7c4f
+  metadata.gz: 3af9788e3c54a5647c912f45ee76b78691c7f1ac7f7654e6af7b7f3ce51b16f4
+  data.tar.gz: 51d6ea019d08c1139e3a865743d4435a304125a3a3b7ee2052332fc83aa170a3
 SHA512:
-  metadata.gz: 7c2a4f49328c01dccf7a8efaa9bbdcb0fda07fe1fd68d2632cb6043329401f9059378ac0ed90d3211dc3d4dfcadefc2fe747dd494ecd9f0dae52681ffa5ef9d5
-  data.tar.gz: acdad73a867e604275325d95c30d3b85f7b784b753cc4461d2838a385ac1b5b0f33cf93c87ecff58e778325a9416baad8994125c1b9108f803418ec7ee74edeb
+  metadata.gz: 26c390300f9e4cb4fc2a970bbfbbc762e2de2bcfcd3fdb50ed8128e065caacecc99572e6f447ef244cb4c51a1cb4f844c0cc2a14aac361b678dc1e0b7ed20d54
+  data.tar.gz: 3370e8ffe872b93910f951f12c29447b28ca411062d31eb3281740b786297505cc6c12408f11f780d10eefdc57bc4d58b3b0a381079eef6ea56d6b312021f4f8

data/README.md

@@ -0,0 +1,79 @@
+# Put your paws up!!
+
+## Example
+
+### ECS
+
+Attach to staging specific container
+
+```
+bundle exec putpaws awesome-api-staging ecs:attach container=app
+```
+
+Run port forwarding session through specific container
+
+```
+bundle exec putpaws awesome-api-staging ecs:forward container=app remote=example-rds-host:3306 local=:1050
+# local=:1050 is optional by the way, then random number is selected.
+# Please check standard output in your shell for the auto-generated local port.
+
+# You can access specified remote host with subsequent command in another shell like:
+mysql -u awesome_user -p --port 1050 -h 127.0.0.1
+```
+
+### CloudWatch Logs
+
+`tail -f`
+
+```
+bundle exec putpaws awesome-api-staging log:tailf
+```
+
+Find logs between specific date range using time symbol
+
+- `s`: second
+- `m`: minute
+- `h`: hour
+- `d`: day
+- `w`: week
+
+```
+# Find logs since 2 hours ago
+bundle exec putpaws awesome-api-staging log:tailf since=2h
+
+# Find logs since 1 day ago for 3 hours
+bundle exec putpaws awesome-api-staging log:tail since=1d for=3h
+```
+
+## Set up
+
+```
+gem 'putpaws'
+```
+
+## Setting Example
+
+`.putpaws/application.json`
+
+```
+{
+  "awesome-api-staging": {
+    "region": "ap-northeast-1",
+    "cluster": "cluster-staging",
+    "service": null,
+    "task_name_prefix": "awesome-api",
+    "log_group_prefix": "/ecs/awesome/awesome-api-staging",
+    "log_region": null,
+    "build_log_group_prefix": "/aws/codebuild/awesome-api-staging",
+    "build_project_name_prefix": "awesome-api-staging"
+  },
+  "awesome-api-production": {
+    "region": "ap-northeast-1",
+    "cluster": "cluster-production",
+    "service": null,
+    "task_name_prefix": "awesome-api",
+    "log_group_prefix": "/ecs/awesome/awesome-api-production",
+    "log_region": null
+  }
+}
+```

data/lib/Putpawsfile

@@ -4,4 +4,5 @@ require "putpaws/setup"
 require "putpaws/hello"
 require "putpaws/ecs/ecs_task"
 require "putpaws/cloud_watch/log_task"
-require "putpaws/scheduler/scheduler_task"
+require "putpaws/scheduler/scheduler_task"
+require "putpaws/code_build/build_task"

data/lib/putpaws/application_config.rb

@@ -6,7 +6,7 @@ class Putpaws::ApplicationConfig < Struct.new(
   :name, :region, 
   :cluster, :service, :task_name_prefix, :ecs_region,
   :log_group_prefix, :log_region,
-  :build_project, :build_log_group_prefix, :build_region,
+  :build_project_name_prefix, :build_log_group_prefix, :build_region,
   :schedules,
   keyword_init: true)
   def self.load(path_prefix: '.putpaws')
@@ -59,4 +59,11 @@ class Putpaws::ApplicationConfig < Struct.new(
   def schedules
     @schedules ||= (self[:schedules] || []).map{|x| Putpaws::ScheduleConfig.find(x)}.compact
   end
+
+  def codebuild_command_params
+    {
+      region: build_region || region,
+      project_name_prefix: build_project_name_prefix,
+    }
+  end
 end

data/lib/putpaws/code_build/build_task.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/build_task.rake", __FILE__)

data/lib/putpaws/code_build/project_command.rb

@@ -0,0 +1,57 @@
+require 'aws-sdk-codebuild'
+# require 'aws-sdk-ssm'
+
+module Putpaws::CodeBuild
+  class ProjectCommand
+    def self.config(config)
+      new(**config.codebuild_command_params)
+    end
+
+    attr_reader :codebuild_client
+    attr_reader :region, :project_name_prefix
+    attr_accessor :codebuild_project
+    def initialize(region:, project_name_prefix: nil)
+      @codebuild_client = Aws::CodeBuild::Client.new({region: region})
+      @region = region
+      @project_name_prefix = project_name_prefix
+      @codebuild_project = nil
+    end
+
+    def list_codebuild_projects
+      res = codebuild_client.batch_get_projects(names: [project_name_prefix])
+      res.projects.select{|pr| pr.name.start_with?(project_name_prefix)}
+    end
+
+    def start_build_with_specific_version(source_version:, environment_variables: {}, buildspec_override: nil, artifacts_override: nil)
+      current_variables = codebuild_project.environment.environment_variables.map{|x| [x.name, {type: x.type, value: x.value}]}.to_h
+      new_variables = environment_variables.reduce(current_variables) {|acc,(k,v)| acc[k] = {type: 'PLANTTEXT', value: v}}
+      environment_variables_override = new_variables.map{|k,v| v.merge(name: k)}
+      params = {
+        project_name: codebuild_project.name,
+        source_version: source_version,
+        environment_variables_override: environment_variables_override,
+      }
+      if buildspec_override
+        params = params.merge(buildspec_override: buildspec_override)
+      end
+      if artifacts_override
+        params = params.merge(artifacts_override: artifacts_override)
+      end
+
+      codebuild_client.start_build(**params)
+    end
+
+    def build_source_version(type:, version:)
+      type = type.to_sym
+      if type == :branch
+        "refs/heads/#{version}"
+      elsif type == :tag
+        "refs/tags/#{version}"
+      elsif type == :commit_id
+        version
+      else
+        raise "Please specify valid type: branch or tag or commit_id"
+      end
+    end
+  end
+end

data/lib/putpaws/code_build/tasks/build_task.rake

@@ -0,0 +1,39 @@
+require "putpaws/prompt"
+require "putpaws/code_build/project_command"
+
+namespace :code_build do
+  desc "Set CodeBuild project."
+  task :set_project do
+    aws = Putpaws::CodeBuild::ProjectCommand.config(fetch(:app))
+    codebuild_projects = aws.list_codebuild_projects.map{|x| 
+      [x.name, x]
+    }.to_h
+    prompt = Putpaws::Prompt.safe
+    selected = prompt.select("Choose a project you're going to operate", codebuild_projects.keys)
+    codebuild_project = codebuild_projects[selected]
+
+    set :codebuild_project, codebuild_project
+  end
+
+  desc "Start build."
+  task build: :set_project do
+    aws = Putpaws::CodeBuild::ProjectCommand.config(fetch(:app))
+
+    source_version = if ENV['branch']
+      aws.build_source_version(type: :branch, version: ENV['branch'])
+    elsif ENV['tag']
+      aws.build_source_version(type: :tag, version: ENV['tag'])
+    elsif ENV['commit_id']
+      aws.build_source_version(type: :commit_id, version: ENV['commit_id'])
+    else
+      raise "Please specify required parameter like: branch=main or tag=release/20240601 or commit_id=0f0f0f0f"
+    end
+    codebuild_project = fetch(:codebuild_project)
+    aws.codebuild_project = codebuild_project
+    aws.start_build_with_specific_version(
+      source_version: source_version, 
+      environment_variables: ENV['env'] ? JSON.parse(ENV['env']) : {}, 
+      buildspec_override: ENV['buildspec']
+    )
+  end
+end

data/lib/putpaws/ecs/task_command.rb

@@ -1,4 +1,5 @@
 require 'aws-sdk-ecs'
+require 'aws-sdk-ssm'
 
 module Putpaws::Ecs
   class TaskCommand
@@ -27,11 +28,35 @@ module Putpaws::Ecs
       }
     end
 
-    def get_attach_command(container: 'app')
+    def get_session_target(container: 'app')
       raise "ECS Task Not Set" unless ecs_task
       ctn = ecs_task.containers.detect{|c| c.name == container}
       task_id = ecs_task.task_arn.split('/').last
       raise "Container: #{container} not found" unless ctn
+      "ecs:#{cluster}_#{task_id}_#{ctn.runtime_id}"
+    end
+
+    def get_port_forwarding_command(container: nil, remote_port:, remote_host:, local_port: nil)
+      container ||= 'app'
+      target = get_session_target(container: container)
+      ssm_client = Aws::SSM::Client.new({region: region})
+      local_port ||= (1050..1079).map(&:to_s).shuffle.first
+      puts "Starting to use local port: #{local_port}"
+      res = ssm_client.start_session({
+        target: target,
+        document_name: "AWS-StartPortForwardingSessionToRemoteHost",
+        parameters: {
+          portNumber: [remote_port],
+          localPortNumber: [local_port],
+          host: [remote_host]
+        }
+      })
+      build_session_manager_plugin_command(session: res, target: target)
+    end
+
+    def get_attach_command(container: nil)
+      container ||= 'app'
+      target = get_session_target(container: container)
       res = ecs_client.execute_command({
         cluster: cluster,
         container: container,
@@ -39,17 +64,26 @@ module Putpaws::Ecs
         interactive: true,
         task: ecs_task.task_arn,
       })
+      build_session_manager_plugin_command(session: res.session, target: target)
+    end
 
+    def build_session_manager_plugin_command(session:, target:)
       ssm_region = ENV['AWS_REGION_SSM'] || @region
-      
+
       # https://github.com/aws/aws-cli/blob/2a6136010d8656a605d41d1e7b5fdab3c2930cad/awscli/customizations/ecs/executecommand.py#L105
-      session_json = {
-        "SessionId" => res.session.session_id,
-        "StreamUrl" => res.session.stream_url,
-        "TokenValue" => res.session.token_value,
-      }.to_json
+      session_json = if session.respond_to?(:session_id)
+        {
+          "SessionId" => session.session_id,
+          "StreamUrl" => session.stream_url,
+          "TokenValue" => session.token_value,
+        }.to_json
+      elsif session.is_a?(Hash)
+        session.to_json
+      else
+        session
+      end
       target_json = {
-        "Target" => "ecs:#{cluster}_#{task_id}_#{ctn.runtime_id}"
+        "Target" => target
       }.to_json
       cmd = [
         "session-manager-plugin",

data/lib/putpaws/ecs/tasks/ecs_task.rake

@@ -22,7 +22,28 @@ namespace :ecs do
     ecs_task = fetch(:ecs_task)
     aws = Putpaws::Ecs::TaskCommand.config(fetch(:app))
     aws.ecs_task = ecs_task
-    cmd = aws.get_attach_command
+    cmd = aws.get_attach_command(container: ENV['container'])
+    puts cmd
+    system(cmd)
+  end
+
+  desc "Run port forwarding session. You need to enable ECS Exec on a specified task and also install session-manager-plugin."
+  task forward: :set_task do
+    ecs_task = fetch(:ecs_task)
+    aws = Putpaws::Ecs::TaskCommand.config(fetch(:app))
+    aws.ecs_task = ecs_task
+
+    remote_host, remote_port = (ENV['remote'] || '').split(':').map(&:strip)
+    _, local_port = (ENV['local'] || '').split(':').map(&:strip)
+    if remote_host.nil? or remote_port.nil?
+      raise "Remote Host, Port is required: (Ex) remote=192.168.1.1:80"
+    end
+    cmd = aws.get_port_forwarding_command(
+      container: ENV['container'],
+      remote_host: remote_host,
+      remote_port: remote_port,
+      local_port: local_port
+    )
     puts cmd
     system(cmd)
   end

data/lib/putpaws/version.rb

@@ -1,3 +1,3 @@
 module Putpaws
-  VERSION = "0.0.7"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putpaws
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - metheglin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-18 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  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-ecs
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-codebuild
+  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'
 description: aws fargate based infra management
 email: pigmybank@gmail.com
 executables:
@@ -87,6 +115,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/putpaws
 - lib/Putpawsfile
 - lib/putpaws.rb
@@ -97,6 +126,9 @@ files:
 - lib/putpaws/cloud_watch/log_command.rb
 - lib/putpaws/cloud_watch/log_task.rb
 - lib/putpaws/cloud_watch/tasks/log_task.rake
+- lib/putpaws/code_build/build_task.rb
+- lib/putpaws/code_build/project_command.rb
+- lib/putpaws/code_build/tasks/build_task.rake
 - lib/putpaws/dsl.rb
 - lib/putpaws/ecs/ecs_task.rb
 - lib/putpaws/ecs/task_command.rb