stax 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff348fae4586ba8565b0716cafbd57a2804fa9ead68069195ec351815833201b
-  data.tar.gz: dcae498f9406661f84112b0034c15a844a1945ef746e19188c05fce565c8e9ed
+  metadata.gz: a329f6a9e49e506570e4b869de676c6811be3cb0fc3725107ecd61dbd87574b0
+  data.tar.gz: a96ea2c978ceab09a1e9f4686be93d5b96929ef84ac7e2972d437c0283c811fb
 SHA512:
-  metadata.gz: e6469ff904a334f9fd228f14c754c59f6b273d9bd0916ca367cabdad103f72d29993f45f6101a12215249197d32fc7dd6cfa1bd78cdbe45c17508b0baa24f223
-  data.tar.gz: 75cae424254fc98fb6696051b2d08e3f1c6a045f54c64e257fb78a6cf65ad6f86f220ab5482568803e396568ae7a5d64b677577b69674ff99f9c455095ec0b38
+  metadata.gz: 71d82f945a2bcd9c9964550ad456714a1f655e6a1df5cbfe19e355b807125306f4e70689ac231344ce55b09dc04d3f248d1c0330939b7f4649817f0a14e879ad
+  data.tar.gz: 46a21736e16236d4f415830e4c07f931ff651a0dfc08e1c289e8d6419c5b0af465eef6df9b9d7a79052e4aae40acb447ef3230a2bab17c41bf655d8071ab3a08

data/lib/stax/aws/cfn.rb

@@ -17,6 +17,7 @@ module Stax
         CREATE_COMPLETE:      :green,
         DELETE_COMPLETE:      :green,
         UPDATE_COMPLETE:      :green,
+        IMPORT_COMPLETE:      :green,
         CREATE_FAILED:        :red,
         DELETE_FAILED:        :red,
         UPDATE_FAILED:        :red,
@@ -24,6 +25,7 @@ module Stax
         ROLLBACK_COMPLETE:    :red,
         ## resource action
         Add:    :green,
+        Import: :green,
         Modify: :yellow,
         Remove: :red,
       }
@@ -170,4 +172,4 @@ module Stax
 
     end
   end
-end
+end

data/lib/stax/base.rb

@@ -1,6 +1,9 @@
 require 'thor'
 require 'stax/aws/sts'
 
+## clean exit on ctrl-c for all methods
+trap('SIGINT', 'EXIT')
+
 module Stax
   class Base < Thor
 
@@ -68,7 +71,9 @@ module Stax
         end
       end
 
-      def color(string, hash)
+      ## color a string according to current class COLORS hash
+      def color(string, hash = nil)
+        hash ||= self.class::COLORS
         set_color(string, hash.fetch(string.to_sym, :yellow))
       end
 
@@ -118,6 +123,7 @@ module Stax
 
       ## convert a diff in seconds to d h m s
       def human_time_diff(t, n = 5)
+        t = t.round # handle fractional seconds
         mm, ss = t.divmod(60)
         hh, mm = mm.divmod(60)
         dd, hh = hh.divmod(24)
@@ -132,6 +138,12 @@ module Stax
         end
       end
 
+      ## run desktop open command
+      def os_open(*args)
+        cmd = RUBY_PLATFORM.end_with?('linux') ? 'xdg-open' : 'open'
+        system(cmd, *args)
+      end
+
     end
   end
-end
+end

data/lib/stax/cli/crud.rb

@@ -56,10 +56,11 @@ module Stax
     end
 
     desc 'delete', 'meta delete task'
+    method_option :notail, aliases: '-n', type: :boolean, default: false, description: 'do not tail stack events'
     def delete
       stack_objects.reverse.each do |s|
         if s.exists?
-          s.delete
+          s.invoke(:delete, [], options)
         else
           say("#{s.stack_name} does not exist", :green)
         end
@@ -67,4 +68,4 @@ module Stax
     end
 
   end
-end
+end

data/lib/stax/mixin/codebuild.rb

@@ -14,6 +14,7 @@ module Stax
     def stack_project_names
       @_stack_project_names ||= stack_projects.map(&:physical_resource_id)
     end
+
   end
 
   module Cmd
@@ -34,6 +35,17 @@ module Stax
           status = p.phase_status || (p.phase_type == 'COMPLETED' ? '' : 'in progress')
           puts "%-16s  %-12s  %4s  %s" % [p.phase_type, color(status, COLORS), duration, p.end_time]
         end
