convox_installer 1.0.9 → 2.0.0

data/spec/lib/convox_installer/config_spec.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require "convox_installer"
-require "securerandom"
+require 'convox_installer'
+require 'securerandom'
 
 RSpec.describe ConvoxInstaller::Config do
-  before(:each) do
+  before do
     stub_const('ConvoxInstaller::Config::CONFIG_FILE', '/path/to/.installer_config.json')
   end
 
-  after(:each) do
-    ENV.delete "AWS_REGION"
-    ENV.delete "AWS_ACCESS_KEY_ID"
+  after do
+    ENV.delete 'AWS_REGION'
+    ENV.delete 'AWS_ACCESS_KEY_ID'
   end
 
-  it "loads the saved config from ./.installer_config.json" do
+  it 'loads the saved config from ./.installer_config.json' do
     expect(described_class).to receive(:config_file_exists?).and_return(true)
     expect(described_class).to receive(:read_config_file).and_return(
       '{ "config": { "aws_region": "us-west-2", "aws_access_key_id": "1234" } }'
@@ -21,42 +21,42 @@ RSpec.describe ConvoxInstaller::Config do
     config = described_class.new
 
     expect(config.config).to eq(
-      aws_region: "us-west-2",
-      aws_access_key_id: "1234",
+      aws_region: 'us-west-2',
+      aws_access_key_id: '1234'
     )
   end
 
-  it "loads config from ENV vars" do
+  it 'loads config from ENV vars' do
     expect(described_class).to receive(:config_file_exists?).and_return(false)
-    ENV["AWS_REGION"] = "us-east-1"
-    ENV["AWS_ACCESS_KEY_ID"] = "2345"
+    ENV['AWS_REGION'] = 'us-east-1'
+    ENV['AWS_ACCESS_KEY_ID'] = '2345'
 
     config = described_class.new
     expect(config.config).to eq(
-      aws_region: "us-east-1",
-      aws_access_key_id: "2345",
+      aws_region: 'us-east-1',
+      aws_access_key_id: '2345'
     )
   end
 
-  it "prompts the user for their AWS details, and re-prompts to correct mistakes" do
+  it 'prompts the user for their AWS details, and re-prompts to correct mistakes' do
     expect(described_class).to receive(:config_file_exists?).and_return(false)
     input = StringIO.new
     output = StringIO.new
     highline = HighLine.new(input, output)
 
     input_details = [
-      [:stack_name, ""],
-      [:aws_region, ""],
-      [:instance_type, "c5.xlarge"],
-      [:aws_access_key_id, "asdf"],
-      [:aws_secret_access_key, "xkcd"],
-      [:confirm?, "n"],
-      [:stack_name, "convox-test"],
-      [:aws_region, "us-north-12"],
-      [:instance_type, "t3.medium"],
-      [:aws_access_key_id, "sdfg"],
-      [:aws_secret_access_key, ""],
-      [:confirm?, "y"],
+      [:stack_name, ''],
+      [:aws_region, ''],
+      [:instance_type, 'c5.xlarge'],
+      [:aws_access_key_id, 'asdf'],
+      [:aws_secret_access_key, 'xkcd'],
+      [:confirm?, 'n'],
+      [:stack_name, 'convox-test'],
+      [:aws_region, 'us-north-12'],
+      [:instance_type, 't3.medium'],
+      [:aws_access_key_id, 'sdfg'],
+      [:aws_secret_access_key, ''],
+      [:confirm?, 'y']
     ]
     input << input_details.map(&:last).join("\n") << "\n"
     input.rewind
@@ -67,59 +67,59 @@ RSpec.describe ConvoxInstaller::Config do
     expect(config.config).to eq({})
     config.prompt_for_config
     expect(config.config).to eq(
-      :stack_name => "convox-test",
-      :aws_region => "us-north-12",
-      :aws_access_key_id => "sdfg",
-      :aws_secret_access_key => "xkcd",
-      :instance_type => "t3.medium",
+      stack_name: 'convox-test',
+      aws_region: 'us-north-12',
+      aws_access_key_id: 'sdfg',
+      aws_secret_access_key: 'xkcd',
+      instance_type: 't3.medium'
     )
     output.rewind
     stripped_output = output.read.lines.map(&:rstrip).join("\n")
-    expected_output = <<-EOS
-Please enter a name for your Convox installation  |convox|
-Please enter your AWS Region: |us-east-1| Please enter your EC2 Instance Type: |t3.medium|
-Admin AWS Credentials
-============================================
-
-Please enter your AWS Access Key ID: Please enter your AWS Secret Access Key:
-============================================
-                 SUMMARY
-============================================
-
-    Convox Stack Name:       convox
-    AWS Region:              us-east-1
-    EC2 Instance Type:       c5.xlarge
-    AWS Access Key ID:       asdf
-    AWS Secret Access Key:   xkcd
-
-We've saved your configuration to: /path/to/.installer_config.json
-If anything goes wrong during the installation, you can restart the script to reload the config and continue.
-
-Please double check all of these configuration details.
-Would you like to start the Convox installation? (press 'n' to correct any settings)
-
-Please enter a name for your Convox installation  |convox|
-Please enter your AWS Region: |us-east-1| Please enter your EC2 Instance Type: |c5.xlarge|
-Admin AWS Credentials
-============================================
-
-Please enter your AWS Access Key ID: |asdf| Please enter your AWS Secret Access Key: |xkcd|
-============================================
-                 SUMMARY
-============================================
-
-    Convox Stack Name:       convox-test
-    AWS Region:              us-north-12
-    EC2 Instance Type:       t3.medium
-    AWS Access Key ID:       sdfg
-    AWS Secret Access Key:   xkcd
-
-We've saved your configuration to: /path/to/.installer_config.json
-If anything goes wrong during the installation, you can restart the script to reload the config and continue.
-
-Please double check all of these configuration details.
-Would you like to start the Convox installation? (press 'n' to correct any settings)
-EOS
+    expected_output = <<~CONVOX_INSTALLER_OUTPUT
+      Please enter a name for your Convox installation  |convox|
+      Please enter your AWS Region: |us-east-1| Please enter your EC2 Instance Type: |t3.medium|
+      Admin AWS Credentials
+      ============================================
+
+      Please enter your AWS Access Key ID: Please enter your AWS Secret Access Key:
+      ============================================
+                       SUMMARY
+      ============================================
+
+          Convox Stack Name:       convox
+          AWS Region:              us-east-1
+          EC2 Instance Type:       c5.xlarge
+          AWS Access Key ID:       asdf
+          AWS Secret Access Key:   xkcd
+
+      We've saved your configuration to: /path/to/.installer_config.json
+      If anything goes wrong during the installation, you can restart the script to reload the config and continue.
+
+      Please double check all of these configuration details.
+      Would you like to start the Convox installation? (press 'n' to correct any settings)
+
+      Please enter a name for your Convox installation  |convox|
+      Please enter your AWS Region: |us-east-1| Please enter your EC2 Instance Type: |c5.xlarge|
+      Admin AWS Credentials
+      ============================================
+
+      Please enter your AWS Access Key ID: |asdf| Please enter your AWS Secret Access Key: |xkcd|
+      ============================================
+                       SUMMARY
+      ============================================
+
+          Convox Stack Name:       convox-test
+          AWS Region:              us-north-12
+          EC2 Instance Type:       t3.medium
+          AWS Access Key ID:       sdfg
+          AWS Secret Access Key:   xkcd
+
+      We've saved your configuration to: /path/to/.installer_config.json
+      If anything goes wrong during the installation, you can restart the script to reload the config and continue.
+
+      Please double check all of these configuration details.
+      Would you like to start the Convox installation? (press 'n' to correct any settings)
+    CONVOX_INSTALLER_OUTPUT
 
     # puts stripped_output
     # puts "---------------"
@@ -127,7 +127,7 @@ EOS
     expect(stripped_output).to eq expected_output.strip
   end
 
-  it "prompts for custom configuration" do
+  it 'prompts for custom configuration' do
     expect(described_class).to receive(:config_file_exists?).and_return(false)
     input = StringIO.new
     output = StringIO.new
@@ -135,99 +135,99 @@ EOS
 
     custom_prompts = ConvoxInstaller::Config::DEFAULT_PROMPTS + [
       {
-        section: "ECR Authentication",
+        section: 'ECR Authentication',
         info: "You should have received authentication details for the Docker Registry\n" \
-        "via email. If not, please contact support@example.com",
+              'via email. If not, please contact support@example.com'
       },
       {
         key: :docker_registry_username,
-        title: "Docker Registry Access Key ID",
+        title: 'Docker Registry Access Key ID'
       },
       {
         key: :docker_registry_password,
-        title: "Docker Registry Secret Access Key",
+        title: 'Docker Registry Secret Access Key'
       },
       {
         key: :admin_email,
-        title: "Admin Email",
-        prompt: "Please enter the email address you would like to use " \
-        "for the default admin user",
-        default: "admin@example.com",
+        title: 'Admin Email',
+        prompt: 'Please enter the email address you would like to use ' \
+                'for the default admin user',
+        default: 'admin@example.com'
       },
       {
         key: :admin_password,
-        title: "Admin Password",
-        value: -> (c) { SecureRandom.hex(8) },
-      },
+        title: 'Admin Password',
+        value: ->(_c) { SecureRandom.hex(8) }
+      }
     ]
 
     input_details = [
-      [:stack_name, ""],
-      [:aws_region, ""],
-      [:instance_type, "c5.xlarge"],
-      [:aws_access_key_id, "asdf"],
-      [:aws_secret_access_key, "xkcd"],
-      [:docker_registry_username, "bob"],
-      [:docker_registry_password, "password1"],
-      [:admin_email, "admin@test.com"],
-      [:confirm?, "y"],
+      [:stack_name, ''],
+      [:aws_region, ''],
+      [:instance_type, 'c5.xlarge'],
+      [:aws_access_key_id, 'asdf'],
+      [:aws_secret_access_key, 'xkcd'],
+      [:docker_registry_username, 'bob'],
+      [:docker_registry_password, 'password1'],
+      [:admin_email, 'admin@test.com'],
+      [:confirm?, 'y']
     ]
     input << input_details.map(&:last).join("\n") << "\n"
     input.rewind
 
     config = described_class.new(highline: highline, prompts: custom_prompts)
     expect(config).to receive(:save_config_to_file).exactly(9).times
