shiprails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8093eda442437b91f2aba6f63e12f4f7e98a5ead
+  data.tar.gz: 5ae7b8820202411d15fdf7be7c57294829e9d467
+SHA512:
+  metadata.gz: 8daa5f07fc78ba4bc67ac15253620c09e4abc904e73a37525043e16444db397dcca9230bcc56e598fe293e2842fe37b216ca5bd597ca49baf07ffc56de960234
+  data.tar.gz: 3cc82233c2be7a576cfecbb517f35fa7380c8056c863a46f34180f47de82d4d77dd1998c866051958f5a549a60ad8d3b4d46bcf372e763577788c94f8139e1d4

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rbenv-vars
+
+# Ignore work products
+.shiprails.yml
+.env.example
+docker-compose.yml
+Dockerfile
+
+# Ignore Docker ENV
+/.env

data/.rbenv-vars.example

@@ -0,0 +1,3 @@
+AWS_ACCESS_KEY_ID=FILL_ME_IN
+AWS_SECRET_ACCESS_KEY=FILL_ME_IN
+AWS_REGION=FILL_ME_IN

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+rails2017_shiprails

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in s3_config.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Zane Shannon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# shiprails
+
+Shiprails is a command-line interface for deploying Rails apps to AWS ECS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shiprails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shiprails
+
+## Setup
+
+- $`shiprails install`
+
+## Usage
+
+*TODO*
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rails2017/shiprails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shiprails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/port

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "shiprails"
+require "shiprails/port"
+
+Shiprails::Port.start

data/exe/ship

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "shiprails"
+require "shiprails/ship"
+
+Shiprails::Ship.start

data/lib/shiprails/application.rb

@@ -0,0 +1,13 @@
+require "aws-sdk"
+require "erb"
+require "yaml"
+
+module Shiprails
+  class Application
+
+    def initialize(options = {})
+      @options = options.inject({}) { |m, (k, v)| m[k.to_sym] = v; m }
+    end
+
+  end
+end

data/lib/shiprails/port.rb

@@ -0,0 +1,53 @@
+require "active_support/all"
+require "thor"
+
+module Shiprails
+  class Port < Thor
+    include Thor::Actions
+
+    desc "config", "Configure services"
+
+    method_option "path",
+      aliases: ["-p"],
+      default: ".shiprails.yml",
+      desc: "Specify a configuration file path"
+
+    def config(*command)
+      say "TODO: store development config vars"
+    end
+
+    desc "up", "Hoist app and services"
+    def up
+      run "docker-compose up"
+    end
+
+    desc "bundle", "Run bundler commands"
+    def bundle(*command)
+      command_string = command.join(' ')
+      if command_string.start_with?("exec")
+        run "docker-compose run --rm app bundle #{command_string}"
+      else
+        run "docker-compose run app bundle #{command_string}"
+      end
+    end
+
+    desc "rails", "Run rails commands"
+    def rails(*command)
+      command_string = command.join(' ')
+      run "docker-compose run --rm app bundle exec rails #{command_string}"
+    end
+
+    desc "bash", "Run bash commands"
+    def bash(*command)
+      command_string = command.join(' ')
+      run "docker-compose run --rm app bash #{command_string}"
+    end
+
+    private
+
+    def configuration
+      YAML.load(File.read(".shiprails.yml")).deep_symbolize_keys
+    end
+
+  end
+end

data/lib/shiprails/ship/config.rb

