settings_spec.rb 12.7 KB
Newer Older
1 2
require 'spec_helper'

3
describe API::Settings, 'Settings' do
4
  let(:user) { create(:user) }
5
  set(:admin) { create(:admin) }
6

7
  describe "GET /application/settings" do
8
    it "returns application settings" do
9
      get api("/application/settings", admin)
10

11
      expect(response).to have_gitlab_http_status(200)
12 13
      expect(json_response).to be_an Hash
      expect(json_response['default_projects_limit']).to eq(42)
14
      expect(json_response['password_authentication_enabled_for_web']).to be_truthy
15
      expect(json_response['repository_storages']).to eq(['default'])
16
      expect(json_response['password_authentication_enabled']).to be_truthy
17 18
      expect(json_response['plantuml_enabled']).to be_falsey
      expect(json_response['plantuml_url']).to be_nil
19 20 21
      expect(json_response['default_project_visibility']).to be_a String
      expect(json_response['default_snippet_visibility']).to be_a String
      expect(json_response['default_group_visibility']).to be_a String
22 23 24 25
      expect(json_response['rsa_key_restriction']).to eq(0)
      expect(json_response['dsa_key_restriction']).to eq(0)
      expect(json_response['ecdsa_key_restriction']).to eq(0)
      expect(json_response['ed25519_key_restriction']).to eq(0)
26
      expect(json_response['performance_bar_allowed_group_id']).to be_nil
27
      expect(json_response['instance_statistics_visibility_private']).to be(false)
28 29 30
      expect(json_response['allow_local_requests_from_hooks_and_services']).to be(false)
      expect(json_response['allow_local_requests_from_web_hooks_and_services']).to be(false)
      expect(json_response['allow_local_requests_from_system_hooks']).to be(true)
31 32
      expect(json_response).not_to have_key('performance_bar_allowed_group_path')
      expect(json_response).not_to have_key('performance_bar_enabled')
33
    end
34 35
  end

36
  describe "PUT /application/settings" do
37 38
    let(:group) { create(:group) }

39 40
    context "custom repository storage type set in the config" do
      before do
41 42 43
        # Add a possible storage to the config
        storages = Gitlab.config.repositories.storages
                     .merge({ 'custom' => 'tmp/tests/custom_repositories' })
44 45 46 47 48
        allow(Gitlab.config.repositories).to receive(:storages).and_return(storages)
      end

      it "updates application settings" do
        put api("/application/settings", admin),
blackst0ne's avatar
blackst0ne committed
49 50
          params: {
            default_projects_limit: 3,
Gosia Ksionek's avatar
Gosia Ksionek committed
51
            default_project_creation: 2,
blackst0ne's avatar
blackst0ne committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
            password_authentication_enabled_for_web: false,
            repository_storages: ['custom'],
            plantuml_enabled: true,
            plantuml_url: 'http://plantuml.example.com',
            default_snippet_visibility: 'internal',
            restricted_visibility_levels: ['public'],
            default_artifacts_expire_in: '2 days',
            help_page_text: 'custom help text',
            help_page_hide_commercial_content: true,
            help_page_support_url: 'http://example.com/help',
            project_export_enabled: false,
            rsa_key_restriction: ApplicationSetting::FORBIDDEN_KEY_VALUE,
            dsa_key_restriction: 2048,
            ecdsa_key_restriction: 384,
            ed25519_key_restriction: 256,
            enforce_terms: true,
            terms: 'Hello world!',
            performance_bar_allowed_group_path: group.full_path,
            instance_statistics_visibility_private: true,
71
            diff_max_patch_bytes: 150_000,
Gosia Ksionek's avatar
Gosia Ksionek committed
72
            default_branch_protection: ::Gitlab::Access::PROTECTION_DEV_CAN_MERGE,
73 74
            local_markdown_version: 3,
            allow_local_requests_from_web_hooks_and_services: true,
75
            allow_local_requests_from_system_hooks: false,
76 77
            push_event_hooks_limit: 2,
            push_event_activities_limit: 2
blackst0ne's avatar
blackst0ne committed
78
          }
79

80
        expect(response).to have_gitlab_http_status(200)
81
        expect(json_response['default_projects_limit']).to eq(3)
Gosia Ksionek's avatar
Gosia Ksionek committed
82
        expect(json_response['default_project_creation']).to eq(::Gitlab::Access::DEVELOPER_MAINTAINER_PROJECT_ACCESS)
