lambda_deployment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c703c23c73564ef0a8f7bd9124ad25f4c3c7abe
+  data.tar.gz: 72a2a8888964fa26bad41af062a81411e708bf9e
+SHA512:
+  metadata.gz: 64b21dc6b85d9a9ac17fba736cadc6c39998b3e760425245c9155509766054ed96ad5cbdad5ddba987b784df7712fd5472c977016f75abc1f572fbf1e0a5d7b6
+  data.tar.gz: 555176f4ddff69b6435aa286234746eabbad8c79dfe8bef09eea60d34e980217aef964dd534118e24d52271795bb47603fabdb5058f97211448c66b2668c7f0f

data/README.md

@@ -0,0 +1,86 @@
+# lambda_deployment
+Ruby gem for deploying lambda functions in AWS with Samson or another tool.
+**This gem is used to update the function code only** - the resources must
+already be provisioned using another tool (or manually).
+
+[![Build Status](https://travis-ci.org/zendesk/lambda_deployment.svg?branch=master)](https://travis-ci.org/zendesk/lambda_deployment)
+
+## Usage
+This gem provides a binary called `lambda_deploy` which will deploy a zip or
+jar file to lambda, version it, and promote it to production (release).
+Usage:
+```
+lambda_deploy [-c path/to/configuration.yml] deploy|release
+```
+
+### Deploy action
+The deploy action will upload the function to S3, and update the function to
+use the new code. If the environmental variable `TAG` is set it will also
+create a version and link that version to an alias named `TAG`.
+
+### Release action
+The release action will link the `production` alias to the version referenced
+by the `TAG` alias. **If `TAG` is not set this action is only required if the
+`production` alias is not already pointing to `$LATEST`.**
+
+## Environmental variables
+The configuration file is intentionally small with the option to override
+environmental variables. The default action is to fetch values from the
+environment to ensure consistency within a given environment. These variables
+should be set within the deploy tool or using the configuration file.
+
+### AWS_REGION (required)
+Region in AWS where resources are located.
+
+### LAMBDA_ASSUME_ROLE (optional)
+STS assume role to use if resources are in another account.
+
+### LAMBDA_S3_BUCKET (required)
+Name of S3 bucket to upload function to. Buckets can be provisioned per project
+or per environment.
+
+### LAMBDA_S3_SSE (optional)
+Type of encryption to use with S3.
+
+### TAG (optional)
+Version of the function being uploaded (e.g. git tag).
+
+## Quickstart Guide
+See the `examples/lambda` directory for a sample project layout.
+
+### Add the gem to your project
+Add the following line to your `Gemfile` and run `bundle install`:
+```
+gem 'lambda_deployment'
+```
+
+### Create a lambda_deploy.yml configuration file
+The only required fields are the project name (the function name in AWS), and
+the zip or jar file to upload (containing at least the script named after the
+lambda_function).
+
+Here is an example:
+```
+file_name: lambda/foobar.zip  # required: zip or jar of lambda function and dependencies
+project: my-dev-lambda-name   # required: name of lambda function
+region: us-east-1             # optional: specify AWS region (will override $AWS_REGION)
+s3_bucket: my-test-bucket     # optional: specify s3 bucket (will override $LAMBDA_S3_BUCKET)
+s3_sse: AES256                # optional: set server side encryption on s3 objects (will override $LAMBDA_S3_SSE)
+```
+
+* *file_name* is a path relative to the configuration file
+* *project* must match the function name in the AWS console (the last value in
+the following example):
+```
+arn:aws:lambda:<region>:<account_id>:function:<project>
+```
+
+### Create lambda function and s3 bucket
+The lambda function and s3 buckets must already exist to use this gem. If you
+are creating actions for your lambda make sure they execute the `production`
+alias (see below). To do this append `:production` to the end of the ARN
+associated with your lambda function.
+
+### Create `production` alias for lambda function
+In the lambda console chose *Create alias* from the *Actions* drop down. The
+name should be `production` and version should point to `$LATEST`.

data/bin/lambda_deploy

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'lambda_deployment/cli'
+
+LambdaDeployment::CLI.new.run(ARGV)

data/lib/lambda_deployment/cli.rb

@@ -0,0 +1,42 @@
+require 'lambda_deployment'
+
+module LambdaDeployment
+  class CLI
+    def run(args)
+      parse_args(args)
+      case @action
+      when 'deploy'
+        deploy
+      when 'release'
+        release
+      else
+        raise 'Action must be either deploy or release'
+      end
+    end
+
+    private
+
+    def config
+      @config ||= LambdaDeployment::Configuration.new
+    end
+
+    def deploy
+      LambdaDeployment::Lambda::Deploy.new(config).run
+    end
+
+    def release
+      LambdaDeployment::Lambda::Release.new(config).run
+    end
+
+    def parse_args(args)
+      config_file = 'lambda_deploy.yml'
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: lambda_deploy [-c FILE] deploy|release'
+        opts.version = LambdaDeployment::VERSION
+        opts.on('-c', '--config [FILE]', 'Use specified config file') { |c| config_file = c }
+      end.parse!(args)
+      @action = args.shift
+      config.load_config(config_file)
+    end
+  end
+end

data/lib/lambda_deployment/client.rb

@@ -0,0 +1,32 @@
+module LambdaDeployment
+  class Client
+    def initialize(region)
+      @region = region
+    end
+
+    def lambda_client
+      @lambda_client ||= Aws::Lambda::Client.new(config)
+    end
+
+    def s3_client
+      @s3_client ||= Aws::S3::Client.new(config)
+    end
+
+    private
+
+    def config
+      config = { region: @region }
+      if role_arn
+        config[:credentials] = Aws::AssumeRoleCredentials.new(
+          role_arn: role_arn,
+          role_session_name: SecureRandom.hex(10)
+        )
+      end
+      config
+    end
+
+    def role_arn
+      ENV.fetch('LAMBDA_ASSUME_ROLE', false)
+    end
+  end
+end

data/lib/lambda_deployment/configuration.rb

@@ -0,0 +1,29 @@
+module LambdaDeployment
+  class Configuration
+    attr_reader :file_path, :project, :region, :s3_bucket, :s3_key, :s3_sse
+
+    def load_config(config_file)
+      config = YAML.load_file(config_file)
+      @project = config.fetch('project')
+      @region = config.fetch('region', ENV.fetch('AWS_REGION', nil))
+      @file_path = File.expand_path(config.fetch('file_name'), File.dirname(config_file))
+      raise "File not found: #{@file_path}" unless File.exist?(@file_path)
+
+      @s3_bucket = config.fetch('s3_bucket', ENV.fetch('LAMBDA_S3_BUCKET', nil))
+      @s3_key = s3_key_name(config.fetch('file_name'))
+      @s3_sse = config.fetch('s3_sse', ENV.fetch('LAMBDA_S3_SSE', nil))
+    end
+
+    def alias_name
+      ENV.fetch('TAG', nil)
+    end
+
+    private
+
+    def s3_key_name(file_name)
+      basename = File.basename(file_name, '.*')
+      extension = File.extname(file_name)
+      "#{basename}-#{ENV.fetch('TAG', 'latest')}#{extension}"
+    end
+  end
+end

data/lib/lambda_deployment/lambda/deploy.rb

@@ -0,0 +1,63 @@
+module LambdaDeployment
+  module Lambda
+    class Deploy
+      def initialize(config)
+        @config = config
+        @client = LambdaDeployment::Client.new(config.region)
+      end
+
+      def run
+        upload_to_s3
+        update_function_code
+        return unless @config.alias_name
+        version = publish_version
+        begin
+          create_alias(version)
+        rescue Aws::Lambda::Errors::ResourceConflictException
+          update_alias(version)
+        end
+      end
+
+      private
+
+      def upload_to_s3
+        @client.s3_client.put_object(
+          body: File.read(@config.file_path),
+          bucket: @config.s3_bucket,
+          key: @config.s3_key,
+          server_side_encryption: @config.s3_sse
+        )
+      end
+
+      def update_function_code
+        @client.lambda_client.update_function_code(
+          function_name: @config.project,
+          s3_bucket: @config.s3_bucket,
+          s3_key: @config.s3_key
+        )
+      end
+
+      def publish_version
+        @client.lambda_client.publish_version(
+          function_name: @config.project
+        ).version
+      end
+
+      def create_alias(version)
+        @client.lambda_client.create_alias(alias_params(version))
+      end
+
+      def update_alias(version)
+        @client.lambda_client.update_alias(alias_params(version))
+      end
+
+      def alias_params(version)
+        {
+          function_name: @config.project,
+          name: @config.alias_name,
+          function_version: version
+        }
+      end
+    end
+  end
+end

data/lib/lambda_deployment/lambda/release.rb

@@ -0,0 +1,36 @@
+module LambdaDeployment
+  module Lambda
+    class Release
+      def initialize(config)
+        @config = config
+        @client = LambdaDeployment::Client.new(config.region)
+      end
+
+      def run
+        version = version_for_tag
+        update_production_alias(version)
+      end
+
+      private
+
+      def version_for_tag
+        if @config.alias_name
+          @client.lambda_client.get_alias(
+            function_name: @config.project,
+            name: @config.alias_name
+          ).function_version
+        else
+          '$LATEST'
+        end
+      end
+
+      def update_production_alias(version)
+        @client.lambda_client.update_alias(
+          function_name: @config.project,
+          function_version: version,
+          name: 'production'
+        )
+      end
+    end
+  end
+end

data/lib/lambda_deployment/version.rb

@@ -0,0 +1,3 @@
+module LambdaDeployment
+  VERSION = '0.1.0'.freeze
+end

data/lib/lambda_deployment.rb

@@ -0,0 +1,10 @@
+require 'aws-sdk-core'
+require 'optparse'
+require 'securerandom'
+require 'yaml'
+require 'lambda_deployment/cli'
+require 'lambda_deployment/client'
+require 'lambda_deployment/configuration'
+require 'lambda_deployment/lambda/deploy'
+require 'lambda_deployment/lambda/release'
+require 'lambda_deployment/version'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: lambda_deployment
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zendesk CloudOps
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: single_cov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables:
+- lambda_deploy
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/lambda_deploy
+- lib/lambda_deployment.rb
+- lib/lambda_deployment/cli.rb
+- lib/lambda_deployment/client.rb
+- lib/lambda_deployment/configuration.rb
+- lib/lambda_deployment/lambda/deploy.rb
+- lib/lambda_deployment/lambda/release.rb
+- lib/lambda_deployment/version.rb
+homepage: https://github.com/zendesk/lambda_deployment
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Lambda Deployment Library
+test_files: []