[bug] Testing and mocking docs are wrong

[anxodio]

Describe the bug
The docs in https://dynaconf.readthedocs.io/en/latest/guides/testing.html explain how to test with dynaconf. The point is that if you follow the explanation, you will see AttributeError: 'DynaconfDict' object has no attribute 'current_env'

To Reproduce

Just try to follow the steps in https://dynaconf.readthedocs.io/en/latest/guides/testing.html

Expected behavior
The code don't fail and the mock can be used.

Debug output

Debug Output

Traceback (most recent call last):
  File "lalala.py", line 5, in <module>
    toml_loader.load(mocked_settings, filename="test_conf.toml", env="testing")
  File "/home/angel/.virtualenvs/navi-Pag0EvBg/lib/python3.6/site-packages/dynaconf/loaders/toml_loader.py", line 38, in load
    loader.load(filename=filename, key=key, silent=silent)
  File "/home/angel/.virtualenvs/navi-Pag0EvBg/lib/python3.6/site-packages/dynaconf/loaders/base.py", line 69, in load
    env_list = build_env_list(self.obj, self.env)
  File "/home/angel/.virtualenvs/navi-Pag0EvBg/lib/python3.6/site-packages/dynaconf/utils/__init__.py", line 220, in build_env_list
    if obj.current_env and obj.current_env not in env_list:
AttributeError: 'DynaconfDict' object has no attribute 'current_env'

Environment (please complete the following information):

• OS: Ubuntu 18.04
• Dynaconf Version 2.2

[rochacbruno]

We need to add a current_env property here

https://github.com/rochacbruno/dynaconf/blob/6bd9d8b88803690117e5cb5b14388da8b8011d91/dynaconf/utils/__init__.py#L52-L72

[rochacbruno]

def __init__(self, *args, **kwargs):
        self._loaded_files = []
+       self.current_env = kwargs.get('env', 'development')
        super(DynaconfDict, self).__init__(*args, **kwargs)

[hilam]

I will work on this.

[hilam]

@rochacbruno Your suggestion results in another error. Any other ideas? I'm trying to figure out.

Traceback (most recent call last):
File "/home/hilam/other-projects/dynaconf/dynaconf/loaders/base.py", line 69, in load
env_list = build_env_list(self.obj, self.env)
File "/home/hilam/other-projects/dynaconf/dynaconf/utils/init.py", line 232, in build_env_list
return [env.lower() for env in env_list]
File "/home/hilam/other-projects/dynaconf/dynaconf/utils/init.py", line 232, in
return [env.lower() for env in env_list]
AttributeError: 'NoneType' object has no attribute 'lower'

[rochacbruno]

@hilam maybe

self.current_env = kwargs.get('env') or 'development'

[sinnedh]

We have the same issue here with additional accessors as as_dict or as_int here:

AttributeError: 'DynaconfDict' object has no attribute 'as_int'

[rochacbruno]

I think it is time to reimplement the DynaconfDict in a way that it inherits from Settings and overrides some methods to avoid unwanted loads under testing environment.

[hilam]

During my attempts to solve it, I tried to inherit from Settings or LazySettings, but it didn't work. Mysterious import errors. As you know the code better, @rochacbruno you may be able to find the solution. I could not.

[ximet]

have the same issue. How I can help with it?

[rochacbruno]

This is a pending issue, we still need a way to have DynaconfDict to be an instance of Dynaconf class or a subclass of it.

Probably we can deprecate the DynaconfDict (alias it to a new class)

[mazzi]

Nice insight!
@rochacbruno So actually there's no way to mock settings?
I was digging in the tests but didn't find anything to load a json or a dict and being able to mock tests.

I wrote something like this. Not optimum but for now it works ok for my purposes. Maybe somebody finds it useful.

    from dynaconf import LazySettings
    from dynaconf.loaders.json_loader import load

    mocked_settings = LazySettings(environments=True, ENV_FOR_DYNACONF="DEFAULT")

    data = """
    {
        "default" : {
            "SETTING_ONE": false,
            "SETTING_TWO": "test"
        }
    }
    """
    load(mocked_settings, filename=data)

Thanks!

Another option would be to use Monkeypatch

[arugifa]

@mazzi In fact, MonkeyPatching Dynaconf settings in Pytest doesn't work, unfortunately. Setting values don't change that way.

[limdauto]

I think the easiest way is to dump a settings file to a temporary location and load it. Something like:

@pytest.fixture
def mock_settings_path(tmpdir):
    settings_path = tmpdir.mkdir("test_package").join("settings.py")
    settings_path.write(
        textwrap.dedent(
            f"""
                SETTING_ONE = True
            """
        )
    )
    return str(settings_path) 

And you can use the fixture as follows:

def test_settings_file(mock_settings_path):
    settings = LazySettings(settings_file=mock_settings_path)
    assert SETTING_ONE == True

The beauty of this approach is that you can actually add a Mock to your mock settings file, e.g.

# in your test module
MOCK_SETTING_TWO = MagicMock()

# in your mock settings file
f"""
from {__name__} import MOCK_SETTING_TWO
SETTING_TWO = MOCK_SETTING_TWO
"""

[GerardoGR]

I haven't had a closer look to the code to see the inner workings of this, but initializing and mocking the object like this:

from unittest.mock import patch

from dynaconf import Dynaconf

from my_module import function_name


@patch("config.settings", Dynaconf(log_level="DEBUG"))
def test_patch(self):
    assert function_name() == "DEBUG"

Gives the expected result when trying to access the setting in function_name like settings.log_level or settings["log_level"]

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.