summaryrefslogtreecommitdiff
path: root/spec/finders/concerns/finder_with_group_hierarchy_spec.rb
blob: c96e35372d6f842177742d6d01bab626705e6646 (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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe FinderWithGroupHierarchy do
  let(:finder_class) do
    Class.new do
      include FinderWithGroupHierarchy
      include Gitlab::Utils::StrongMemoize

      def initialize(current_user, params = {})
        @current_user = current_user
        @params = params
      end

      def execute(skip_authorization: false)
        @skip_authorization = skip_authorization

        item_ids
      end

      # normally an array of item ids would be returned,
      # however for this spec just return the group ids
      def item_ids
        group? ? group_ids_for(group) : []
      end

      private

      attr_reader :current_user, :params, :skip_authorization

      def read_permission
        :read_label
      end
    end
  end

  let_it_be(:parent_group) { create(:group) }
  let_it_be(:group) { create(:group, parent: parent_group) }
  let_it_be(:private_group) { create(:group, :private) }
  let_it_be(:private_subgroup) { create(:group, :private, parent: private_group) }

  let!(:user) { create(:user) }

  context 'when specifying group' do
    it 'returns only the group by default' do
      finder = finder_class.new(user, group: group)

      expect(finder.execute).to match_array([group.id])
    end
  end

  context 'when specifying group_id' do
    it 'returns only the group by default' do
      finder = finder_class.new(user, group_id: group.id)

      expect(finder.execute).to match_array([group.id])
    end
  end

  context 'when including items from group ancestors' do
    before do
      private_subgroup.add_developer(user)
    end

    it 'returns group and its ancestors' do
      private_group.add_developer(user)

      finder = finder_class.new(user, group: private_subgroup, include_ancestor_groups: true)

      expect(finder.execute).to match_array([private_group.id, private_subgroup.id])
    end

    it 'ignores groups which user can not read' do
      finder = finder_class.new(user, group: private_subgroup, include_ancestor_groups: true)

      expect(finder.execute).to match_array([private_subgroup.id])
    end

    it 'returns them all when skip_authorization is true' do
      finder = finder_class.new(user, group: private_subgroup, include_ancestor_groups: true)

      expect(finder.execute(skip_authorization: true)).to match_array([private_group.id, private_subgroup.id])
    end
  end

  context 'when including items from group descendants' do
    before do
      private_subgroup.add_developer(user)
    end

    it 'returns items from group and its descendants' do
      private_group.add_developer(user)

      finder = finder_class.new(user, group: private_group, include_descendant_groups: true)

      expect(finder.execute).to match_array([private_group.id, private_subgroup.id])
    end

    it 'ignores items from groups which user can not read' do
      finder = finder_class.new(user, group: private_group, include_descendant_groups: true)

      expect(finder.execute).to match_array([private_subgroup.id])
    end

    it 'returns them all when skip_authorization is true' do
      finder = finder_class.new(user, group: private_group, include_descendant_groups: true)

      expect(finder.execute(skip_authorization: true)).to match_array([private_group.id, private_subgroup.id])
    end
  end

  context 'with N+1 query check' do
    def run_query(group)
      finder_class
        .new(user, group: group, include_descendant_groups: true)
        .execute
        .to_a

      RequestStore.clear!
    end

    it 'does not produce N+1 query', :request_store do
      private_group.add_developer(user)

      run_query(private_subgroup) # warmup
      control = ActiveRecord::QueryRecorder.new { run_query(private_subgroup) }

      expect { run_query(private_group) }.not_to exceed_query_limit(control)
    end
  end

  context 'when preload_max_access_levels_for_labels_finder is disabled' do
    # All test cases were copied from above, these will be removed once the FF is removed.

    before do
      stub_feature_flags(preload_max_access_levels_for_labels_finder: false)
    end

    context 'when specifying group' do
      it 'returns only the group by default' do
        finder = finder_class.new(user, group: group)

        expect(finder.execute).to match_array([group.id])
      end
    end

    context 'when specifying group_id' do
      it 'returns only the group by default' do
        finder = finder_class.new(user, group_id: group.id)

        expect(finder.execute).to match_array([group.id])
      end
    end

    context 'when including items from group ancestors' do
      before do
        private_subgroup.add_developer(user)
      end

      it 'returns group and its ancestors' do
        private_group.add_developer(user)

        finder = finder_class.new(user, group: private_subgroup, include_ancestor_groups: true)

        expect(finder.execute).to match_array([private_group.id, private_subgroup.id])
      end

      it 'ignores groups which user can not read' do
        finder = finder_class.new(user, group: private_subgroup, include_ancestor_groups: true)

        expect(finder.execute).to match_array([private_subgroup.id])
      end

      it 'returns them all when skip_authorization is true' do
        finder = finder_class.new(user, group: private_subgroup, include_ancestor_groups: true)

        expect(finder.execute(skip_authorization: true)).to match_array([private_group.id, private_subgroup.id])
      end
    end

    context 'when including items from group descendants' do
      before do
        private_subgroup.add_developer(user)
      end

      it 'returns items from group and its descendants' do
        private_group.add_developer(user)

        finder = finder_class.new(user, group: private_group, include_descendant_groups: true)

        expect(finder.execute).to match_array([private_group.id, private_subgroup.id])
      end

      it 'ignores items from groups which user can not read' do
        finder = finder_class.new(user, group: private_group, include_descendant_groups: true)

        expect(finder.execute).to match_array([private_subgroup.id])
      end

      it 'returns them all when skip_authorization is true' do
        finder = finder_class.new(user, group: private_group, include_descendant_groups: true)

        expect(finder.execute(skip_authorization: true)).to match_array([private_group.id, private_subgroup.id])
      end
    end
  end
end