dynamocli 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1efb4611b31d80e7ec45a7f4ff3ac153f20b4d597fdcf10bc42700b0fafc237
-  data.tar.gz: 35d2937a8c46b67fbbfcfd26d329aeb65298bd057b5683648a6b6e7ed72229bf
+  metadata.gz: 613ace3c66e1db3954fef903bc0f86700787448328964687ebed39520dfe2205
+  data.tar.gz: e0fb394d2b04fc78928fe64eb7107301c91a5edcf17719ece5decb65007ca5ed
 SHA512:
-  metadata.gz: 2145d414772764d63004a75c6d519281b58827de57796bf938efcdf24cd9dc122fb60c8d7abdf765820449588022e503d87fe2931dd09605fba4f4124855f7a2
-  data.tar.gz: ded7bc87428451cabdd87b8e50bd382938ff5cad544d43ae477d50fc19ea87ddc795e818c97ade0047ad5eba3c2e29b26b3b0c22dc66f11d59d60b9e63023520
+  metadata.gz: fdd626d3441fbeaf0869542d356946f954b554d8daae402a908c15b059b7405f889d408f9ad67a4dfdbc72380e13ec20738a8e16ef743b235d3f75c55c662f29
+  data.tar.gz: 802b9d48e4b77c5a40675234c04f7057204601bfa7077f4f45c5646157481389a36f8cd12437b922850bf8b8f533bfbb7c6d655e17e38421932f01da42884009

data/.gitignore

@@ -13,3 +13,5 @@
 .byebug_history
 
 *.gem
+
+*.swp

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# CHANGELOG
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.2] - 2019-06-20
+### Added
+- Command to erase a DynamoDB table.
+
+## [0.1.1] - 2019-05-21 [YANKED]
+
+## [0.1.0] - 2019-05-20
+### Added
+- Command to import data from a CSV file to a DynamoDB table.
+
+[0.1.0]: https://github.com/matheussilvasantos/dynamocli/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    dynamocli (0.1.0)
+    dynamocli (0.1.2)
+      aws-sdk-cloudformation
       aws-sdk-dynamodb (~> 1.28)
       thor (~> 0.20)
 
@@ -9,14 +10,17 @@ GEM
   remote: https://rubygems.org/
   specs:
     aws-eventstream (1.0.3)
-    aws-partitions (1.164.0)
-    aws-sdk-core (3.52.1)
+    aws-partitions (1.174.0)
+    aws-sdk-cloudformation (1.22.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.54.2)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.28.0)
-      aws-sdk-core (~> 3, >= 3.52.1)
+    aws-sdk-dynamodb (1.30.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.1.0)
       aws-eventstream (~> 1.0, >= 1.0.2)

data/README.md

@@ -1,6 +1,6 @@
 # Dynamocli
 
-Utilites for interaction with your DynamoDB tables (only importation of data from a CSV file to a table is available for now).
+Utilites for interaction with your DynamoDB tables.
 
 ## Installation
 
@@ -10,14 +10,52 @@ gem install dynamocli
 
 ## Usage
 
+
 You have to configure AWS in your computer first. The program will use the AWS credentials configured in your computer.
 
-After install the program you will be able to run:
+- Import data from a CSV file to a DynamoDB table
+
+```
+Usage:
+  dynamocli import FILE -t, --table, --to=TABLE
+
+Options:
+  -t, --table, --to=TABLE  # table you want to import the data
+
+Description:
+  `dynamocli import` will import the data in from a file to a table specified.
+
+  > $ dynamo import users.csv --to users
+
+```
+
+- Erase all the data of a DynamoDB table
 
 ```
-dynamocli import your_data.csv --to your_table
+Usage:
+  dynamocli erase TABLE
+
+Options:
+  [--with-drift], [--no-with-drift]  # drop the table and
+  recreate it directly instead of use deployments
+
+Description:
+  `dynamocli erase` will erase all the data of the specified table.
+
+  It will drop the table and recreate it.
+
+  If the table is in a stack it will try to deploy
+  the stack without the table and then redeploy the
+  stack with the original template. You can change
+  this behavior passing the option --with-drift.
+
+  > $ dynamo erase users
 ```
 
+From the DynamoDB Guidelines for Working with Tables documentation:
+
+> Deleting an entire table is significantly more efficient than removing items one-by-one, which essentially doubles the write throughput as you do as many delete operations as put operations.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/{dynamorb.gemspec → dynamocli.gemspec}

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "thor", "~> 0.20"
   spec.add_dependency "aws-sdk-dynamodb", "~> 1.28"
+  spec.add_dependency "aws-sdk-cloudformation"
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/dynamocli.rb

@@ -1,11 +1,13 @@
+require "thor"
 require "dynamocli/version"
 require "dynamocli/import"