+
+        ## latest run id for a build project
+        def latest_run(name)
+          Aws::Codebuild.builds_for_project(name, 1).first
+        end
+
+        ## aws console link to latest project run
+        def latest_run_link(name)
+          id = latest_run(name)
+          "https://console.aws.amazon.com/codesuite/codebuild/#{aws_account_id}/projects/#{name}/build/#{id}/?region=#{aws_region}"
+        end
       end
 
       desc 'projects', 'list projects'
@@ -118,6 +130,20 @@ module Stax
         tail build.id
       end
 
+      desc 'link', 'link to latest run for builds'
+      def link
+        my.stack_project_names.map do |name|
+          puts latest_run_link(name)
+        end
+      end
+
+      desc 'open', 'open latest run in aws console'
+      def open
+        my.stack_project_names.map do |name|
+          os_open(latest_run_link(name))
+        end
+      end
+
     end
   end
-end
+end

data/lib/stax/mixin/codepipeline.rb

@@ -14,6 +14,12 @@ module Stax
     def stack_pipeline_names
       @_stack_pipeline_names ||= stack_pipelines.map(&:physical_resource_id)
     end
+
+    ## get status string for n-th pipeline
+    def stack_pipeline_status(n = 0)
+      name = stack_pipeline_names[n]
+      Aws::Codepipeline.executions(name, 1)&.first&.status
+    end
   end
 
   module Cmd
@@ -29,6 +35,12 @@ module Stax
         disabled:  :red,
       }
 
+      no_commands do
+        def pipeline_link(name)
+          "https://console.aws.amazon.com/codesuite/codepipeline/pipelines/#{name}/view?region=#{aws_region}"
+        end
+      end
+
       desc 'stages', 'list pipeline stages'
       def stages
         my.stack_pipeline_names.each do |name|
@@ -54,6 +66,14 @@ module Stax
         end
       end
 
+      ## print status as one of InProgress, Stopped, Stopping, Succeeded, Superseded, Failed
+      desc 'status', 'pipeline execution status'
+      def status
+        s = my.stack_pipeline_status
+        puts(s)
+        exit(1) if s == 'Failed'
+      end
+
       desc 'state', 'pipeline state'
       def state
         my.stack_pipeline_names.each do |name|
@@ -187,6 +207,20 @@ module Stax
         end
       end
 
+      desc 'link', 'link to pipelines in aws console'
+      def link
+        my.stack_pipeline_names.each do |name|
+          puts pipeline_link(name)
+        end
+      end
+
+      desc 'open', 'open pipelines in aws console'
+      def open
+        my.stack_pipeline_names.each do |name|
+          os_open(pipeline_link(name))
+        end
+      end
+
     end
   end
 end

data/lib/stax/mixin/rds.rb

@@ -14,6 +14,7 @@ module Stax
 
       COLORS = {
         available: :green,
+        'in-sync': :green,
         Complete:  :green,
         Active:    :green,
       }
@@ -40,13 +41,36 @@ module Stax
         def stack_db_subnet_groups
           Aws::Cfn.resources_by_type(my.stack_name, 'AWS::RDS::DBSubnetGroup')
         end
+
+        def print_rds_events(opt)
+          Aws::Rds.client.describe_events(opt).map(&:events).flatten.map do |e|
+            [ e.date, e.message ]
+          end.tap(&method(:print_table))
+        end
+
+      end
+
+      desc 'ls', 'list clusters with members'
+      def ls
+        debug("RDS databases for #{my.stack_name}")
+        stack_rds_clusters.map do |c|
+          cluster = [ c.db_cluster_identifier, 'cluster', color(c.status), c.engine ]
+          instances = c.db_cluster_members.map do |m|
+            role = m.is_cluster_writer ? 'writer' : 'reader'
+            i = Aws::Rds.instances(filters: [ { name: 'db-instance-id', values: [ m.db_instance_identifier ] } ]).first
+            [ '- ' + i.db_instance_identifier, role, color(i.db_instance_status), i.engine, i.availability_zone, i.db_instance_class ]
+          end
+          [ cluster ] + instances
+        end.flatten(1).tap do |list|
+          print_table list
+        end
       end
 
       desc 'clusters', 'list db clusters for stack'
       def clusters
         debug("RDS DB clusters for #{my.stack_name}")
         print_table stack_rds_clusters.map { |c|
-          [c.db_cluster_identifier, c.engine, c.engine_version, color(c.status, COLORS), c.cluster_create_time]
+          [c.db_cluster_identifier, c.engine, c.engine_version, color(c.status), c.cluster_create_time]
         }
       end
 
