revert recipe fixture back, explicitly set scope to 'function', and add a new helper function that builds recipe for init testing

Author: cadenmyers13

tests/conftest.py

@@ -147,29 +147,25 @@ def _capturestdout(f, *args, **kwargs):
     return _capturestdout
 
 
-@pytest.fixture()
+@pytest.fixture(scope="function")
 def build_recipe_one_contribution():
-    "helper to build a simple recipe"
-
-    def _build_recipe():
-        profile = Profile()
-        x = linspace(0, pi, 11)
-        y = sin(x)
-        profile.set_observed_profile(x, y)
-        contribution = FitContribution("c1")
-        contribution.set_profile(profile)
-        contribution.set_equation("amplitude*sin(wave_number*x + phase_shift)")
-        recipe = FitRecipe()
-        recipe.add_contribution(contribution)
-        recipe.add_variable(contribution.amplitude, 4)
-        recipe.add_variable(contribution.wave_number, 3)
-        recipe.add_variable(contribution.phase_shift, 2)
-        return recipe
-
-    return _build_recipe
-
-
-@pytest.fixture()
+    """Helper to build a simple recipe."""
+    profile = Profile()
+    x = linspace(0, pi, 11)
+    y = sin(x)
+    profile.set_observed_profile(x, y)
+    contribution = FitContribution("c1")
+    contribution.set_profile(profile)
+    contribution.set_equation("amplitude*sin(wave_number*x + phase_shift)")
+    recipe = FitRecipe()
+    recipe.add_contribution(contribution)
+    recipe.add_variable(contribution.amplitude, 4)
+    recipe.add_variable(contribution.wave_number, 3)
+    recipe.add_variable(contribution.phase_shift, 2)
+    return recipe
+
+
+@pytest.fixture(scope="function")
 def build_recipe_two_contributions():
     """Helper to build a recipe with two physically related
     contributions."""

tests/test_fitrecipe.py

@@ -33,6 +33,29 @@
 matplotlib.use("Agg")
 
 
+def build_recipe_for_init_testing():
+    """A helper to build a FitRecipe with one contribution and three
+    variables.
+
+    This is identical to the build_recipe_one_contribution fixture, but
+    is a function instead of a fixture so we can call it to get unique
+    recipe objects in a singular test.
+    """
+    profile = Profile()
+    x = linspace(0, pi, 11)
+    y = sin(x)
+    profile.set_observed_profile(x, y)
+    contribution = FitContribution("c1")
+    contribution.set_profile(profile)
+    contribution.set_equation("amplitude*sin(wave_number*x + phase_shift)")
+    recipe = FitRecipe()
+    recipe.add_contribution(contribution)
+    recipe.add_variable(contribution.amplitude, 4)
+    recipe.add_variable(contribution.wave_number, 3)
+    recipe.add_variable(contribution.phase_shift, 2)
+    return recipe
+
+
 class TestFitRecipe(unittest.TestCase):
 
     def setUp(self):
@@ -530,48 +553,44 @@ def test_initialize_recipe_from_recipe_bad(build_recipe_two_contributions):
 def test_initialize_recipe_from_results_object(build_recipe_one_contribution):
     # Case: User initializes a FitRecipe from a FitResults object
     # expected: recipe is initialized with variables from previous fit
-    recipe1 = build_recipe_one_contribution()
+
+    # create unique recipe1
+    recipe1 = build_recipe_for_init_testing()
     optimize_recipe(recipe1)
     results1 = FitResults(recipe1)
     expected_values = np.round(results1.varvals, 5)
     expected_names = results1.varnames
 
-    recipe2 = build_recipe_one_contribution()
-    recipe2.create_new_variable(
-        "extra_var", 5
-    )  # should be included in the initialized recipe
+    # create unique recipe2 with same contributions
+    # and variables as recipe1 but not optimized yet
+    recipe2 = build_recipe_for_init_testing()
+    assert recipe1 != recipe2
+    # create a new var that should be include in the initialized recipe
+    recipe2.create_new_variable("extra_var", 5)
     actual_values_before_init = [val for val in recipe2.get_values()]