83
        expect(json_response['password_authentication_enabled_for_web']).to be_falsey
84
        expect(json_response['repository_storages']).to eq(['custom'])
85 86
        expect(json_response['plantuml_enabled']).to be_truthy
        expect(json_response['plantuml_url']).to eq('http://plantuml.example.com')
87 88
        expect(json_response['default_snippet_visibility']).to eq('internal')
        expect(json_response['restricted_visibility_levels']).to eq(['public'])
89
        expect(json_response['default_artifacts_expire_in']).to eq('2 days')
90 91 92
        expect(json_response['help_page_text']).to eq('custom help text')
        expect(json_response['help_page_hide_commercial_content']).to be_truthy
        expect(json_response['help_page_support_url']).to eq('http://example.com/help')
93
        expect(json_response['project_export_enabled']).to be_falsey
94 95 96 97
        expect(json_response['rsa_key_restriction']).to eq(ApplicationSetting::FORBIDDEN_KEY_VALUE)
        expect(json_response['dsa_key_restriction']).to eq(2048)
        expect(json_response['ecdsa_key_restriction']).to eq(384)
        expect(json_response['ed25519_key_restriction']).to eq(256)
98 99
        expect(json_response['enforce_terms']).to be(true)
        expect(json_response['terms']).to eq('Hello world!')
100
        expect(json_response['performance_bar_allowed_group_id']).to eq(group.id)
101
        expect(json_response['instance_statistics_visibility_private']).to be(true)
102
        expect(json_response['diff_max_patch_bytes']).to eq(150_000)
103
        expect(json_response['default_branch_protection']).to eq(Gitlab::Access::PROTECTION_DEV_CAN_MERGE)
Jan Provaznik's avatar
Jan Provaznik committed
104
        expect(json_response['local_markdown_version']).to eq(3)
105 106
        expect(json_response['allow_local_requests_from_web_hooks_and_services']).to eq(true)
        expect(json_response['allow_local_requests_from_system_hooks']).to eq(false)
107
        expect(json_response['push_event_hooks_limit']).to eq(2)
108
        expect(json_response['push_event_activities_limit']).to eq(2)
109
      end
110 111
    end

112 113
    it "supports legacy performance_bar_allowed_group_id" do
      put api("/application/settings", admin),
blackst0ne's avatar
blackst0ne committed
114
        params: { performance_bar_allowed_group_id: group.full_path }
115 116 117 118 119 120 121

      expect(response).to have_gitlab_http_status(200)
      expect(json_response['performance_bar_allowed_group_id']).to eq(group.id)
    end

    it "supports legacy performance_bar_enabled" do
      put api("/application/settings", admin),
blackst0ne's avatar
blackst0ne committed
122 123 124 125
        params: {
          performance_bar_enabled: false,
          performance_bar_allowed_group_id: group.full_path
        }
126 127 128 129 130

      expect(response).to have_gitlab_http_status(200)
      expect(json_response['performance_bar_allowed_group_id']).to be_nil
    end

131 132 133 134 135 136 137 138
    it 'supports legacy allow_local_requests_from_hooks_and_services' do
      put api("/application/settings", admin),
          params: { allow_local_requests_from_hooks_and_services: true }

      expect(response).to have_gitlab_http_status(200)
      expect(json_response['allow_local_requests_from_hooks_and_services']).to eq(true)
    end

139 140 141 142 143 144 145 146 147 148 149 150
    context 'external policy classification settings' do
      let(:settings) do
        {
          external_authorization_service_enabled: true,
          external_authorization_service_url: 'https://custom.service/',
          external_authorization_service_default_label: 'default',
          external_authorization_service_timeout: 9.99,
          external_auth_client_cert: File.read('spec/fixtures/passphrase_x509_certificate.crt'),
          external_auth_client_key: File.read('spec/fixtures/passphrase_x509_certificate_pk.key'),
          external_auth_client_key_pass: "5iveL!fe"
        }
      end
