aws_beanstalk_tunkki 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f226c4c68ba5bd6380f70933d8c04b449a89fdd6e27ad53333e89758f6333682
+  data.tar.gz: 39848528ce0ce80fc0e14ab678573d2d7ede28bb34c0031061a04a769533d31c
+SHA512:
+  metadata.gz: f4229f11c843d1edffa590cb0f3d5e43b5d3304e952d9d2e2179466a396bd38d2e17f04a6b752e0beed12f0371f13adb2e8825f33250bfad0a1a80489dc19158
+  data.tar.gz: 810275c477f8ebe857f71cdd4d9865b11b147e7ee65c83bb36d952ab4ecef2afe8868855bea26a306832cbe521902e6528cf7f7b54cfd10be1ec456c30854604

data/bin/aws_beanstalk_tunkki

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'aws_beanstalk_tunkki'
+AWSBeanstalkTunkki.new.run_deployment()

data/lib/aws_beanstalk_tunkki.rb

@@ -0,0 +1,253 @@
+require 'aws-sdk-elasticbeanstalk'
+require 'aws-sdk-s3'
+require 'optparse'
+require 'fileutils'
+
+class AWSBeanstalkTunkki
+
+  def initialize
+    init_deploy_variables()
+  end
+
+  def run_deployment
+    application = get_bs_app()
+    if !check_bs_env()
+      create_bs_env(application.configuration_templates)
+    end
+    deploy_app(generate_version_label())
+  end
+
+  def init_deploy_variables
+    parse_command_line_options()
+    set_application_environment()
+    set_aws_clients()
+  end
+
+  def parse_command_line_options
+    OptionParser.new do |opt|
+      opt.on('--app APP_NAME') { |app_name| @app = app_name }
+      opt.on('--branch BRANCH_NAME') { |branch_name| @branch = branch_name }
+      opt.on('--dir DIR') { |dir| @dir = dir }
+      opt.on('--region REGION') { |aws_region| @aws_region = aws_region }
+      opt.on('--local LOCAL') { |local| @local = local }
+    end.parse!
+    raise "Beanstalk application (--app) required!" if @app.nil?
+    raise "Git branch (--branch) required!" if @branch.nil?
+    raise "App dir location (--dir) required!" if @branch.nil?
+    raise "AWS Region missing (--region) required!" if @aws_region.nil?
+  end
+
+  def set_application_environment
+    case @branch
+    when /\Aprod/
+      set_application_environment_vars(environment: 'prod', env_simple: 'production')
+    when /\Ast/
+      set_application_environment_vars(environment: 'st', env_simple: 'staging')
+    when /\Adev/
+      set_application_environment_vars(environment: 'dev', env_simple: 'development')
+    when /\Aft/
+      set_application_environment_vars(environment: 'ft', env_simple: 'feature')
+    else
+      raise "Invalid deployment branch name detected! Branch name must start with prod, st, dev or ft"
+    end
+  end
+
+  def set_application_environment_vars(environment: 'dev', env_simple: '')
+    puts "Using branch '#{@branch}' as #{env_simple}"
+    @bs_env = @branch.gsub(/[\/:;.,+_<>#]/, '-')
+    @environment = environment
+    @bs_env_simple = env_simple
+  end
+
+  def set_aws_clients
+    if @local == "true"
+      # Deploy from local machine, requires AWS_PROFILE=default and aws-mfa based login before execution
+      credentials = Aws::SharedCredentials.new()
+    else
+      aws_access_key_id, aws_secret_access_key = *get_aws_keys()
+      raise "AWS keys are not defined!" if aws_access_key_id.nil? || aws_secret_access_key.nil?
+      credentials = Aws::Credentials.new(aws_access_key_id, aws_secret_access_key)
+    end
+    @elasticbeanstalk = Aws::ElasticBeanstalk::Client.new(region: @aws_region, credentials: credentials)
+    @s3 = Aws::S3::Client.new(region: @aws_region, credentials: credentials)
+    bucket = @s3.list_buckets.buckets.find { |b| /\Aelasticbeanstalk-#{@aws_region}/ =~ b.name }
+    raise "Could not resolve s3 bucket name." if bucket.nil?
+    @s3_bucket_name = bucket.name
+  end
+
+  def get_aws_keys
+    case @environment
+    when 'prod', 'st'
+      [ENV['AWS_ACCESS_KEY_ID_PROD'], ENV['AWS_SECRET_ACCESS_KEY_PROD']]
+    when 'dev', 'ft'
+      [ENV['AWS_ACCESS_KEY_ID_DEV'], ENV['AWS_SECRET_ACCESS_KEY_DEV']]
+    end
+  end
+
+  def get_bs_app
+    application_description = @elasticbeanstalk.describe_applications({application_names: [@app]})
+    raise "Application '#{@app}' not found." if application_description.applications.empty?
+    application_description.applications.first
+  end
+
+  def check_bs_env
+    env_name = "#{@app}-#{@bs_env}"
+    puts "Checking if Beanstalk environment '#{env_name}' in application '#{@app}' exists."
+    application_environments = @elasticbeanstalk.describe_environments({environment_names: [env_name]})
+    if is_environment_found?(application_environments.environments)
+      puts "Environment '#{env_name}' already exists in application '#{@app}'."
+      true
+    else
+      puts "Environment '#{env_name}' does not exist."
+      false
+    end
+  end
+
+  def is_environment_found?(environments)
+    !environments.empty? && !environments.all? { |env| env.status == 'Terminated' }
+  end
+
+  def create_bs_env(configuration_templates)
+    puts "Searching for Beanstalk configuration template.."
+
+    app_bs_env_simple = "#{@app}-#{@bs_env_simple}"
+    app_default       = "#{@app}-default"
+    app_bs_env        = "#{@app}-#{@bs_env}"
+
+    conf_template = find_configuration_template(configuration_templates)
+    puts "Using '#{conf_template}' configuration template."
+    puts "Launching new environment '#{@app}-#{@bs_env}' to application '#{@app}'."
+
+    begin
+      @elasticbeanstalk.create_environment(
+        {
+          application_name: @app,
+          environment_name: app_bs_env,
+          cname_prefix:     app_bs_env,
+          template_name:    conf_template,
+        })
+      if (poll_for_environment_changes(app_bs_env) { |env| env.status != 'Launching' })
+        puts "Created environment '#{app_bs_env}'!"
+      else
+        raise "Timeout when creating environment."
+      end
+    rescue => e
+      raise "Environment launch failed, unable to proceed. Error: #{e}"
+    end
+  end
+
+  def find_configuration_template(configuration_templates)
+    configuration_templates.find do |tpl|
+      /(?<conf_app_stub>[\w-]+)-(?<conf_env_stub>\w+)-\w+\z/ =~ tpl
+      conf_app_stub && conf_env_stub && @app.match(conf_app_stub) && @bs_env_simple.match(conf_env_stub)
+    end or raise "No configuration templates found, can't create environment."
+  end
+
+  def poll_for_environment_changes(env_name)
+    print "Making changes to environment #{env_name}"
+    ten_minutes = 60 * 10
+    ten_minutes.times do |i|
+      if (yield(@elasticbeanstalk.describe_environments({environment_names: [env_name]}).environments.first))
+        print "\n"
+        return true
+      else
+        print '.'
+        sleep(1)
+      end
+    end
+    false
+  end
+
+  def create_app_version
+    version_label = generate_version_label()
+    response = @elasticbeanstalk.create_application_version(
+      {
+        application_name: @app,
+        version_label: version_label,
+      })
+    version_label
+  rescue => e
+    raise "Application version launch failed. Error: #{e}"
+  end
+
+  def deploy_app(version_label)
+    puts "Deploying application to Beanstalk environment."
+    s3_upload_details = upload_version_to_s3(version_label)
+    create_app_version(version_label, s3_upload_details)
+    update_environment(version_label)
+  end
+
+  def upload_version_to_s3(version_label)
+    zip_name = make_zip_file(version_label)
+    zip_name_with_path = "#{@app}/#{zip_name}"
+    print "Uploading '#{zip_name}' to S3 bucket (#{@s3_bucket_name})... "
+    begin
+      File.open(zip_name) do |zip_file|
+        @s3.put_object(bucket: @s3_bucket_name, body: zip_file, key: zip_name_with_path)
+      end
+      print "Done!\n"
+      {bucket: @s3_bucket_name, file: zip_name_with_path}
+    rescue => e
+      raise "Upload to S3 bucket (#{@s3_bucket_name}) failed. Error: #{e}"
+    end
+  end
+
+  def make_zip_file(version_label)
+    print 'Zipping application files ... '
+    zip_name = "#{version_label}.zip"
+    `cd #{@dir}; zip #{zip_name} -r ./ -x *.git* *.log*`
+    raise "Creating ZIP failed!" if $?.exitstatus != 0
+    FileUtils.mv("#{@dir}/#{zip_name}", './')
+    print "Done!\n"
+    zip_name
+  end
+
+  def create_app_version(version_label, s3_upload_details)
+    if @app.length > 199
+      raise "Error! Beanstalk environment name max length is 200 characters! Length: #{@app.length} characters"
+    end
+    @elasticbeanstalk.create_application_version(
+      {
+        application_name: @app,
+        version_label: version_label,
+        source_bundle: {
+          s3_bucket: s3_upload_details[:bucket],
+          s3_key:    s3_upload_details[:file],
+        },
+        auto_create_application: true,
+        process: true,
+      })
+    puts "Created application version '#{version_label}'"
+  rescue => e
+    raise "Creating application version '#{version_label}' failed. Error: #{e}"
+  end
+
+  def update_environment(version_label)
+    sleep(5) # Environment is in an invalid state for this operation. Must be Ready. (RuntimeError)
+    @elasticbeanstalk.update_environment(
+      {
+        environment_name: "#{@app}-#{@bs_env}",
+        version_label: version_label,
+        option_settings: [
+          {
+            namespace: "aws:elasticbeanstalk:command",
+            option_name: "Timeout",
+            value: "1800",
+          }
+        ]
+      })
+    if (poll_for_environment_changes("#{@app}-#{@bs_env}") { |env| env.status != 'Updating' })
+      puts "Updated '#{@app}-#{@bs_env}' environment successfully."
+    else
+      raise "Timeout of 10 minutes reached when updating environment."
+    end
+  rescue => e
+    raise "Updating environment failed. Error: #{e}"
+  end
+
+  def generate_version_label
+    time = Time.now
+    "#{@app}-#{@bs_env_simple}-#{time.strftime('%Y-%m-%d-%H%M%S')}"
+  end
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: aws_beanstalk_tunkki
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Valtteri Pajunen
+- Janne Saraste
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-elasticbeanstalk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.26'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.26'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.59'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.59'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+description: Tool for deploying your app to AWS ElasticBeanstalk.
+email: IL.Tekniikka@iltalehti.fi
+executables:
+- aws_beanstalk_tunkki
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/aws_beanstalk_tunkki
+- lib/aws_beanstalk_tunkki.rb
+homepage: https://github.com/almamedia/aws-beanstalk-tunkki
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: AWS Beanstalk Tunkki
+test_files: []