-    expect(SecureRandom).to receive(:hex).with(8).and_return("99a6f67de0c7a117")
+    expect(SecureRandom).to receive(:hex).with(8).and_return('99a6f67de0c7a117')
 
     expect(config.config).to eq({})
 
     config.prompt_for_config
 
     expect(config.config).to eq(
-      :stack_name => "convox",
-      :aws_region => "us-east-1",
-      :aws_access_key_id => "asdf",
-      :aws_secret_access_key => "xkcd",
-      :instance_type => "c5.xlarge",
-      :docker_registry_username => "bob",
-      :docker_registry_password => "password1",
-      :admin_email => "admin@test.com",
-      :admin_password => "99a6f67de0c7a117",
+      stack_name: 'convox',
+      aws_region: 'us-east-1',
+      aws_access_key_id: 'asdf',
+      aws_secret_access_key: 'xkcd',
+      instance_type: 'c5.xlarge',
+      docker_registry_username: 'bob',
+      docker_registry_password: 'password1',
+      admin_email: 'admin@test.com',
+      admin_password: '99a6f67de0c7a117'
     )
     output.rewind
     stripped_output = output.read.lines.map(&:rstrip).join("\n")
-    expected_output = <<-EOS
-Please enter a name for your Convox installation  |convox|
-Please enter your AWS Region: |us-east-1| Please enter your EC2 Instance Type: |t3.medium|
-Admin AWS Credentials
-============================================
-
-Please enter your AWS Access Key ID: Please enter your AWS Secret Access Key:
-ECR Authentication
-============================================
-
-Please enter your Docker Registry Access Key ID: Please enter your Docker Registry Secret Access Key: Please enter the email address you would like to use for the default admin user  |admin@example.com|
-
-============================================
-                 SUMMARY
-============================================
-
-    Convox Stack Name:                   convox
-    AWS Region:                          us-east-1
-    EC2 Instance Type:                   c5.xlarge
-    AWS Access Key ID:                   asdf
-    AWS Secret Access Key:               xkcd
-    Docker Registry Access Key ID:       bob
-    Docker Registry Secret Access Key:   password1
-    Admin Email:                         admin@test.com
-    Admin Password:                      99a6f67de0c7a117
-
-We've saved your configuration to: /path/to/.installer_config.json
-If anything goes wrong during the installation, you can restart the script to reload the config and continue.
-
-Please double check all of these configuration details.
-Would you like to start the Convox installation? (press 'n' to correct any settings)
-EOS
+    expected_output = <<~CONVOX_INSTALLER_OUTPUT
+      Please enter a name for your Convox installation  |convox|
+      Please enter your AWS Region: |us-east-1| Please enter your EC2 Instance Type: |t3.medium|
+      Admin AWS Credentials
+      ============================================
+
+      Please enter your AWS Access Key ID: Please enter your AWS Secret Access Key:
+      ECR Authentication
+      ============================================
+
+      Please enter your Docker Registry Access Key ID: Please enter your Docker Registry Secret Access Key: Please enter the email address you would like to use for the default admin user  |admin@example.com|
+
+      ============================================
+                       SUMMARY
+      ============================================
+
+          Convox Stack Name:                   convox
+          AWS Region:                          us-east-1
+          EC2 Instance Type:                   c5.xlarge
+          AWS Access Key ID:                   asdf
+          AWS Secret Access Key:               xkcd
+          Docker Registry Access Key ID:       bob
+          Docker Registry Secret Access Key:   password1
+          Admin Email:                         admin@test.com
+          Admin Password:                      99a6f67de0c7a117
+
+      We've saved your configuration to: /path/to/.installer_config.json
+      If anything goes wrong during the installation, you can restart the script to reload the config and continue.
+
+      Please double check all of these configuration details.
+      Would you like to start the Convox installation? (press 'n' to correct any settings)
+    CONVOX_INSTALLER_OUTPUT
 
     # puts stripped_output
     # puts "---------------"