-    actual_names_before_init = recipe2.get_names()
-    expected_names_before_init = [
-        "amplitude",
-        "extra_var",
-        "phase_shift",
-        "wave_number",
-    ]
-    expected_values_before_init = [
-        4,
-        3,
-        2,
-        5,
-    ]  # the three variables + the extra_var
-
-    assert actual_values_before_init == expected_values_before_init
-    assert sorted(actual_names_before_init) == sorted(
-        expected_names_before_init
+    actual_names_before_init = sorted(recipe2.get_names())
+    # the three variables + the extra_var
+    expected_names_before_init = sorted(
+        [
+            "amplitude",
+            "extra_var",
+            "phase_shift",
+            "wave_number",
+        ]
     )
-
+    expected_values_before_init = [4, 3, 2, 5]
+    assert actual_values_before_init == expected_values_before_init
+    assert actual_names_before_init == expected_names_before_init
     recipe2.initialize_recipe_with_results(results1)
     optimize_recipe(recipe2)
     results2 = FitResults(recipe2)
     actual_values = np.round(results2.varvals, 5)
     actual_names = results2.varnames
 
-    expected_names = expected_names + [
-        "extra_var"
-    ]  # add the new variable name to expected names
-    expected_values = list(expected_values) + [
-        5
-    ]  # add the value of the new variable to expected values
+    # add the new variable name to expected names
+    expected_names = expected_names + ["extra_var"]
+    # add the value of the new variable to expected values
+    expected_values = list(expected_values) + [5]
     assert sorted(expected_names) == sorted(actual_names)
     assert sorted(expected_values) == sorted(list(actual_values))
 
@@ -585,7 +604,7 @@ def test_initialize_recipe_from_results_file(
     expected_names = ["amplitude", "phase_shift", "wave_number"]
     expected_values = [1, 1, 0]
 
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     recipe.initialize_recipe_with_results(results_file)
     results = FitResults(recipe)
     actual_values = np.round(results.varvals, 5)
@@ -601,7 +620,7 @@ def test_initialize_recipe_from_results_file_bad(
     # Case: User tries to initialize a recipe with something that
     #       isn't a path, str, or FitResults object
     # Expected: raised ValueError with message
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     bad_input = 12345  # not a valid input type
     msg = (
         "The input results must be a FitResults object or a path to a "
@@ -695,7 +714,7 @@ def build_recipe_from_datafile_deprecated(datafile):
 
 
 def test_plot_recipe_bad_display(build_recipe_one_contribution):
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     # Case: All plots are disabled
     # expected: raised ValueError with message
     plt.close("all")
@@ -725,7 +744,7 @@ def test_plot_recipe_before_refinement(capsys, build_recipe_one_contribution):
     # Case: User tries to plot recipe before refinement
     # expected: Data plotted without fit line or difference curve
     #          and warning message printed
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     plt.close("all")
     before = set(plt.get_fignums())
     # include fit_label="nothing" to make sure fit line is not plotted
@@ -753,7 +772,7 @@ def test_plot_recipe_before_refinement(capsys, build_recipe_one_contribution):
 def test_plot_recipe_after_refinement(build_recipe_one_contribution):
     # Case: User refines recipe and then plots
     # expected: Plot generates with no problem
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     before = set(plt.get_fignums())
@@ -790,7 +809,7 @@ def test_plot_recipe_two_contributions(build_recipe_two_contributions):
 def test_plot_recipe_on_existing_plot(build_recipe_one_contribution):
     # Case: User passes axes to plot_recipe to plot on existing figure
     # expected: User modifications are present in the final figure
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     fig, ax = plt.subplots()
@@ -810,7 +829,7 @@ def test_plot_recipe_on_existing_plot(build_recipe_one_contribution):
 def test_plot_recipe_add_new_data(build_recipe_one_contribution):
     # Case: User wants to add data to figure generated by plot_recipe
     # Expected: New data is added to existing figure (check with labels)
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     before = set(plt.get_fignums())
@@ -854,7 +873,7 @@ def test_plot_recipe_add_new_data_two_figs(build_recipe_two_contributions):
 def test_plot_recipe_set_title(build_recipe_one_contribution):
     # Case: User sets title via plot_recipe
     # Expected: Title is set correctly
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     expected_title = "Custom Recipe Title"
@@ -868,7 +887,7 @@ def test_plot_recipe_set_title(build_recipe_one_contribution):
 def test_plot_recipe_set_defaults(build_recipe_one_contribution):
     # Case: user sets default plot options with set_plot_defaults
     # Expected: plot_recipe uses the default options for all calls
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     # set new defaults
@@ -896,7 +915,7 @@ def test_plot_recipe_set_defaults(build_recipe_one_contribution):
 def test_plot_recipe_set_defaults_bad(capsys, build_recipe_one_contribution):
     # Case: user tries to set kwargs that are not valid plot_recipe options
     # Expected: Plot is shown and warning is printed
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
     recipe.set_plot_defaults(
@@ -1006,7 +1025,7 @@ def test_plot_recipe_reset_all_defaults(build_recipe_one_contribution):
         "show": True,
     }
 
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     plt.close("all")
 

tests/test_fitresults.py

@@ -54,10 +54,9 @@ def optimize_recipe(recipe):
 
 
 def test_formatResults(build_recipe_one_contribution):
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
-    results.save_results("res.res")
     actual_results_string = results.formatResults(header="My Custom header")
     # Because slight variations in refinement, just check
     # that the header of the results are the same.
@@ -68,7 +67,7 @@ def test_formatResults(build_recipe_one_contribution):
 
 
 def test_get_results_string(build_recipe_one_contribution):
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     actual_results_string = results.get_results_string(
@@ -83,7 +82,7 @@ def test_get_results_string(build_recipe_one_contribution):
 
 
 def test_printResults(build_recipe_one_contribution, capsys):
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     results.printResults(header="My Custom header")
@@ -97,7 +96,7 @@ def test_printResults(build_recipe_one_contribution, capsys):
 
 
 def test_print_results(build_recipe_one_contribution, capsys):
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     results.print_results(header="My Custom header")
@@ -111,7 +110,7 @@ def test_print_results(build_recipe_one_contribution, capsys):
 
 
 def test_saveResults(build_recipe_one_contribution, tmp_path):
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     actual_results_file = tmp_path / "fit_results.txt"
@@ -128,7 +127,7 @@ def test_saveResults(build_recipe_one_contribution, tmp_path):
 
 
 def test_save_results(build_recipe_one_contribution, tmp_path):
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     actual_results_file = tmp_path / "fit_results.txt"
@@ -147,7 +146,7 @@ def test_save_results(build_recipe_one_contribution, tmp_path):
 def test_get_results_dictionary(build_recipe_one_contribution):
     # Case: user gets results dictionary after optimization
     # expected: results dictionary contains expected keys and values
-    recipe = build_recipe_one_contribution()
+    recipe = build_recipe_one_contribution
     optimize_recipe(recipe)
     results = FitResults(recipe)
     actual_results_dict = results.get_results_dictionary()