@@ -65,7 +89,7 @@ module Stax
       def instances
         debug("RDS DB instances for #{my.stack_name}")
         print_table stack_rds_instances.map { |i|
-          [i.db_instance_identifier, i.engine, i.engine_version, color(i.db_instance_status, COLORS), i.db_instance_class, i.db_subnet_group&.vpc_id, i.availability_zone]
+          [i.db_instance_identifier, i.engine, i.engine_version, color(i.db_instance_status), i.db_instance_class, i.db_subnet_group&.vpc_id, i.availability_zone]
         }
       end
 
@@ -92,11 +116,48 @@ module Stax
         end.flatten.each do |g|
           debug("Subnets for group #{g.db_subnet_group_name}")
           print_table g.subnets.map { |s|
-            [s&.subnet_availability_zone&.name, s&.subnet_identifier, color(s&.subnet_status, COLORS)]
+            [s&.subnet_availability_zone&.name, s&.subnet_identifier, color(s&.subnet_status)]
           }
         end
       end
 
+      desc 'failover', 'failover clusters'
+      method_option :target, type: :string, default: nil, desc: 'id of instance to promote'
+      def failover
+        stack_rds_clusters.each do |c|
+          if yes?("Failover #{c.db_cluster_identifier}?", :yellow)
+            resp = Aws::Rds.client.failover_db_cluster(db_cluster_identifier: c.db_cluster_identifier, target_db_instance_identifier: options[:target])
+            puts "failing over #{resp.db_cluster.db_cluster_identifier}"
+          end
+        end
+      end
+
+      desc 'snapshots', 'list snapshots for stack clusters'
+      def snapshots
+        stack_db_clusters.map(&:physical_resource_id).each do |id|
+          debug("Snapshots for cluster #{id}")
+          Aws::Rds.client.describe_db_cluster_snapshots(db_cluster_identifier: id).map(&:db_cluster_snapshots).flatten.map do |s|
+            [ s.db_cluster_snapshot_identifier, s.snapshot_create_time, "#{s.allocated_storage}G", color(s.status), s.snapshot_type ]
+          end.tap do |list|
+            print_table list
+          end
+        end
+      end
+
+      desc 'events', 'list rds events for this stack'
+      option :duration, aliases: '-d', type: :numeric, default: 60*24, desc: 'duration in mins to show'
+      def events
+        stack_db_clusters.map(&:physical_resource_id).each do |id|
+          debug("Events for cluster #{id}")
+          print_rds_events(duration: options[:duration], source_type: 'db-cluster', source_identifier: id)
+        end
+
+        stack_db_instances.map(&:physical_resource_id).each do |id|
+          debug("Events for instance #{id}")
+          print_rds_events(duration: options[:duration], source_type: 'db-instance', source_identifier: id)
+        end
+      end
+
     end
   end
-end
+end

data/lib/stax/stack/changeset.rb

@@ -30,6 +30,23 @@ module Stax
         fail_task(e.message)
       end
 
+      ## create change set to import a resource
+      def change_set_import(resource)
+        Aws::Cfn.changeset(
+          change_set_type: :IMPORT,
+          resources_to_import: [ resource ],
+          stack_name: stack_name,
+          template_body: cfn_template_body,
+          template_url: cfn_template_url,
+          parameters: cfn_parameters_update,
+          capabilities: cfn_capabilities,
+          notification_arns: cfn_notification_arns,
+          change_set_name: change_set_name,
+        ).id
+      rescue ::Aws::CloudFormation::Errors::ValidationError => e
+        fail_task(e.message)
+      end
+
       ## wait and return true if changeset ready for execute
       def change_set_complete?(id)
         begin
@@ -71,11 +88,15 @@ module Stax
       end
 
       def change_set_unlock
-        Aws::Cfn.set_policy(stack_name: stack_name, stack_policy_body: stack_policy_during_update)
+        unless stack_policy_during_update.nil?
+          Aws::Cfn.set_policy(stack_name: stack_name, stack_policy_body: stack_policy_during_update)
+        end
       end
 
       def change_set_lock
-        Aws::Cfn.set_policy(stack_name: stack_name, stack_policy_body: stack_policy)
+        unless stack_policy.nil?
+          Aws::Cfn.set_policy(stack_name: stack_name, stack_policy_body: stack_policy)
+        end
       end
     end
 
@@ -90,5 +111,32 @@ module Stax
       change_set_lock
     end
 
