convox_installer 1.0.9 → 2.0.0

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,55 @@ 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
 
       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
+      return if client.convox_2_cli?
+
+      logger.error 'This script requires Convox CLI version 2.x.x. ' \
+                   "Your Convox CLI version is: #{client.cli_version_string}"
+      logger.error 'Please follow the instructions here to downgrade your ' \
+                   'Convox CLI version: https://docsv2.convox.com/introduction/installation'
+      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.9'.freeze
+  VERSION = '2.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,7 +32,7 @@ module ConvoxInstaller
   %w[
     backup_convox_host_and_rack
     install_convox
-    validate_convox_auth_and_set_host!
+    validate_convox_auth_and_write_host!
     validate_convox_rack!
     convox_rack_data
     create_convox_app!

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_host).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