Merge pull request #8 from collective/issue-5-fixture-generate-mo

Add fixture  to compile translation files during tests

README.md

@@ -11,8 +11,7 @@
 
 [![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/pytest-plone)](https://pypi.org/project/pytest-plone/)
 
-[![Code analysis checks](https://github.com/collective/pytest-plone/actions/workflows/code-analysis.yml/badge.svg)](https://github.com/collective/pytest-plone/actions/workflows/code-analysis.yml)
-[![Tests](https://github.com/collective/pytest-plone/actions/workflows/tests.yml/badge.svg)](https://github.com/collective/pytest-plone/actions/workflows/tests.yml)
+[![Tests](https://github.com/collective/pytest-plone/actions/workflows/meta.yml/badge.svg)](https://github.com/collective/pytest-plone/actions/workflows/meta.yml)
 ![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000)
 
 [![GitHub contributors](https://img.shields.io/github/contributors/collective/pytest-plone)](https://github.com/collective/pytest-plone)
@@ -72,6 +71,25 @@ In the code above, the following pytest fixtures will be available to your tests
 
 ## Fixtures
 
+### generate_mo
+
+|  |  |
+| --- | --- |
+| Description | Set environment variable to force Zope to compile translation files |
+| Required Fixture |  |
+| Scope | **Session** |
+
+Add a new fixture to your `conftest.py` to force `generate_mo` to be called for all tests.
+
+```python
+
+@pytest.fixture(scope="session", autouse=True)
+def session_initialization(generate_mo):
+    """Fixture used to force translation files to be compiled."""
+    yield
+
+```
+
 ### app
 
 |  |  |

news/5.feature

@@ -0,0 +1 @@
+Add fixture `generate_mo` to compile translation files during tests [@ericof]

src/pytest_plone/fixtures/__init__.py

@@ -9,6 +9,7 @@
 from .base import portal
 from .content import get_behaviors
 from .content import get_fti
+from .env import generate_mo
 from .vocabularies import get_vocabulary
 
 
@@ -17,6 +18,7 @@
     browser_layers,
     controlpanel_actions,
     get_behaviors,
+    generate_mo,
     get_fti,
     get_vocabulary,
     http_request,

src/pytest_plone/fixtures/env.py

@@ -0,0 +1,23 @@
+"""Environment fixtures."""
+import os
+import pytest
+
+
+@pytest.fixture(scope="session")
+def generate_mo():
+    """Compile translation files and generate .mo files.
+
+    This is a session fixture, as it needs to compile files just once.
+    """
+    # Set environment variable
+    key = "zope_i18n_compile_mo_files"
+    current_value = os.getenv(key, None)
+    os.environ[key] = "1"
+    try:
+        yield
+    finally:
+        # Revert to previous state
+        if current_value is None:
+            os.environ.pop(key)
+        else:
+            os.environ[key] = current_value

tests/env/test_env_generate_mo.py

@@ -0,0 +1,30 @@
+TEST_FILES = {
+    "test_generate_mo_result_no_env.py": """
+    import os
+
+    def test_generate_mo_result(generate_mo):
+        assert os.getenv("zope_i18n_compile_mo_files") == "1"
+
+    """,
+    "test_generate_mo_result_with_env.py": """
+    import pytest
+    import os
+
+    @pytest.fixture(scope="session", autouse=True)
+    def set_i18n_var():
+        os.environ["zope_i18n_compile_mo_files"] = "2"
+
+    def test_generate_mo_result():
+        assert os.getenv("zope_i18n_compile_mo_files") == "2"
+
+    """,
+}
+
+
+def test_generate_mo(testdir):
+    """Test generate_mo adds environment variable."""
+    testdir.makepyfile(**TEST_FILES)
+    # run all tests with pytest
+    result = testdir.runpytest()
+    # check that all tests passed
+    result.assert_outcomes(passed=len(TEST_FILES))

tests/test_fixtures.py

@@ -4,22 +4,25 @@ def test_all_fixtures(testdir):
         "app",
         "browser_layers",
         "controlpanel_actions",
+        "generate_mo",
         "get_behaviors",
         "get_fti",
         "get_vocabulary",
         "http_request",
         "installer",
-        "profile_last_version",
         "portal",
+        "profile_last_version",
         "setup_tool",
     ]
     pyfile = ""
     for fixture in fixtures:
         pyfile = f"""
         {pyfile}
 
-        def test_{fixture}({fixture}):
-            assert {fixture} is not None
+        def test_{fixture}_exists({fixture}):
+            # Just pass the test, because if a fixture is not available,
+            # it will raise an error
+            assert True
 
         """