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
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the tests of our environment variable helpers.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/special-thanks.html
Contributors:
https://pyfunceble.github.io/contributors.html
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://docs.pyfunceble.com
Project homepage:
https://pyfunceble.github.io/
License:
::
Copyright 2017, 2018, 2019, 2020, 2021, 2021 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import os
import tempfile
import unittest
from PyFunceble.helpers.environment_variable import EnvironmentVariableHelper
class TestEnvironmentVariableHelper(unittest.TestCase):
"""
Tests of our environment variable helper.
"""
def setUp(self) -> None:
"""
Setups everything needed for the tests.
"""
self.helper = EnvironmentVariableHelper()
self.test_name = "PYFUNCEBLE_TESTING"
self.temp_env_file = tempfile.NamedTemporaryFile("w", delete=False)
def tearDown(self) -> None:
"""
Destroys everything needed for the tests.
"""
self.temp_env_file.close()
os.remove(self.temp_env_file.name)
del self.temp_env_file
del self.test_name
del self.helper
def test_set_name_return(self) -> None:
"""
Tests the response from the method which let us set the name to work
with.
"""
actual = self.helper.set_name(self.test_name)
self.assertIsInstance(actual, EnvironmentVariableHelper)
def test_set_name_method(self) -> None:
"""
Tests the method which let us set the name to work with.
"""
given = self.test_name
expected = given
self.helper.set_name(given)
actual = self.helper.name
self.assertEqual(expected, actual)
def test_set_name_attribute(self) -> None:
"""
Tests the method which let us overwrite the `name` attribute.
"""
given = self.test_name
expected = given
self.helper.name = given
actual = self.helper.name
self.assertEqual(expected, actual)
def test_set_name_through_init(self) -> None:
"""
Tests the overwritting of the name to work with through the class
constructor.
"""
given = self.test_name
expected = given
helper = EnvironmentVariableHelper(given)
actual = helper.name
self.assertEqual(expected, actual)
def test_set_env_file_path_return(self) -> None:
"""
Tests the response from the method which let us set the path to the
dot env file to work with.
"""
actual = self.helper.set_env_file_path(self.temp_env_file.name)
self.assertIsInstance(actual, EnvironmentVariableHelper)
def test_set_env_file_path_method(self) -> None:
"""
Tests the method which let us set the path to the dotenv file to work with.
"""
given = self.temp_env_file.name
expected = given
self.helper.set_env_file_path(given)
actual = self.helper.env_file_path
self.assertEqual(expected, actual)
def test_set_env_file_path_attribute(self) -> None:
"""
Tests the method which let us overwrite the `env_file_path` attribute.
"""
given = self.temp_env_file.name
expected = given
self.helper.env_file_path = given
actual = self.helper.env_file_path
self.assertEqual(expected, actual)
def test_set_env_file_path_through_init(self) -> None:
"""
Tests the overwritting of the dotenv file to work with through the class
constructor.
"""
given = self.temp_env_file.name
expected = given
helper = EnvironmentVariableHelper(env_file_path=given)
actual = helper.env_file_path
self.assertEqual(expected, actual)
def test_set_name_not_str(self) -> None:
"""
Tests the method which let us set the name of the environment variable
to work with for the case that the given name is not a string.
"""
given = ["Hello", "World"]
self.assertRaises(TypeError, lambda: self.helper.set_name(given))
def test_set_env_file_path_not_str(self) -> None:
"""
Tests the method which let us set the path to the dotenv file to work
with for the case that the given path is not a string.
"""
given = ["Hello", "World"]
self.assertRaises(TypeError, lambda: self.helper.set_env_file_path(given))
def test_exists(self) -> None:
"""
Tests of the method which let us test if an environment variable exists.
"""
expected = False
actual = self.helper.set_name(self.test_name).exists()
self.assertEqual(expected, actual)
os.environ[self.test_name] = "This is a test."
expected = True
actual = self.helper.exists()
self.assertEqual(expected, actual)
del os.environ[self.test_name]
def test_get_value(self) -> None:
"""
Tests of the method which let us get the value of an environment
variable.
"""
expected = False
actual = self.helper.set_name(self.test_name).exists()
self.assertEqual(expected, actual)
expected = "Hello"
actual = self.helper.get_value(default="Hello")
self.assertEqual(expected, actual)
expected = "This is a test."
os.environ[self.test_name] = "This is a test."
actual = self.helper.get_value(default="Hello")
self.assertEqual(expected, actual)
del os.environ[self.test_name]
def test_get_value_from_file(self) -> None:
"""
Tests of the method which let us get the value of an environment
variable from a given environment file.
"""
self.temp_env_file.write("IS_THIS_A_GHOST=yes\n")
self.temp_env_file.seek(0)
self.helper.set_env_file_path(self.temp_env_file.name)
self.helper.set_name("IS_THIS_A_GHOST")
expected = "yes"
actual = self.helper.get_value_from_env_file()
self.assertEqual(expected, actual)
def test_get_value_from_file_not_found(self) -> None:
"""
Tests of the method which let us get the value of an environment
variable from a given environment file.
In this case, we test the case that the given value is not known.
"""
self.temp_env_file.write("IS_THIS_A_GHOST_NOOOO=yes")
self.temp_env_file.seek(0)
self.helper.set_env_file_path(self.temp_env_file.name)
self.helper.set_name("IS_THIS_A_GHOST")
expected = "hello"
actual = self.helper.get_value_from_env_file(default="hello")
self.assertEqual(expected, actual)
def test_set_value(self) -> None:
"""
Tests of the method which let us set the value of an environment
variable.
"""
expected = False
actual = self.helper.set_name(self.test_name).exists()
self.assertEqual(expected, actual)
self.helper.set_value("Hello, World!")
expected = "Hello, World!"
actual = self.helper.get_value()
self.assertEqual(expected, actual)
del os.environ[self.test_name]
def test_set_value_in_env_file(self) -> None:
"""
Tests of the method which let us set the value of an environment
variable into a file.
"""
self.helper.set_env_file_path(self.temp_env_file.name)
self.helper.set_name("GHOST_FINDER")
self.assertIsNone(self.helper.get_value())
expected = 'GHOST_FINDER="no"\n'
self.helper.set_value_in_env_file("no")
with open(self.temp_env_file.name, "r", encoding="utf-8") as file_stream:
self.assertTrue("no" in file_stream.read())
expected = "no"
self.assertEqual(expected, self.helper.get_value())
def test_set_value_not_str(self) -> None:
"""
Tests of the method which let us set the value of an environment
variable for the case that the given value to set is not a string.
"""
expected = False
actual = self.helper.set_name(self.test_name).exists()
self.assertEqual(expected, actual)
self.assertRaises(TypeError, lambda: self.helper.set_value(["Hello", "World!"]))
def test_delete(self) -> None:
"""
Tests of the method which let us delete an environment variable.
"""
expected = False
actual = self.helper.set_name(self.test_name).exists()
self.assertEqual(expected, actual)
self.helper.set_value("Hello, World!")
expected = True
actual = self.helper.exists()
self.assertEqual(expected, actual)
self.helper.delete()
expected = False
actual = self.helper.exists()
self.assertEqual(expected, actual)
def test_delete_value_in_env_file(self) -> None:
"""
Tests of the method which let us delete the value of an environment
variable into a file.
"""
self.temp_env_file.write("GHOST_SPEAKER=yes\n")
self.helper.set_env_file_path(self.temp_env_file.name)
self.helper.set_name("GHOST_SPEAKER")
self.helper.set_value("no")
with open(self.temp_env_file.name, "r", encoding="utf-8") as file_stream:
self.assertTrue(self.helper.name in x for x in file_stream.readlines())
self.helper.delete_from_env_file()
with open(self.temp_env_file.name, "r", encoding="utf-8") as file_stream:
self.assertTrue(self.helper.name not in x for x in file_stream.readlines())
self.assertIsNone(self.helper.get_value())
if __name__ == "__main__":
unittest.main()
|