@@ -0,0 +1,121 @@
+require "active_support/all"
+require "aws-sdk"
+require "git"
+require "thor/group"
+
+module Shiprails
+  class Ship < Thor
+    class Config < Thor::Group
+      include Thor::Actions
+
+      class_option "path",
+        aliases: ["-p"],
+        default: ".",
+        desc: "Specify a configuration path"
+
+      def update_s3_config
+        command_string = args.join ' '
+        result = `S3_CONFIG_BUCKET=#{configuration[:config_s3_bucket]} bundle exec config #{command_string}`
+        puts result
+        @version = result.match(/New version: v([0-9]+)/)[1] rescue false
+      end
+
+      def update_ecs_tasks
+        return unless @version
+        say "Updating config version for ECS tasks..."
+        configuration[:services].each do |service_name, service|
+          service[:regions].each do |region_name, region|
+            ecs = Aws::ECS::Client.new(region: region_name.to_s)
+            region[:environments].each do |environment_name|
+              cluster_name = "#{project_name}_#{environment_name}"
+              task_name = "#{project_name}_#{service_name}_#{environment_name}"
+              begin
+                task_definition_description = ecs.describe_task_definition({task_definition: task_name})
+                task_definition = task_definition_description.task_definition.to_hash
+                task_definition.delete :task_definition_arn
+                task_definition.delete :revision
+                task_definition.delete :status
+                task_definition.delete :requires_attributes
+              rescue Aws::ECS::Errors::ClientException => e
+                say "Missing ECS task for #{task_name}!", :red
+                say "Run `ship setup`", :red
+                exit
+              end
+              task_definition[:container_definitions][0][:environment].map! do |e|
+                if e[:name] == "S3_CONFIG_REVISION"
+                  e[:value] = "#{@version}"
+                end
+                e
+              end
+              task_definition_response = ecs.register_task_definition(task_definition)
+              say "Updated #{task_name} task."
+            end
+          end
+        end
+        say "ECS tasks updated.", :green
+      end
+
+      def update_ecs_services
+        return unless @version
+        say "Updating ECS services..."
+        configuration[:services].each do |service_name, service|
+          service[:regions].each do |region_name, region|
+            ecs = Aws::ECS::Client.new(region: region_name.to_s)
+            region[:environments].each do |environment_name|
+              cluster_name = "#{project_name}_#{environment_name}"
+              task_name = "#{project_name}_#{service_name}_#{environment_name}"
+              begin
+                task_definition_response = ecs.describe_task_definition({task_definition: task_name})
+                task_definition = task_definition_response.task_definition.to_hash
+              rescue Aws::ECS::Errors::ClientException => e
+                say "Missing ECS task for #{task_name}!", :red
+                say "Run `ship setup`", :red
+                exit
+              end
+              begin
+                service_response = ecs.update_service({
+                  cluster: cluster_name,
+                  service: service_name,
+                  task_definition: task_definition_response.task_definition.task_definition_arn
+                })
+                say "Updated #{service_name} service."
+              rescue Aws::ECS::Errors::ServiceNotFoundException, Aws::ECS::Errors::ServiceNotActiveException => e
+                say "Missing ECS service for #{task_name}!", :red
+                say "Run `ship setup`", :red
+                exit
+              end
+            end
+          end
+        end
+        say "ECS services updated.", :green
+      end
+
+      def done
+        unless @version
+          say "No config updates.", :green
+        else
+          say "Config update complete!", :green
+        end
+      end
+
+      private
+
+      def aws_access_key_id
+        @aws_access_key_id ||= ask "AWS Access Key ID", default: ENV.fetch("AWS_ACCESS_KEY_ID")
+      end
+
+      def aws_access_key_secret
+        @aws_access_key_secret ||= ask "AWS Access Key Secret", default: ENV.fetch("AWS_SECRET_ACCESS_KEY")
+      end
+
+      def configuration
+        YAML.load(File.read("#{options[:path]}/.shiprails.yml")).deep_symbolize_keys
+      end
+
+      def project_name
+        configuration[:project_name]
+      end
+
+    end
+  end
+end

data/lib/shiprails/ship/deploy.rb

