jets 0.2.0 → 0.5.0

data/lib/jets/commands/delete.rb

@@ -0,0 +1,119 @@
+class Jets::Commands::Delete
+  include Jets::AwsServices
+
+  def initialize(options)
+    @options = options
+  end
+
+  def run
+    puts("Deleting project...")
+    return if @options[:noop]
+
+    are_you_sure?
+
+    confirm_project_exists
+
+    # Must first remove all objects from s3 bucket in order to delete stack
+    puts "First, deleting objects in s3 bucket #{s3_bucket_name}" if s3_bucket_name
+    empty_s3_bucket
+
+    stack_in_progress?(parent_stack_name)
+
+    cfn.delete_stack(stack_name: parent_stack_name)
+    puts "Deleting #{Jets.config.project_namespace.colorize(:green)}..."
+
+    wait_for_stack if @options[:wait]
+    puts "Project #{Jets.config.project_namespace.colorize(:green)} deleted!"
+  end
+
+  def wait_for_stack
+    status = Jets::Cfn::Status.new(@options)
+    start_time = Time.now
+    status.wait
+    took = Time.now - start_time
+    puts "Time took for deletion: #{status.pretty_time(took).green}."
+  end
+
+  def confirm_project_exists
+    begin
+      resp = cfn.describe_stacks(stack_name: parent_stack_name)
+    rescue Aws::CloudFormation::Errors::ValidationError
+      # Aws::CloudFormation::Errors::ValidationError is thrown when the stack
+      # does not exist
+      puts "The parent stack #{Jets.config.project_namespace.colorize(:green)} for the project #{Jets.config.project_name.colorize(:green)} does not exist. So it cannot be deleted."
+      exit 0
+    end
+  end
+
+  def empty_s3_bucket
+    return unless s3_bucket_name # Happens when minimal stack fails to build
+
+    resp = s3.list_objects(bucket: s3_bucket_name)
+    if resp.contents.size > 0
+      # IE: objects = [{key: "objectkey1"}, {key: "objectkey2"}]
+      objects = resp.contents.map { |item| {key: item.key} }
+      s3.delete_objects(
+        bucket: s3_bucket_name,
+        delete: {
+          objects: objects,
+          quiet: false,
+        }
+      )
+      empty_s3_bucket # keep deleting objects until bucket is empty
+    end
+  end
+
+  def s3_bucket_name
+    return @s3_bucket_name if defined?(@s3_bucket_name)
+
+    resp = cfn.describe_stacks(stack_name: parent_stack_name)
+    outputs = resp.stacks[0].outputs
+    if outputs.empty?
+      @s3_bucket_name = false
+    else
+      @s3_bucket_name = outputs.find {|o| o.output_key == 'S3Bucket'}.output_value
+    end
+  end
+
+  def parent_stack_name
+    Jets::Naming.parent_stack_name
+  end
+
+  def are_you_sure?
+    if @options[:sure]
+      sure = 'y'
+    else
+      puts "Are you sure you want to want to delete the '#{Jets.config.project_namespace}' project? (y/N)"
+      sure = $stdin.gets
+    end
+
+    unless sure =~ /^y/
+      puts "Phew! Jets '#{Jets.config.project_namespace}' project was not deleted."
+      exit 0
+    end
+  end
+
+    # All CloudFormation states listed here: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html
+    #
+    # Returns resp so we can use it to grab data about the stack without calling api again.
+    def check_deleteable_status
+      return true if !stack_exists?(@parent_stack_name)
+
+      # Assumes stack exists
+      resp = cfn.describe_stacks(stack_name: @parent_stack_name)
+      status = resp.stacks[0].stack_status
+      if status =~ /_IN_PROGRESS$/
+        puts "The '#{@parent_stack_name}' stack status is #{status}. " \
+             "It is not in an updateable status. Please wait until the stack is ready and try again.".colorize(:red)
+        exit 0
+      elsif resp.stacks[0].outputs.empty?
+        # This Happens when the miminal stack fails at the very beginning.
+        # There is no s3 bucket at all.  User should delete the stack.
+        puts "The minimal stack failed to create. Please delete the stack first and try again." \
+        "You can delete the CloudFormation stack or use the `jets delete` command"
+        exit 0
+      else
+        true
+      end
+    end
+end

data/lib/jets/commands/deploy.rb

