workhorse_spec.rb 13 KB
Newer Older
1 2
require 'spec_helper'

3
describe Gitlab::Workhorse do
4
  let(:project)    { create(:project, :repository) }
5 6 7 8 9 10 11 12 13
  let(:repository) { project.repository }

  def decode_workhorse_header(array)
    key, value = array
    command, encoded_params = value.split(":")
    params = JSON.parse(Base64.urlsafe_decode64(encoded_params))

    [key, command, params]
  end
14

15
  describe ".send_git_archive" do
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
    let(:ref) { 'master' }
    let(:format) { 'zip' }
    let(:storage_path) { Gitlab.config.gitlab.repository_downloads_path }
    let(:base_params) { repository.archive_metadata(ref, storage_path, format) }
    let(:gitaly_params) do
      base_params.merge(
        'GitalyServer' => {
          'address' => Gitlab::GitalyClient.address(project.repository_storage),
          'token' => Gitlab::GitalyClient.token(project.repository_storage)
        },
        'GitalyRepository' => repository.gitaly_repository.to_h.deep_stringify_keys
      )
    end

    subject do
      described_class.send_git_archive(repository, ref: ref, format: format)
    end

34
    context 'when Gitaly workhorse_archive feature is enabled' do
35 36 37 38 39 40 41 42 43
      it 'sets the header correctly' do
        key, command, params = decode_workhorse_header(subject)

        expect(key).to eq('Gitlab-Workhorse-Send-Data')
        expect(command).to eq('git-archive')
        expect(params).to include(gitaly_params)
      end
    end

44
    context 'when Gitaly workhorse_archive feature is disabled', :skip_gitaly_mock do
45 46 47 48 49 50 51 52 53
      it 'sets the header correctly' do
        key, command, params = decode_workhorse_header(subject)

        expect(key).to eq('Gitlab-Workhorse-Send-Data')
        expect(command).to eq('git-archive')
        expect(params).to eq(base_params)
      end
    end

54 55 56 57 58 59
    context "when the repository doesn't have an archive file path" do
      before do
        allow(project.repository).to receive(:archive_metadata).and_return(Hash.new)
      end

      it "raises an error" do
60
        expect { subject }.to raise_error(RuntimeError)
61 62 63
      end
    end
  end
64

65 66 67 68
  describe '.send_git_patch' do
    let(:diff_refs) { double(base_sha: "base", head_sha: "head") }
    subject { described_class.send_git_patch(repository, diff_refs) }

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
    context 'when Gitaly workhorse_send_git_patch feature is enabled' do
      it 'sets the header correctly' do
        key, command, params = decode_workhorse_header(subject)

        expect(key).to eq("Gitlab-Workhorse-Send-Data")
        expect(command).to eq("git-format-patch")
        expect(params).to eq({
          'GitalyServer' => {
            address: Gitlab::GitalyClient.address(project.repository_storage),
            token: Gitlab::GitalyClient.token(project.repository_storage)
          },
          'RawPatchRequest' => Gitaly::RawPatchRequest.new(
            repository: repository.gitaly_repository,
            left_commit_id: 'base',
            right_commit_id: 'head'
          ).to_json
        }.deep_stringify_keys)
      end
    end
88

89 90 91 92 93 94 95 96
    context 'when Gitaly workhorse_send_git_patch feature is disabled', skip_gitaly_mock: true do
      it 'sets the header correctly' do
        key, command, params = decode_workhorse_header(subject)

        expect(key).to eq("Gitlab-Workhorse-Send-Data")
        expect(command).to eq("git-format-patch")
        expect(params).to eq("RepoPath" => repository.path_to_repo, "ShaFrom" => "base", "ShaTo" => "head")
      end
97 98 99
    end
  end

100 101 102 103 104
  describe '.terminal_websocket' do
    def terminal(ca_pem: nil)
      out = {
        subprotocols: ['foo'],
        url: 'wss://example.com/terminal.ws',
105 106
        headers: { 'Authorization' => ['Token x'] },
        max_session_time: 600
107 108 109 110 111 112 113 114 115 116
      }
      out[:ca_pem] = ca_pem if ca_pem
      out
    end

    def workhorse(ca_pem: nil)
      out = {
        'Terminal' => {
          'Subprotocols' => ['foo'],
          'Url' => 'wss://example.com/terminal.ws',
117 118
          'Header' => { 'Authorization' => ['Token x'] },
          'MaxSessionTime' => 600
119 120 121 122 123 124 125
        }
      }
      out['Terminal']['CAPem'] = ca_pem if ca_pem
      out
    end

    context 'without ca_pem' do
126
      subject { described_class.terminal_websocket(terminal) }
127 128 129 130 131

      it { is_expected.to eq(workhorse) }
    end

    context 'with ca_pem' do
132
      subject { described_class.terminal_websocket(terminal(ca_pem: "foo")) }
133 134 135 136 137

      it { is_expected.to eq(workhorse(ca_pem: "foo")) }
    end
  end

