python-gitlab-python-gitlab/tests/unit/test_config.py at master · alvistack/python-gitlab-python-gitlab · GitHub

Repository navigation

History

317 lines (268 loc) · 8.28 KB

Raw

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

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

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

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

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

# -*- coding: utf-8 -*-

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU Lesser General Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU Lesser General Public License for more details.

# You should have received a copy of the GNU Lesser General Public License

# along with this program. If not, see <http://www.gnu.org/licenses/>.

import io

import os

from textwrap import dedent

import mock

import pytest

from gitlab import config, USER_AGENT

custom_user_agent = "my-package/1.0.0"

valid_config = u"""[global]

default = one

ssl_verify = true

timeout = 2

[one]

url = http://one.url

private_token = ABCDEF

[two]

url = https://two.url

private_token = GHIJKL

ssl_verify = false

timeout = 10

[three]

url = https://three.url

private_token = MNOPQR

ssl_verify = /path/to/CA/bundle.crt

per_page = 50

[four]

url = https://four.url

oauth_token = STUV

"""

custom_user_agent_config = """[global]

default = one

user_agent = {}

[one]

url = http://one.url

private_token = ABCDEF

""".format(

custom_user_agent

)

no_default_config = u"""[global]

[there]

url = http://there.url

private_token = ABCDEF

"""

missing_attr_config = u"""[global]

[one]

url = http://one.url

[two]

private_token = ABCDEF

[three]

meh = hem

[four]

url = http://four.url

private_token = ABCDEF

per_page = 200

"""

def global_retry_transient_errors(value: bool) -> str:

return u"""[global]

default = one

retry_transient_errors={}

[one]

url = http://one.url

private_token = ABCDEF""".format(

value

)

def global_and_gitlab_retry_transient_errors(

global_value: bool, gitlab_value: bool

) -> str:

return u"""[global]

default = one

retry_transient_errors={global_value}

[one]

url = http://one.url

private_token = ABCDEF

retry_transient_errors={gitlab_value}""".format(

global_value=global_value, gitlab_value=gitlab_value

)

@mock.patch.dict(os.environ, {"PYTHON_GITLAB_CFG": "/some/path"})

def test_env_config_present():

assert ["/some/path"] == config._env_config()

@mock.patch.dict(os.environ, {}, clear=True)

def test_env_config_missing():

assert [] == config._env_config()

@mock.patch("os.path.exists")

def test_missing_config(path_exists):

path_exists.return_value = False

with pytest.raises(config.GitlabConfigMissingError):

config.GitlabConfigParser("test")

@mock.patch("os.path.exists")

@mock.patch("builtins.open")

def test_invalid_id(m_open, path_exists):

fd = io.StringIO(no_default_config)

fd.close = mock.Mock(return_value=None)

m_open.return_value = fd

path_exists.return_value = True

config.GitlabConfigParser("there")

with pytest.raises(config.GitlabIDError):

config.GitlabConfigParser()

fd = io.StringIO(valid_config)

fd.close = mock.Mock(return_value=None)

m_open.return_value = fd

with pytest.raises(config.GitlabDataError):

config.GitlabConfigParser(gitlab_id="not_there")

@mock.patch("os.path.exists")

@mock.patch("builtins.open")

def test_invalid_data(m_open, path_exists):

fd = io.StringIO(missing_attr_config)

fd.close = mock.Mock(return_value=None, side_effect=lambda: fd.seek(0))

m_open.return_value = fd

path_exists.return_value = True

config.GitlabConfigParser("one")

with pytest.raises(config.GitlabDataError):

config.GitlabConfigParser(gitlab_id="two")

with pytest.raises(config.GitlabDataError):

config.GitlabConfigParser(gitlab_id="three")

with pytest.raises(config.GitlabDataError) as emgr:

config.GitlabConfigParser("four")

assert "Unsupported per_page number: 200" == emgr.value.args[0]

@mock.patch("os.path.exists")

@mock.patch("builtins.open")

def test_valid_data(m_open, path_exists):

fd = io.StringIO(valid_config)

fd.close = mock.Mock(return_value=None)

m_open.return_value = fd

path_exists.return_value = True

