summaryrefslogtreecommitdiff
path: root/spec/support/shared_examples/controllers/sessionless_auth_controller_shared_examples.rb
blob: 041695d8111e65daf3b2e6b298719d76d80f92f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# frozen_string_literal: true

# This controller shared examples will be migrated to
# spec/support/shared_examples/requests/sessionless_auth_request_shared_examples.rb
# See also https://gitlab.com/groups/gitlab-org/-/epics/5076

RSpec.shared_examples 'authenticates sessionless user' do |path, format, params|
  params ||= {}

  before do
    stub_authentication_activity_metrics(debug: false)
  end

  let(:user) { create(:user) }
  let(:personal_access_token) { create(:personal_access_token, user: user) }
  let(:default_params) { { format: format }.merge(params.except(:public) || {}) }

  context "when the 'personal_access_token' param is populated with the personal access token" do
    it 'logs the user in' do
      expect(authentication_metrics)
        .to increment(:user_authenticated_counter)
              .and increment(:user_session_override_counter)
                     .and increment(:user_sessionless_authentication_counter)

      get path, params: default_params.merge(private_token: personal_access_token.token)

      expect(response).to have_gitlab_http_status(:ok)
      expect(controller.current_user).to eq(user)
    end

    it 'does not log the user in if page is public', if: params[:public] do
      get path, params: default_params

      expect(response).to have_gitlab_http_status(:ok)
      expect(controller.current_user).to be_nil
    end
  end

  context 'when the personal access token has no api scope', unless: params[:public] do
    it 'does not log the user in' do
      # Several instances of where these specs are shared route the request
      #   through ApplicationController#route_not_found which does not involve
      #   the usual auth code from Devise, so does not increment the
      #   :user_unauthenticated_counter
      #
      unless params[:ignore_incrementing]
        expect(authentication_metrics)
          .to increment(:user_unauthenticated_counter)
      end

      personal_access_token.update!(scopes: [:read_user])

      get path, params: default_params.merge(private_token: personal_access_token.token)

      expect(response).not_to have_gitlab_http_status(:ok)
    end
  end

  context "when the 'PERSONAL_ACCESS_TOKEN' header is populated with the personal access token" do
    it 'logs the user in' do
      expect(authentication_metrics)
        .to increment(:user_authenticated_counter)
              .and increment(:user_session_override_counter)
                     .and increment(:user_sessionless_authentication_counter)

      @request.headers['PRIVATE-TOKEN'] = personal_access_token.token
      get path, params: default_params

      expect(response).to have_gitlab_http_status(:ok)
    end
  end

  context "when the 'feed_token' param is populated with the feed token", if: format == :rss do
    it "logs the user in" do
      expect(authentication_metrics)
        .to increment(:user_authenticated_counter)
              .and increment(:user_session_override_counter)
                     .and increment(:user_sessionless_authentication_counter)

      get path, params: default_params.merge(feed_token: user.feed_token)

      expect(response).to have_gitlab_http_status(:ok)
    end
  end

  context "when the 'feed_token' param is populated with an invalid feed token", if: format == :rss, unless: params[:public] do
    it "logs the user" do
      expect(authentication_metrics)
        .to increment(:user_unauthenticated_counter)

      get path, params: default_params.merge(feed_token: 'token')

      expect(response).not_to have_gitlab_http_status(:ok)
    end
  end

  it "doesn't log the user in otherwise", unless: params[:public] do
    # Several instances of where these specs are shared route the request
    #   through ApplicationController#route_not_found which does not involve
    #   the usual auth code from Devise, so does not increment the
    #   :user_unauthenticated_counter
    #
    unless params[:ignore_incrementing]
      expect(authentication_metrics)
        .to increment(:user_unauthenticated_counter)
    end

    get path, params: default_params.merge(private_token: 'token')

    expect(response).not_to have_gitlab_http_status(:ok)
  end
end