@@ -0,0 +1,53 @@
+module Jets::Commands
+  class Deploy
+    include StackInfo
+    include Jets::Timing
+
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      deployment_env = Jets.config.project_namespace.colorize(:green)
+      puts "Deploying to Lambda #{deployment_env} environment..."
+      return if @options[:noop]
+
+      build_code
+      # first time will deploy minimal stack
+      exit_unless_updateable!
+
+      ship(stack_type: :minimal) if first_run?
+      # deploy full nested stack when stack already exists
+      ship(stack_type: :full, s3_bucket: s3_bucket)
+    end
+    time :run
+
+    def build_code
+      Jets::Commands::Build.new(@options).build_code
+    end
+    time :build_code
+
+    def ship(stack_options)
+      options = @options.merge(stack_options) # includes stack_type and s3_bucket
+      Jets::Commands::Build.new(options).build_templates
+      Jets::Cfn::Ship.new(options).run
+    end
+    time :ship
+
+    # All CloudFormation states listed here: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html
+    def exit_unless_updateable!
+      stack_name = Jets::Naming.parent_stack_name
+      exists = stack_exists?(stack_name)
+      return unless exists # continue because stack could be updating
+
+      stack = cfn.describe_stacks(stack_name: stack_name).stacks.first
+      status = stack["stack_status"]
+      if status =~ /^ROLLBACK_/ ||
+         status =~ /_IN_PROGRESS$/
+        puts "Parent stack associate with this '#{Jets.config.project_name}' project not in a updateable state.".colorize(:red)
+        puts "Stack name #{stack_name} status #{stack["stack_status"]}"
+        exit
+      end
+    end
+  end
+end

data/lib/jets/commands/dynamodb.rb

@@ -0,0 +1,22 @@
+module Jets::Commands
+  class Dynamodb < Jets::Commands::Base
+    autoload :Migrator, 'jets/commands/dynamodb/migrator'
+    autoload :Migrate, 'jets/commands/dynamodb/migrate'
+
+    desc "migrate [path]", "Runs migrations"
+    long_desc Help.text('dynamodb:migrate')
+    def migrate(path)
+      Migrator.new(path, options).run
+    end
+
+    desc "generate [name]", "Creates a migration for a DynamoDB table"
+    long_desc Help.text('dynamodb:generate')
+    option :partition_key, default: "id:string:hash", desc: "table's partition key"
+    option :sort_key, default: nil, desc: "table's sort key"
+    option :table_name, desc: "override the the conventional table name"
+    option :table_action, desc: "create_table or update_table. Defaults to convention based on the name of the migration."
+    def generate(name)
+      Dynomite::Migration::Generator.new(name, options).generate
+    end
+  end
+end

data/lib/jets/commands/dynamodb/migrate.rb

@@ -0,0 +1,9 @@
+class Jets::Commands::Dynamodb::Migrate < Jets::Commands::Base
+  desc "down", "Runs migrations down"
+  # desc "migrate:down [path]", "Runs migrations down"
+  # long_desc Help.migrate
+  def down#(path)
+    # Migrate.new(path, options).run
+    puts "Jets::Commands::Dynamodb::Down ran"
+  end
+end

data/lib/jets/commands/dynamodb/migrator.rb

@@ -0,0 +1,36 @@
+begin
+  require "dynomite"
+rescue LoadError # Commands::Base.eager_load
+  nil
+end
+
+class Jets::Commands::Dynamodb::Migrator
+  def initialize(path, options)
+    @path = path
+    @options = options
+  end
+
+  def run
+    puts "Running database migrations"
+    return if @options[:noop]
+    migrate
+  end
+
+  def migrate
+    path = "#{Jets.root}#{@path}"
+    unless File.exist?(path)
+      puts "Unable to find the migration file: #{path}"
+      exit 1
+    end
+
+    require path
+    migration_class = get_migration_class
+    migration_class.new.up
+  end
+
+  def get_migration_class
+    filename = File.basename(@path, '.rb')
+    filename = filename.sub(/\d+[-_]/, '') # strip leading timestsamp
+    filename.classify.constantize
+  end
+end

data/lib/jets/commands/help.rb

@@ -0,0 +1,9 @@
+module Jets::Commands::Help
+  class << self
+    def text(namespaced_command)
+      path = namespaced_command.to_s.gsub(':','/')
+      path = File.expand_path("../help/#{path}.md", __FILE__)
+      IO.read(path) if File.exist?(path)
+    end
+  end
+end

