env_spec.rb 9.53 KB
Newer Older
Mark Lapierre's avatar
Mark Lapierre committed
1 2
# frozen_string_literal: true

3
describe QA::Runtime::Env do
4
  include Helpers::StubENV
5

6 7 8 9 10
  shared_examples 'boolean method' do |**kwargs|
    it_behaves_like 'boolean method with parameter', kwargs
  end

  shared_examples 'boolean method with parameter' do |method:, param: nil, env_key:, default:|
11 12
    context 'when there is an env variable set' do
      it 'returns false when falsey values specified' do
13
        stub_env(env_key, 'false')
14
        expect(described_class.public_send(method, *param)).to be_falsey
15

16
        stub_env(env_key, 'no')
17
        expect(described_class.public_send(method, *param)).to be_falsey
18

19
        stub_env(env_key, '0')
20
        expect(described_class.public_send(method, *param)).to be_falsey
21 22 23
      end

      it 'returns true when anything else specified' do
24
        stub_env(env_key, 'true')
25
        expect(described_class.public_send(method, *param)).to be_truthy
26

27
        stub_env(env_key, '1')
28
        expect(described_class.public_send(method, *param)).to be_truthy
29

30
        stub_env(env_key, 'anything')
31
        expect(described_class.public_send(method, *param)).to be_truthy
32 33 34 35
      end
    end

    context 'when there is no env variable set' do
36 37
      it "returns the default, #{default}" do
        stub_env(env_key, nil)
38
        expect(described_class.public_send(method, *param)).to be(default)
39 40 41 42
      end
    end
  end

43
  describe '.signup_disabled?' do
44 45 46 47
    it_behaves_like 'boolean method',
      method: :signup_disabled?,
      env_key: 'SIGNUP_DISABLED',
      default: false
48 49
  end

Mark Lapierre's avatar
Mark Lapierre committed
50
  describe '.debug?' do
51 52 53 54
    it_behaves_like 'boolean method',
      method: :debug?,
      env_key: 'QA_DEBUG',
      default: false
Mark Lapierre's avatar
Mark Lapierre committed
55 56
  end

57
  describe '.chrome_headless?' do
58 59 60 61
    it_behaves_like 'boolean method',
      method: :chrome_headless?,
      env_key: 'CHROME_HEADLESS',
      default: true
62 63
  end

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
  describe '.running_in_ci?' do
    context 'when there is an env variable set' do
      it 'returns true if CI' do
        stub_env('CI', 'anything')
        expect(described_class.running_in_ci?).to be_truthy
      end

      it 'returns true if CI_SERVER' do
        stub_env('CI_SERVER', 'anything')
        expect(described_class.running_in_ci?).to be_truthy
      end
    end

    context 'when there is no env variable set' do
      it 'returns true' do
        stub_env('CI', nil)
        stub_env('CI_SERVER', nil)
        expect(described_class.running_in_ci?).to be_falsey
      end
    end
  end
85

86 87 88 89 90 91 92
  describe '.personal_access_token' do
    around do |example|
      described_class.instance_variable_set(:@personal_access_token, nil)
      example.run
      described_class.instance_variable_set(:@personal_access_token, nil)
    end

93
    context 'when GITLAB_QA_ACCESS_TOKEN is set' do
94
      before do
95
        stub_env('GITLAB_QA_ACCESS_TOKEN', 'a_token_too')
96 97 98
      end

      it 'returns specified token from env' do
99
        expect(described_class.personal_access_token).to eq 'a_token_too'
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
      end
    end

    context 'when @personal_access_token is set' do
      before do
        described_class.personal_access_token = 'another_token'
      end

      it 'returns the instance variable value' do
        expect(described_class.personal_access_token).to eq 'another_token'
      end
    end
  end

  describe '.personal_access_token=' do
    around do |example|
      described_class.instance_variable_set(:@personal_access_token, nil)
      example.run
      described_class.instance_variable_set(:@personal_access_token, nil)
    end

    it 'saves the token' do
      described_class.personal_access_token = 'a_token'

      expect(described_class.personal_access_token).to eq 'a_token'
    end
  end

128
  describe '.forker?' do
129 130 131 132 133
    before do
      stub_env('GITLAB_FORKER_USERNAME', nil)
      stub_env('GITLAB_FORKER_PASSWORD', nil)
    end

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
    it 'returns false if no forker credentials are defined' do
      expect(described_class).not_to be_forker
    end

    it 'returns false if only forker username is defined' do
      stub_env('GITLAB_FORKER_USERNAME', 'foo')

      expect(described_class).not_to be_forker
    end

    it 'returns false if only forker password is defined' do
      stub_env('GITLAB_FORKER_PASSWORD', 'bar')

      expect(described_class).not_to be_forker
    end

    it 'returns true if forker username and password are defined' do
      stub_env('GITLAB_FORKER_USERNAME', 'foo')
      stub_env('GITLAB_FORKER_PASSWORD', 'bar')

      expect(described_class).to be_forker
    end
  end

158 159
  describe '.github_access_token' do
    it 'returns "" if GITHUB_ACCESS_TOKEN is not defined' do
160 161
      stub_env('GITHUB_ACCESS_TOKEN', nil)

162 163 164 165 166 167 168 169 170
      expect(described_class.github_access_token).to eq('')
    end

    it 'returns stripped string if GITHUB_ACCESS_TOKEN is defined' do
      stub_env('GITHUB_ACCESS_TOKEN', ' abc123 ')
      expect(described_class.github_access_token).to eq('abc123')
    end
  end

