Refactor pytest fixtures - Part 1

tests/core/conftest.py

@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+
+from pytest import fixture
+
+from openfisca_country_template import CountryTaxBenefitSystem
+from openfisca_country_template.entities import *  # noqa analysis:ignore
+
+from openfisca_core.simulation_builder import SimulationBuilder
+from openfisca_core.tools.test_runner import yaml
+from openfisca_core.variables import Variable
+from openfisca_core.periods import ETERNITY
+from openfisca_core.entities import Entity, GroupEntity
+from openfisca_core.model_api import *  # noqa analysis:ignore
+
+
+# PERIODS
+
+@fixture
+def period():
+    return "2016-01"
+
+
+# ENTITIES
+
+
+class TestVariable(Variable):
+    definition_period = ETERNITY
+    value_type = float
+
+    def __init__(self, entity):
+        self.__class__.entity = entity
+        super().__init__()
+
+
+@fixture
+def persons():
+    class TestPersonEntity(Entity):
+        def get_variable(self, variable_name):
+            result = TestVariable(self)
+            result.name = variable_name
+            return result
+
+        def check_variable_defined_for_entity(self, variable_name):
+            return True
+
+    return TestPersonEntity("person", "persons", "", "")
+
+
+@fixture
+def group_entity():
+    class Household(GroupEntity):
+        def get_variable(self, variable_name):
+            result = TestVariable(self)
+            result.name = variable_name
+            return result
+
+        def check_variable_defined_for_entity(self, variable_name):
+            return True
+
+    roles = [{
+        'key': 'parent',
+        'plural': 'parents',
+        'max': 2
+        }, {
+        'key': 'child',
+        'plural': 'children'
+        }]
+
+    return Household("household", "households", "", "", roles)
+
+
+@fixture
+def single():
+    return {
+        "persons": {
+            "Alicia": {
+                "birth": {
+                    "2017-01": None
+                    },
+                "disposable_income": {
+                    "2017-01": None
+                    }
+                }
+            },
+        "households": {
+            "_": {
+                "parents": ["Alicia"]
+                }
+            }
+        }
+
+
+@fixture
+def couple():
+    return {
+        "persons": {
+            "Alicia": {
+                "birth": {
+                    "ETERNITY": "1980-01-01"
+                    },
+                "salary": {
+                    "2017-01": 4000
+                    },
+                "disposable_income": {
+                    "2017-01": None
+                    }
+                },
+            "Javier": {
+                "birth": {
+                    "ETERNITY": "1984-01-01"
+                    },
+                "salary": {
+                    "2017-01": 2500
+                    },
+                "disposable_income": {
+                    "2017-01": None
+                    }
+                }
+            },
+        "households": {
+            "_": {
+                "parents": ["Alicia", "Javier"],
+                "total_benefits": {
+                    "2017-01": None
+                    },
+                "total_taxes": {
+                    "2017-01": None
+                    }
+                }
+            }
+        }
+
+# TAX BENEFIt SYSTEMS
+
+
+@fixture
+def tax_benefit_system():
+    return CountryTaxBenefitSystem()
+
+
+# SIMULATIONS
+
+
+@fixture
+def simulation_builder():
+    return SimulationBuilder()
+
+
+@fixture
+def simulation(tax_benefit_system, simulation_builder):
+    return SimulationBuilder().build_default_simulation(tax_benefit_system)
+
+
+@fixture
+def make_simulation_from_entities(tax_benefit_system, simulation_builder):
+    def _make_simulation_from_entities(entities):
+        return simulation_builder.build_from_entities(tax_benefit_system, entities)
+    return _make_simulation_from_entities
+
+
+@fixture
+def make_simulation_from_tbs_and_variables(simulation_builder, period):
+    def _make_simulation_from_variables_and_tbs(tbs, variables):
+        simulation_builder.default_period = period
+        return simulation_builder.build_from_variables(tbs, variables)
+    return _make_simulation_from_variables_and_tbs
+
+
+@fixture
+def make_simulation_from_yaml(tax_benefit_system, simulation_builder):
+    def _make_simulation_from_yaml(simulation_yaml):
+        return simulation_builder.build_from_dict(tax_benefit_system, yaml.safe_load(simulation_yaml))
+    return _make_simulation_from_yaml
+
+
+@fixture
+def simulation_single(make_simulation_from_entities, single):
+    return make_simulation_from_entities(single)
+
+
+@fixture
+def simulation_couple(make_simulation_from_entities, couple):
+    return make_simulation_from_entities(couple)
+
+
+# VARIABLES
+
+
+@fixture
+def make_variable():
+    def _make_variable(name, **new_methods_and_attrs):
+        methods_and_attrs = {}
+        default = dict(value_type = int, entity = Person, definition_period = MONTH)
+        methods_and_attrs.update(default)
+        methods_and_attrs.update(new_methods_and_attrs)
+        return type(name, (Variable, ), methods_and_attrs)
+    return _make_variable