data/lib/jets/commands/help/build.md

@@ -0,0 +1 @@
+Generates a node shim and bundles a Linux Ruby in the bundled folder.  Creates a zip file to be uploaded to Lambda for each handler. This allows you to build the project and inspect the zip file that gets deployed to AWS Lambda.

data/lib/jets/commands/help/call.md

@@ -0,0 +1,55 @@
+Invoke the lambda function on AWS. The `jets call` command does a few extra things for your convenience:
+
+It adds the function namespace to the function name.  So, you pass in `posts_controller-index` and the Lambda function is `demo-dev-posts_controller-index`.
+
+It can print out the last 4KB of the lambda logs with the `--show-logs` option. The logging output is directed to stderr.  The response output from the lambda function itself is directed to stdout.  This is done so you can safely pipe the results of the call command to other tools like jq.
+
+For controllers, the event you pass at the CLI is automatically transformed into Lambda Proxy payload that contains the params as the queryStringParameters.  For example:
+
+    {"test":1}
+
+Gets changed to:
+
+    {"queryStringParameters":{"test":1}}
+
+This spares you from assembling the event payload manually to the payload that Jets controllers normally recieve.  If you would like to disable this Lambda Proxy transformation then use the `--no-lambda-proxy` flag.
+
+For jobs, the event is passed through untouched.
+
+Examples:
+
+    jets call hard_job-drive '{"test":1}'
+    jets call hard_job-drive '{"test":1}' | jq .
+    jets call hard_job-drive file://event.json | jq . # load event with a file
+    jets call posts_controller-index # event payload is optional
+    jets call posts_controller-index '{"test":1}' --show-log | jq .
+    jets call posts_controller-index 'file://event.json' --show-log | jq .
+
+The equivalent AWS Lambda CLI command:
+
+    aws lambda invoke --function-name demo-dev-hard_job-dig --payload '{"test":1}' outfile.txt
+    cat outfile.txt | jq '.'
+
+    aws lambda invoke --function-name demo-dev-posts_controller-index --payload '{"queryStringParameters":{"test":1}}' outfile.txt
+    cat outfile.txt | jq '.'
+
+For convenience, you can also provide the function name with only dashes and jets call will gets what function you intend to call. Examples:
+
+    jets call posts-controller-index
+    jets call admin-related-pages-controller-index
+
+Are the same as:
+
+    aws lambda invoke --function-name demo-dev-posts_controller-index
+    aws lambda invoke --function-name demo-dev-admin/related_pages_controller-index
+
+In order to allow calling functions with all dashes, the call method evaluates the app code and finds if the controller and method actually exists.  If you want to turn this off and want to always explicitly provide the method name use the `--no-guess` option.  The function name will then have to match the lambda function without the namespace. Example:
+
+    jets call admin-related_pages_controller-index --no-guess
+
+Local mode:
+
+Instead of calling AWS lambda remote, you can also have `jets call` use the code directly on your machine.  To enable this use the `--local` flag. Example:
+
+    jets call hard_job-drive --local
+

data/lib/jets/commands/help/console.md

@@ -0,0 +1,4 @@
+## Example
+
+    $ jets console
+    > Post.find("myid")

data/lib/jets/commands/help/db/generate.md

@@ -0,0 +1,8 @@
+Generates migration in `db/migrate`
+
+## Examples
+
+    jets db:generate create_articles title:string user_id:integer
+    jets db:generate AddTitleBodyToPost title:string body:text published:boolean
+
+This task delegates to Rails `rails generate migration`.  For more examples: `rails generate migration -h`.

data/lib/jets/commands/help/dbconsole.md

@@ -0,0 +1,5 @@
+This is like running the psql command with the `config/database.yml` values and set for you.
+
+## Example
+
+    jets dbconsole

data/lib/jets/commands/help/delete.md

@@ -0,0 +1,9 @@
+This essentially deletes the associated CloudFormation stacks.
+
+## Examples
+
+    $ jets delete
+
+You can bypass the are you sure prompt with the `--sure` flag.
+
+    $ jets delete --sure

data/lib/jets/commands/help/deploy.md

@@ -0,0 +1,5 @@
+This packages up the project and deploys it AWS Lambda. This essentially updating the CloudFormation stack.
+
+## Example
+
+    $ jets deploy

