gitlab-ce/spec/lib/gitlab/patch/database_config_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Patch::DatabaseConfig do
  it 'module is included' do
    expect(Rails::Application::Configuration).to include(described_class)
  end

  describe '#database_configuration' do
    let(:configuration) { Rails::Application::Configuration.new(Rails.root) }

    before do
      # The `AS::ConfigurationFile` calls `read` in `def initialize`
      # thus we cannot use `expect_next_instance_of`
      # rubocop:disable RSpec/AnyInstanceOf
      expect_any_instance_of(ActiveSupport::ConfigurationFile)
        .to receive(:read).with(Rails.root.join('config/database.yml')).and_return(database_yml)
      # rubocop:enable RSpec/AnyInstanceOf
    end

    shared_examples 'hash containing main: connection name' do
      it 'returns a hash containing only main:' do
        database_configuration = configuration.database_configuration

        expect(database_configuration).to match(
          "production" => { "main" => a_hash_including("adapter") },
          "development" => { "main" => a_hash_including("adapter" => "postgresql") },
          "test" => { "main" => a_hash_including("adapter" => "postgresql") }
        )
      end
    end

    let(:database_yml) do
      <<-EOS
          production:
            main:
              adapter: postgresql
              encoding: unicode
              database: gitlabhq_production
              username: git
              password: "secure password"
              host: localhost

          development:
            main:
              adapter: postgresql
              encoding: unicode
              database: gitlabhq_development
              username: postgres
              password: "secure password"
              host: localhost
              variables:
                statement_timeout: 15s

          test: &test
            main:
              adapter: postgresql
              encoding: unicode
              database: gitlabhq_test
              username: postgres
              password:
              host: localhost
              prepared_statements: false
              variables:
                statement_timeout: 15s
      EOS
    end

    include_examples 'hash containing main: connection name'

    context 'when config/database.yml contains extra configuration through an external command' do
      let(:database_yml) do
        <<-EOS
            production:
              config_command: '/opt/database-config.sh'
              main:
                adapter: postgresql
                encoding: unicode
                database: gitlabhq_production
                username: git
                password: "dummy password"
                host: localhost

            development:
              config_command: '/opt/database-config.sh'
              main:
                adapter: postgresql
                encoding: unicode
                database: gitlabhq_development
                username: postgres
                password: "dummy password"
                host: localhost
                variables:
                  statement_timeout: 15s

            test: &test
              config_command: '/opt/database-config.sh'
              main:
                adapter: postgresql
                encoding: unicode
                database: gitlabhq_test
                username: postgres
                password:
                host: localhost
                prepared_statements: false
                variables:
                  statement_timeout: 15s
        EOS
      end

      context 'when the external command returns valid yaml' do
        before do
          allow(Gitlab::Popen)
            .to receive(:popen)
            .and_return(["---\nmain:\n  password: 'secure password'\n", 0])
        end

        it 'merges the extra configuration' do
          database_configuration = configuration.database_configuration

          expect(database_configuration).to match(
            "production" => { "main" => a_hash_including("password" => "secure password") },
            "development" => { "main" => a_hash_including("password" => "secure password") },
            "test" => { "main" => a_hash_including("password" => "secure password") }
          )
        end
      end

      context 'when the external command returns invalid yaml' do
        before do
          allow(Gitlab::Popen)
            .to receive(:popen)
            .and_return(["---\nmain:\n  password: 'secure password\n", 0])
        end

        it 'raises an error' do
          expect { configuration.database_configuration }
            .to raise_error(
              Gitlab::Patch::DatabaseConfig::CommandExecutionError,
              %r{database.yml: Execution of `/opt/database-config.sh` generated invalid yaml}
            )
        end
      end

      context 'when the parsed external command output returns invalid hash' do
        before do
          allow(Gitlab::Popen)
            .to receive(:popen)
            .and_return(["hello", 0])
        end

        it 'raises an error' do
          expect { configuration.database_configuration }
            .to raise_error(
              Gitlab::Patch::DatabaseConfig::CommandExecutionError,
              %r{database.yml: The output of `/opt/database-config.sh` must be a Hash, String given}
            )
        end
      end

      context 'when the external command fails' do
        before do
          allow(Gitlab::Popen).to receive(:popen).and_return(["", 125])
        end

        it 'raises error' do
          expect { configuration.database_configuration }
            .to raise_error(
              Gitlab::Patch::DatabaseConfig::CommandExecutionError,
              %r{database.yml: Execution of `/opt/database-config.sh` failed}
            )
        end
      end
    end
  end
end