138 139
  describe '.send_git_diff' do
    let(:diff_refs) { double(base_sha: "base", head_sha: "head") }
140
    subject { described_class.send_git_diff(repository, diff_refs) }
141

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
    context 'when Gitaly workhorse_send_git_diff feature is enabled' do
      it 'sets the header correctly' do
        key, command, params = decode_workhorse_header(subject)

        expect(key).to eq("Gitlab-Workhorse-Send-Data")
        expect(command).to eq("git-diff")
        expect(params).to eq({
          'GitalyServer' => {
            address: Gitlab::GitalyClient.address(project.repository_storage),
            token: Gitlab::GitalyClient.token(project.repository_storage)
          },
          'RawDiffRequest' => Gitaly::RawDiffRequest.new(
            repository: repository.gitaly_repository,
            left_commit_id: 'base',
            right_commit_id: 'head'
          ).to_json
        }.deep_stringify_keys)
      end
    end
161

162 163 164 165 166 167 168 169
    context 'when Gitaly workhorse_send_git_diff feature is disabled', skip_gitaly_mock: true do
      it 'sets the header correctly' do
        key, command, params = decode_workhorse_header(subject)

        expect(key).to eq("Gitlab-Workhorse-Send-Data")
        expect(command).to eq("git-diff")
        expect(params).to eq("RepoPath" => repository.path_to_repo, "ShaFrom" => "base", "ShaTo" => "head")
      end
170 171 172
    end
  end

173 174 175 176 177 178 179 180 181 182 183 184 185 186
  describe ".secret" do
    subject { described_class.secret }

    before do
      described_class.instance_variable_set(:@secret, nil)
      described_class.write_secret
    end

    it 'returns 32 bytes' do
      expect(subject).to be_a(String)
      expect(subject.length).to eq(32)
      expect(subject.encoding).to eq(Encoding::ASCII_8BIT)
    end

187 188 189 190 191
    it 'accepts a trailing newline' do
      open(described_class.secret_path, 'a') { |f| f.write "\n" }
      expect(subject.length).to eq(32)
    end

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
    it 'raises an exception if the secret file cannot be read' do
      File.delete(described_class.secret_path)
      expect { subject }.to raise_exception(Errno::ENOENT)
    end

    it 'raises an exception if the secret file contains the wrong number of bytes' do
      File.truncate(described_class.secret_path, 0)
      expect { subject }.to raise_exception(RuntimeError)
    end
  end

  describe ".write_secret" do
    let(:secret_path) { described_class.secret_path }
    before do
      begin
        File.delete(secret_path)
      rescue Errno::ENOENT
      end

      described_class.write_secret
    end

    it 'uses mode 0600' do
      expect(File.stat(secret_path).mode & 0777).to eq(0600)
    end

    it 'writes base64 data' do
      bytes = Base64.strict_decode64(File.read(secret_path))
      expect(bytes).not_to be_empty
    end
  end

  describe '#verify_api_request!' do
Jacob Vosmaer's avatar
Jacob Vosmaer committed
225
    let(:header_key) { described_class::INTERNAL_API_REQUEST_HEADER }
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
    let(:payload) { { 'iss' => 'gitlab-workhorse' } }

    it 'accepts a correct header' do
      headers = { header_key => JWT.encode(payload, described_class.secret, 'HS256') }
      expect { call_verify(headers) }.not_to raise_error
    end

    it 'raises an error when the header is not set' do
      expect { call_verify({}) }.to raise_jwt_error
    end

    it 'raises an error when the header is not signed' do
      headers = { header_key => JWT.encode(payload, nil, 'none') }
      expect { call_verify(headers) }.to raise_jwt_error
    end

    it 'raises an error when the header is signed with the wrong key' do
      headers = { header_key => JWT.encode(payload, 'wrongkey', 'HS256') }
      expect { call_verify(headers) }.to raise_jwt_error
    end

    it 'raises an error when the issuer is incorrect' do
      payload['iss'] = 'somebody else'
      headers = { header_key => JWT.encode(payload, described_class.secret, 'HS256') }
      expect { call_verify(headers) }.to raise_jwt_error
    end

    def raise_jwt_error
      raise_error(JWT::DecodeError)
    end

    def call_verify(headers)
      described_class.verify_api_request!(headers)
    end
  end
261 262 263

  describe '.git_http_ok' do
    let(:user) { create(:user) }
264
    let(:repo_path) { repository.path_to_repo }
265
    let(:action) { 'info_refs' }
266
    let(:params) do
267 268 269 270 271 272
      {
        GL_ID: "user-#{user.id}",
        GL_USERNAME: user.username,
        GL_REPOSITORY: "project-#{project.id}",
        RepoPath: repo_path
      }
273 274 275 276 277
    end

    subject { described_class.git_http_ok(repository, false, user, action) }

    it { expect(subject).to include(params) }
278

279 280
    context 'when is_wiki' do
      let(:params) do