data/lib/jets/commands/help/dynamodb/generate.md

@@ -0,0 +1,50 @@
+Generates a migration file which can be used to create a DynamoDB table.  To run the migration file use `jets db:migrate`.
+
+The table name will have a namespace. For example, given your project is called `proj`, the env is called `dev`, and you create a table called `posts`.  The DynamoDB full table name will be `demo-dev-posts`.  You can change this behavior by editing your `config/dynamodb.yml`.
+
+For the `--partition-key` option, DynamoDB tables support certain types of attribute types. The cli will parse the --partition-key option and use the second part of the option to map it to the underlying DynamoDB type using this mapping.
+
+  ATTRIBUTE_TYPE_MAP = {
+    'string' => 'S',
+    'number' => 'N',
+    'binary' => 'B',
+    's' => 'S',
+    'n' => 'N',
+    'b' => 'B',
+  }
+
+For example, --partition-key id:string will map 'string' to 's'.  More info available at the ruby aws-sdk docs: [Aws::DynamoDB::Types::AttributeDefinition](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Types/AttributeDefinition.html)
+
+Examples:
+
+    $ jets dynamodb:generate create_posts --partition-key id # default attribute type is string
+    $ jets dynamodb:generate create_posts --partition-key id:number # attribute type will be number
+    $ jets dynamodb:generate create_comments --partition-key post_id:string --sort-key created_at:string
+
+To run migrations:
+
+    $ jets dynamodb:migrate path/to/migration
+    $ jets dynamodb:migrate dynamodb/migrate/20171112162404-create_articles_migration.rb
+
+To add global secondary indexes:
+
+    $ jets dynamodb:generate update_comments --partition-key user_id:string --sort-key created_at:string
+
+To run:
+
+    $ jets dynamodb:migrate dynamodb/migrate/20171112161530-create_posts_migration.rb
+
+Conventions:
+
+An create_table or update_table migration file is generated based name you provide.  If update is found in the name then an update_table migration table is generated.
+
+The table_name is also inferred from the migration name you provide.  Examples:
+
+    $ jets dynamodb:generate create_posts => table_name: posts
+    $ jets dynamodb:generate update_comments => table_name: comments
+
+You can override both of these conventions:
+
+    $ jets dynamodb:generate create_my_posts --table-name posts
+    $ jets dynamodb:generate my_posts --table-action create_table --table-name posts
+    $ jets dynamodb:generate my_posts --table-action update_table --table-name posts

data/lib/jets/commands/help/dynamodb/migrate.md

@@ -0,0 +1,4 @@
+## Examples
+
+    jets dynamodb:migrate path/to/migration
+    jets dynamodb:migrate db/migrate/posts_migration.rb

data/lib/jets/commands/help/generate.md

@@ -0,0 +1,5 @@
+This piggy backs off of rails generators.
+
+## Example
+
+    jets generate scaffold Post title:string body:text published:boolean

data/lib/jets/commands/help/new.md

@@ -0,0 +1,9 @@
+## Examples
+
+    $ jets new blog
+
+Use the `--repo` flag to clone an example project from GitHub instead.  With this flag, jets new command clones a jets project repo from GitHub:
+
+    $ jets new blog --repo tongueroo/tutorial
+    $ jets new blog --repo tongueroo/todos
+    $ jets new blog --repo user/repo # any github repo

data/lib/jets/commands/help/process/controller.md

@@ -0,0 +1,6 @@
+The node shim spawns out to this command.
+
+## Example
+
+    $ jets process:controller '{"pathParameters":{}}' '{"context":"data"}' "handlers/controllers/posts_controller.index"
+    $ jets process:controller '{"pathParameters":{"id":"tung"}}' '{}' handlers/controllers/posts_controller.show

data/lib/jets/commands/help/process/function.md

@@ -0,0 +1,5 @@
+The node shim spawns out to this command.
+
+## Example
+
+    $ jets process function '{"key1":"value1"}' '{}' "handlers/function/hello.world"

data/lib/jets/commands/help/process/job.md

@@ -0,0 +1,5 @@
+The node shim spawns out to this command.
+
+## Example
+
+    $ jets process:job '{"we":"love", "using":"Lambda"}' '{"context":"data"}' "handlers/jobs/hard_job.dig"