Welcome to mirror list, hosted at ThFree Co, Russian Federation.

asset_proxy_filter_spec.rb « filter « banzai « lib « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 7a34bf13c8f8effd443316b18706d484952ec0b2 (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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Banzai::Filter::AssetProxyFilter, feature_category: :team_planning do
  include FilterSpecHelper

  def image(path)
    %(<img src="#{path}" />)
  end

  it 'does not replace if disabled' do
    stub_asset_proxy_setting(enabled: false)

    context = described_class.transform_context({})
    src     = 'http://example.com/test.png'
    doc     = filter(image(src), context)

    expect(doc.at_css('img')['src']).to eq src
  end

  context 'during initialization' do
    after do
      Gitlab.config.asset_proxy['enabled'] = false
    end

    it '#initialize_settings' do
      stub_application_setting(asset_proxy_enabled: true)
      stub_application_setting(asset_proxy_secret_key: 'shared-secret')
      stub_application_setting(asset_proxy_url: 'https://assets.example.com')
      stub_application_setting(asset_proxy_allowlist: %w(gitlab.com *.mydomain.com))

      described_class.initialize_settings

      expect(Gitlab.config.asset_proxy.enabled).to be_truthy
      expect(Gitlab.config.asset_proxy.secret_key).to eq 'shared-secret'
      expect(Gitlab.config.asset_proxy.url).to eq 'https://assets.example.com'
      expect(Gitlab.config.asset_proxy.allowlist).to eq %w(gitlab.com *.mydomain.com)
      expect(Gitlab.config.asset_proxy.domain_regexp).to eq(/^(gitlab\.com|.*?\.mydomain\.com)$/i)
    end

    context 'when allowlist is empty' do
      it 'defaults to the install domain' do
        stub_application_setting(asset_proxy_enabled: true)
        stub_application_setting(asset_proxy_allowlist: [])

        described_class.initialize_settings

        expect(Gitlab.config.asset_proxy.allowlist).to eq [Gitlab.config.gitlab.host]
      end
    end

    it 'supports deprecated whitelist settings' do
      stub_application_setting(asset_proxy_enabled: true)
      stub_application_setting(asset_proxy_whitelist: %w(foo.com bar.com))
      stub_application_setting(asset_proxy_allowlist: [])

      described_class.initialize_settings

      expect(Gitlab.config.asset_proxy.allowlist).to eq %w(foo.com bar.com)
    end
  end

  context 'when properly configured' do
    before do
      stub_asset_proxy_setting(enabled: true)
      stub_asset_proxy_setting(secret_key: 'shared-secret')
      stub_asset_proxy_setting(url: 'https://assets.example.com')
      stub_asset_proxy_setting(allowlist: %W(gitlab.com *.mydomain.com #{Gitlab.config.gitlab.host}))
      stub_asset_proxy_setting(domain_regexp: described_class.compile_allowlist(Gitlab.config.asset_proxy.allowlist))
      @context = described_class.transform_context({})
    end

    it 'replaces img src' do
      src     = 'http://example.com/test.png'
      new_src = 'https://assets.example.com/08df250eeeef1a8cf2c761475ac74c5065105612/687474703a2f2f6578616d706c652e636f6d2f746573742e706e67'
      doc     = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq new_src
      expect(doc.at_css('img')['data-canonical-src']).to eq src
    end

    it 'replaces invalid URLs' do
      src     = '///example.com/test.png'
      new_src = 'https://assets.example.com/3368d2c7b9bed775bdd1e811f36a4b80a0dcd8ab/2f2f2f6578616d706c652e636f6d2f746573742e706e67'
      doc     = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq new_src
      expect(doc.at_css('img')['data-canonical-src']).to eq src
    end

    it 'replaces by default, even strings that do not look like URLs' do
      src     = 'oigjsie8787%$**(#(%0'
      new_src = 'https://assets.example.com/1b893f9a71d66c99437f27e19b9a061a6f5d9391/6f69676a7369653837383725242a2a2823282530'
      doc     = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq new_src
      expect(doc.at_css('img')['data-canonical-src']).to eq src
    end

    it 'replaces URL with non-ASCII characters' do
      src     = 'https://example.com/x?¬'
      new_src = 'https://assets.example.com/2f29a8c7f13f3ae14dc18c154dbbd657d703e75f/68747470733a2f2f6578616d706c652e636f6d2f783fc2ac'
      doc     = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq new_src
      expect(doc.at_css('img')['data-canonical-src']).to eq src
    end

    it 'replaces out-of-spec URL that would still be rendered in the browser' do
      src     = 'https://example.com/##'
      new_src = 'https://assets.example.com/d7d0c845cc553d9430804c07e9456545ef3e6fe6/68747470733a2f2f6578616d706c652e636f6d2f2323'
      doc     = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq new_src
      expect(doc.at_css('img')['data-canonical-src']).to eq src
    end

    it 'skips internal images' do
      src      = "#{Gitlab.config.gitlab.url}/test.png"
      doc      = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq src
    end

    it 'skip relative urls' do
      src = "/test.png"
      doc = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq src
    end

    it 'skips single domain' do
      src = "http://gitlab.com/test.png"
      doc = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq src
    end

    it 'skips single domain and ignores url in query string' do
      src = "http://gitlab.com/test.png?url=http://example.com/test.png"
      doc = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq src
    end

    it 'skips wildcarded domain' do
      src = "http://images.mydomain.com/test.png"
      doc = filter(image(src), @context)

      expect(doc.at_css('img')['src']).to eq src
    end
  end
end