171
  describe '.knapsack?' do
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    it 'returns true if KNAPSACK_GENERATE_REPORT is defined' do
      stub_env('KNAPSACK_GENERATE_REPORT', 'true')

      expect(described_class.knapsack?).to be_truthy
    end

    it 'returns true if KNAPSACK_REPORT_PATH is defined' do
      stub_env('KNAPSACK_REPORT_PATH', '/a/path')

      expect(described_class.knapsack?).to be_truthy
    end

    it 'returns true if KNAPSACK_TEST_FILE_PATTERN is defined' do
      stub_env('KNAPSACK_TEST_FILE_PATTERN', '/a/**/pattern')

      expect(described_class.knapsack?).to be_truthy
    end

    it 'returns false if neither KNAPSACK_GENERATE_REPORT nor KNAPSACK_REPORT_PATH nor KNAPSACK_TEST_FILE_PATTERN are defined' do
      expect(described_class.knapsack?).to be_falsey
    end
  end

  describe '.knapsack?' do
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
    it 'returns true if KNAPSACK_GENERATE_REPORT is defined' do
      stub_env('KNAPSACK_GENERATE_REPORT', 'true')

      expect(described_class.knapsack?).to be_truthy
    end

    it 'returns true if KNAPSACK_REPORT_PATH is defined' do
      stub_env('KNAPSACK_REPORT_PATH', '/a/path')

      expect(described_class.knapsack?).to be_truthy
    end

    it 'returns true if KNAPSACK_TEST_FILE_PATTERN is defined' do
      stub_env('KNAPSACK_TEST_FILE_PATTERN', '/a/**/pattern')

      expect(described_class.knapsack?).to be_truthy
    end

    it 'returns false if neither KNAPSACK_GENERATE_REPORT nor KNAPSACK_REPORT_PATH nor KNAPSACK_TEST_FILE_PATTERN are defined' do
      expect(described_class.knapsack?).to be_falsey
    end
  end

219 220
  describe '.require_github_access_token!' do
    it 'raises ArgumentError if GITHUB_ACCESS_TOKEN is not defined' do
221 222
      stub_env('GITHUB_ACCESS_TOKEN', nil)

223 224 225 226 227 228 229 230 231
      expect { described_class.require_github_access_token! }.to raise_error(ArgumentError)
    end

    it 'does not raise if GITHUB_ACCESS_TOKEN is defined' do
      stub_env('GITHUB_ACCESS_TOKEN', ' abc123 ')

      expect { described_class.require_github_access_token! }.not_to raise_error
    end
  end
Mark Lapierre's avatar
Mark Lapierre committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245

  describe '.log_destination' do
    it 'returns $stdout if QA_LOG_PATH is not defined' do
      stub_env('QA_LOG_PATH', nil)

      expect(described_class.log_destination).to eq($stdout)
    end

    it 'returns the path if QA_LOG_PATH is defined' do
      stub_env('QA_LOG_PATH', 'path/to_file')

      expect(described_class.log_destination).to eq('path/to_file')
    end
  end
246 247 248 249 250 251 252 253

  describe '.can_test?' do
    it_behaves_like 'boolean method with parameter',
      method: :can_test?,
      param: :git_protocol_v2,
      env_key: 'QA_CAN_TEST_GIT_PROTOCOL_V2',
      default: true

254 255 256 257 258 259
    it_behaves_like 'boolean method with parameter',
      method: :can_test?,
      param: :admin,
      env_key: 'QA_CAN_TEST_ADMIN_FEATURES',
      default: true

260 261 262 263
    it 'raises ArgumentError if feature is unknown' do
      expect { described_class.can_test? :foo }.to raise_error(ArgumentError, 'Unknown feature "foo"')
    end
  end
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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322

  describe 'remote grid credentials' do
    it 'is blank if username is empty' do
      stub_env('QA_REMOTE_GRID_USERNAME', nil)

      expect(described_class.send(:remote_grid_credentials)).to eq('')
    end

    it 'throws ArgumentError if GRID_ACCESS_KEY is not specified with USERNAME' do
      stub_env('QA_REMOTE_GRID_USERNAME', 'foo')

      expect { described_class.send(:remote_grid_credentials) }.to raise_error(ArgumentError, 'Please provide an access key for user "foo"')
    end

    it 'returns a user:key@ combination when all args are satiated' do
      stub_env('QA_REMOTE_GRID_USERNAME', 'foo')
      stub_env('QA_REMOTE_GRID_ACCESS_KEY', 'bar')

      expect(described_class.send(:remote_grid_credentials)).to eq('foo:bar@')
    end
  end

  describe '.remote_grid_protocol' do
    it 'defaults protocol to http' do
      stub_env('QA_REMOTE_GRID_PROTOCOL', nil)
      expect(described_class.remote_grid_protocol).to eq('http')
    end
  end

  describe '.remote_grid' do
    it 'is falsey if QA_REMOTE_GRID is not set' do
      expect(described_class.remote_grid).to be_falsey
    end

    it 'accepts https protocol' do
      stub_env('QA_REMOTE_GRID', 'localhost:4444')
      stub_env('QA_REMOTE_GRID_PROTOCOL', 'https')

      expect(described_class.remote_grid).to eq('https://localhost:4444/wd/hub')
    end

    context 'with credentials' do
      it 'has a grid of http://user:key@grid/wd/hub' do
        stub_env('QA_REMOTE_GRID_USERNAME', 'foo')
        stub_env('QA_REMOTE_GRID_ACCESS_KEY', 'bar')
        stub_env('QA_REMOTE_GRID', 'localhost:4444')

        expect(described_class.remote_grid).to eq('http://foo:bar@localhost:4444/wd/hub')
      end
    end

    context 'without credentials' do
      it 'has a grid of http://grid/wd/hub' do
        stub_env('QA_REMOTE_GRID', 'localhost:4444')

        expect(described_class.remote_grid).to eq('http://localhost:4444/wd/hub')
      end
    end
  end
323
end