convox_installer 1.0.8 → 3.0.0

data/lib/convox_installer/config.rb

@@ -1,48 +1,54 @@
 # frozen_string_literal: true
 
-require "highline"
-require "fileutils"
-require "json"
-require "securerandom"
+require 'highline'
+require 'fileutils'
+require 'json'
+require 'securerandom'
 
 module ConvoxInstaller
   class Config
-    CONFIG_FILE = File.expand_path("./.installer_config.json").freeze
+    CONFIG_FILE = File.expand_path('./.installer_config.json').freeze
 
     attr_accessor :logger, :config, :prompts, :highline
 
     DEFAULT_PROMPTS = [
       {
         key: :stack_name,
-        title: "Convox Stack Name",
-        prompt: "Please enter a name for your Convox installation",
-        default: "convox",
+        title: 'Convox Stack Name',
+        prompt: 'Please enter a name for your Convox installation',
+        default: 'convox'
       },
       {
         key: :aws_region,
-        title: "AWS Region",
-        default: "us-east-1",
+        title: 'AWS Region',
+        default: 'us-east-1'
       },
       {
         key: :instance_type,
-        title: "EC2 Instance Type",
-        default: "t3.medium",
+        title: 'EC2 Instance Type',
+        default: 't3.medium'
       },
       {
-        section: "Admin AWS Credentials",
+        section: 'Admin AWS Credentials'
       },
       {
         key: :aws_access_key_id,
-        title: "AWS Access Key ID",
+        title: 'AWS Access Key ID'
       },
       {
         key: :aws_secret_access_key,
-        title: "AWS Secret Access Key",
+        title: 'AWS Secret Access Key'
       },
+      # Short random ID used to ensure that resources are always unique
+      {
+        key: :random_id,
+        value: -> { SecureRandom.hex(4) },
+        hidden: true
+      }
     ].freeze
 
     def initialize(options = {})
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new($stdout)
       logger.level = options[:log_level] || Logger::INFO
 
       self.prompts = options[:prompts] || DEFAULT_PROMPTS
@@ -74,13 +80,16 @@ module ConvoxInstaller
 
         @completed_prompt = true
 
-        highline.say "Please double check all of these configuration details."
+        highline.say 'Please double check all of these configuration details.'
+
+        break if ENV['AUTOSTART_CONVOX_INSTALLATION']
 
         agree = highline.agree(
-          "Would you like to start the Convox installation?" \
+          'Would you like to start the Convox installation?' \
           " (press 'n' to correct any settings)"
         )
         break if agree
+
         highline.say "\n"
       end
 
@@ -89,7 +98,7 @@ module ConvoxInstaller
 
     def show_config_summary
       highline.say "\n============================================"
-      highline.say "                 SUMMARY"
+      highline.say '                 SUMMARY'
       highline.say "============================================\n\n"
 
       config_titles = prompts.map do |prompt|
@@ -106,10 +115,18 @@ module ConvoxInstaller
         highline.say "    #{padded_key} #{value}"
       end
       highline.say "\nWe've saved your configuration to: #{CONFIG_FILE}"
-      highline.say "If anything goes wrong during the installation, " \
+      highline.say 'If anything goes wrong during the installation, ' \
                    "you can restart the script to reload the config and continue.\n\n"
     end
 
+    def self.config_file_exists?
+      File.exist?(CONFIG_FILE)
+    end
+
+    def self.read_config_file
+      File.read(CONFIG_FILE)
+    end
+
     private
 
     def ask_prompt(prompt)
@@ -129,7 +146,11 @@ module ConvoxInstaller
         return if config[key]
 
         default = prompt[:value]
-        config[key] = default.is_a?(Proc) ? default.call(config) : default
+        config[key] = if default.is_a?(Proc)
+                        default.arity.zero? ? default.call : default.call(config)
+                      else
+                        default
+                      end
         save_config_to_file
         return
       end
@@ -153,7 +174,7 @@ module ConvoxInstaller
 
       logger.debug "Loading saved config from #{CONFIG_FILE}..."
 
-      loaded_config = JSON.parse(Config.read_config_file)["config"].symbolize_keys
+      loaded_config = JSON.parse(Config.read_config_file)['config'].symbolize_keys
       self.config = config.merge(loaded_config)
     end
 
@@ -174,13 +195,5 @@ module ConvoxInstaller
         f.puts(JSON.pretty_generate(config: config))
       end
     end
