application_setting_spec.rb 19.4 KB
Newer Older
1 2
require 'spec_helper'

3
describe ApplicationSetting do
4
  let(:setting) { described_class.create_from_defaults }
5

6 7 8
  it { include(CacheableAttributes) }
  it { expect(described_class.current_without_cache).to eq(described_class.last) }

Kamil Trzcinski's avatar
Kamil Trzcinski committed
9
  it { expect(setting).to be_valid }
10
  it { expect(setting.uuid).to be_present }
11
  it { expect(setting).to have_db_column(:auto_devops_enabled) }
12

Robert Speicher's avatar
Robert Speicher committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26
  describe 'validations' do
    let(:http)  { 'http://example.com' }
    let(:https) { 'https://example.com' }
    let(:ftp)   { 'ftp://example.com' }

    it { is_expected.to allow_value(nil).for(:home_page_url) }
    it { is_expected.to allow_value(http).for(:home_page_url) }
    it { is_expected.to allow_value(https).for(:home_page_url) }
    it { is_expected.not_to allow_value(ftp).for(:home_page_url) }

    it { is_expected.to allow_value(nil).for(:after_sign_out_path) }
    it { is_expected.to allow_value(http).for(:after_sign_out_path) }
    it { is_expected.to allow_value(https).for(:after_sign_out_path) }
    it { is_expected.not_to allow_value(ftp).for(:after_sign_out_path) }
27

28 29 30
    it { is_expected.to allow_value("dev.gitlab.com").for(:commit_email_hostname) }
    it { is_expected.not_to allow_value("@dev.gitlab").for(:commit_email_hostname) }

31
    describe 'default_artifacts_expire_in' do
32
      it 'sets an error if it cannot parse' do
33 34
        setting.update(default_artifacts_expire_in: 'a')

35
        expect_invalid
36 37
      end

38 39
      it 'sets an error if it is blank' do
        setting.update(default_artifacts_expire_in: ' ')
40

41
        expect_invalid
42 43
      end

44 45 46 47 48 49 50
      it 'sets the value if it is valid' do
        setting.update(default_artifacts_expire_in: '30 days')

        expect(setting).to be_valid
        expect(setting.default_artifacts_expire_in).to eq('30 days')
      end

51 52
      it 'sets the value if it is 0' do
        setting.update(default_artifacts_expire_in: '0')
53 54

        expect(setting).to be_valid
55 56 57 58 59 60
        expect(setting.default_artifacts_expire_in).to eq('0')
      end

      def expect_invalid
        expect(setting).to be_invalid
        expect(setting.errors.messages)
61
          .to have_key(:default_artifacts_expire_in)
62 63 64
      end
    end

65 66 67 68 69 70 71
    it { is_expected.to validate_presence_of(:max_attachment_size) }

    it do
      is_expected.to validate_numericality_of(:max_attachment_size)
        .only_integer
        .is_greater_than(0)
    end
72

73 74 75 76
    context 'key restrictions' do
      it 'supports all key types' do
        expect(described_class::SUPPORTED_KEY_TYPES).to contain_exactly(:rsa, :dsa, :ecdsa, :ed25519)
      end
77

Nick Thomas's avatar
Nick Thomas committed
78 79 80 81 82 83 84 85 86
      it 'does not allow all key types to be disabled' do
        described_class::SUPPORTED_KEY_TYPES.each do |type|
          setting["#{type}_key_restriction"] = described_class::FORBIDDEN_KEY_VALUE
        end

        expect(setting).not_to be_valid
        expect(setting.errors.messages).to have_key(:allowed_key_types)
      end

87 88 89
      where(:type) do
        described_class::SUPPORTED_KEY_TYPES
      end
90

91 92
      with_them do
        let(:field) { :"#{type}_key_restriction" }
93

94
        it { is_expected.to validate_presence_of(field) }
95
        it { is_expected.to allow_value(*KeyRestrictionValidator.supported_key_restrictions(type)).for(field) }
96 97
        it { is_expected.not_to allow_value(128).for(field) }
      end
98 99
    end

100 101 102
    it_behaves_like 'an object with email-formated attributes', :admin_notification_email do
      subject { setting }
    end
103

104 105
    # Upgraded databases will have this sort of content
    context 'repository_storages is a String, not an Array' do
