summaryrefslogtreecommitdiff
path: root/spec/models/pages/lookup_path_spec.rb
blob: 9e65635da91b296266c7d78be38d434eb3bd4966 (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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Pages::LookupPath do
  let(:project) { create(:project, :pages_private, pages_https_only: true) }

  subject(:lookup_path) { described_class.new(project) }

  before do
    stub_pages_setting(access_control: true, external_https: ["1.1.1.1:443"])
    stub_pages_object_storage(::Pages::DeploymentUploader)
  end

  describe '#project_id' do
    it 'delegates to Project#id' do
      expect(lookup_path.project_id).to eq(project.id)
    end
  end

  describe '#access_control' do
    it 'delegates to Project#private_pages?' do
      expect(lookup_path.access_control).to eq(true)
    end
  end

  describe '#https_only' do
    subject(:lookup_path) { described_class.new(project, domain: domain) }

    context 'when no domain provided' do
      let(:domain) { nil }

      it 'delegates to Project#pages_https_only?' do
        expect(lookup_path.https_only).to eq(true)
      end
    end

    context 'when there is domain provided' do
      let(:domain) { instance_double(PagesDomain, https?: false) }

      it 'takes into account the https setting of the domain' do
        expect(lookup_path.https_only).to eq(false)
      end
    end
  end

  describe '#source' do
    let(:source) { lookup_path.source }

    shared_examples 'uses disk storage' do
      it 'uses disk storage', :aggregate_failures do
        expect(source[:type]).to eq('file')
        expect(source[:path]).to eq(project.full_path + "/public/")
      end
    end

    include_examples 'uses disk storage'

    it 'return nil when legacy storage is disabled and there is no deployment' do
      stub_feature_flags(pages_serve_from_legacy_storage: false)
      expect(Gitlab::ErrorTracking).to receive(:track_exception)
                                         .with(described_class::LegacyStorageDisabledError)
                                         .and_call_original

      expect(source).to eq(nil)
    end

    context 'when there is pages deployment' do
      let(:deployment) { create(:pages_deployment, project: project) }

      before do
        project.mark_pages_as_deployed
        project.pages_metadatum.update!(pages_deployment: deployment)
      end

      it 'uses deployment from object storage' do
        freeze_time do
          expect(source).to(
            eq({
                 type: 'zip',
                 path: deployment.file.url(expire_at: 1.day.from_now),
                 global_id: "gid://gitlab/PagesDeployment/#{deployment.id}",
                 sha256: deployment.file_sha256,
                 file_size: deployment.size,
                 file_count: deployment.file_count
               })
          )
        end
      end

      context 'when deployment is in the local storage' do
        before do
          deployment.file.migrate!(::ObjectStorage::Store::LOCAL)
        end

        it 'uses file protocol' do
          freeze_time do
            expect(source).to(
              eq({
                   type: 'zip',
                   path: 'file://' + deployment.file.path,
                   global_id: "gid://gitlab/PagesDeployment/#{deployment.id}",
                   sha256: deployment.file_sha256,
                   file_size: deployment.size,
                   file_count: deployment.file_count
                 })
            )
          end
        end

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

          include_examples 'uses disk storage'
        end
      end

      context 'when deployment were created during migration' do
        before do
          allow(deployment).to receive(:migrated?).and_return(true)
        end

        it 'uses deployment from object storage' do
          freeze_time do
            expect(source).to(
              eq({
                   type: 'zip',
                   path: deployment.file.url(expire_at: 1.day.from_now),
                   global_id: "gid://gitlab/PagesDeployment/#{deployment.id}",
                   sha256: deployment.file_sha256,
                   file_size: deployment.size,
                   file_count: deployment.file_count
                 })
            )
          end
        end

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

          include_examples 'uses disk storage'
        end
      end
    end
  end

  describe '#prefix' do
    it 'returns "/" for pages group root projects' do
      project = instance_double(Project, pages_group_root?: true)
      lookup_path = described_class.new(project, trim_prefix: 'mygroup')

      expect(lookup_path.prefix).to eq('/')
    end

    it 'returns the project full path with the provided prefix removed' do
      project = instance_double(Project, pages_group_root?: false, full_path: 'mygroup/myproject')
      lookup_path = described_class.new(project, trim_prefix: 'mygroup')

      expect(lookup_path.prefix).to eq('/myproject/')
    end
  end
end