Store default profile in aiida_profile_factory (#6893)

Ensures that the config set in fixture `aiida_profile_factory` is stored
persistently on disk and not just in memory. Tests have been added that use the
`aiida_config_tmp` implicitly through autouse `aiida_profile` fixture. The test
checks if the default profile is set when loading the config from file. Note that
`aiida_profile_factory` is intended to be used with a path argument to chose
the configuration directory. By that we avoid race conditions on configuration
tests due to concurrent tests.

The tests did not fail before because only the default profile option was not
stored persistently while the profile was, and further all CLI tests specify
the profile explicitly.

Author: danielhollas

src/aiida/tools/pytest_fixtures/configuration.py

@@ -141,6 +141,7 @@ def factory(
             is_test_profile=True,
         )
         config.set_default_profile(profile.name)
+        config.store()
 
         def reset_storage():
             """Reset the storage of the profile.

tests/tools/pytest_fixtures/test_configuration.py

@@ -1,14 +1,29 @@
 """Test the pytest fixtures."""
 
+from pathlib import Path
+
+from aiida.manage.configuration import get_config, load_config
+from aiida.manage.configuration.settings import DEFAULT_CONFIG_FILE_NAME
+
 
 def test_aiida_config(tmp_path_factory):
     """Test that ``aiida_config`` fixture is loaded by default and creates a config instance in temp directory."""
-    from aiida.manage.configuration import get_config
-    from aiida.manage.configuration.config import Config
+    from aiida.manage.configuration import CONFIG
+
+    config = get_config(create=False)
+    assert config is CONFIG
+    assert config.dirpath.startswith(str(tmp_path_factory.getbasetemp()))
+    assert Path(config.dirpath, DEFAULT_CONFIG_FILE_NAME).is_file()
+    assert config._default_profile
+
 
-    config = get_config()
-    assert isinstance(config, Config)
+def test_aiida_config_file(tmp_path_factory):
+    """Test that ``aiida_config`` fixture stores the configuration in a config file in a temp directory."""
+    # Unlike get_config, load_config always loads the configuration from a file
+    config = load_config(create=False)
     assert config.dirpath.startswith(str(tmp_path_factory.getbasetemp()))
+    assert Path(config.dirpath, DEFAULT_CONFIG_FILE_NAME).is_file()
+    assert config._default_profile
 
 
 def test_aiida_config_tmp(aiida_config_tmp, tmp_path_factory):