File: extensions_gallery_metadata_validator_spec.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (122 lines) | stat: -rw-r--r-- 3,444 bytes parent folder | download
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
# frozen_string_literal: true

require "fast_spec_helper"

RSpec.describe WebIde::Settings::ExtensionsGalleryMetadataValidator, :web_ide_fast, feature_category: :web_ide do
  include ResultMatchers

  let(:context) do
    {
      requested_setting_names: [:vscode_extensions_gallery_metadata],
      settings: {
        vscode_extensions_gallery_metadata: extensions_gallery_metadata
      }
    }
  end

  subject(:result) do
    described_class.validate(context)
  end

  context "when vscode_extensions_gallery_metadata is valid" do
    shared_examples "success result" do
      it "return an ok Result containing the original context which was passed" do
        expect(result).to eq(Gitlab::Fp::Result.ok(context))
      end
    end

    context "when enabled is true" do
      let(:extensions_gallery_metadata) do
        {
          enabled: true
        }
      end

      it_behaves_like 'success result'
    end

    context "when enabled is false and disabled_reason is present" do
      let(:extensions_gallery_metadata) do
        {
          enabled: false,
          disabled_reason: :no_user
        }
      end

      it_behaves_like 'success result'
    end
  end

  context "when vscode_extensions_gallery_metadata is invalid" do
    shared_examples "err result" do |expected_error_details:|
      it "returns an err Result containing error details" do
        expect(result).to be_err_result do |message|
          expect(message)
            .to be_a(WebIde::Settings::Messages::SettingsVscodeExtensionsGalleryMetadataValidationFailed)
          message.content => { details: String => error_details }
          expect(error_details).to eq(expected_error_details)
        end
      end
    end

    context "when empty" do
      let(:extensions_gallery_metadata) { {} }

      it_behaves_like "err result", expected_error_details: "root is missing required keys: enabled"
    end

    context "when enabled is missing but disabled_reason is present" do
      let(:extensions_gallery_metadata) { { disabled_reason: :no_user } }

      it_behaves_like "err result", expected_error_details: "root is missing required keys: enabled"
    end

    context "when enabled is false but disabled_reason is missing" do
      let(:extensions_gallery_metadata) do
        {
          enabled: false
        }
      end

      it_behaves_like "err result", expected_error_details: "root is missing required keys: disabled_reason"
    end

    context "for enabled" do
      context "when not a boolean" do
        let(:extensions_gallery_metadata) do
          {
            enabled: "not a boolean"
          }
        end

        it_behaves_like "err result", expected_error_details: "property '/enabled' is not of type: boolean"
      end
    end

    context "for disabled_reason" do
      context "when not a string" do
        let(:extensions_gallery_metadata) do
          {
            enabled: false,
            disabled_reason: 1
          }
        end

        it_behaves_like "err result", expected_error_details:
          "property '/disabled_reason' is not of type: string"
      end
    end
  end

  context "when requested_setting_names does not include vscode_extensions_gallery_metadata" do
    let(:context) do
      {
        requested_setting_names: [:some_other_setting]
      }
    end

    it "returns an ok result with the original context" do
      expect(result).to be_ok_result(context)
    end
  end
end