summaryrefslogtreecommitdiffstats
path: root/gitlint/tests/test_utils.py
blob: 6f667c215c22a89eab9a3c8a0742cbd5668bba95 (plain)
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
# -*- coding: utf-8 -*-

from gitlint import utils
from gitlint.tests.base import BaseTestCase

try:
    # python 2.x
    from mock import patch
except ImportError:
    # python 3.x
    from unittest.mock import patch  # pylint: disable=no-name-in-module, import-error


class UtilsTests(BaseTestCase):

    def tearDown(self):
        # Since we're messing around with `utils.PLATFORM_IS_WINDOWS` during these tests, we need to reset
        # its value after we're done this doesn't influence other tests
        utils.PLATFORM_IS_WINDOWS = utils.platform_is_windows()

    @patch('os.environ')
    def test_use_sh_library(self, patched_env):
        patched_env.get.return_value = "1"
        self.assertEqual(utils.use_sh_library(), True)
        patched_env.get.assert_called_once_with("GITLINT_USE_SH_LIB", None)

        for invalid_val in ["0", u"foöbar"]:
            patched_env.get.reset_mock()  # reset mock call count
            patched_env.get.return_value = invalid_val
            self.assertEqual(utils.use_sh_library(), False, invalid_val)
            patched_env.get.assert_called_once_with("GITLINT_USE_SH_LIB", None)

        # Assert that when GITLINT_USE_SH_LIB is not set, we fallback to checking whether we're on Windows
        utils.PLATFORM_IS_WINDOWS = True
        patched_env.get.return_value = None
        self.assertEqual(utils.use_sh_library(), False)

        utils.PLATFORM_IS_WINDOWS = False
        self.assertEqual(utils.use_sh_library(), True)

    @patch('gitlint.utils.locale')
    def test_default_encoding_non_windows(self, mocked_locale):
        utils.PLATFORM_IS_WINDOWS = False
        mocked_locale.getpreferredencoding.return_value = u"foöbar"
        self.assertEqual(utils.getpreferredencoding(), u"foöbar")
        mocked_locale.getpreferredencoding.assert_called_once()

        mocked_locale.getpreferredencoding.return_value = False
        self.assertEqual(utils.getpreferredencoding(), u"UTF-8")

    @patch('os.environ')
    def test_default_encoding_windows(self, patched_env):
        utils.PLATFORM_IS_WINDOWS = True
        # Mock out os.environ
        mock_env = {}

        def mocked_get(key, default):
            return mock_env.get(key, default)

        patched_env.get.side_effect = mocked_get

        # Assert getpreferredencoding reads env vars in order: LC_ALL, LC_CTYPE, LANG
        mock_env = {"LC_ALL": u"lc_all_välue", "LC_CTYPE": u"foo", "LANG": u"bar"}
        self.assertEqual(utils.getpreferredencoding(), u"lc_all_välue")
        mock_env = {"LC_CTYPE": u"lc_ctype_välue", "LANG": u"hur"}
        self.assertEqual(utils.getpreferredencoding(), u"lc_ctype_välue")
        mock_env = {"LANG": u"lang_välue"}
        self.assertEqual(utils.getpreferredencoding(), u"lang_välue")

        # Assert split on dot
        mock_env = {"LANG": u"foo.bär"}
        self.assertEqual(utils.getpreferredencoding(), u"bär")

        # assert default encoding is UTF-8
        mock_env = {}
        self.assertEqual(utils.getpreferredencoding(), "UTF-8")
        mock_env = {"FOO": u"föo"}
        self.assertEqual(utils.getpreferredencoding(), "UTF-8")