File: test_fileaware.py

package info (click to toggle)
django-environ 0.12.0-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 516 kB
  • sloc: python: 2,434; makefile: 171
file content (189 lines) | stat: -rw-r--r-- 5,071 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
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
# This file is part of the django-environ.
#
# Copyright (c) 2021-2024, Serghei Iakovlev <oss@serghei.pl>
# Copyright (c) 2013-2021, Daniele Faraglia <daniele.faraglia@gmail.com>
#
# For the full copyright and license information, please view
# the LICENSE.txt file that was distributed with this source code.

import os
import tempfile
from contextlib import contextmanager

import pytest

import environ


@contextmanager
def make_temp_file(text):
    with tempfile.NamedTemporaryFile("w", delete=False) as f:
        f.write(text)
        f.close()
    try:
        yield f.name
    finally:
        if os.path.exists(f.name):
            os.unlink(f.name)


@pytest.fixture
def tmp_f():
    with make_temp_file(text="fish") as f_name:
        yield f_name


def test_mapping(tmp_f):
    env = environ.FileAwareMapping(env={"ANIMAL_FILE": tmp_f})
    assert env["ANIMAL"] == "fish"


def test_precidence(tmp_f):
    env = environ.FileAwareMapping(
        env={
            "ANIMAL_FILE": tmp_f,
            "ANIMAL": "cat",
        }
    )
    assert env["ANIMAL"] == "fish"


def test_missing_file_raises_exception():
    env = environ.FileAwareMapping(env={"ANIMAL_FILE": "non-existant-file"})
    with pytest.raises(FileNotFoundError):
        env["ANIMAL"]


def test_iter():
    env = environ.FileAwareMapping(
        env={
            "ANIMAL_FILE": "some-file",
            "VEGETABLE": "leek",
            "VEGETABLE_FILE": "some-vegetable-file",
        }
    )
    keys = set(env)
    assert keys == {"ANIMAL_FILE", "ANIMAL", "VEGETABLE", "VEGETABLE_FILE"}
    assert "ANIMAL" in keys


def test_len():
    env = environ.FileAwareMapping(
        env={
            "ANIMAL_FILE": "some-file",
            "VEGETABLE": "leek",
            "VEGETABLE_FILE": "some-vegetable-file",
        }
    )
    assert len(env) == 4


def test_cache(tmp_f):
    env = environ.FileAwareMapping(env={"ANIMAL_FILE": tmp_f})
    assert env["ANIMAL"] == "fish"

    with open(tmp_f, "w") as f:
        f.write("cat")
    assert env["ANIMAL"] == "fish"

    os.unlink(tmp_f)
    assert not os.path.exists(env["ANIMAL_FILE"])
    assert env["ANIMAL"] == "fish"


def test_no_cache(tmp_f):
    env = environ.FileAwareMapping(
        cache=False,
        env={"ANIMAL_FILE": tmp_f},
    )
    assert env["ANIMAL"] == "fish"

    with open(tmp_f, "w") as f:
        f.write("cat")
    assert env["ANIMAL"] == "cat"

    os.unlink(tmp_f)
    assert not os.path.exists(env["ANIMAL_FILE"])
    with pytest.raises(FileNotFoundError):
        assert env["ANIMAL"]


def test_setdefault(tmp_f):
    env = environ.FileAwareMapping(env={"ANIMAL_FILE": tmp_f})
    assert env.setdefault("FRUIT", "apple") == "apple"
    assert env.setdefault("ANIMAL", "cat") == "fish"
    assert env.env == {"ANIMAL_FILE": tmp_f, "FRUIT": "apple"}


class TestDelItem:
    def test_del_key(self):
        env = environ.FileAwareMapping(env={"FRUIT": "apple"})
        del env["FRUIT"]
        with pytest.raises(KeyError):
            env["FRUIT"]

    def test_del_key_with_file_key(self):
        env = environ.FileAwareMapping(env={"ANIMAL_FILE": "some-file"})
        del env["ANIMAL"]
        with pytest.raises(KeyError):
            env["ANIMAL"]

    def test_del_shadowed_key_with_file_key(self):
        env = environ.FileAwareMapping(
            env={"ANIMAL_FILE": "some-file", "ANIMAL": "cat"}
        )
        del env["ANIMAL"]
        with pytest.raises(KeyError):
            env["ANIMAL"]

    def test_del_file_key(self):
        env = environ.FileAwareMapping(
            env={
                "ANIMAL_FILE": "some-file",
                "ANIMAL": "fish",
            }
        )
        del env["ANIMAL_FILE"]
        assert env["ANIMAL"] == "fish"

    def test_del_file_key_clears_cache(self, tmp_f):
        env = environ.FileAwareMapping(
            env={
                "ANIMAL_FILE": tmp_f,
                "ANIMAL": "cat",
            }
        )
        assert env["ANIMAL"] == "fish"
        del env["ANIMAL_FILE"]
        assert env["ANIMAL"] == "cat"


class TestSetItem:
    def test_set_key(self):
        env = environ.FileAwareMapping(env={"FRUIT": "apple"})
        env["FRUIT"] = "banana"
        assert env["FRUIT"] == "banana"

    def test_cant_override_key_with_file_key(self, tmp_f):
        env = environ.FileAwareMapping(
            env={
                "FRUIT": "apple",
                "FRUIT_FILE": tmp_f,
            }
        )
        with open(tmp_f, "w") as f:
            f.write("banana")
        env["FRUIT"] = "cucumber"
        assert env["FRUIT"] == "banana"

    def test_set_file_key(self, tmp_f):
        env = environ.FileAwareMapping(env={"ANIMAL": "cat"})
        env["ANIMAL_FILE"] = tmp_f
        assert env["ANIMAL"] == "fish"

    def test_change_file_key_clears_cache(self, tmp_f):
        env = environ.FileAwareMapping(env={"ANIMAL_FILE": tmp_f})
        assert env["ANIMAL"] == "fish"
        with make_temp_file(text="cat") as new_tmp_f:
            env["ANIMAL_FILE"] = new_tmp_f
            assert env["ANIMAL"] == "cat"