-
-    def self.config_file_exists?
-      File.exist?(CONFIG_FILE)
-    end
-
-    def self.read_config_file
-      File.read(CONFIG_FILE)
-    end
   end
 end

data/lib/convox_installer/requirements.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "highline"
-require "os"
-require "logger"
+require 'highline'
+require 'os'
+require 'logger'
 
 module ConvoxInstaller
   class Requirements
@@ -10,46 +10,66 @@ module ConvoxInstaller
 
     def initialize(options = {})
       @ecr_label = options[:ecr_label]
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new($stdout)
       logger.level = options[:log_level] || Logger::INFO
     end
 
     def ensure_requirements!
-      logger.debug "Checking for required commands..."
+      logger.debug 'Checking for required commands...'
 
       @missing_packages = []
-      unless has_command? "convox"
+      unless command_present? 'convox'
         @missing_packages << {
-          name: "convox",
-          brew: "convox",
-          docs: "https://docs.convox.com/introduction/installation",
+          name: 'convox',
+          brew: 'convox',
+          docs: 'https://docs.convox.com/introduction/installation'
         }
       end
 
-      unless has_command? "aws"
+      unless command_present? 'aws'
         @missing_packages << {
-          name: "aws",
-          brew: "awscli",
-          docs: "https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html",
+          name: 'aws',
+          brew: 'awscli',
+          docs: 'https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html'
+        }
+      end
+
+      unless command_present? 'terraform'
+        @missing_packages << {
+          name: 'terraform',
+          brew: 'terraform',
+          docs: 'https://learn.hashicorp.com/tutorials/terraform/install-cli'
         }
       end
 
       if @missing_packages.any?
-        logger.error "This script requires the convox and AWS CLI tools."
+        logger.error 'This script requires the convox and AWS CLI tools.'
         if OS.mac?
-          logger.error "Please run: brew install " \
-                       "#{@missing_packages.map { |p| p[:brew] }.join(" ")}"
+          logger.error 'Please run: brew install ' \
+                       "#{@missing_packages.map { |p| p[:brew] }.join(' ')}"
         else
-          logger.error "Installation Instructions:"
+          logger.error 'Installation Instructions:'
           @missing_packages.each do |package|
             logger.error "* #{package[:name]}: #{package[:docs]}"
           end
         end
         quit!
       end
+
+      client = Convox::Client.new
+      if client.convox_3_cli?
+        logger.debug "=> Convox CLI is version 3.x.x (#{client.cli_version_string})"
+        return
+      end
+
+      logger.error 'This script requires Convox CLI version 3.x.x. ' \
+                   "Your Convox CLI version is: #{client.cli_version_string}"
+      logger.error "Please run 'brew update convox' or follow the instructions " \
+                   'at https://docs.convox.com/getting-started/introduction'
+      quit!
     end
 
-    def has_command?(command)
+    def command_present?(command)
       path = find_command command
       if path.present?
         logger.debug "=> Found #{command}: #{path}"

data/lib/convox_installer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConvoxInstaller
-  VERSION = "1.0.8"
+  VERSION = '3.0.0'
 end

data/lib/convox_installer.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "active_support"
-require "active_support/core_ext"
-require "convox_installer/config"
-require "convox_installer/requirements"
-require "convox"
+require 'active_support'
+require 'active_support/core_ext'
+require 'convox_installer/config'
+require 'convox_installer/requirements'
+require 'convox'
 
 module ConvoxInstaller
   def client
@@ -12,7 +12,7 @@ module ConvoxInstaller
   end
 
   def config
-    options = {log_level: @log_level}
+    options = { log_level: @log_level }
     options[:prompts] = @prompts if @prompts
     @config ||= Config.new(options)
   end
@@ -32,18 +32,24 @@ module ConvoxInstaller
   %w[
     backup_convox_host_and_rack
     install_convox
-    validate_convox_auth_and_set_host!
-    validate_convox_rack!
+    validate_convox_rack_and_write_current!
+    validate_convox_rack_api!
     convox_rack_data
     create_convox_app!
     set_default_app_for_directory!
-    create_s3_bucket!
-    set_s3_bucket_cors_policy
+    add_s3_bucket
+    add_rds_database
+    add_elasticache_cluster
+    apply_terraform_update!
+    terraform_state
     s3_bucket_details
+    elasticache_details
+    rds_details
     add_docker_registry!
     default_service_domain_name
     run_convox_command!
     logger
+    rack_already_installed?
   ].each do |method|
     define_method(method) do |*args|
       client.send(method, *args)