+    desc 'import', 'create and execute changeset to import a resource'
+    option :type,  aliases: '-t', type: :string, default: nil, desc: 'cfn resource (e.g. AWS::DynamoDB::Table)'
+    option :id,    aliases: '-i', type: :string, default: nil, desc: 'logical id (e.g. OrdersTable)'
+    option :key,   aliases: '-k', type: :string, default: nil, desc: 'resource key (e.g. TableName)'
+    option :value, aliases: '-v', type: :string, default: nil, desc: 'resource value (e.g. orders)'
+    def import
+      ## prompt for missing options
+      %i[type id key value].each do |opt|
+        options[opt] ||= ask("Resource #{opt}?", :yellow)
+      end
+
+      ## create import changeset
+      debug("Creating import change set for #{stack_name}")
+      id = change_set_import(
+        resource_type: options[:type],
+        logical_resource_id: options[:id],
+        resource_identifier: {
+          options[:key] => options[:value]
+        }
+      )
+
+      ## wait for changeset, prompt for changes, and execute
+      change_set_complete?(id) || fail_task(change_set_reason(id))
+      change_set_changes(id)
+      change_set_execute(id) && tail && update_warn_imports
+    end
+
   end
-end
+end

data/lib/stax/stack/crud.rb

@@ -24,28 +24,31 @@ module Stax
         }
       end
 
-      ## policy to lock the stack to all updates
+      ## policy to lock the stack to all updates, for example:
+      ## {
+      ##   Statement: [
+      ##     Effect:    'Deny',
+      ##     Action:    'Update:*',
+      ##     Principal: '*',
+      ##     Resource:  '*'
+      ##   ]
+      ## }.to_json
       def stack_policy
-        {
-          Statement: [
-            Effect:    'Deny',
-            Action:    'Update:*',
-            Principal: '*',
-            Resource:  '*'
-          ]
-        }.to_json
+        nil
       end
 
-      ## temporary policy during updates; modify this to restrict resources
+      ## tmp policy during updates, in case a deny was set in stack_policy()
+      ## for example:
+      ## {
+      ##   Statement: [
+      ##     Effect:    'Allow',
+      ##     Action:    'Update:*',
+      ##     Principal: '*',
+      ##     Resource:  '*'
+      ##   ]
+      ## }.to_json
       def stack_policy_during_update
-        {
-          Statement: [
-            Effect:    'Allow',
-            Action:    'Update:*',
-            Principal: '*',
-            Resource:  '*'
-          ]
-        }.to_json
+        nil
       end
 
       ## cleanup sometimes needs to wait
@@ -206,11 +209,12 @@ module Stax
     end
 
     desc 'delete', 'delete stack'
+    method_option :notail, aliases: '-n', type: :boolean, default: false, description: 'do not tail stack events'
     def delete
       delete_warn_imports
       if yes? "Really delete stack #{stack_name}?", :yellow
         Aws::Cfn.delete(stack_name)
-        tail
+        tail unless options[:notail]
       end
     rescue ::Aws::CloudFormation::Errors::ValidationError => e
       fail_task(e.message)

data/lib/stax/stack/{imports.rb → exports.rb}

@@ -21,8 +21,8 @@ module Stax
       end
     end
 
-    desc 'imports', 'list imports from this stack'
-    def imports
+    desc 'exports', 'list exports from this stack, and stacks that import them'
+    def exports
       debug("Stacks that import from #{stack_name}")
       print_table Aws::Cfn.exports(stack_name).map { |e|
         imports = (i = Aws::Cfn.imports(e.export_name)).empty? ? '-' : i.join('  ')
@@ -30,5 +30,11 @@ module Stax
       }.sort
     end
 
+    desc 'imports', 'deprecated: use exports'
+    def imports
+      warn("deprecated method: please use 'exports' instead")
+      exports
+    end
+
   end
-end
+end

data/lib/stax/version.rb

@@ -1,3 +1,3 @@
 module Stax
-  VERSION = '0.1.4'
+  VERSION = '0.1.8'
 end

data/lib/stax.rb

@@ -16,7 +16,7 @@ require 'stax/stack/crud'
 require 'stax/stack/changeset'
 require 'stax/stack/parameters'
 require 'stax/stack/outputs'
-require 'stax/stack/imports'
+require 'stax/stack/exports'
 require 'stax/stack/resources'
 require 'stax/stack/drift'
 

data/stax.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "docile", "1.2.0"
   spec.add_development_dependency "stax-examples"
 
   spec.add_dependency('aws-sdk-cloudformation')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stax
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Richard Lister
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: docile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: stax-examples
   requirement: !ruby/object:Gem::Requirement
@@ -596,7 +582,7 @@ files:
 - lib/stax/stack/changeset.rb
 - lib/stax/stack/crud.rb
 - lib/stax/stack/drift.rb
-- lib/stax/stack/imports.rb
+- lib/stax/stack/exports.rb
 - lib/stax/stack/outputs.rb
 - lib/stax/stack/parameters.rb
 - lib/stax/stack/resources.rb
@@ -624,7 +610,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Control Cloudformation stack and other stuff.