tests/core/parameter_validation/test_parameter_clone.py

@@ -1,6 +1,4 @@
 # -*- coding: utf-8 -*-
-from ..test_countries import tax_benefit_system
-
 import os
 from openfisca_core.parameters import ParameterNode
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
@@ -20,7 +18,7 @@ def test_clone():
     assert id(clone.node1.param) != id(parameters.node1.param)
 
 
-def test_clone_parameter():
+def test_clone_parameter(tax_benefit_system):
 
     param = tax_benefit_system.parameters.taxes.income_tax_rate
     clone = param.clone()
@@ -32,7 +30,7 @@ def test_clone_parameter():
     assert clone.values_list == param.values_list
 
 
-def test_clone_parameter_node():
+def test_clone_parameter_node(tax_benefit_system):
     node = tax_benefit_system.parameters.taxes
     clone = node.clone()
 
@@ -41,15 +39,15 @@ def test_clone_parameter_node():
     assert clone.children['income_tax_rate'] is not node.children['income_tax_rate']
 
 
-def test_clone_scale():
+def test_clone_scale(tax_benefit_system):
     scale = tax_benefit_system.parameters.taxes.social_security_contribution
     clone = scale.clone()
 
     assert clone.brackets[0] is not scale.brackets[0]
     assert clone.brackets[0].rate is not scale.brackets[0].rate
 
 
-def test_deep_edit():
+def test_deep_edit(tax_benefit_system):
     parameters = tax_benefit_system.parameters
     clone = parameters.clone()
 

tests/core/test_axes.py

@@ -1,13 +1,5 @@
 # -*- coding: utf-8 -*-
-from pytest import fixture, approx
-
-from openfisca_core.simulation_builder import SimulationBuilder
-from .test_simulation_builder import *  # noqa: F401
-
-
-@fixture
-def simulation_builder():
-    return SimulationBuilder()
+from pytest import approx
 
 
 def test_add_axis_on_persons(simulation_builder, persons):
@@ -134,9 +126,8 @@ def test_add_perpendicular_axes(simulation_builder, persons):
 # Integration test
 
 
-def test_simulation_with_axes(simulation_builder):
-    from .test_countries import tax_benefit_system
-    input_yaml = """
+def test_simulation_with_axes(make_simulation_from_yaml):
+    simulation = make_simulation_from_yaml("""
         persons:
           Alicia: {salary: {2018-11: 0}}
           Javier: {}
@@ -153,8 +144,6 @@ def test_simulation_with_axes(simulation_builder):
                   min: 0
                   max: 3000
                   period: 2018-11
-    """
-    data = yaml.safe_load(input_yaml)
-    simulation = simulation_builder.build_from_dict(tax_benefit_system, data)
+    """)
     assert simulation.get_array('salary', '2018-11') == approx([0, 0, 0, 0, 0, 0])
     assert simulation.get_array('rent', '2018-11') == approx([0, 0, 3000, 0])

tests/core/test_calculate_output.py