151

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
      let(:attribute_names) { settings.keys.map(&:to_s) }

      it 'includes the attributes in the API' do
        get api("/application/settings", admin)

        expect(response).to have_gitlab_http_status(200)
        attribute_names.each do |attribute|
          expect(json_response.keys).to include(attribute)
        end
      end

      it 'allows updating the settings' do
        put api("/application/settings", admin), params: settings

        expect(response).to have_gitlab_http_status(200)
        settings.each do |attribute, value|
          expect(ApplicationSetting.current.public_send(attribute)).to eq(value)
        end
      end
    end

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 213 214 215 216 217 218 219 220 221 222
    context "snowplow tracking settings" do
      let(:settings) do
        {
          snowplow_collector_hostname: "snowplow.example.com",
          snowplow_cookie_domain: ".example.com",
          snowplow_enabled: true,
          snowplow_site_id: "site_id"
        }
      end

      let(:attribute_names) { settings.keys.map(&:to_s) }

      it "includes the attributes in the API" do
        get api("/application/settings", admin)

        expect(response).to have_gitlab_http_status(200)
        attribute_names.each do |attribute|
          expect(json_response.keys).to include(attribute)
        end
      end

      it "allows updating the settings" do
        put api("/application/settings", admin), params: settings

        expect(response).to have_gitlab_http_status(200)
        settings.each do |attribute, value|
          expect(ApplicationSetting.current.public_send(attribute)).to eq(value)
        end
      end

      context "missing snowplow_collector_hostname value when snowplow_enabled is true" do
        it "returns a blank parameter error message" do
          put api("/application/settings", admin), params: { snowplow_enabled: true }

          expect(response).to have_gitlab_http_status(400)
          expect(json_response["error"]).to eq("snowplow_collector_hostname is missing")
        end

        it "handles validation errors" do
          put api("/application/settings", admin), params: settings.merge({
            snowplow_collector_hostname: nil
          })

          expect(response).to have_gitlab_http_status(400)
          message = json_response["message"]
          expect(message["snowplow_collector_hostname"]).to include("can't be blank")
        end
      end
    end

223 224
    context "missing plantuml_url value when plantuml_enabled is true" do
      it "returns a blank parameter error message" do
blackst0ne's avatar
blackst0ne committed
225
        put api("/application/settings", admin), params: { plantuml_enabled: true }
226

227
        expect(response).to have_gitlab_http_status(400)
228 229 230
        expect(json_response['error']).to eq('plantuml_url is missing')
      end
    end
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258

    context 'asset_proxy settings' do
      it 'updates application settings' do
        put api('/application/settings', admin),
          params: {
            asset_proxy_enabled: true,
            asset_proxy_url: 'http://assets.example.com',
            asset_proxy_secret_key: 'shared secret',
            asset_proxy_whitelist: ['example.com', '*.example.com']
          }

        expect(response).to have_gitlab_http_status(200)
        expect(json_response['asset_proxy_enabled']).to be(true)
        expect(json_response['asset_proxy_url']).to eq('http://assets.example.com')
        expect(json_response['asset_proxy_secret_key']).to be_nil
        expect(json_response['asset_proxy_whitelist']).to eq(['example.com', '*.example.com', 'localhost'])
      end

      it 'allows a string for asset_proxy_whitelist' do
        put api('/application/settings', admin),
          params: {
            asset_proxy_whitelist: 'example.com, *.example.com'
          }

        expect(response).to have_gitlab_http_status(200)
        expect(json_response['asset_proxy_whitelist']).to eq(['example.com', '*.example.com', 'localhost'])
      end
    end
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296

    context 'domain_blacklist settings' do
      it 'rejects domain_blacklist_enabled when domain_blacklist is empty' do
        put api('/application/settings', admin),
          params: {
            domain_blacklist_enabled: true,
            domain_blacklist: []
          }

        expect(response).to have_gitlab_http_status(400)
        message = json_response["message"]
        expect(message["domain_blacklist"]).to eq(["Domain blacklist cannot be empty if Blacklist is enabled."])
      end

      it 'allows array for domain_blacklist' do
        put api('/application/settings', admin),
          params: {
            domain_blacklist_enabled: true,
            domain_blacklist: ['domain1.com', 'domain2.com']
          }

        expect(response).to have_gitlab_http_status(200)
        expect(json_response['domain_blacklist_enabled']).to be(true)
        expect(json_response['domain_blacklist']).to eq(['domain1.com', 'domain2.com'])
      end

      it 'allows a string for domain_blacklist' do
        put api('/application/settings', admin),
          params: {
            domain_blacklist_enabled: true,
            domain_blacklist: 'domain3.com, *.domain4.com'
          }

        expect(response).to have_gitlab_http_status(200)
        expect(json_response['domain_blacklist_enabled']).to be(true)
        expect(json_response['domain_blacklist']).to eq(['domain3.com', '*.domain4.com'])
      end
    end
297 298
  end
end