File: test_config.py

package info (click to toggle)
python-pystow 0.5.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 408 kB
  • sloc: python: 3,119; makefile: 13
file content (110 lines) | stat: -rw-r--r-- 4,195 bytes parent folder | download | duplicates (2)
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
# -*- coding: utf-8 -*-

"""Test configuration loading."""

import tempfile
import unittest
from pathlib import Path

import pystow
from pystow.config_api import CONFIG_HOME_ENVVAR, _get_cfp
from pystow.utils import mock_envvar


class TestConfig(unittest.TestCase):
    """Test configuration."""

    @classmethod
    def setUpClass(cls) -> None:
        """Set up the class for testing."""
        cls.test_section = "test"
        cls.test_option = "option"
        cls.test_value = "value"
        cls.cfp = _get_cfp(cls.test_section)
        cls.cfp.add_section(cls.test_section)
        cls.cfp.set(
            section=cls.test_section,
            option=cls.test_option,
            value=cls.test_value,
        )

    def test_env_cast(self):
        """Test casting works properly when getting from the environment."""
        with mock_envvar("TEST_VAR", "1234"):
            self.assertEqual("1234", pystow.get_config("test", "var"))
            self.assertEqual("1234", pystow.get_config("test", "var", dtype=str))
            self.assertEqual(1234, pystow.get_config("test", "var", dtype=int))
            with self.assertRaises(ValueError):
                pystow.get_config("test", "var", dtype=bool)
            with self.assertRaises(TypeError):
                pystow.get_config("test", "var", dtype=object)

    def test_get_config(self):
        """Test lookup not existing."""
        self.assertIsNone(pystow.get_config(self.test_section, "key"))
        self.assertEqual("1234", pystow.get_config(self.test_section, "key", default="1234"))

        value = "not_value"
        self.assertEqual(
            value, pystow.get_config(self.test_section, self.test_option, passthrough=value)
        )

        self.assertEqual(1, pystow.get_config(self.test_section, self.test_option, passthrough=1))
        self.assertEqual(
            1, pystow.get_config(self.test_section, self.test_option, passthrough="1", dtype=int)
        )

        self.assertEqual(
            True,
            pystow.get_config(self.test_section, self.test_option, passthrough="1", dtype=bool),
        )
        self.assertEqual(
            True,
            pystow.get_config(self.test_section, self.test_option, passthrough="yes", dtype=bool),
        )
        self.assertEqual(
            True,
            pystow.get_config(self.test_section, self.test_option, passthrough="Yes", dtype=bool),
        )
        self.assertEqual(
            True,
            pystow.get_config(self.test_section, self.test_option, passthrough="YES", dtype=bool),
        )
        self.assertEqual(
            True,
            pystow.get_config(self.test_section, self.test_option, passthrough="True", dtype=bool),
        )
        self.assertEqual(
            True,
            pystow.get_config(self.test_section, self.test_option, passthrough="TRUE", dtype=bool),
        )
        self.assertEqual(
            True,
            pystow.get_config(self.test_section, self.test_option, passthrough="T", dtype=bool),
        )
        self.assertEqual(
            True,
            pystow.get_config(self.test_section, self.test_option, passthrough="t", dtype=bool),
        )
        self.assertEqual(
            True,
            pystow.get_config(self.test_section, self.test_option, passthrough=True, dtype=bool),
        )
        self.assertEqual(
            True, pystow.get_config(self.test_section, self.test_option, passthrough=1, dtype=bool)
        )

    def test_subsection(self):
        """Test subsections."""
        with tempfile.TemporaryDirectory() as directory, mock_envvar(CONFIG_HOME_ENVVAR, directory):
            directory = Path(directory)
            path = directory.joinpath("test.ini")
            self.assertFalse(path.is_file(), msg="file should not already exist")

            self.assertIsNone(pystow.get_config("test:subtest", "key"))
            self.assertFalse(path.is_file(), msg="getting config should not create a file")

            pystow.write_config("test:subtest", "key", "value")
            self.assertTrue(path.is_file(), msg=f"{list(directory.iterdir())}")

            self.assertEqual("value", pystow.get_config("test:subtest", "key"))