106
      before do
107
        described_class.where(id: setting.id).update_all(repository_storages: 'default')
108
      end
109 110 111 112

      it { expect(setting.repository_storages).to eq(['default']) }
    end

113 114 115 116 117 118 119 120
    context '#commit_email_hostname' do
      it 'returns configured gitlab hostname if commit_email_hostname is not defined' do
        setting.update(commit_email_hostname: nil)

        expect(setting.commit_email_hostname).to eq("users.noreply.#{Gitlab.config.gitlab.host}")
      end
    end

121 122 123 124 125 126
    context 'auto_devops_domain setting' do
      context 'when auto_devops_enabled? is true' do
        before do
          setting.update(auto_devops_enabled: true)
        end

127 128 129 130 131 132
        it 'can be blank' do
          setting.update(auto_devops_domain: '')

          expect(setting).to be_valid
        end

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
        context 'with a valid value' do
          before do
            setting.update(auto_devops_domain: 'domain.com')
          end

          it 'is valid' do
            expect(setting).to be_valid
          end
        end

        context 'with an invalid value' do
          before do
            setting.update(auto_devops_domain: 'definitelynotahostname')
          end

          it 'is invalid' do
            expect(setting).to be_invalid
          end
        end
      end
    end

155
    context 'repository storages' do
156
      before do
157 158 159
        storages = {
          'custom1' => 'tmp/tests/custom_repositories_1',
          'custom2' => 'tmp/tests/custom_repositories_2',
160
          'custom3' => 'tmp/tests/custom_repositories_3'
161 162

        }
163 164 165
        allow(Gitlab.config.repositories).to receive(:storages).and_return(storages)
      end

166 167
      describe 'inclusion' do
        it { is_expected.to allow_value('custom1').for(:repository_storages) }
Douwe Maan's avatar
Douwe Maan committed
168
        it { is_expected.to allow_value(%w(custom2 custom3)).for(:repository_storages) }
169
        it { is_expected.not_to allow_value('alternative').for(:repository_storages) }
Douwe Maan's avatar
Douwe Maan committed
170
        it { is_expected.not_to allow_value(%w(alternative custom1)).for(:repository_storages) }
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
      end

      describe 'presence' do
        it { is_expected.not_to allow_value([]).for(:repository_storages) }
        it { is_expected.not_to allow_value("").for(:repository_storages) }
        it { is_expected.not_to allow_value(nil).for(:repository_storages) }
      end

      describe '.pick_repository_storage' do
        it 'uses Array#sample to pick a random storage' do
          array = double('array', sample: 'random')
          expect(setting).to receive(:repository_storages).and_return(array)

          expect(setting.pick_repository_storage).to eq('random')
        end
      end
187
    end
188 189 190 191

    context 'housekeeping settings' do
      it { is_expected.not_to allow_value(0).for(:housekeeping_incremental_repack_period) }

192
      it 'wants the full repack period to be at least the incremental repack period' do
193 194 195 196 197 198
        subject.housekeeping_incremental_repack_period = 2
        subject.housekeeping_full_repack_period = 1

        expect(subject).not_to be_valid
      end

199 200 201
      it 'wants the gc period to be at least the full repack period' do
        subject.housekeeping_full_repack_period = 100
        subject.housekeeping_gc_period = 90
202 203 204

        expect(subject).not_to be_valid
      end
205 206 207 208 209 210 211 212 213 214 215 216 217 218

      it 'allows the same period for incremental repack and full repack, effectively skipping incremental repack' do
        subject.housekeeping_incremental_repack_period = 2
        subject.housekeeping_full_repack_period = 2

        expect(subject).to be_valid
      end

      it 'allows the same period for full repack and gc, effectively skipping full repack' do
        subject.housekeeping_full_repack_period = 100
        subject.housekeeping_gc_period = 100

        expect(subject).to be_valid
      end
219
    end
