summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/web_ide/config/entry/terminal_spec.rb
blob: 7d96adf95e884776d2bfa9d5136d9bd1e45d73e3 (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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::WebIde::Config::Entry::Terminal do
  let(:entry) { described_class.new(config, with_image_ports: true) }

  describe '.nodes' do
    context 'when filtering all the entry/node names' do
      subject { described_class.nodes.keys }

      let(:result) do
        %i[before_script script image services variables]
      end

      it { is_expected.to match_array result }
    end
  end

  describe 'validations' do
    before do
      entry.compose!
    end

    context 'when entry config value is correct' do
      let(:config) { { script: 'rspec' } }

      describe '#valid?' do
        it 'is valid' do
          expect(entry).to be_valid
        end
      end

      context 'when the same port is not duplicated' do
        let(:config) do
          {
            image: { name: "ruby", ports: [80] },
            services: [{ name: "mysql", alias: "service1", ports: [81] }, { name: "mysql", alias: "service2", ports: [82] }]
          }
        end

        describe '#valid?' do
          it 'is valid' do
            expect(entry).to be_valid
          end
        end
      end

      context 'when unknown port keys detected' do
        let(:config) do
          {
            image: { name: "ruby", ports: [80] },
            services: [{ name: "mysql", alias: "service2", ports: [{ number: 81, invalid_key: 'foobar' }] }]
          }
        end

        it 'is not valid' do
          expect(entry).not_to be_valid
          expect(entry.errors.first)
            .to match /port config contains unknown keys: invalid_key/
        end
      end
    end

    context 'when entry value is not correct' do
      context 'incorrect config value type' do
        let(:config) { ['incorrect'] }

        describe '#errors' do
          it 'reports error about a config type' do
            expect(entry.errors)
              .to include 'terminal config should be a hash'
          end
        end
      end

      context 'when config is empty' do
        let(:config) { {} }

        describe '#valid' do
          it 'is valid' do
            expect(entry).to be_valid
          end
        end
      end

      context 'when unknown keys detected' do
        let(:config) { { unknown: true } }

        describe '#valid' do
          it 'is not valid' do
            expect(entry).not_to be_valid
          end
        end
      end

      context 'when the same port is duplicated' do
        let(:config) do
          {
            image: { name: "ruby", ports: [80] },
            services: [{ name: "mysql", ports: [80] }, { name: "mysql", ports: [81] }]
          }
        end

        describe '#valid?' do
          it 'is invalid' do
            expect(entry).not_to be_valid
            expect(entry.errors.count).to eq 1
            expect(entry.errors.first).to match "each port number can only be referenced once"
          end
        end
      end
    end
  end

  describe '#relevant?' do
    it 'is a relevant entry' do
      entry = described_class.new({ script: 'rspec' })

      expect(entry).to be_relevant
    end
  end

  context 'when composed' do
    before do
      entry.compose!
    end

    describe '#value' do
      context 'when entry is correct' do
        let(:config) do
          { before_script: %w[ls pwd],
            script: 'sleep 100',
            tags: ['webide'],
            image: 'image:1.0',
            services: ['mysql'],
            variables: { KEY: 'value' } }
        end

        it 'returns correct value' do
          expect(entry.value)
            .to eq(
              tag_list: ['webide'],
              job_variables: [{ key: 'KEY', value: 'value', public: true }],
              options: {
                image: { name: "image:1.0" },
                services: [{ name: "mysql" }],
                before_script: %w[ls pwd],
                script: ['sleep 100']
              }
            )
        end
      end
    end
  end
end