BigW Consortium Gitlab

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

3
describe API::Helpers, api: true do
4
  include API::APIGuard::HelperMethods
5
  include API::Helpers
6
  include SentryHelper
7

8 9 10 11 12
  let(:user) { create(:user) }
  let(:admin) { create(:admin) }
  let(:key) { create(:key, user: user) }

  let(:params) { {} }
13 14
  let(:env) { { 'REQUEST_METHOD' => 'GET' } }
  let(:request) { Rack::Request.new(env) }
15

16
  def set_env(user_or_token, identifier)
17 18
    clear_env
    clear_param
19
    env[API::APIGuard::PRIVATE_TOKEN_HEADER] = user_or_token.respond_to?(:private_token) ? user_or_token.private_token : user_or_token
20
    env[API::Helpers::SUDO_HEADER] = identifier.to_s
21 22
  end

23
  def set_param(user_or_token, identifier)
24 25
    clear_env
    clear_param
26
    params[API::APIGuard::PRIVATE_TOKEN_PARAM] = user_or_token.respond_to?(:private_token) ? user_or_token.private_token : user_or_token
27
    params[API::Helpers::SUDO_PARAM] = identifier.to_s
28 29 30
  end

  def clear_env
31
    env.delete(API::APIGuard::PRIVATE_TOKEN_HEADER)
32
    env.delete(API::Helpers::SUDO_HEADER)
33 34 35
  end

  def clear_param
36
    params.delete(API::APIGuard::PRIVATE_TOKEN_PARAM)
37
    params.delete(API::Helpers::SUDO_PARAM)
38 39
  end

40 41 42 43 44 45 46 47 48
  def warden_authenticate_returns(value)
    warden = double("warden", authenticate: value)
    env['warden'] = warden
  end

  def doorkeeper_guard_returns(value)
    allow_any_instance_of(self.class).to receive(:doorkeeper_guard){ value }
  end

49
  def error!(message, status)
50
    raise Exception.new("#{status} - #{message}")
51 52 53
  end

  describe ".current_user" do
54 55
    subject { current_user }

56
    describe "Warden authentication" do
57 58
      before { doorkeeper_guard_returns false }

59 60 61 62 63
      context "with invalid credentials" do
        context "GET request" do
          before { env['REQUEST_METHOD'] = 'GET' }
          it { is_expected.to be_nil }
        end
64 65
      end

66
      context "with valid credentials" do
67 68
        before { warden_authenticate_returns user }

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
        context "GET request" do
          before { env['REQUEST_METHOD'] = 'GET' }
          it { is_expected.to eq(user) }
        end

        context "HEAD request" do
          before { env['REQUEST_METHOD'] = 'HEAD' }
          it { is_expected.to eq(user) }
        end

        context "PUT request" do
          before { env['REQUEST_METHOD'] = 'PUT' }
          it { is_expected.to be_nil }
        end

        context "POST request" do
          before { env['REQUEST_METHOD'] = 'POST' }
          it { is_expected.to be_nil }
        end

        context "DELETE request" do
          before { env['REQUEST_METHOD'] = 'DELETE' }
          it { is_expected.to be_nil }
        end
93 94 95
      end
    end

96
    describe "when authenticating using a user's private token" do
97
      it "returns nil for an invalid token" do
98
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = 'invalid token'
99
        allow_any_instance_of(self.class).to receive(:doorkeeper_guard){ false }
100

101 102 103
        expect(current_user).to be_nil
      end

104
      it "returns nil for a user without access" do
105
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = user.private_token
106
        allow_any_instance_of(Gitlab::UserAccess).to receive(:allowed?).and_return(false)
107

108 109
        expect(current_user).to be_nil
      end
110

111
      it "leaves user as is when sudo not specified" do
112
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = user.private_token
113

114
        expect(current_user).to eq(user)
115

116
        clear_env
117

118
        params[API::APIGuard::PRIVATE_TOKEN_PARAM] = user.private_token
119

120 121
        expect(current_user).to eq(user)
      end
122 123
    end

124 125 126
    describe "when authenticating using a user's personal access tokens" do
      let(:personal_access_token) { create(:personal_access_token, user: user) }

