Test for pg_upgrade with custom port

- Add rspec test validating that pg_upgrade uses a custom PostgreSQL
  listen port when it is set

Signed-off-by: Robert Marshall <rmarshall@gitlab.com>

spec/gitlab-ctl-commands/lib/gitlab_ctl_pg_upgrade_spec.rb

@@ -4,69 +4,104 @@ $LOAD_PATH << File.join(__dir__, '../../../files/gitlab-ctl-commands/lib')
 require 'gitlab_ctl'
+def stub_json(config = nil)
+  options = config || {}
+  options['port'] ||= '5432'
+  data = { 'default' => { 'postgresql' => options } }
+  allow(GitlabCtl::Util).to receive(:parse_json_file).and_return(data)
+end
+
 RSpec.describe GitlabCtl::PgUpgrade do
   before do
     @fake_default_dir = '/fake/data/postgresql/data'
     allow(GitlabCtl::Util).to receive(:get_command_output).with(
       "/fakebasedir/embedded/bin/pg_ctl --version"
     ).and_return('fakeoldverision')
-    @dbw = GitlabCtl::PgUpgrade.new('/fakebasedir', '/fake/data', 'fakenewversion', nil, 123)
   end
-  it 'should create a new object' do
-    expect(@dbw).to be_instance_of(GitlabCtl::PgUpgrade)
-  end
-  it 'should allow for a custom base directory' do
-    expect(@dbw.base_path).to eq('/fakebasedir')
+  context 'with a default configuration' do
+    before do
+      stub_json
+      @dbw = GitlabCtl::PgUpgrade.new('/fakebasedir', '/fake/data', 'fakenewversion', nil, 123)
+    end
+
+    it 'should create a new object' do
+      expect(@dbw).to be_instance_of(GitlabCtl::PgUpgrade)
+    end
+
+    it 'should allow for a custom base directory' do
+      expect(@dbw.base_path).to eq('/fakebasedir')
+    end
+
+    it 'should use the specified timeout' do
+      expect(@dbw.timeout).to eq(123)
+    end
+
+    it 'should set tmp_data_dir to data_dir if tmp_dir is nil on initialization' do
+      allow(GitlabCtl::Util).to receive(:parse_json_file).and_return({ 'default' => {} })
+
+      expect(@dbw.tmp_data_dir).to eq(@dbw.data_dir)
+    end
+
+    it 'should return the appropriate data version' do
+      stub_json
+      allow(File).to receive(:read).with(
+        File.join(@fake_default_dir, 'PG_VERSION')
+      ).and_return("99.99\n")
+
+      expect(@dbw.fetch_data_version).to eq('99.99')
+    end
+
+    context 'when determining if there is enough free space to perform an upgrade' do
+      before do
+        stub_json
+      end
+
+      it 'detects when there is not enough available disk space for upgrade' do
+        allow(GitlabCtl::Util).to receive(:get_command_output).with(
+          "du -s --block-size=1m #{@dbw.data_dir}", nil, 123
+        ).and_return("200000\n#{@dbw.data_dir}")
+
+        allow(GitlabCtl::Util).to receive(:get_command_output).with(
+          "df -P --block-size=1m #{@dbw.data_dir} | awk '{print $4}'", nil, 123
+        ).and_return("Available\n300000")
+
+        expect(@dbw.enough_free_space?(@dbw.data_dir)).to eq(false)
+      end
+
+      it 'detects when there is enough available disk space for upgrade' do
+        allow(GitlabCtl::Util).to receive(:get_command_output).with(
+          "du -s --block-size=1m #{@dbw.data_dir}", nil, 123
+        ).and_return("200000\n#{@dbw.data_dir}")
+        allow(GitlabCtl::Util).to receive(:get_command_output).with(
+          "df -P --block-size=1m #{@dbw.data_dir} | awk '{print $4}'", nil, 123
+        ).and_return("Available\n450000")
+
+        expect(@dbw.enough_free_space?(@dbw.data_dir)).to eq(true)
+      end
+    end
   end
-  it 'should use the specified timeout' do
-    expect(@dbw.timeout).to eq(123)
+  it 'should use the configured port when running pg_upgrade' do
+    stub_json({ 'port' => '1959' })
+    @dbw = GitlabCtl::PgUpgrade.new('/fakebasedir', '/fake/data', 'fakenewversion', nil, 123)
+    expect(@dbw.port).to eq('1959')
   end
   it 'should call pg_command with the appropriate command' do