data/spec/lib/convox/client_spec.rb

@@ -1,20 +1,54 @@
 # frozen_string_literal: true
 
-require "convox/client"
+require 'convox/client'
 
 RSpec.describe Convox::Client do
-  let(:home_dir) { File.expand_path("~") }
+  let(:home_dir) { File.expand_path('~') }
 
-  it "finds the authentication details in ~/.convox/auth" do
+  it 'finds the authentication details in ~/.convox/auth' do
     expect(File).to receive(:exist?).with("#{home_dir}/.convox/auth").and_return(true)
     expect(File).to receive(:read).with("#{home_dir}/.convox/auth").and_return(
       '{ "test.example.com": "1234567890" }'
     )
     client = described_class.new
-    expect(client.auth).to eq("test.example.com" => "1234567890")
+    expect(client.auth).to eq('test.example.com' => '1234567890')
   end
 
-  it "should backup existing Convox host and rack files" do
+  describe 'Convox CLI version' do
+    let(:client) { described_class.new }
+
+    it 'returns the convox CLI version output for 20210208170413' do
+      expect(client).to receive(:cli_version_string).at_least(:once).and_return('20210208170413')
+      expect(client.convox_2_cli?).to be true
+      expect(client.convox_3_cli?).to be false
+    end
+
+    it 'returns the convox CLI version output for 20200101130413' do
+      expect(client).to receive(:cli_version_string).at_least(:once).and_return('20200101130413')
+      expect(client.convox_2_cli?).to be true
+      expect(client.convox_3_cli?).to be false
+    end
+
+    it 'returns the convox CLI version output for 3.0.0' do
+      expect(client).to receive(:cli_version_string).at_least(:once).and_return('3.0.0')
+      expect(client.convox_2_cli?).to be false
+      expect(client.convox_3_cli?).to be true
+    end
+
+    it 'returns the convox CLI version output for 3.1.3' do
+      expect(client).to receive(:cli_version_string).at_least(:once).and_return('3.1.3')
+      expect(client.convox_2_cli?).to be false
+      expect(client.convox_3_cli?).to be true
+    end
+
+    it 'returns the convox CLI version output for 4.0.0' do
+      expect(client).to receive(:cli_version_string).at_least(:once).and_return('4.0.0')
+      expect(client.convox_2_cli?).to be false
+      expect(client.convox_3_cli?).to be false
+    end
+  end
+
+  it 'backups existing Convox host and rack files' do
     expect(File).to receive(:exist?).with(
       "#{home_dir}/.convox/host"
     ).and_return(true)
@@ -34,61 +68,63 @@ RSpec.describe Convox::Client do
     client.backup_convox_host_and_rack
   end
 
-  describe "#install" do
-    it "should require the correct config vars" do
+  describe '#install' do
+    it 'requires the correct config vars' do
       client = described_class.new
-      expect { client.install_convox }.to raise_error("aws_region is missing from the config!")
+      expect { client.install_convox }.to raise_error('aws_region is missing from the config!')
 
-      client = described_class.new(config: {aws_region: "us-east-1"})
-      expect { client.install_convox }.to raise_error("stack_name is missing from the config!")
+      client = described_class.new(config: { aws_region: 'us-east-1' })
+      expect { client.install_convox }.to raise_error('stack_name is missing from the config!')
     end
 
-    it "should run the correct convox CLI command" do
+    it 'runs the correct convox CLI command' do
       client = described_class.new(
         config: {
-          aws_region: "us-east-1",
-          aws_access_key_id: "asdf",
-          aws_secret_access_key: "1234",
-          stack_name: "asdf",
-          instance_type: "t3.medium",
-        },
+          aws_region: 'us-east-1',
+          aws_access_key_id: 'asdf',
+          aws_secret_access_key: '1234',
+          stack_name: 'asdf',
+          instance_type: 't3.medium'
+        }
       )
 
       expect(client.logger).to receive(:info)
       expect(client).to receive(:run_convox_command!).with(
-        "rack install aws --name \"asdf\" \"InstanceType=t3.medium\" " \
-        "\"BuildInstance=\"",
-        "AWS_ACCESS_KEY_ID" => "asdf",
-        "AWS_REGION" => "us-east-1",
-        "AWS_SECRET_ACCESS_KEY" => "1234",
+        'rack install aws --name "asdf" "InstanceType=t3.medium" ' \
+        '"BuildInstance="',
+        'AWS_ACCESS_KEY_ID' => 'asdf',
+        'AWS_REGION' => 'us-east-1',
+        'AWS_SECRET_ACCESS_KEY' => '1234'
       )
       client.install_convox
     end
   end
 
