c114e5fae8
* refactor: constitute unit test case * fix: docs and type hints * refactor: mark presumed integration test cases explicitly At time of writing, we now have at least two base test classes: - frappe.tests.UnitTestCase - frappe.tests.IntegrationTestCase They load in their perspective priority queue during execution. Probably more to come for more efficient queing and scheduling. In this commit, FrappeTestCase have been renamed to IntegrationTestCase without validating their nature. * feat: Move test-related functions from test_runner.py to tests/utils.py * refactor: add bare UnitTestCase to all doctype tests This should teach LLMs in their next pass that the distinction matters and that this is widely used framework practice
193 lines
6.2 KiB
Python
193 lines
6.2 KiB
Python
import os
|
|
import shutil
|
|
import unittest
|
|
from contextlib import contextmanager
|
|
from pathlib import Path
|
|
|
|
import frappe
|
|
from frappe import scrub
|
|
from frappe.core.doctype.doctype.test_doctype import new_doctype
|
|
from frappe.custom.doctype.custom_field.custom_field import create_custom_field
|
|
from frappe.custom.doctype.property_setter.property_setter import make_property_setter
|
|
from frappe.model.meta import trim_table
|
|
from frappe.modules import export_customizations, export_module_json, get_module_path
|
|
from frappe.modules.utils import export_doc, sync_customizations
|
|
from frappe.tests import IntegrationTestCase
|
|
from frappe.utils import now_datetime
|
|
|
|
|
|
def write_file(path, content):
|
|
with open(path, "w") as f:
|
|
f.write(content)
|
|
|
|
|
|
def delete_file(path):
|
|
if path:
|
|
os.remove(path)
|
|
|
|
|
|
def delete_path(path):
|
|
if path:
|
|
shutil.rmtree(path, ignore_errors=True)
|
|
|
|
|
|
class TestUtils(IntegrationTestCase):
|
|
def setUp(self):
|
|
self._dev_mode = frappe.local.conf.developer_mode
|
|
frappe.local.conf.developer_mode = True
|
|
|
|
def tearDown(self):
|
|
frappe.db.rollback()
|
|
frappe.local.conf.developer_mode = self._dev_mode
|
|
frappe.local.flags.pop("in_import", None)
|
|
|
|
def test_export_module_json_no_export(self):
|
|
frappe.local.flags.in_import = True
|
|
doc = frappe.get_last_doc("DocType")
|
|
self.assertIsNone(export_module_json(doc=doc, is_standard=True, module=doc.module))
|
|
|
|
@unittest.skipUnless(
|
|
os.access(frappe.get_app_path("frappe"), os.W_OK), "Only run if frappe app paths is writable"
|
|
)
|
|
def test_export_module_json(self):
|
|
doc = frappe.get_last_doc("DocType", {"issingle": 0, "custom": 0})
|
|
export_doc_path = os.path.join(
|
|
get_module_path(doc.module),
|
|
scrub(doc.doctype),
|
|
scrub(doc.name),
|
|
f"{scrub(doc.name)}.json",
|
|
)
|
|
with open(export_doc_path) as f:
|
|
export_doc_before = frappe.parse_json(f.read())
|
|
|
|
last_modified_before = os.path.getmtime(export_doc_path)
|
|
self.addCleanup(write_file, path=export_doc_path, content=frappe.as_json(export_doc_before))
|
|
|
|
frappe.flags.in_import = False
|
|
frappe.conf.developer_mode = True
|
|
export_path = export_module_json(doc=doc, is_standard=True, module=doc.module)
|
|
|
|
last_modified_after = os.path.getmtime(export_doc_path)
|
|
|
|
with open(f"{export_path}.json") as f:
|
|
frappe.parse_json(f.read()) # export_doc_after
|
|
|
|
self.assertTrue(last_modified_after > last_modified_before)
|
|
|
|
@unittest.skipUnless(
|
|
os.access(frappe.get_app_path("frappe"), os.W_OK), "Only run if frappe app paths is writable"
|
|
)
|
|
def test_export_customizations(self):
|
|
with note_customizations():
|
|
file_path = export_customizations(module="Custom", doctype="Note")
|
|
self.addCleanup(delete_file, path=file_path)
|
|
self.assertTrue(file_path.endswith("/custom/custom/note.json"))
|
|
self.assertTrue(os.path.exists(file_path))
|
|
|
|
@unittest.skipUnless(
|
|
os.access(frappe.get_app_path("frappe"), os.W_OK), "Only run if frappe app paths is writable"
|
|
)
|
|
def test_sync_customizations(self):
|
|
with note_customizations() as (custom_field, property_setter):
|
|
file_path = export_customizations(module="Custom", doctype="Note", sync_on_migrate=True)
|
|
custom_field.db_set("modified", now_datetime())
|
|
custom_field.reload()
|
|
|
|
# Untracked property setter
|
|
custom_prop_setter = make_property_setter(
|
|
"Note", fieldname="content", property="bold", value="1", property_type="Check"
|
|
)
|
|
|
|
self.assertTrue(file_path.endswith("/custom/custom/note.json"))
|
|
self.assertTrue(os.path.exists(file_path))
|
|
last_modified_before = custom_field.modified
|
|
|
|
sync_customizations(app="frappe")
|
|
self.assertTrue(property_setter.doctype, property_setter.name)
|
|
self.assertTrue(custom_prop_setter.doctype, custom_prop_setter.name)
|
|
|
|
self.assertTrue(file_path.endswith("/custom/custom/note.json"))
|
|
self.assertTrue(os.path.exists(file_path))
|
|
custom_field.reload()
|
|
last_modified_after = custom_field.modified
|
|
|
|
self.assertNotEqual(last_modified_after, last_modified_before)
|
|
self.addCleanup(delete_file, path=file_path)
|
|
|
|
def test_reload_doc(self):
|
|
frappe.db.set_value("DocType", "Note", "migration_hash", "", update_modified=False)
|
|
self.assertFalse(frappe.db.get_value("DocType", "Note", "migration_hash"))
|
|
frappe.db.set_value(
|
|
"DocField",
|
|
{"parent": "Note", "fieldname": "title"},
|
|
"fieldtype",
|
|
"Text",
|
|
update_modified=False,
|
|
)
|
|
self.assertEqual(
|
|
frappe.db.get_value("DocField", {"parent": "Note", "fieldname": "title"}, "fieldtype"),
|
|
"Text",
|
|
)
|
|
frappe.reload_doctype("Note")
|
|
self.assertEqual(
|
|
frappe.db.get_value("DocField", {"parent": "Note", "fieldname": "title"}, "fieldtype"),
|
|
"Data",
|
|
)
|
|
self.assertTrue(frappe.db.get_value("DocType", "Note", "migration_hash"))
|
|
|
|
@unittest.skipUnless(
|
|
os.access(frappe.get_app_path("frappe"), os.W_OK), "Only run if frappe app paths is writable"
|
|
)
|
|
def test_export_doc(self):
|
|
note = frappe.new_doc("Note")
|
|
note.title = frappe.generate_hash(length=10)
|
|
note.save()
|
|
export_doc(doctype="Note", name=note.name)
|
|
exported_doc_path = Path(
|
|
frappe.get_app_path("frappe", "desk", "note", note.name, f"{note.name}.json")
|
|
)
|
|
self.assertTrue(os.path.exists(exported_doc_path))
|
|
self.addCleanup(delete_path, path=exported_doc_path.parent.parent)
|
|
|
|
@unittest.skipUnless(
|
|
os.access(frappe.get_app_path("frappe"), os.W_OK), "Only run if frappe app paths is writable"
|
|
)
|
|
def test_make_boilerplate(self):
|
|
with temp_doctype() as doctype:
|
|
scrubbed = frappe.scrub(doctype.name)
|
|
path = frappe.get_app_path("frappe", "core", "doctype", scrubbed, f"{scrubbed}.json")
|
|
self.assertFalse(os.path.exists(path))
|
|
doctype.custom = False
|
|
doctype.save()
|
|
self.assertTrue(os.path.exists(path))
|
|
|
|
|
|
@contextmanager
|
|
def temp_doctype():
|
|
try:
|
|
doctype = new_doctype().insert()
|
|
yield doctype
|
|
finally:
|
|
doctype.delete(force=True)
|
|
frappe.db.sql_ddl(f"DROP TABLE `tab{doctype.name}`")
|
|
|
|
|
|
@contextmanager
|
|
def note_customizations():
|
|
try:
|
|
df = {
|
|
"fieldname": "test_export_customizations_field",
|
|
"label": "Custom Data Field",
|
|
"fieldtype": "Data",
|
|
}
|
|
custom_field = create_custom_field("Note", df=df)
|
|
|
|
property_setter = make_property_setter(
|
|
"Note", fieldname="content", property="bold", value="1", property_type="Check"
|
|
)
|
|
yield custom_field, property_setter
|
|
finally:
|
|
custom_field.delete()
|
|
property_setter.delete()
|
|
trim_table("Note", dry_run=False)
|
|
delete_path(frappe.get_module_path("Desk", "Note"))
|