+require "dynamocli/erase"
 
 module Dynamocli
   class Client < Thor
     desc "import FILE", "import data from FILE to dynamodb"
     long_desc <<-LONGDESC
-      `dynamo import` will import the data in from a file
+      `dynamocli import` will import the data in from a file
       to a table specified.
 
       > $ dynamo import users.csv --to users
@@ -14,5 +16,22 @@ module Dynamocli
     def import(file)
       Dynamocli::Import.new(file: file, table: options[:to]).start
     end
+
+    desc "erase TABLE", "erase all the data from the DynamoDB TABLE"
+    long_desc <<-LONGDESC
+      `dynamocli erase` will erase all the data of the specified table.
+
+      It will drop the table and recreate it.
+
+      If the table is in a stack it will try to deploy the stack without
+      the table and then redeploy the stack with the original template.
+      You can change this behavior passing the option --with-drift.
+
+      > $ dynamo erase users
+    LONGDESC
+    option "with-drift", desc: "drop the table and recreate it directly instead of use deployments", type: :boolean
+    def erase(table)
+      Dynamocli::Erase.new(table_name: table, with_drift: options["with-drift"]).start
+    end
   end
 end

data/lib/dynamocli/erase.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+require "json"
+require "yaml"
+require "aws-sdk-dynamodb"
+require "aws-sdk-cloudformation"
+
+class Dynamocli::Erase
+  def initialize(table_name:, with_drift: false)
+    @with_drift = with_drift
+    @table_name = table_name
+
+    @dynamodb = Aws::DynamoDB::Client.new
+    @cloudformation = Aws::CloudFormation::Client.new
+    @table = Aws::DynamoDB::Table.new(@table_name)
+
+    set_schema
+
+    @stack_resources = @cloudformation.describe_stack_resources(physical_resource_id: @table_name).to_h
+
+    set_stack_information
+  rescue Aws::DynamoDB::Errors::ResourceNotFoundException => e
+    STDERR.puts "ERROR: #{e.message}"
+    exit(42)
+  rescue Aws::CloudFormation::Errors::ValidationError
+    @stack_resources = nil
+  end
+
+  def start
+    erase_table
+  rescue Aws::CloudFormation::Errors::ValidationError => e
+    STDERR.puts "ERROR: #{e.message}"
+    exit(42)
+  end
+
+  private
+
+  def set_schema
+    @schema = @dynamodb.describe_table(table_name: @table_name).to_h[:table].tap do |schema|
+      schema.delete(:table_status)
+      schema.delete(:creation_date_time)
+      schema.delete(:table_size_bytes)
+      schema.delete(:item_count)
+      schema.delete(:table_arn)
+      schema.delete(:table_id)
+      schema[:provisioned_throughput].delete(:number_of_decreases_today)
+    end
+  end
+  
+  def set_stack_information
+    return if @stack_resources.nil?
+
+    set_stack_name
+    set_stack
+    set_templates
+  rescue Aws::CloudFormation::Errors::ValidationError => e
+    STDERR.puts "ERROR: #{e.message}"
+    exit(42)
+  end
+
+  def set_stack_name
+    table_resource = @stack_resources[:stack_resources].find do |resource|
+      resource[:physical_resource_id] == @table_name
+    end
+    @stack_name = table_resource[:stack_name]
+  end
+
+  def set_stack
+    @stack = @cloudformation.describe_stacks(stack_name: @stack_name)[0][0]
+  end
+
+  def set_templates
+    template_body = @cloudformation.get_template(stack_name: @stack_name).to_h[:template_body]
+    @original_template = parse_template(template_body)
+    @template_without_table = parse_template(template_body)
+
+    tables = @original_template["Resources"].select { |_, v| v["Type"] == "AWS::DynamoDB::Table" }
+    table = tables.find { |_, v| v["Properties"]["TableName"] == @table_name }
+
+    if tables.nil?
+      STDERR.puts "ERROR: table #{@table_name} not found in the #{@stack_name} stack"
+      exit(42)
+    end
+
+    logical_resource_id = table.first
+    @template_without_table["Resources"].delete(logical_resource_id)
+  end
+
+  def parse_template(template)
+    JSON.parse(template)
+  rescue JSON::ParserError
+    YAML.load(template)
+  end
+
+  def erase_table
+    if @stack_resources.nil? || @with_drift
+      check_if_user_wants_to_continue_with_recreation
+      delete_and_recreate_the_table
+    else
+      check_if_user_wants_to_continue_with_deployment
+      erase_table_through_cloudformation
+    end
+  end
+
+  def check_if_user_wants_to_continue_with_recreation
+    STDOUT.print(
+      "WARNING: You're going to drop and recreate your #{@table_name} table,\n" \
+      "do you really want to continue?\n" \
+      "(anything other than 'y' will cancel) > "
+    )
+
+    confirmation = STDIN.gets.strip
+    return if confirmation == "y"
+
+    STDOUT.puts abort_message
+    exit(0)
+  end
+
+  def abort_message
+    "INFO: Erase of #{@table_name} table canceled"
+  end
+
+  def delete_and_recreate_the_table
+    delete_table
+    wait_for_deletion_to_complete
+    create_table
+  end
+
+  def delete_table
+    STDOUT.puts "INFO: Deleting the #{@table_name} table"
+
+    @table.delete
+
+    STDOUT.puts "INFO: #{@table_name} table deleted"
+  end
+
+  def wait_for_deletion_to_complete
+    waiting_seconds = 0
+    while get_table_status == "DELETING"
+      STDOUT.puts "INFO: Waiting for deletion to complete"
+      sleep waiting_seconds += 1
+    end
+  rescue Aws::DynamoDB::Errors::ResourceNotFoundException
+    true
+  end
+
+  def get_table_status
+    @dynamodb.describe_table(table_name: @table_name).table.table_status
+  end
+
+  def create_table
+    STDOUT.puts "INFO: Creating the #{@table_name} table"
+
+    @dynamodb.create_table(@schema)
+
+    STDOUT.puts "INFO: #{@table_name} table created"
+  end
+  
+  def check_if_user_wants_to_continue_with_deployment
+    STDOUT.print(
+      "WARNING: You are going to deploy and redeploy your #{@stack_name} stack\n" \
+      "to drop and recreate the #{@table_name} table, do you really want to continue?\n" \
+      "(anything other than 'y' will cancel) > "
+    )
+
+    confirmation = STDIN.gets.strip
+    return if confirmation == "y"
+
+    STDOUT.puts abort_message
+    exit(0)
+  end
+
+  def erase_table_through_cloudformation
+    deploy_stack_without_the_table
+    wait_for_deployment_to_complete
+    deploy_stack_with_the_original_template
+  end
+
+  def deploy_stack_without_the_table
+    STDOUT.puts "INFO: Deploying the stack without the #{@table_name} table"
+
+    @cloudformation.update_stack(
+      stack_name: @stack_name,
+      template_body: @template_without_table.to_json,
+      parameters: @stack.parameters.map(&:to_h),
+      capabilities: @stack.capabilities,
+      role_arn: @stack.role_arn,
+      rollback_configuration: @stack.rollback_configuration.to_h,
+      stack_policy_body: get_stack_policy_body,
+      notification_arns: @stack.notification_arns,
+      tags: @stack.tags.map(&:to_h)
+    )
+
+    STDOUT.puts "INFO: Stack deployed without the #{@table_name} table"
+  end
+
+  def get_stack_policy_body
+    @cloudformation.get_stack_policy(stack_name: @stack_name).stack_policy_body
+  end
+
+  def wait_for_deployment_to_complete
+    waiting_seconds = 0
+    while get_stack_status != "UPDATE_COMPLETE"
+      STDOUT.puts "INFO: Waiting for deployment to complete"
+      sleep waiting_seconds += 1
+    end
+  end
+
+  def get_stack_status
+    @cloudformation.describe_stacks(stack_name: @stack_name)[0][0].stack_status
+  end
+
+  def deploy_stack_with_the_original_template
+    STDOUT.puts "INFO: Deploying the stack with the #{@table_name} table"
+
+    @cloudformation.update_stack(
+      stack_name: @stack_name,
+      template_body: @original_template.to_json,
+      parameters: @stack.parameters.map(&:to_h),
+      capabilities: @stack.capabilities,
+      role_arn: @stack.role_arn,
+      rollback_configuration: @stack.rollback_configuration.to_h,
+      stack_policy_body: get_stack_policy_body,
+      notification_arns: @stack.notification_arns,
+      tags: @stack.tags.map(&:to_h)
+    )
+
+    STDOUT.puts "INFO: Stack deployed with the #{@table_name} table"
+  end
+end

data/lib/dynamocli/import.rb

@@ -1,4 +1,3 @@
-require "thor"
 require "csv"
 require "aws-sdk-dynamodb"
 

data/lib/dynamocli/version.rb

@@ -1,3 +1,3 @@
 module Dynamocli
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamocli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Matheus Silva Santos de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.28'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudformation
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +107,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -102,8 +117,9 @@ files:
 - bin/console
 - bin/dynamocli
 - bin/setup
-- dynamorb.gemspec
+- dynamocli.gemspec
 - lib/dynamocli.rb
+- lib/dynamocli/erase.rb
 - lib/dynamocli/import.rb
 - lib/dynamocli/version.rb
 homepage: https://github.com/matheussilvasantos/dynamocli