@@ -0,0 +1,191 @@
+require "active_support/all"
+require "aws-sdk"
+require "git"
+require "thor/group"
+
+module Shiprails
+  class Ship < Thor
+    class Deploy < Thor::Group
+      include Thor::Actions
+
+      class_option "path",
+        aliases: ["-p"],
+        default: ".",
+        desc: "Specify a configuration path"
+
+      def check_git_status
+        if git.status.added.any? or git.status.changed.any? or git.status.deleted.any?
+          say "You have uncommitted changes. Commit and try again.", :red
+          exit
+        end
+      end
+
+      def build_docker_images
+        say "Building images..."
+        s3_config_bucket = configuration[:config_s3_bucket].to_s
+        commands = []
+        configuration[:services].each do |service_name, service|
+          image_name = "#{compose_project_name}_#{service[:image]}"
+          service[:regions].each do |region_name, region|
+            aws_region = region_name.to_s
+            region[:environments].each do |environment_name|
+              result = `S3_CONFIG_BUCKET=#{s3_config_bucket} bundle exec config list #{environment_name}`
+              s3_config_revision = result.match(/#{environment_name} \(v([0-9]+)\)/)[1] rescue 0
+              commands << "docker build -t #{image_name} --build-arg AWS_ACCESS_KEY_ID='#{aws_access_key_id}' --build-arg AWS_SECRET_ACCESS_KEY='#{aws_access_key_secret}' --build-arg AWS_REGION='#{aws_region}' --build-arg S3_CONFIG_BUCKET='#{s3_config_bucket}' --build-arg S3_CONFIG_REVISION='#{s3_config_revision}' -f Dockerfile.production ."
+            end
+          end
+        end
+        commands.uniq!
+        commands.each { |c| run c } # TODO: check that this succeeded
+        say "Build complete", :green
+      end
+
+      def tag_docker_images
+        say "Tagging images..."
+        commands = []
+        configuration[:services].each do |service_name, service|
+          image_name = "#{compose_project_name}_#{service[:image]}"
+          service[:regions].each do |region_name, region|
+            repository_url = region[:repository_url]
+            commands << "docker tag #{image_name} #{repository_url}:#{git_sha}"
+          end
+        end
+        commands.uniq!
+        commands.each { |c| run c } # TODO: check that this succeeded
+        say "Tagging complete.", :green
+      end
+
+      def push_docker_images
+        say "Pushing images..."
+        repository_urls_to_regions = {}
+        configuration[:services].each do |service_name, service|
+          service[:regions].each do |region, values|
+            repository_urls_to_regions[values[:repository_url]] = region
+          end
+        end
+        repository_urls_to_regions.each do |repository_url, region|
+          run "`aws ecr get-login --region #{region}`"
+          run "docker push #{repository_url}:#{git_sha}" # TODO: check that this succeeded
+        end
+        say "Push complete.", :green
+      end
+
+      def update_ecs_tasks
+        say "Updating ECS tasks..."
+        configuration[:services].each do |service_name, service|
+          image_name = "#{project_name}_#{service_name}"
+          service[:regions].each do |region_name, region|
+            ecs = Aws::ECS::Client.new(region: region_name.to_s)
+            region[:environments].each do |environment_name|
+              cluster_name = "#{project_name}_#{environment_name}"
+              task_name = "#{project_name}_#{service_name}_#{environment_name}"
+              image_name = "#{region[:repository_url]}:#{git_sha}"
+              begin
+                task_definition_description = ecs.describe_task_definition({task_definition: task_name})
+                task_definition = task_definition_description.task_definition.to_hash
+                task_definition.delete :task_definition_arn
+                task_definition.delete :revision
+                task_definition.delete :status
+                task_definition.delete :requires_attributes
+              rescue Aws::ECS::Errors::ClientException => e
+                say "Missing ECS task for #{task_name}!", :red
+                say "Run `ship setup`", :red
+                exit
+              end
+              if container = task_definition[:container_definitions].find{ |container| container[:name] == service_name.to_s }
+                container[:cpu] = service[:resources][:cpu_units]
+                container[:image] = image_name
+                container[:memory] = service[:resources][:memory_units]
+                config_s3_version = container[:environment].find{|e| e[:name] == "S3_CONFIG_REVISION" }[:value]
+                container[:environment] = [
+                  { name: "AWS_REGION", value: region_name.to_s },
+                  { name: "GIT_SHA", value: git_sha },
+                  { name: "RACK_ENV", value: environment_name },
+                  { name: "S3_CONFIG_BUCKET", value: config_s3_bucket },
+                  { name: "S3_CONFIG_REVISION", value: config_s3_version }
+                ]
+                say "Updated #{service_name} container (#{image_name})."
+              end
+              task_definition_response = ecs.register_task_definition(task_definition)
+              say "Updated #{task_name}.", :green
+            end
+          end
+        end
+        say "ECS tasks updated.", :green
+      end
+
+      def update_ecs_services
+        say "Updating ECS services..."
+        configuration[:services].each do |service_name, service|
+          service[:regions].each do |region_name, region|
+            ecs = Aws::ECS::Client.new(region: region_name.to_s)
+            region[:environments].each do |environment_name|
+              cluster_name = "#{project_name}_#{environment_name}"
+              task_name = "#{project_name}_#{service_name}_#{environment_name}"
+              begin
+                task_definition_response = ecs.describe_task_definition({task_definition: task_name})
+                task_definition = task_definition_response.task_definition.to_hash
+              rescue Aws::ECS::Errors::ClientException => e
+                say "Missing ECS task for #{task_name}!", :red
+                say "Run `ship setup`", :red
+                exit
+              end
+              begin
+                service_response = ecs.update_service({
+                  cluster: cluster_name,
+                  service: service_name,
+                  task_definition: task_definition_response.task_definition.task_definition_arn
+                })
+                say "Updated #{service_name}.", :green
+              rescue Aws::ECS::Errors::ServiceNotFoundException, Aws::ECS::Errors::ServiceNotActiveException => e
+                say "Missing ECS service for #{task_name}!", :red
+                say "Run `ship setup`", :red
+                exit
+              end
+            end
+          end
+        end
+        say "ECS services updated.", :green
+      end
+
+      def done
+        say "Deploy complete!", :green
+      end
+
+      private
+
+      def aws_access_key_id
+        @aws_access_key_id ||= ENV.fetch("AWS_ACCESS_KEY_ID") { ask "AWS Access Key ID" }
+      end
+
+      def aws_access_key_secret
+        @aws_access_key_secret ||= ENV.fetch("AWS_SECRET_ACCESS_KEY") { ask "AWS Access Key Secret" }
+      end
+
+      def configuration
+        YAML.load(File.read("#{options[:path]}/.shiprails.yml")).deep_symbolize_keys
+      end
+
+      def git
+        @_git ||= Git.open(Dir.getwd)
+      end
+
+      def git_sha
+        @_git_sha ||= git.object('HEAD').sha
+      end
+
+      def project_name
+        configuration[:project_name]
+      end
+
+      def compose_project_name
+        project_name.gsub /[^0-9a-zA-Z]/i, ''
+      end
+
+      def config_s3_bucket
+        configuration[:config_s3_bucket]
+      end
+
+    end
+  end
+end