-    allow(GitlabCtl::Util).to receive(:parse_json_file).and_return(
-      {
-        'default' => {
-          'postgresql' => {
-            'username' => 'arbitrary-user-name'
-          }
-        }
-      })
+    stub_json({ 'username' => 'arbitrary-user-name' })
+    @dbw = GitlabCtl::PgUpgrade.new('/fakebasedir', '/fake/data', 'fakenewversion', nil, 123)
     expect(GitlabCtl::Util).to receive(
       :get_command_output
     ).with('su - arbitrary-user-name -c "fake command"', nil, 123)
     @dbw.run_pg_command('fake command')
   end
-  it 'should set tmp_data_dir to data_dir if tmp_dir is nil on initialization' do
-    allow(GitlabCtl::Util).to receive(:parse_json_file).and_return({ 'default' => {} })
-
-    expect(@dbw.tmp_data_dir).to eq(@dbw.data_dir)
-  end
-
-  it 'should return the appropriate data version' do
-    allow(GitlabCtl::Util).to receive(:parse_json_file).and_return({ 'default' => {} })
-    allow(File).to receive(:read).with(
-      File.join(@fake_default_dir, 'PG_VERSION')
-    ).and_return("99.99\n")
-
-    expect(@dbw.fetch_data_version).to eq('99.99')
-  end
-
   context 'when an explicit data directory is specified' do
     it 'should use it as data_dir' do
-      allow(GitlabCtl::Util).to receive(:parse_json_file).and_return(
-        {
-          'default' => {
-            'gitlab' => {
-              'postgresql' => {
-                'data_dir' => 'randomdir'
-              }
-            }
-          }
-        })
+      stub_json({ 'data_dir' => 'randomdir' })
+      @dbw = GitlabCtl::PgUpgrade.new('/fakebasedir', '/fake/data', 'fakenewversion', nil, 123)
       expect(@dbw.data_dir).to eq('randomdir')
     end
@@ -74,48 +109,10 @@ RSpec.describe GitlabCtl::PgUpgrade do
   context 'when an explicit data directory is not specified' do
     it 'should use find data_dir using dir/data' do
-      allow(GitlabCtl::Util).to receive(:parse_json_file).and_return(
-        {
-          'default' => {
-            'gitlab' => {
-              'postgresql' => {
-                'dir' => 'parentdir'
-              }
-            }
-          }
-        })
+      stub_json({ 'dir' => 'parentdir' })
+      @dbw = GitlabCtl::PgUpgrade.new('/fakebasedir', '/fake/data', 'fakenewversion', nil, 123)
       expect(@dbw.data_dir).to eq('parentdir/data')
     end
   end
-
-  context 'when determining if there is enough free space to perform an upgrade' do
-    before do
-      allow(GitlabCtl::Util).to receive(:parse_json_file).and_return({ 'default' => {} })
-    end
-
-    it 'detects when there is not enough available disk space for upgrade' do
-      allow(GitlabCtl::Util).to receive(:get_command_output).with(
-        "du -s --block-size=1m #{@dbw.data_dir}", nil, 123
-      ).and_return("200000\n#{@dbw.data_dir}")
-
-      allow(GitlabCtl::Util).to receive(:get_command_output).with(
-        "df -P --block-size=1m #{@dbw.data_dir} | awk '{print $4}'", nil, 123
-      ).and_return("Available\n300000")
-
-      expect(@dbw.enough_free_space?(@dbw.data_dir)).to eq(false)
-    end
-
-    it 'detects when there is enough available disk space for upgrade' do
-      allow(GitlabCtl::Util).to receive(:get_command_output).with(
-        "du -s --block-size=1m #{@dbw.data_dir}", nil, 123
-      ).and_return("200000\n#{@dbw.data_dir}")
-
-      allow(GitlabCtl::Util).to receive(:get_command_output).with(
-        "df -P --block-size=1m #{@dbw.data_dir} | awk '{print $4}'", nil, 123
-      ).and_return("Available\n450000")
-
-      expect(@dbw.enough_free_space?(@dbw.data_dir)).to eq(true)
-    end
-  end
 end