data/spec/lib/convox_installer/requirements_spec.rb

@@ -1,56 +1,85 @@
 # frozen_string_literal: true
 
-require "convox_installer"
+require 'convox_installer'
 
 RSpec.describe ConvoxInstaller::Requirements do
-  context "with no missing packages" do
-    it "should do nothing" do
-      req = ConvoxInstaller::Requirements.new
-      expect(req).to receive(:find_command).with("convox").and_return(true)
-      expect(req).to receive(:find_command).with("aws").and_return(true)
-      expect(req).to_not receive(:quit!)
+  let(:convox_cli_version) { '20210208170413' }
 
-      expect(req.logger).to_not receive(:error)
+  before do
+    allow_any_instance_of(
+      Convox::Client
+    ).to receive(:cli_version_string).and_return(convox_cli_version)
+  end
+
+  context 'with no missing packages and correct CLI version' do
+    it 'does nothing' do
+      req = described_class.new
+      expect(req).to receive(:find_command).with('convox').and_return(true)
+      expect(req).to receive(:find_command).with('aws').and_return(true)
+      expect(req).not_to receive(:quit!)
+
+      expect(req.logger).not_to receive(:error)
 
       req.ensure_requirements!
     end
   end
 
-  context "on Mac" do
-    context "with two missing packages" do
-      it "should show the correct error message and quit" do
+  context 'with Mac' do
+    context 'with two missing packages' do
+      it 'shows the correct error message and quit' do
         expect(OS).to receive(:mac?).and_return(true)
 