127 128 129 130
      before do
        allow_any_instance_of(self.class).to receive(:doorkeeper_guard) { false }
      end

131
      it "returns nil for an invalid token" do
132
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = 'invalid token'
133

134 135 136
        expect(current_user).to be_nil
      end

137
      it "returns nil for a user without access" do
138
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
139
        allow_any_instance_of(Gitlab::UserAccess).to receive(:allowed?).and_return(false)
140

141 142 143
        expect(current_user).to be_nil
      end

144 145 146 147
      it "returns nil for a token without the appropriate scope" do
        personal_access_token = create(:personal_access_token, user: user, scopes: ['read_user'])
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
        allow_access_with_scope('write_user')
148

149 150 151
        expect(current_user).to be_nil
      end

152
      it "leaves user as is when sudo not specified" do
153
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
154 155
        expect(current_user).to eq(user)
        clear_env
156
        params[API::APIGuard::PRIVATE_TOKEN_PARAM] = personal_access_token.token
157

158 159 160 161 162
        expect(current_user).to eq(user)
      end

      it 'does not allow revoked tokens' do
        personal_access_token.revoke!
163
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
164

165 166 167 168 169
        expect(current_user).to be_nil
      end

      it 'does not allow expired tokens' do
        personal_access_token.update_attributes!(expires_at: 1.day.ago)
170
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
171

172 173
        expect(current_user).to be_nil
      end
174 175
    end

176 177 178 179 180 181
    context 'sudo usage' do
      context 'with admin' do
        context 'with header' do
          context 'with id' do
            it 'changes current_user to sudo' do
              set_env(admin, user.id)
182

183 184
              expect(current_user).to eq(user)
            end
185

186 187 188 189 190 191 192
            it 'memoize the current_user: sudo permissions are not run against the sudoed user' do
              set_env(admin, user.id)

              expect(current_user).to eq(user)
              expect(current_user).to eq(user)
            end

193 194
            it 'handles sudo to oneself' do
              set_env(admin, admin.id)
195

196 197
              expect(current_user).to eq(admin)
            end
198

199 200 201 202
            it 'throws an error when user cannot be found' do
              id = user.id + admin.id
              expect(user.id).not_to eq(id)
              expect(admin.id).not_to eq(id)
203

204
              set_env(admin, id)
205

206 207 208
              expect { current_user }.to raise_error(Exception)
            end
          end
209

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 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
          context 'with username' do
            it 'changes current_user to sudo' do
              set_env(admin, user.username)

              expect(current_user).to eq(user)
            end

            it 'handles sudo to oneself' do
              set_env(admin, admin.username)

              expect(current_user).to eq(admin)
            end

            it "throws an error when the user cannot be found for a given username" do
              username = "#{user.username}#{admin.username}"
              expect(user.username).not_to eq(username)
              expect(admin.username).not_to eq(username)

              set_env(admin, username)

              expect { current_user }.to raise_error(Exception)
            end
          end
        end

        context 'with param' do
          context 'with id' do
            it 'changes current_user to sudo' do
              set_param(admin, user.id)

              expect(current_user).to eq(user)
            end

            it 'handles sudo to oneself' do
              set_param(admin, admin.id)

              expect(current_user).to eq(admin)
            end

            it 'handles sudo to oneself using string' do
              set_env(admin, user.id.to_s)

              expect(current_user).to eq(user)
            end

            it 'throws an error when user cannot be found' do
              id = user.id + admin.id
              expect(user.id).not_to eq(id)
              expect(admin.id).not_to eq(id)
259

260
              set_param(admin, id)
261

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
              expect { current_user }.to raise_error(Exception)
            end
          end

          context 'with username' do
            it 'changes current_user to sudo' do
              set_param(admin, user.username)

              expect(current_user).to eq(user)
            end

            it 'handles sudo to oneself' do
              set_param(admin, admin.username)

              expect(current_user).to eq(admin)
            end

            it "throws an error when the user cannot be found for a given username" do
              username = "#{user.username}#{admin.username}"
              expect(user.username).not_to eq(username)
              expect(admin.username).not_to eq(username)

              set_param(admin, username)

              expect { current_user }.to raise_error(Exception)
            end
          end
        end
      end

      context 'with regular user' do
        context 'with env' do
          it 'changes current_user to sudo when admin and user id' do
            set_env(user, admin.id)

            expect { current_user }.to raise_error(Exception)
          end

          it 'changes current_user to sudo when admin and user username' do
            set_env(user, admin.username)

            expect { current_user }.to raise_error(Exception)
          end
        end

        context 'with params' do
          it 'changes current_user to sudo when admin and user id' do
            set_param(user, admin.id)

            expect { current_user }.to raise_error(Exception)
          end

          it 'changes current_user to sudo when admin and user username' do
            set_param(user, admin.username)

            expect { current_user }.to raise_error(Exception)
          end
        end
      end