@@ -1,59 +1,47 @@
-from openfisca_core.model_api import *  # noqa analysis:ignore
-from openfisca_core.simulation_builder import SimulationBuilder
-from openfisca_core.tools import assert_near
-
-from openfisca_country_template import CountryTaxBenefitSystem
-from openfisca_country_template.entities import *  # noqa analysis:ignore
-from openfisca_country_template.situation_examples import single
-
 from pytest import fixture, raises
 
-
-@fixture
-def simulation():
-    return SimulationBuilder().build_from_entities(tax_benefit_system, single)
+from openfisca_core.tools import assert_near
+from openfisca_core.simulations import calculate_output_add
+from openfisca_core.simulations import calculate_output_divide
+from openfisca_core.periods import YEAR
 
 
-class simple_variable(Variable):
-    entity = Person
-    definition_period = MONTH
-    value_type = int
+@fixture
+def simple_variable(make_variable):
+    return make_variable('simple_variable')
 
 
-class variable_with_calculate_output_add(Variable):
-    entity = Person
-    definition_period = MONTH
-    value_type = int
-    calculate_output = calculate_output_add
+@fixture
+def variable_with_calculate_output_add(make_variable):
+    return make_variable('variable_with_calculate_output_add', calculate_output = calculate_output_add)
 
 
-class variable_with_calculate_output_divide(Variable):
-    entity = Person
-    definition_period = YEAR
-    value_type = int
-    calculate_output = calculate_output_divide
+@fixture
+def variable_with_calculate_output_divide(make_variable):
+    return make_variable('variable_with_calculate_output_divide',
+            definition_period = YEAR,
+            calculate_output = calculate_output_divide)
 
 
-tax_benefit_system = CountryTaxBenefitSystem()
-tax_benefit_system.add_variables(
-    simple_variable,
-    variable_with_calculate_output_add,
-    variable_with_calculate_output_divide
-    )
+@fixture
+def simulation_single_with_variables(simulation_builder, tax_benefit_system, single,
+        simple_variable, variable_with_calculate_output_add, variable_with_calculate_output_divide):
+    tax_benefit_system.add_variables(simple_variable, variable_with_calculate_output_add, variable_with_calculate_output_divide)
+    return simulation_builder.build_from_entities(tax_benefit_system, single)
 
 
-def test_calculate_output_default(simulation):
+def test_calculate_output_default(simulation_single_with_variables):
     with raises(ValueError):
-        simulation.calculate_output('simple_variable', 2017)
+        simulation_single_with_variables.calculate_output('simple_variable', 2017)
 
 
-def test_calculate_output_add(simulation):
-    simulation.set_input('variable_with_calculate_output_add', '2017-01', [10])
-    simulation.set_input('variable_with_calculate_output_add', '2017-05', [20])
-    simulation.set_input('variable_with_calculate_output_add', '2017-12', [70])
-    assert_near(simulation.calculate_output('variable_with_calculate_output_add', 2017), 100)
+def test_calculate_output_add(simulation_single_with_variables):
+    simulation_single_with_variables.set_input('variable_with_calculate_output_add', '2017-01', [10])
+    simulation_single_with_variables.set_input('variable_with_calculate_output_add', '2017-05', [20])
+    simulation_single_with_variables.set_input('variable_with_calculate_output_add', '2017-12', [70])
+    assert_near(simulation_single_with_variables.calculate_output('variable_with_calculate_output_add', 2017), 100)
 
 
-def test_calculate_output_divide(simulation):
-    simulation.set_input('variable_with_calculate_output_divide', 2017, [12000])
-    assert_near(simulation.calculate_output('variable_with_calculate_output_divide', '2017-06'), 1000)
+def test_calculate_output_divide(simulation_single_with_variables):
+    simulation_single_with_variables.set_input('variable_with_calculate_output_divide', 2017, [12000])
+    assert_near(simulation_single_with_variables.calculate_output('variable_with_calculate_output_divide', '2017-06'), 1000)