220 221 222 223 224 225 226 227 228 229 230 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

    context 'gitaly timeouts' do
      [:gitaly_timeout_default, :gitaly_timeout_medium, :gitaly_timeout_fast].each do |timeout_name|
        it do
          is_expected.to validate_presence_of(timeout_name)
          is_expected.to validate_numericality_of(timeout_name).only_integer
            .is_greater_than_or_equal_to(0)
        end
      end

      [:gitaly_timeout_medium, :gitaly_timeout_fast].each do |timeout_name|
        it "validates that #{timeout_name} is lower than timeout_default" do
          subject[:gitaly_timeout_default] = 50
          subject[timeout_name] = 100

          expect(subject).to be_invalid
        end
      end

      it 'accepts all timeouts equal' do
        subject.gitaly_timeout_default = 0
        subject.gitaly_timeout_medium = 0
        subject.gitaly_timeout_fast = 0

        expect(subject).to be_valid
      end

      it 'accepts timeouts in descending order' do
        subject.gitaly_timeout_default = 50
        subject.gitaly_timeout_medium = 30
        subject.gitaly_timeout_fast = 20

        expect(subject).to be_valid
      end

      it 'rejects timeouts in ascending order' do
        subject.gitaly_timeout_default = 20
        subject.gitaly_timeout_medium = 30
        subject.gitaly_timeout_fast = 50

        expect(subject).to be_invalid
      end

      it 'rejects medium timeout larger than default' do
        subject.gitaly_timeout_default = 30
        subject.gitaly_timeout_medium = 50
        subject.gitaly_timeout_fast = 20

        expect(subject).to be_invalid
      end

      it 'rejects medium timeout smaller than fast' do
        subject.gitaly_timeout_default = 30
        subject.gitaly_timeout_medium = 15
        subject.gitaly_timeout_fast = 20

        expect(subject).to be_invalid
      end
    end
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293

    describe 'enforcing terms' do
      it 'requires the terms to present when enforcing users to accept' do
        subject.enforce_terms = true

        expect(subject).to be_invalid
      end

      it 'is valid when terms are created' do
        create(:term)
        subject.enforce_terms = true

        expect(subject).to be_valid
      end
    end
294 295
  end

296 297 298 299 300 301 302 303 304 305
  context 'restrict creating duplicates' do
    before do
      described_class.create_from_defaults
    end

    it 'raises an record creation violation if already created' do
      expect { described_class.create_from_defaults }.to raise_error(ActiveRecord::RecordNotUnique)
    end
  end

Stan Hu's avatar
Stan Hu committed
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
  describe 'setting Sentry DSNs' do
    context 'server DSN' do
      it 'strips leading and trailing whitespace' do
        subject.update(sentry_dsn: ' http://test ')

        expect(subject.sentry_dsn).to eq('http://test')
      end

      it 'handles nil values' do
        subject.update(sentry_dsn: nil)

        expect(subject.sentry_dsn).to be_nil
      end
    end

    context 'client-side DSN' do
      it 'strips leading and trailing whitespace' do
        subject.update(clientside_sentry_dsn: ' http://test ')

        expect(subject.clientside_sentry_dsn).to eq('http://test')
      end

      it 'handles nil values' do
        subject.update(clientside_sentry_dsn: nil)

        expect(subject.clientside_sentry_dsn).to be_nil
      end
    end
  end

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
  describe '#disabled_oauth_sign_in_sources=' do
    before do
      allow(Devise).to receive(:omniauth_providers).and_return([:github])
    end

    it 'removes unknown sources (as strings) from the array' do
      subject.disabled_oauth_sign_in_sources = %w[github test]

      expect(subject).to be_valid
      expect(subject.disabled_oauth_sign_in_sources).to eq ['github']
    end

    it 'removes unknown sources (as symbols) from the array' do
      subject.disabled_oauth_sign_in_sources = %i[github test]

      expect(subject).to be_valid
      expect(subject.disabled_oauth_sign_in_sources).to eq ['github']
    end

    it 'ignores nil' do
      subject.disabled_oauth_sign_in_sources = nil

      expect(subject).to be_valid
      expect(subject.disabled_oauth_sign_in_sources).to be_empty
    end
  end

Kamil Trzcinski's avatar
Kamil Trzcinski committed
363
  context 'restricted signup domains' do
364
    it 'sets single domain' do
365 366
      setting.domain_whitelist_raw = 'example.com'
      expect(setting.domain_whitelist).to eq(['example.com'])
367 368
    end

369
    it 'sets multiple domains with spaces' do
