summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/object_hierarchy_spec.rb
blob: 08e1a5ee0a3b966402fa84d85aaec3a0d58a01b4 (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
209
210
211
212
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::ObjectHierarchy do
  let!(:parent) { create(:group) }
  let!(:child1) { create(:group, parent: parent) }
  let!(:child2) { create(:group, parent: child1) }

  shared_context 'Gitlab::ObjectHierarchy test cases' do
    describe '#base_and_ancestors' do
      let(:relation) do
        described_class.new(Group.where(id: child2.id)).base_and_ancestors
      end

      it 'includes the base rows' do
        expect(relation).to include(child2)
      end

      it 'includes all of the ancestors' do
        expect(relation).to include(parent, child1)
      end

      it 'can find ancestors upto a certain level' do
        relation = described_class.new(Group.where(id: child2)).base_and_ancestors(upto: child1)

        expect(relation).to contain_exactly(child2)
      end

      it 'uses ancestors_base #initialize argument' do
        relation = described_class.new(Group.where(id: child2.id), Group.none).base_and_ancestors

        expect(relation).to include(parent, child1, child2)
      end

      it 'does not allow the use of #update_all' do
        expect { relation.update_all(share_with_group_lock: false) }
          .to raise_error(ActiveRecord::ReadOnlyRecord)
      end

      describe 'hierarchy_order option' do
        let(:relation) do
          described_class.new(Group.where(id: child2.id)).base_and_ancestors(hierarchy_order: hierarchy_order)
        end

        context ':asc' do
          let(:hierarchy_order) { :asc }

          it 'orders by child to parent' do
            expect(relation).to eq([child2, child1, parent])
          end
        end

        context ':desc' do
          let(:hierarchy_order) { :desc }

          it 'orders by parent to child' do
            expect(relation).to eq([parent, child1, child2])
          end
        end
      end
    end

    describe '#base_and_descendants' do
      let(:relation) do
        described_class.new(Group.where(id: parent.id)).base_and_descendants
      end

      it 'includes the base rows' do
        expect(relation).to include(parent)
      end

      it 'includes all the descendants' do
        expect(relation).to include(child1, child2)
      end

      it 'uses descendants_base #initialize argument' do
        relation = described_class.new(Group.none, Group.where(id: parent.id)).base_and_descendants

        expect(relation).to include(parent, child1, child2)
      end

      it 'does not allow the use of #update_all' do
        expect { relation.update_all(share_with_group_lock: false) }
          .to raise_error(ActiveRecord::ReadOnlyRecord)
      end

      context 'when with_depth is true' do
        let(:relation) do
          described_class.new(Group.where(id: parent.id)).base_and_descendants(with_depth: true)
        end

        it 'includes depth in the results' do
          object_depths = {
            parent.id => 1,
            child1.id => 2,
            child2.id => 3
          }

          relation.each do |object|
            expect(object.depth).to eq(object_depths[object.id])
          end
        end
      end
    end

    describe '#descendants' do
      it 'includes only the descendants' do
        relation = described_class.new(Group.where(id: parent)).descendants

        expect(relation).to contain_exactly(child1, child2)
      end
    end

    describe '#max_descendants_depth' do
      subject { described_class.new(base_relation).max_descendants_depth }

      context 'when base relation is empty' do
        let(:base_relation) { Group.where(id: nil) }

        it { expect(subject).to be_nil }
      end

      context 'when base has no children' do
        let(:base_relation) { Group.where(id: child2) }

        it { expect(subject).to eq(1) }
      end

      context 'when base has grandchildren' do
        let(:base_relation) { Group.where(id: parent) }

        it { expect(subject).to eq(3) }
      end
    end

    describe '#ancestors' do
      it 'includes only the ancestors' do
        relation = described_class.new(Group.where(id: child2)).ancestors

        expect(relation).to contain_exactly(child1, parent)
      end

      it 'can find ancestors upto a certain level' do
        relation = described_class.new(Group.where(id: child2)).ancestors(upto: child1)

        expect(relation).to be_empty
      end
    end

    describe '#all_objects' do
      let(:relation) do
        described_class.new(Group.where(id: child1.id)).all_objects
      end

      it 'includes the base rows' do
        expect(relation).to include(child1)
      end

      it 'includes the ancestors' do
        expect(relation).to include(parent)
      end

      it 'includes the descendants' do
        expect(relation).to include(child2)
      end

      it 'uses ancestors_base #initialize argument for ancestors' do
        relation = described_class.new(Group.where(id: child1.id), Group.where(id: non_existing_record_id)).all_objects

        expect(relation).to include(parent)
      end

      it 'uses descendants_base #initialize argument for descendants' do
        relation = described_class.new(Group.where(id: non_existing_record_id), Group.where(id: child1.id)).all_objects

        expect(relation).to include(child2)
      end

      it 'does not allow the use of #update_all' do
        expect { relation.update_all(share_with_group_lock: false) }
          .to raise_error(ActiveRecord::ReadOnlyRecord)
      end
    end
  end

  context 'when the use_distinct_in_object_hierarchy feature flag is enabled' do
    before do
      stub_feature_flags(use_distinct_in_object_hierarchy: true)
    end

    it_behaves_like 'Gitlab::ObjectHierarchy test cases'

    it 'calls DISTINCT' do
      expect(parent.self_and_descendants.to_sql).to include("DISTINCT")
      expect(child2.self_and_ancestors.to_sql).to include("DISTINCT")
    end
  end

  context 'when the use_distinct_in_object_hierarchy feature flag is disabled' do
    before do
      stub_feature_flags(use_distinct_in_object_hierarchy: false)
    end

    it_behaves_like 'Gitlab::ObjectHierarchy test cases'

    it 'does not call DISTINCT' do
      expect(parent.self_and_descendants.to_sql).not_to include("DISTINCT")
      expect(child2.self_and_ancestors.to_sql).not_to include("DISTINCT")
    end
  end
end