-        req = ConvoxInstaller::Requirements.new
-        expect(req).to receive(:find_command).with("convox").and_return(false)
-        expect(req).to receive(:find_command).with("aws").and_return(false)
+        req = described_class.new
+        expect(req).to receive(:find_command).with('convox').and_return(false)
+        expect(req).to receive(:find_command).with('aws').and_return(false)
+        expect(req).to receive(:quit!)
+
+        expect(req.logger).to receive(:error).with(
+          'This script requires the convox and AWS CLI tools.'
+        )
+        expect(req.logger).to receive(:error).with(
+          'Please run: brew install convox awscli'
+        )
+
+        req.ensure_requirements!
+      end
+    end
+
+    context 'with Convox CLI version 3.3.4' do
+      let(:convox_cli_version) { '3.3.4' }
+
+      it 'shows the correct error message and quit' do
+        req = described_class.new
+        expect(req).to receive(:find_command).with('convox').and_return(true)
+        expect(req).to receive(:find_command).with('aws').and_return(true)
         expect(req).to receive(:quit!)
 
         expect(req.logger).to receive(:error).with(
-          "This script requires the convox and AWS CLI tools."
+          'This script requires Convox CLI version 2.x.x. Your Convox CLI version is: 3.3.4'
         )
         expect(req.logger).to receive(:error).with(
-          "Please run: brew install convox awscli"
+          'Please follow the instructions here to downgrade your ' \
+          'Convox CLI version: https://docsv2.convox.com/introduction/installation'
         )
 
         req.ensure_requirements!
       end
     end
 