370 371
      setting.domain_whitelist_raw = 'example.com *.example.com'
      expect(setting.domain_whitelist).to eq(['example.com', '*.example.com'])
372 373
    end

374
    it 'sets multiple domains with newlines and a space' do
375 376
      setting.domain_whitelist_raw = "example.com\n *.example.com"
      expect(setting.domain_whitelist).to eq(['example.com', '*.example.com'])
377 378
    end

379
    it 'sets multiple domains with commas' do
380 381
      setting.domain_whitelist_raw = "example.com, *.example.com"
      expect(setting.domain_whitelist).to eq(['example.com', '*.example.com'])
382 383
    end
  end
384 385

  context 'blacklisted signup domains' do
386
    it 'sets single domain' do
387
      setting.domain_blacklist_raw = 'example.com'
388
      expect(setting.domain_blacklist).to contain_exactly('example.com')
389 390
    end

391
    it 'sets multiple domains with spaces' do
392
      setting.domain_blacklist_raw = 'example.com *.example.com'
393
      expect(setting.domain_blacklist).to contain_exactly('example.com', '*.example.com')
394 395
    end

396
    it 'sets multiple domains with newlines and a space' do
397
      setting.domain_blacklist_raw = "example.com\n *.example.com"
398
      expect(setting.domain_blacklist).to contain_exactly('example.com', '*.example.com')
399 400
    end

401
    it 'sets multiple domains with commas' do
402
      setting.domain_blacklist_raw = "example.com, *.example.com"
403
      expect(setting.domain_blacklist).to contain_exactly('example.com', '*.example.com')
404 405
    end

406
    it 'sets multiple domains with semicolon' do
407 408 409 410
      setting.domain_blacklist_raw = "example.com; *.example.com"
      expect(setting.domain_blacklist).to contain_exactly('example.com', '*.example.com')
    end

411
    it 'sets multiple domains with mixture of everything' do
412 413 414 415
      setting.domain_blacklist_raw = "example.com; *.example.com\n test.com\sblock.com   yes.com"
      expect(setting.domain_blacklist).to contain_exactly('example.com', '*.example.com', 'test.com', 'block.com', 'yes.com')
    end

416
    it 'sets multiple domain with file' do
417
      setting.domain_blacklist_file = File.open(Rails.root.join('spec/fixtures/', 'domain_blacklist.txt'))
418
      expect(setting.domain_blacklist).to contain_exactly('example.com', 'test.com', 'foo.bar')
419 420
    end
  end
421

422 423 424 425 426 427 428 429 430 431 432 433
  describe 'performance bar settings' do
    describe 'performance_bar_allowed_group' do
      context 'with no performance_bar_allowed_group_id saved' do
        it 'returns nil' do
          expect(setting.performance_bar_allowed_group).to be_nil
        end
      end

      context 'with a performance_bar_allowed_group_id saved' do
        let(:group) { create(:group) }

        before do
434
          setting.update!(performance_bar_allowed_group_id: group.id)
435 436 437
        end

        it 'returns the group' do
438
          expect(setting.reload.performance_bar_allowed_group).to eq(group)
439 440 441 442
        end
      end
    end

443 444 445
    describe 'performance_bar_enabled' do
      context 'with the Performance Bar is enabled' do
        let(:group) { create(:group) }
446 447

        before do
448
          setting.update!(performance_bar_allowed_group_id: group.id)
449 450 451
        end

        it 'returns true' do
452
          expect(setting.reload.performance_bar_enabled).to be_truthy
453 454 455 456 457
        end
      end
    end
  end

