Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Always use tmp path for clobber tests. #3043

Merged
merged 2 commits into from
Nov 14, 2023
Merged

Always use tmp path for clobber tests. #3043

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eac7dbe
Always use tmp path for clobber tests.
jdangerx Nov 13, 2023
3c6c93f
Also use tmp path in test_xbrl2sqlite
jdangerx Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions test/unit/extract/xbrl_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,22 @@ def test_ferc_xbrl_datastore_get_filings(mocker):
),
],
)
def test_xbrl2sqlite(settings, forms, mocker):
def test_xbrl2sqlite(settings, forms, mocker, tmp_path):
convert_form_mock = mocker.MagicMock()
mocker.patch("pudl.extract.xbrl.convert_form", new=convert_form_mock)

# Mock datastore object to allow comparison
mock_datastore = mocker.MagicMock()
mocker.patch("pudl.extract.xbrl.FercXbrlDatastore", return_value=mock_datastore)

# always use tmp path here so that we don't clobber the live DB when --live-dbs is passed
mock_pudl_paths = mocker.MagicMock(
spec=PudlPaths(),
sqlite_db_path=lambda form_name: tmp_path / f"{form_name}.sqlite",
output_dir=PudlPaths().output_dir,
)
mocker.patch("pudl.extract.xbrl.PudlPaths", return_value=mock_pudl_paths)

# Construct xbrl2sqlite op context
context = build_op_context(
resources={
Expand All @@ -122,7 +130,7 @@ def test_xbrl2sqlite(settings, forms, mocker):
form,
mock_datastore,
output_path=PudlPaths().output_dir,
sql_path=PudlPaths().output_dir / f"ferc{form.value}_xbrl.sqlite",
sql_path=tmp_path / f"ferc{form.value}_xbrl.sqlite",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you need to mock PudlPaths if you're using tmp_path here?

batch_size=20,
workers=10,
)
Expand Down Expand Up @@ -163,15 +171,16 @@ def test_xbrl2sqlite_db_exists_no_clobber(mocker):
xbrl2sqlite(context)


def test_xbrl2sqlite_db_exists_yes_clobber(mocker):
def test_xbrl2sqlite_db_exists_yes_clobber(mocker, tmp_path):
convert_form_mock = mocker.MagicMock()
mocker.patch("pudl.extract.xbrl.convert_form", new=convert_form_mock)

# Mock datastore object to allow comparison
mock_datastore = mocker.MagicMock()
mocker.patch("pudl.extract.xbrl.FercXbrlDatastore", return_value=mock_datastore)

ferc1_sqlite_path = PudlPaths().output_dir / "ferc1_xbrl.sqlite"
# always use tmp path here so that we don't clobber the live DB when --live-dbs is passed
ferc1_sqlite_path = tmp_path / "ferc1_xbrl.sqlite"
ferc1_sqlite_path.touch()

# mock the db path so we can assert it gets clobbered
Expand Down