cp = config.GitlabConfigParser()

assert "one" == cp.gitlab_id

assert "http://one.url" == cp.url

assert "ABCDEF" == cp.private_token

assert cp.oauth_token is None

assert 2 == cp.timeout

assert cp.ssl_verify is True

assert cp.per_page is None

fd = io.StringIO(valid_config)

fd.close = mock.Mock(return_value=None)

m_open.return_value = fd

cp = config.GitlabConfigParser(gitlab_id="two")

assert "two" == cp.gitlab_id

assert "https://two.url" == cp.url

assert "GHIJKL" == cp.private_token

assert cp.oauth_token is None

assert 10 == cp.timeout

assert cp.ssl_verify is False

fd = io.StringIO(valid_config)

fd.close = mock.Mock(return_value=None)

m_open.return_value = fd

cp = config.GitlabConfigParser(gitlab_id="three")

assert "three" == cp.gitlab_id

assert "https://three.url" == cp.url

assert "MNOPQR" == cp.private_token

assert cp.oauth_token is None

assert 2 == cp.timeout

assert "/path/to/CA/bundle.crt" == cp.ssl_verify

assert 50 == cp.per_page

fd = io.StringIO(valid_config)

fd.close = mock.Mock(return_value=None)

m_open.return_value = fd

cp = config.GitlabConfigParser(gitlab_id="four")

assert "four" == cp.gitlab_id

assert "https://four.url" == cp.url

assert cp.private_token is None

assert "STUV" == cp.oauth_token

assert 2 == cp.timeout

assert cp.ssl_verify is True

@mock.patch("os.path.exists")

@mock.patch("builtins.open")

def test_data_from_helper(m_open, path_exists, tmp_path):

helper = tmp_path / "helper.sh"

helper.write_text(

dedent(

"""\

#!/bin/sh

echo "secret"

"""

)

helper.chmod(0o755)

fd = io.StringIO(

dedent(

"""\

[global]

default = helper

[helper]

url = https://helper.url

oauth_token = helper: %s

"""

)

% helper

)

fd.close = mock.Mock(return_value=None)

m_open.return_value = fd

cp = config.GitlabConfigParser(gitlab_id="helper")

assert "helper" == cp.gitlab_id

assert "https://helper.url" == cp.url

assert cp.private_token is None

assert "secret" == cp.oauth_token

@mock.patch("os.path.exists")

@mock.patch("builtins.open")

@pytest.mark.parametrize(

"config_string,expected_agent",

[

(valid_config, USER_AGENT),

(custom_user_agent_config, custom_user_agent),

)

def test_config_user_agent(m_open, path_exists, config_string, expected_agent):

fd = io.StringIO(config_string)

fd.close = mock.Mock(return_value=None)

m_open.return_value = fd

cp = config.GitlabConfigParser()

assert cp.user_agent == expected_agent

@mock.patch("os.path.exists")

@mock.patch("builtins.open")

@pytest.mark.parametrize(

"config_string,expected",

[

pytest.param(valid_config, False, id="default_value"),

pytest.param(

global_retry_transient_errors(True), True, id="global_config_true"

pytest.param(

global_retry_transient_errors(False), False, id="global_config_false"

pytest.param(

global_and_gitlab_retry_transient_errors(False, True),

True,

id="gitlab_overrides_global_true",

pytest.param(

global_and_gitlab_retry_transient_errors(True, False),

False,

id="gitlab_overrides_global_false",

pytest.param(

global_and_gitlab_retry_transient_errors(True, True),

True,

id="gitlab_equals_global_true",

pytest.param(

global_and_gitlab_retry_transient_errors(False, False),

False,

id="gitlab_equals_global_false",

)

def test_config_retry_transient_errors_when_global_config_is_set(

m_open, path_exists, config_string, expected

fd = io.StringIO(config_string)

fd.close = mock.Mock(return_value=None)

m_open.return_value = fd

cp = config.GitlabConfigParser()

assert cp.retry_transient_errors == expected

python-gitlab-python-gitlab/tests/unit/test_config.py at master · alvistack/python-gitlab-python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

test_config.py

Latest commit

History

Breadcrumbs

test_config.py

File metadata and controls