458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
  describe 'usage ping settings' do
    context 'when the usage ping is disabled in gitlab.yml' do
      before do
        allow(Settings.gitlab).to receive(:usage_ping_enabled).and_return(false)
      end

      it 'does not allow the usage ping to be configured' do
        expect(setting.usage_ping_can_be_configured?).to be_falsey
      end

      context 'when the usage ping is disabled in the DB' do
        before do
          setting.usage_ping_enabled = false
        end

        it 'returns false for usage_ping_enabled' do
          expect(setting.usage_ping_enabled).to be_falsey
        end
      end

      context 'when the usage ping is enabled in the DB' do
        before do
          setting.usage_ping_enabled = true
        end

        it 'returns false for usage_ping_enabled' do
          expect(setting.usage_ping_enabled).to be_falsey
        end
      end
    end

    context 'when the usage ping is enabled in gitlab.yml' do
      before do
        allow(Settings.gitlab).to receive(:usage_ping_enabled).and_return(true)
      end

      it 'allows the usage ping to be configured' do
        expect(setting.usage_ping_can_be_configured?).to be_truthy
      end

      context 'when the usage ping is disabled in the DB' do
        before do
          setting.usage_ping_enabled = false
        end

        it 'returns false for usage_ping_enabled' do
          expect(setting.usage_ping_enabled).to be_falsey
        end
      end

      context 'when the usage ping is enabled in the DB' do
        before do
          setting.usage_ping_enabled = true
        end

        it 'returns true for usage_ping_enabled' do
          expect(setting.usage_ping_enabled).to be_truthy
        end
      end
    end
  end
519

520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
  describe '#allowed_key_types' do
    it 'includes all key types by default' do
      expect(setting.allowed_key_types).to contain_exactly(*described_class::SUPPORTED_KEY_TYPES)
    end

    it 'excludes disabled key types' do
      expect(setting.allowed_key_types).to include(:ed25519)

      setting.ed25519_key_restriction = described_class::FORBIDDEN_KEY_VALUE

      expect(setting.allowed_key_types).not_to include(:ed25519)
    end
  end

  describe '#key_restriction_for' do
    it 'returns the restriction value for recognised types' do
      setting.rsa_key_restriction = 1024

      expect(setting.key_restriction_for(:rsa)).to eq(1024)
    end

    it 'allows types to be passed as a string' do
      setting.rsa_key_restriction = 1024

      expect(setting.key_restriction_for('rsa')).to eq(1024)
545 546
    end

547 548
    it 'returns forbidden for unrecognised type' do
      expect(setting.key_restriction_for(:foo)).to eq(described_class::FORBIDDEN_KEY_VALUE)
549 550
    end
  end
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568

  describe '#allow_signup?' do
    it 'returns true' do
      expect(setting.allow_signup?).to be_truthy
    end

    it 'returns false if signup is disabled' do
      allow(setting).to receive(:signup_enabled?).and_return(false)

      expect(setting.allow_signup?).to be_falsey
    end

    it 'returns false if password authentication is disabled for the web interface' do
      allow(setting).to receive(:password_authentication_enabled_for_web?).and_return(false)

      expect(setting.allow_signup?).to be_falsey
    end
  end
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592

  describe '#user_default_internal_regex_enabled?' do
    using RSpec::Parameterized::TableSyntax

    where(:user_default_external, :user_default_internal_regex, :result) do
      false | nil                        | false
      false | ''                         | false
      false | '^(?:(?!\.ext@).)*$\r?\n?' | false
      true  | ''                         | false
      true  | nil                        | false
      true  | '^(?:(?!\.ext@).)*$\r?\n?' | true
    end

    with_them do
      before do
        setting.update(user_default_external: user_default_external)
        setting.update(user_default_internal_regex: user_default_internal_regex)
      end

      subject { setting.user_default_internal_regex_enabled? }

      it { is_expected.to eq(result) }
    end
  end
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607

  context 'diff limit settings' do
    describe '#diff_max_patch_bytes' do
      context 'validations' do
        it { is_expected.to validate_presence_of(:diff_max_patch_bytes) }

        it do
          is_expected.to validate_numericality_of(:diff_max_patch_bytes)
          .only_integer
          .is_greater_than_or_equal_to(Gitlab::Git::Diff::DEFAULT_MAX_PATCH_BYTES)
          .is_less_than_or_equal_to(Gitlab::Git::Diff::MAX_PATCH_BYTES_UPPER_BOUND)
        end
      end
    end
  end
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627

  describe '#archive_builds_older_than' do
    subject { setting.archive_builds_older_than }

    context 'when the archive_builds_in_seconds is set' do
      before do
        setting.archive_builds_in_seconds = 3600
      end

      it { is_expected.to be_within(1.minute).of(1.hour.ago) }
    end

    context 'when the archive_builds_in_seconds is set' do
      before do
        setting.archive_builds_in_seconds = nil
      end

      it { is_expected.to be_nil }
    end
  end
628
end