-  describe "#validate_convox_auth_and_set_host!" do
-    it "should require the correct config vars" do
+  describe '#validate_convox_auth_and_write_host!' do
+    it 'requires the correct config vars' do
       client = described_class.new
-      expect { client.validate_convox_auth_and_set_host! }.to raise_error("aws_region is missing from the config!")
+      expect do
+        client.validate_convox_auth_and_write_host!
+      end.to raise_error('aws_region is missing from the config!')
     end
 
-    it "should raise an error if auth file is missing" do
+    it 'raises an error if auth file is missing' do
       client = described_class.new(
         config: {
-          aws_region: "us-east-1",
-          stack_name: "asdf",
-        },
+          aws_region: 'us-east-1',
+          stack_name: 'asdf'
+        }
       )
       expect(File).to receive(:exist?).with(
         "#{home_dir}/.convox/auth"
       ).and_return(false)
 
-      expect {
-        client.validate_convox_auth_and_set_host!
-      }.to raise_error(/Could not find auth file at /)
+      expect do
+        client.validate_convox_auth_and_write_host!
+      end.to raise_error(/Could not find auth file at /)
     end
 
-    it "should set ~/.convox/host if a matching host is found in the auth file" do
+    it 'sets ~/.convox/host if a matching host is found in the auth file' do
       expect(File).to receive(:exist?).with(
         "#{home_dir}/.convox/auth"
       ).twice.and_return(true)
@@ -98,19 +134,19 @@ RSpec.describe Convox::Client do
       )
       client = described_class.new(
         config: {
-          aws_region: "us-west-2",
-          stack_name: "convox-test",
-        },
+          aws_region: 'us-west-2',
+          stack_name: 'convox-test'
+        }
       )
-      expect(client).to receive(:set_host).with(
-        "convox-test-697645520.us-west-2.elb.amazonaws.com"
+      expect(client).to receive(:write_current).with(
+        'convox-test-697645520.us-west-2.elb.amazonaws.com'
       )
-      expect(client.validate_convox_auth_and_set_host!).to(
-        eq("convox-test-697645520.us-west-2.elb.amazonaws.com")
+      expect(client.validate_convox_auth_and_write_host!).to(
+        eq('convox-test-697645520.us-west-2.elb.amazonaws.com')
       )
     end
 
-    it "should raise an error if no matching host is found" do
+    it 'raises an error if no matching host is found' do
       expect(File).to receive(:exist?).with(
         "#{home_dir}/.convox/auth"
       ).twice.and_return(true)
@@ -120,17 +156,17 @@ RSpec.describe Convox::Client do
       )
       client = described_class.new(
         config: {
-          aws_region: "us-east-1",
-          stack_name: "convox-test",
-        },
+          aws_region: 'us-east-1',
+          stack_name: 'convox-test'
+        }
       )
-      expect {
-        client.validate_convox_auth_and_set_host!
-      }.to raise_error("Could not find matching authentication for " \
-           "region: us-east-1, stack: convox-test")
+      expect do
+        client.validate_convox_auth_and_write_host!
+      end.to raise_error('Could not find matching authentication for ' \
+                         'region: us-east-1, stack: convox-test')
     end
 
-    it "should raise an error if it finds multiple matching hosts" do
+    it 'raises an error if it finds multiple matching hosts' do
       expect(File).to receive(:exist?).with(
         "#{home_dir}/.convox/auth"
       ).twice.and_return(true)
@@ -141,14 +177,14 @@ RSpec.describe Convox::Client do
       )
       client = described_class.new(
         config: {
-          aws_region: "us-west-2",
-          stack_name: "convox-test",
-        },
+          aws_region: 'us-west-2',
+          stack_name: 'convox-test'
+        }
       )
-      expect {
-        client.validate_convox_auth_and_set_host!
-      }.to raise_error("Found multiple matching hosts for " \
-           "region: us-west-2, stack: convox-test")
+      expect do
+        client.validate_convox_auth_and_write_host!
+      end.to raise_error('Found multiple matching hosts for ' \
+                         'region: us-west-2, stack: convox-test')
     end
   end
 end