281 282 283 284 285 286
        {
          GL_ID: "user-#{user.id}",
          GL_USERNAME: user.username,
          GL_REPOSITORY: "wiki-#{project.id}",
          RepoPath: repo_path
        }
287 288 289
      end

      subject { described_class.git_http_ok(repository, true, user, action) }
290

291 292
      it { expect(subject).to include(params) }
    end
293

294
    context 'when Gitaly is enabled' do
295 296
      let(:gitaly_params) do
        {
297 298 299 300
          GitalyServer: {
            address: Gitlab::GitalyClient.address('default'),
            token: Gitlab::GitalyClient.token('default')
          }
301 302 303
        }
      end

304
      before do
305
        allow(Gitlab.config.gitaly).to receive(:enabled).and_return(true)
306 307
      end

308
      it 'includes a Repository param' do
309
        repo_param = {
310
          storage_name: 'default',
311 312
          relative_path: project.full_path + '.git',
          gl_repository: "project-#{project.id}"
313
        }
314

315
        expect(subject[:Repository]).to include(repo_param)
316 317
      end

318 319 320 321
      context "when git_upload_pack action is passed" do
        let(:action) { 'git_upload_pack' }
        let(:feature_flag) { :post_upload_pack }

322 323
        it 'includes Gitaly params in the returned value' do
          allow(Gitlab::GitalyClient).to receive(:feature_enabled?).with(feature_flag).and_return(true)
324

325
          expect(subject).to include(gitaly_params)
326 327 328
        end
      end

329 330 331
      context "when git_receive_pack action is passed" do
        let(:action) { 'git_receive_pack' }

332
        it { expect(subject).to include(gitaly_params) }
333 334
      end

335 336 337 338 339 340 341 342 343 344
      context "when info_refs action is passed" do
        let(:action) { 'info_refs' }

        it { expect(subject).to include(gitaly_params) }
      end

      context 'when action passed is not supported by Gitaly' do
        let(:action) { 'download' }

        it { expect { subject }.to raise_exception('Unsupported action: download') }
345 346 347
      end
    end
  end
348

Kamil Trzcinski's avatar
Kamil Trzcinski committed
349
  describe '.set_key_and_notify' do
350 351 352
    let(:key) { 'test-key' }
    let(:value) { 'test-value' }

Kamil Trzcinski's avatar
Kamil Trzcinski committed
353
    subject { described_class.set_key_and_notify(key, value, overwrite: overwrite) }
354 355 356 357 358 359 360

    shared_examples 'set and notify' do
      it 'set and return the same value' do
        is_expected.to eq(value)
      end

      it 'set and notify' do
361
        expect_any_instance_of(::Redis).to receive(:publish)
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
          .with(described_class::NOTIFICATION_CHANNEL, "test-key=test-value")

        subject
      end
    end

    context 'when we set a new key' do
      let(:overwrite) { true }

      it_behaves_like 'set and notify'
    end

    context 'when we set an existing key' do
      let(:old_value) { 'existing-key' }

      before do
Kamil Trzcinski's avatar
Kamil Trzcinski committed
378
        described_class.set_key_and_notify(key, old_value, overwrite: true)
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
      end

      context 'and overwrite' do
        let(:overwrite) { true }

        it_behaves_like 'set and notify'
      end

      context 'and do not overwrite' do
        let(:overwrite) { false }

        it 'try to set but return the previous value' do
          is_expected.to eq(old_value)
        end

Kamil Trzcinski's avatar
Kamil Trzcinski committed
394
        it 'does not notify' do
395
          expect_any_instance_of(::Redis).not_to receive(:publish)
396 397 398 399 400 401

          subject
        end
      end
    end
  end
402 403 404 405 406 407 408 409

  describe '.send_git_blob' do
    include FakeBlobHelpers

    let(:blob) { fake_blob }

    subject { described_class.send_git_blob(repository, blob) }

410
    context 'when Gitaly workhorse_raw_show feature is enabled' do
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
      it 'sets the header correctly' do
        key, command, params = decode_workhorse_header(subject)

        expect(key).to eq('Gitlab-Workhorse-Send-Data')
        expect(command).to eq('git-blob')
        expect(params).to eq({
          'GitalyServer' => {
            address: Gitlab::GitalyClient.address(project.repository_storage),
            token: Gitlab::GitalyClient.token(project.repository_storage)
          },
          'GetBlobRequest' => {
            repository: repository.gitaly_repository.to_h,
            oid: blob.id,
            limit: -1
          }
        }.deep_stringify_keys)
      end
    end

430
    context 'when Gitaly workhorse_raw_show feature is disabled', :skip_gitaly_mock do
431 432 433 434 435 436 437 438 439
      it 'sets the header correctly' do
        key, command, params = decode_workhorse_header(subject)

        expect(key).to eq('Gitlab-Workhorse-Send-Data')
        expect(command).to eq('git-blob')
        expect(params).to eq('RepoPath' => repository.path_to_repo, 'BlobId' => blob.id)
      end
    end
  end
440
end