-    context "with one missing packages" do
-      it "should show the correct error message and quit" do
+    context 'with one missing packages' do
+      it 'shows the correct error message and quit' do
         expect(OS).to receive(:mac?).and_return(true)
 
-        req = ConvoxInstaller::Requirements.new
-        expect(req).to receive(:find_command).with("convox").and_return(false)
-        expect(req).to receive(:find_command).with("aws").and_return(true)
+        req = described_class.new
+        expect(req).to receive(:find_command).with('convox').and_return(false)
+        expect(req).to receive(:find_command).with('aws').and_return(true)
         expect(req).to receive(:quit!)
 
         expect(req.logger).to receive(:error).with(
-          "This script requires the convox and AWS CLI tools."
+          'This script requires the convox and AWS CLI tools.'
         )
         expect(req.logger).to receive(:error).with(
-          "Please run: brew install convox"
+          'Please run: brew install convox'
         )
 
         req.ensure_requirements!
@@ -58,26 +87,26 @@ RSpec.describe ConvoxInstaller::Requirements do
     end
   end
 
-  context "on Linux" do
-    context "with two missing packages" do
-      it "should show the correct error message and quit" do
+  context 'with Linux' do
+    context 'with two missing packages' do
+      it 'shows the correct error message and quit' do
         expect(OS).to receive(:mac?).and_return(false)
 
-        req = ConvoxInstaller::Requirements.new
-        expect(req).to receive(:find_command).with("convox").and_return(false)
-        expect(req).to receive(:find_command).with("aws").and_return(false)
+        req = described_class.new
+        expect(req).to receive(:find_command).with('convox').and_return(false)
+        expect(req).to receive(:find_command).with('aws').and_return(false)
         expect(req).to receive(:quit!)
 
         expect(req.logger).to receive(:error).with(
-          "This script requires the convox and AWS CLI tools."
+          'This script requires the convox and AWS CLI tools.'
         )
-        expect(req.logger).to receive(:error).with("Installation Instructions:")
+        expect(req.logger).to receive(:error).with('Installation Instructions:')
         expect(req.logger).to receive(:error).with(
-          "* convox: https://docs.convox.com/introduction/installation"
+          '* convox: https://docs.convox.com/introduction/installation'
         )
         expect(req.logger).to receive(:error).with(
-          "* aws: https://docs.aws.amazon.com/cli/latest/" \
-          "userguide/cli-chap-install.html"
+          '* aws: https://docs.aws.amazon.com/cli/latest/' \
+          'userguide/cli-chap-install.html'
         )
 
         req.ensure_requirements!

data/spec/spec_helper.rb

@@ -20,7 +20,7 @@ $LOAD_PATH << File.expand_path(__dir__, '../lib')
 
 require 'vcr'
 require 'webmock/rspec'
-require 'pry-byebug'
+# require 'pry-byebug'
 
 VCR.configure do |config|
   config.cassette_library_dir = 'spec/vcr_cassettes'

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: convox_installer
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 2.0.0
 platform: ruby
 authors:
 - Form Applications Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.10
+        version: 5.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.10
+        version: 5.2.3
 - !ruby/object:Gem::Dependency
-  name: json
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 1.7.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 1.7.10
 - !ruby/object:Gem::Dependency
-  name: os
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 1.0.1
 description: Build a Convox installation workflow
 email:
 - support@formapi.io
@@ -112,7 +112,8 @@ files:
 homepage: https://github.com/FormAPI/convox_installer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -121,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="