321 322 323
    end
  end

324 325 326 327 328 329 330 331 332
  describe '.sudo?' do
    context 'when no sudo env or param is passed' do
      before do
        doorkeeper_guard_returns(nil)
      end

      it 'returns false' do
        expect(sudo?).to be_falsy
      end
333 334
    end

335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
    context 'when sudo env or param is passed', 'user is not an admin' do
      before do
        set_env(user, '123')
      end

      it 'returns an 403 Forbidden' do
        expect { sudo? }.to raise_error '403 - {"message"=>"403 Forbidden  - Must be admin to use sudo"}'
      end
    end

    context 'when sudo env or param is passed', 'user is admin' do
      context 'personal access token is used' do
        before do
          personal_access_token = create(:personal_access_token, user: admin)
          set_env(personal_access_token.token, user.id)
        end

        it 'returns an 403 Forbidden' do
          expect { sudo? }.to raise_error '403 - {"message"=>"403 Forbidden  - Private token must be specified in order to use sudo"}'
        end
      end

      context 'private access token is used' do
        before do
          set_env(admin.private_token, user.id)
        end

        it 'returns true' do
          expect(sudo?).to be_truthy
        end
      end
366 367
    end
  end
368

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
  describe '.handle_api_exception' do
    before do
      allow_any_instance_of(self.class).to receive(:sentry_enabled?).and_return(true)
      allow_any_instance_of(self.class).to receive(:rack_response)
    end

    it 'does not report a MethodNotAllowed exception to Sentry' do
      exception = Grape::Exceptions::MethodNotAllowed.new({ 'X-GitLab-Test' => '1' })
      allow(exception).to receive(:backtrace).and_return(caller)

      expect(Raven).not_to receive(:capture_exception).with(exception)

      handle_api_exception(exception)
    end

    it 'does report RuntimeError to Sentry' do
      exception = RuntimeError.new('test error')
      allow(exception).to receive(:backtrace).and_return(caller)

      expect_any_instance_of(self.class).to receive(:sentry_context)
      expect(Raven).to receive(:capture_exception).with(exception)

      handle_api_exception(exception)
    end
  end
394 395 396 397 398

  describe '.authenticate_non_get!' do
    %w[HEAD GET].each do |method_name|
      context "method is #{method_name}" do
        before do
399
          expect_any_instance_of(self.class).to receive(:route).and_return(double(request_method: method_name))
400 401 402 403 404 405 406 407 408 409 410 411 412
        end

        it 'does not raise an error' do
          expect_any_instance_of(self.class).not_to receive(:authenticate!)

          expect { authenticate_non_get! }.not_to raise_error
        end
      end
    end

    %w[POST PUT PATCH DELETE].each do |method_name|
      context "method is #{method_name}" do
        before do
413
          expect_any_instance_of(self.class).to receive(:route).and_return(double(request_method: method_name))
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
        end

        it 'calls authenticate!' do
          expect_any_instance_of(self.class).to receive(:authenticate!)

          authenticate_non_get!
        end
      end
    end
  end

  describe '.authenticate!' do
    context 'current_user is nil' do
      before do
        expect_any_instance_of(self.class).to receive(:current_user).and_return(nil)
      end

      it 'returns a 401 response' do
        expect { authenticate! }.to raise_error '401 - {"message"=>"401 Unauthorized"}'
      end
    end

    context 'current_user is present' do
      before do
        expect_any_instance_of(self.class).to receive(:current_user).and_return(true)
      end

      it 'does not raise an error' do
        expect { authenticate! }.not_to raise_error
      end
    end
  end
446
end