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
204 lines
7.3 KiB
Python
204 lines
7.3 KiB
Python
# Copyright (c) 2022, Frappe Technologies Pvt. Ltd. and Contributors
|
|
# License: MIT. See LICENSE
|
|
|
|
import base64
|
|
|
|
import requests
|
|
|
|
import frappe
|
|
from frappe.core.doctype.user.user import generate_keys
|
|
from frappe.frappeclient import FrappeClient, FrappeException
|
|
from frappe.model import default_fields
|
|
from frappe.tests import IntegrationTestCase
|
|
from frappe.utils.data import get_url
|
|
|
|
|
|
class TestFrappeClient(IntegrationTestCase):
|
|
PASSWORD = frappe.conf.admin_password or "admin"
|
|
|
|
def test_insert_many(self):
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
server.insert_many(
|
|
[
|
|
{"doctype": "Note", "title": "Sing"},
|
|
{"doctype": "Note", "title": "a"},
|
|
{"doctype": "Note", "title": "song"},
|
|
{"doctype": "Note", "title": "of"},
|
|
{"doctype": "Note", "title": "sixpence"},
|
|
]
|
|
)
|
|
records = server.get_list("Note", fields=["title"])
|
|
records = [r.get("title") for r in records]
|
|
|
|
self.assertIn("Sing", records)
|
|
self.assertIn("a", records)
|
|
self.assertIn("song", records)
|
|
self.assertIn("of", records)
|
|
self.assertIn("sixpence", records)
|
|
|
|
def test_create_doc(self):
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
response = server.insert({"doctype": "Note", "title": "test_create"})
|
|
|
|
for field in default_fields:
|
|
self.assertIn(field, response)
|
|
|
|
self.assertEqual(response.get("doctype"), "Note")
|
|
self.assertEqual(response.get("title"), "test_create")
|
|
|
|
def test_list_docs(self):
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
doc_list = server.get_list("Note")
|
|
|
|
self.assertTrue(len(doc_list))
|
|
|
|
def test_get_doc(self):
|
|
USER = "Administrator"
|
|
TITLE = "get_this"
|
|
DOCTYPE = "Note"
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
|
|
NAME = server.insert({"doctype": DOCTYPE, "title": TITLE}).get("name")
|
|
doc = server.get_doc(DOCTYPE, NAME)
|
|
|
|
for field in default_fields:
|
|
self.assertIn(field, doc)
|
|
|
|
self.assertEqual(doc.get("doctype"), DOCTYPE)
|
|
self.assertEqual(doc.get("name"), NAME)
|
|
self.assertEqual(doc.get("title"), TITLE)
|
|
self.assertEqual(doc.get("owner"), USER)
|
|
|
|
def test_get_value_by_filters(self):
|
|
CONTENT = "test get value"
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
server.insert({"doctype": "Note", "title": "get_value", "content": CONTENT}).get("name")
|
|
|
|
self.assertEqual(server.get_value("Note", "content", {"title": "get_value"}).get("content"), CONTENT)
|
|
|
|
def test_get_value_by_name(self):
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
CONTENT = "test get value"
|
|
NAME = server.insert({"doctype": "Note", "title": "get_value", "content": CONTENT}).get("name")
|
|
|
|
self.assertEqual(server.get_value("Note", "content", NAME).get("content"), CONTENT)
|
|
|
|
def test_get_value_with_malicious_query(self):
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
server.insert({"doctype": "Note", "title": "get_value"})
|
|
|
|
self.assertRaises(
|
|
FrappeException,
|
|
server.get_value,
|
|
"Note",
|
|
"(select (password) from(__Auth) order by name desc limit 1)",
|
|
{"title": "get_value"},
|
|
)
|
|
|
|
def test_get_single(self):
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
server.set_value("Website Settings", "Website Settings", "title_prefix", "test-prefix")
|
|
self.assertEqual(
|
|
server.get_value("Website Settings", "title_prefix", "Website Settings").get("title_prefix"),
|
|
"test-prefix",
|
|
)
|
|
self.assertEqual(
|
|
server.get_value("Website Settings", "title_prefix").get("title_prefix"), "test-prefix"
|
|
)
|
|
frappe.db.set_single_value("Website Settings", "title_prefix", "")
|
|
|
|
def test_update_doc(self):
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
resp = server.insert({"doctype": "Note", "title": "Sing"})
|
|
doc = server.get_doc("Note", resp.get("name"))
|
|
|
|
CONTENT = "<h1>Hello, World!</h1>"
|
|
doc["content"] = CONTENT
|
|
doc = server.update(doc)
|
|
self.assertTrue(doc["content"] == CONTENT)
|
|
|
|
def test_update_child_doc(self):
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
frappe.db.delete("Contact", {"first_name": "George", "last_name": "Steevens"})
|
|
frappe.db.delete("Contact", {"first_name": "William", "last_name": "Shakespeare"})
|
|
frappe.db.delete("Communication", {"reference_doctype": "Event"})
|
|
frappe.db.delete("Communication Link", {"link_doctype": "Contact"})
|
|
frappe.db.delete("Event", {"subject": "Sing a song of sixpence"})
|
|
frappe.db.delete("Event Participants", {"reference_doctype": "Contact"})
|
|
frappe.db.commit()
|
|
|
|
# create multiple contacts
|
|
server.insert_many(
|
|
[
|
|
{"doctype": "Contact", "first_name": "George", "last_name": "Steevens"},
|
|
{"doctype": "Contact", "first_name": "William", "last_name": "Shakespeare"},
|
|
]
|
|
)
|
|
|
|
# create an event with one of the created contacts
|
|
event = server.insert(
|
|
{
|
|
"doctype": "Event",
|
|
"subject": "Sing a song of sixpence",
|
|
"event_participants": [
|
|
{"reference_doctype": "Contact", "reference_docname": "George Steevens"}
|
|
],
|
|
}
|
|
)
|
|
|
|
# update the event's contact to the second contact
|
|
server.update(
|
|
{
|
|
"doctype": "Event Participants",
|
|
"name": event.get("event_participants")[0].get("name"),
|
|
"reference_docname": "William Shakespeare",
|
|
}
|
|
)
|
|
|
|
# the change should run the parent document's validations and
|
|
# create a Communication record with the new contact
|
|
self.assertTrue(frappe.db.exists("Communication Link", {"link_name": "William Shakespeare"}))
|
|
|
|
def test_delete_doc(self):
|
|
server = FrappeClient(get_url(), "Administrator", self.PASSWORD, verify=False)
|
|
NAME_TO_DELETE = server.insert({"doctype": "Note", "title": "Sing"}).get("name")
|
|
server.delete("Note", NAME_TO_DELETE)
|
|
self.assertFalse(frappe.db.get_value("Note", NAME_TO_DELETE))
|
|
|
|
def test_auth_via_api_key_secret(self):
|
|
# generate API key and API secret for administrator
|
|
keys = generate_keys("Administrator")
|
|
frappe.db.commit()
|
|
generated_secret = frappe.utils.password.get_decrypted_password(
|
|
"User", "Administrator", fieldname="api_secret"
|
|
)
|
|
|
|
api_key = frappe.db.get_value("User", "Administrator", "api_key")
|
|
header = {"Authorization": f"token {api_key}:{generated_secret}"}
|
|
res = requests.post(get_url() + "/api/method/frappe.auth.get_logged_user", headers=header)
|
|
|
|
self.assertEqual(res.status_code, 200)
|
|
self.assertEqual("Administrator", res.json()["message"])
|
|
self.assertEqual(keys["api_secret"], generated_secret)
|
|
|
|
header = {
|
|
"Authorization": "Basic {}".format(
|
|
base64.b64encode(frappe.safe_encode(f"{api_key}:{generated_secret}")).decode()
|
|
)
|
|
}
|
|
res = requests.post(get_url() + "/api/method/frappe.auth.get_logged_user", headers=header)
|
|
self.assertEqual(res.status_code, 200)
|
|
self.assertEqual("Administrator", res.json()["message"])
|
|
|
|
# Valid api key, invalid api secret
|
|
api_secret = "ksk&93nxoe3os"
|
|
header = {"Authorization": f"token {api_key}:{api_secret}"}
|
|
res = requests.post(get_url() + "/api/method/frappe.auth.get_logged_user", headers=header)
|
|
self.assertEqual(res.status_code, 401)
|
|
|
|
# random api key and api secret
|
|
api_key = "@3djdk3kld"
|
|
api_secret = "ksk&93nxoe3os"
|
|
header = {"Authorization": f"token {api_key}:{api_secret}"}
|
|
res = requests.post(get_url() + "/api/method/frappe.auth.get_logged_user", headers=header)
|
|
self.assertEqual(res.status_code, 401)
|