convox_installer 1.0.0

data/lib/convox_installer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+require "convox_installer/config"
+require "convox_installer/requirements"
+require "convox"
+
+module ConvoxInstaller
+  def client
+    @client ||= Convox::Client.new(log_level: @log_level, config: config.config)
+  end
+
+  def config
+    options = {log_level: @log_level}
+    options[:prompts] = @prompts if @prompts
+    @config ||= Config.new(options)
+  end
+
+  def requirements
+    @requirements ||= Requirements.new(log_level: @log_level)
+  end
+
+  def ensure_requirements!
+    requirements.ensure_requirements!
+  end
+
+  def prompt_for_config
+    config.prompt_for_config
+  end
+
+  %w[
+    backup_convox_host_and_rack
+    install_convox
+    validate_convox_auth_and_set_host!
+    validate_convox_rack!
+    create_convox_app!
+    set_default_app_for_directory!
+    create_s3_bucket!
+    add_docker_registry!
+    s3_bucket_details
+    convox_rack_data
+    default_service_domain_name
+    run_convox_command!
+  ].each do |method|
+    define_method(method) do |*args|
+      client.send(method, *args)
+    end
+  end
+end

data/spec/lib/convox/client_spec.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require "convox/client"
+
+RSpec.describe Convox::Client do
+  let(:home_dir) { File.expand_path("~") }
+
+  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")
+  end
+
+  it "should backup existing Convox host and rack files" do
+    expect(File).to receive(:exist?).with(
+      "#{home_dir}/.convox/host"
+    ).and_return(true)
+    expect(File).to receive(:exist?).with(
+      "#{home_dir}/.convox/rack"
+    ).and_return(true)
+    expect(FileUtils).to receive(:mv).with(
+      "#{home_dir}/.convox/host", "#{home_dir}/.convox/host.bak"
+    )
+    expect(FileUtils).to receive(:mv).with(
+      "#{home_dir}/.convox/rack", "#{home_dir}/.convox/rack.bak"
+    )
+
+    client = described_class.new
+    expect(client.logger).to receive(:info).twice
+
+    client.backup_convox_host_and_rack
+  end
+
+  describe "#install" do
+    it "should require the correct config vars" do
+      client = described_class.new
+      expect { client.install_convox }.to raise_error("aws_region is missing from the config!")
+
+      client = described_class.new(config: {aws_region: "asdf"})
+      expect { client.install_convox }.to raise_error("aws_access_key_id is missing from the config!")
+    end
+
+    it "should run 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",
+        },
+      )
+
+      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",
+      )
+      client.install_convox
+    end
+  end
+
+  describe "#validate_convox_auth_and_set_host!" do
+    it "should require 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!")
+    end
+
+    it "should raise an error if auth file is missing" do
+      client = described_class.new(
+        config: {
+          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 /)
+    end
+
+    it "should set ~/.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)
+
+      expect(File).to receive(:read).with("#{home_dir}/.convox/auth").and_return(
+        '{ "convox-test-697645520.us-west-2.elb.amazonaws.com": "1234567890" }'
+      )
+      client = described_class.new(
+        config: {
+          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.validate_convox_auth_and_set_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
+      expect(File).to receive(:exist?).with(
+        "#{home_dir}/.convox/auth"
+      ).twice.and_return(true)
+
+      expect(File).to receive(:read).with("#{home_dir}/.convox/auth").and_return(
+        '{ "convox-test-697645520.us-west-2.elb.amazonaws.com": "1234567890" }'
+      )
+      client = described_class.new(
+        config: {
+          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")
+    end
+
+    it "should raise an error if it finds multiple matching hosts" do
+      expect(File).to receive(:exist?).with(
+        "#{home_dir}/.convox/auth"
+      ).twice.and_return(true)
+
+      expect(File).to receive(:read).with("#{home_dir}/.convox/auth").and_return(
+        '{ "convox-test-697645520.us-west-2.elb.amazonaws.com": "1234567890", ' \
+        '"convox-test-1234123412.us-west-2.elb.amazonaws.com": "1234567890" }'
+      )
+      client = described_class.new(
+        config: {
+          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")
+    end
+  end
+end

data/spec/lib/convox_installer/config_spec.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require "convox_installer"
+require "securerandom"
+
+RSpec.describe ConvoxInstaller::Config do
+  after(:each) do
+    ENV.delete "AWS_REGION"
+    ENV.delete "AWS_ACCESS_KEY_ID"
+  end
+
+  it "loads the saved config from ~/.convox/installer_config" 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" } }'
+    )
+    config = described_class.new
+
+    expect(config.config).to eq(
+      aws_region: "us-west-2",
+      aws_access_key_id: "1234",
+    )
+  end
+
+  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"
+
+    config = described_class.new
+    expect(config.config).to eq(
+      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
+    expect(described_class).to receive(:config_file_exists?).and_return(false)
+    input = StringIO.new
+    output = StringIO.new
+    highline = HighLine.new(input, output)
+
+    input << "\nus-north-12\nasdf\nxkcd\n\nn\nconvox-test\n\nsdfg\n\n\ny\n"
+    input.rewind
+
+    config = described_class.new(highline: highline)
+    expect(config).to receive(:save_config_to_file).exactly(10).times
+
+    expect(config.config).to eq({})
+    config.prompt_for_config
+    expect(config.config).to eq(
+      :stack_name => "convox-test",
+      :aws_access_key_id => "sdfg",
+      :aws_region => "us-north-12",
+      :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|
+Admin AWS Credentials
+============================================
+
+Please enter your AWS Access Key ID: Please enter your AWS Secret Access Key: Please enter your EC2 Instance Type: |t3.medium|
+============================================
+                 SUMMARY
+============================================
+
+    Convox Stack Name:       convox
+    AWS Region:              us-north-12
+    AWS Access Key ID:       asdf
+    AWS Secret Access Key:   xkcd
+    EC2 Instance Type:       t3.medium
+
+We've saved your configuration to: /Users/ndbroadbent/.convox/installer_config
+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-north-12|
+Admin AWS Credentials
+============================================
+
+Please enter your AWS Access Key ID: |asdf| Please enter your AWS Secret Access Key: |xkcd| Please enter your EC2 Instance Type: |t3.medium|
+============================================
+                 SUMMARY
+============================================
+
+    Convox Stack Name:       convox-test
+    AWS Region:              us-north-12
+    AWS Access Key ID:       sdfg
+    AWS Secret Access Key:   xkcd
+    EC2 Instance Type:       t3.medium
+
+We've saved your configuration to: /Users/ndbroadbent/.convox/installer_config
+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
+
+    # puts stripped_output
+    # puts "---------------"
+    # puts expected_output
+    expect(stripped_output).to eq expected_output.strip
+  end
+
+  it "prompts for custom configuration" do
+    expect(described_class).to receive(:config_file_exists?).and_return(false)
+    input = StringIO.new
+    output = StringIO.new
+    highline = HighLine.new(input, output)
+
+    custom_prompts = ConvoxInstaller::Config::DEFAULT_PROMPTS + [
+      {
+        section: "ECR Authentication",
+        info: "You should have received authentication details for the Docker Registry\n" \
+        "via email. If not, please contact support@example.com",
+      },
+      {
+        key: :docker_registry_username,
+        title: "Docker Registry Access Key ID",
+      },
+      {
+        key: :docker_registry_password,
+        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",
+      },
+      {
+        key: :admin_password,
+        title: "Admin Password",
+        value: -> () { SecureRandom.hex(8) },
+      },
+    ]
+
+    input << "\n\nasdf\nxkcd\n\nsdfg\nqwer\n\ny\n"
+    input.rewind
+
+    config = described_class.new(highline: highline, prompts: custom_prompts)
+    expect(config).to receive(:save_config_to_file).exactly(8).times
+    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 => "t3.medium",
+      :docker_registry_username => "sdfg",
+      :docker_registry_password => "qwer",
+      :admin_email => "admin@example.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|
+Admin AWS Credentials
+============================================
+
+Please enter your AWS Access Key ID: Please enter your AWS Secret Access Key: Please enter your EC2 Instance Type: |t3.medium|
+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
+    AWS Access Key ID:                   asdf
+    AWS Secret Access Key:               xkcd
+    EC2 Instance Type:                   t3.medium
+    Docker Registry Access Key ID:       sdfg
+    Docker Registry Secret Access Key:   qwer
+    Admin Email:                         admin@example.com
+    Admin Password:                      99a6f67de0c7a117
+
+We've saved your configuration to: /Users/ndbroadbent/.convox/installer_config
+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
+
+    # puts stripped_output
+    # puts "---------------"
+    # puts expected_output
+    expect(stripped_output).to eq expected_output.strip
+  end
+end

data/spec/lib/convox_installer/requirements_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+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!)
+
+      expect(req.logger).to_not 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
+        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)
+        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 one missing packages" do
+      it "should show 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)
+        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"
+        )
+
+        req.ensure_requirements!
+      end
+    end
+  end
+
+  context "on Linux" do
+    context "with two missing packages" do
+      it "should show 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)
+        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("Installation Instructions:")
+        expect(req.logger).to receive(:error).with(
+          "* 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"
+        )
+
+        req.ensure_requirements!
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+$LOAD_PATH << File.expand_path(__dir__, '../lib')
+
+require 'vcr'
+require 'webmock/rspec'
+require 'pry-byebug'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/vcr_cassettes'
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+
+  config.debug_logger = File.open(
+    File.join(__dir__, '../log/vcr_debug.log'), 'w'
+  )
+  config.default_cassette_options = { record: :none, erb: true }
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end