Module pedantic.tests.validate.test_parameter_environment_variable

Classes

class TestParameterEnvironmentVariable (methodName='runTest')

A class whose instances are single test cases.

By default, the test code itself should be placed in a method named 'runTest'.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment ('fixture') can be implemented by overriding the 'setUp' and 'tearDown' methods respectively.

If it is necessary to override the init method, the base class init method must always be called. It is important that subclasses should not change the signature of their init method, since instances of the classes are instantiated automatically by parts of the framework in order to be run.

When subclassing TestCase, you can set these attributes: * failureException: determines which exception will be raised when the instance's assertion methods fail; test methods raising this exception will be deemed to have 'failed' rather than 'errored'. * longMessage: determines whether long messages (including repr of objects used in assert methods) will be printed on failure in addition to any explicit message passed. * maxDiff: sets the maximum length of a diff in failure messages by assert methods using difflib. It is looked up as an instance attribute so can be configured by individual tests if required.

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Expand source code

class TestParameterEnvironmentVariable(TestCase):
    def setUp(self) -> None:
        if 'foo' in os.environ:
            del os.environ['foo']

    def test_parameter_environment_variable_str(self) -> None:
        @validate(EnvironmentVariableParameter(name='foo', value_type=str))
        def bar(foo):
            return foo

        os.environ['foo'] = '42'
        self.assertEqual('42', bar())

    def test_parameter_environment_variable_int(self) -> None:
        @validate(EnvironmentVariableParameter(name='foo', value_type=int))
        def bar(foo):
            return foo

        os.environ['foo'] = '42'
        self.assertEqual(42, bar())

    def test_parameter_environment_variable_float(self) -> None:
        @validate(EnvironmentVariableParameter(name='foo', value_type=float))
        def bar(foo):
            return foo

        os.environ['foo'] = '42.7'
        self.assertEqual(42.7, bar())

    def test_parameter_environment_variable_bool(self) -> None:
        @validate(EnvironmentVariableParameter(name='foo', value_type=bool))
        def bar(foo):
            return foo

        for value in ['true', 'True', 'TRUE']:
            os.environ['foo'] = value
            self.assertTrue(bar())

        for value in ['false', 'False', 'FALSE']:
            os.environ['foo'] = value
            self.assertFalse(bar())

        for value in ['invalid', 'frue', 'talse']:
            os.environ['foo'] = value

            with self.assertRaises(expected_exception=ParameterException):
                bar()

    def test_parameter_environment_variable_not_set(self) -> None:
        @validate(EnvironmentVariableParameter(name='foo'))
        def bar(foo):
            return foo

        with self.assertRaises(expected_exception=ParameterException):
            bar()

    def test_invalid_value_type(self) -> None:
        with self.assertRaises(expected_exception=AssertionError):
            @validate(EnvironmentVariableParameter(name='foo', value_type=dict))
            def bar(foo):
                return foo

    def test_parameter_environment_variable_different_name(self) -> None:
        @validate(EnvironmentVariableParameter(name='foo', env_var_name='fuu', value_type=str))
        def bar(foo):
            return foo

        os.environ['fuu'] = '42'
        self.assertEqual('42', bar())

    def test_two_parameters(self) -> None:
        @validate(EnvironmentVariableParameter(name='a'), strict=False)
        def foo(a: float, b: int):
            print(f'{a} and {b}')

        os.environ['a'] = '42'
        foo(b=42)

Ancestors

• unittest.case.TestCase

Methods

def setUp(self) ‑> None

Hook method for setting up the test fixture before exercising it.

Expand source code

def setUp(self) -> None:
    if 'foo' in os.environ:
        del os.environ['foo']

def test_invalid_value_type(self) ‑> None

Expand source code

def test_invalid_value_type(self) -> None:
    with self.assertRaises(expected_exception=AssertionError):
        @validate(EnvironmentVariableParameter(name='foo', value_type=dict))
        def bar(foo):
            return foo

def test_parameter_environment_variable_bool(self) ‑> None

Expand source code

def test_parameter_environment_variable_bool(self) -> None:
    @validate(EnvironmentVariableParameter(name='foo', value_type=bool))
    def bar(foo):
        return foo

    for value in ['true', 'True', 'TRUE']:
        os.environ['foo'] = value
        self.assertTrue(bar())

    for value in ['false', 'False', 'FALSE']:
        os.environ['foo'] = value
        self.assertFalse(bar())

    for value in ['invalid', 'frue', 'talse']:
        os.environ['foo'] = value

        with self.assertRaises(expected_exception=ParameterException):
            bar()

def test_parameter_environment_variable_different_name(self) ‑> None

Expand source code

def test_parameter_environment_variable_different_name(self) -> None:
    @validate(EnvironmentVariableParameter(name='foo', env_var_name='fuu', value_type=str))
    def bar(foo):
        return foo

    os.environ['fuu'] = '42'
    self.assertEqual('42', bar())

def test_parameter_environment_variable_float(self) ‑> None

Expand source code

def test_parameter_environment_variable_float(self) -> None:
    @validate(EnvironmentVariableParameter(name='foo', value_type=float))
    def bar(foo):
        return foo

    os.environ['foo'] = '42.7'
    self.assertEqual(42.7, bar())

def test_parameter_environment_variable_int(self) ‑> None

Expand source code

def test_parameter_environment_variable_int(self) -> None:
    @validate(EnvironmentVariableParameter(name='foo', value_type=int))
    def bar(foo):
        return foo

    os.environ['foo'] = '42'
    self.assertEqual(42, bar())

def test_parameter_environment_variable_not_set(self) ‑> None

Expand source code

def test_parameter_environment_variable_not_set(self) -> None:
    @validate(EnvironmentVariableParameter(name='foo'))
    def bar(foo):
        return foo

    with self.assertRaises(expected_exception=ParameterException):
        bar()

def test_parameter_environment_variable_str(self) ‑> None

Expand source code

def test_parameter_environment_variable_str(self) -> None:
    @validate(EnvironmentVariableParameter(name='foo', value_type=str))
    def bar(foo):
        return foo

    os.environ['foo'] = '42'
    self.assertEqual('42', bar())

def test_two_parameters(self) ‑> None

Expand source code

def test_two_parameters(self) -> None:
    @validate(EnvironmentVariableParameter(name='a'), strict=False)
    def foo(a: float, b: int):
        print(f'{a} and {b}')

    os.environ['a'] = '42'
    foo(b=42)