// Copyright 2022 Memgraph Ltd. // // Use of this software is governed by the Business Source License // included in the file licenses/BSL.txt; by using this file, you agree to be bound by the terms of the Business Source // License, and you may not use this file except in compliance with the Business Source License. // // As of the Change Date specified in that file, in accordance with // the Business Source License, use of this software will be governed // by the Apache License, Version 2.0, included in the file // licenses/APL.txt. #include #include #include #include "query/procedure/mg_procedure_impl.hpp" #include "query/procedure/py_module.hpp" #include "test_utils.hpp" TEST(PyModule, MgpValueToPyObject) { mgp_memory memory{memgraph::utils::NewDeleteResource()}; auto *list = EXPECT_MGP_NO_ERROR(mgp_list *, mgp_list_make_empty, 42, &memory); { // Create a list: [null, false, true, 42, 0.1, "some text"] auto primitive_values = {EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_null, &memory), EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_bool, 0, &memory), EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_bool, 1, &memory), EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_int, 42, &memory), EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_double, 0.1, &memory), EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_string, "some text", &memory)}; for (auto *val : primitive_values) { EXPECT_EQ(mgp_list_append(list, val), mgp_error::MGP_ERROR_NO_ERROR); mgp_value_destroy(val); } } auto *list_val = EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_list, list); auto *map = EXPECT_MGP_NO_ERROR(mgp_map *, mgp_map_make_empty, &memory); EXPECT_EQ(mgp_map_insert(map, "list", list_val), mgp_error::MGP_ERROR_NO_ERROR); mgp_value_destroy(list_val); auto *map_val = EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_map, map); auto gil = memgraph::py::EnsureGIL(); memgraph::py::Object py_graph(memgraph::query::procedure::MakePyGraph(nullptr, &memory)); auto py_dict = memgraph::query::procedure::MgpValueToPyObject( *map_val, reinterpret_cast(py_graph.Ptr())); mgp_value_destroy(map_val); // We should now have in Python: // {"list": (None, False, True, 42, 0.1, "some text")} ASSERT_TRUE(PyDict_Check(py_dict)); EXPECT_EQ(PyDict_Size(py_dict.Ptr()), 1); PyObject *key = nullptr; PyObject *value = nullptr; Py_ssize_t pos = 0; while (PyDict_Next(py_dict.Ptr(), &pos, &key, &value)) { ASSERT_TRUE(PyUnicode_Check(key)); EXPECT_EQ(std::string(PyUnicode_AsUTF8(key)), "list"); ASSERT_TRUE(PyTuple_Check(value)); ASSERT_EQ(PyTuple_Size(value), 6); EXPECT_EQ(PyTuple_GetItem(value, 0), Py_None); EXPECT_EQ(PyTuple_GetItem(value, 1), Py_False); EXPECT_EQ(PyTuple_GetItem(value, 2), Py_True); auto *py_long = PyTuple_GetItem(value, 3); ASSERT_TRUE(PyLong_Check(py_long)); EXPECT_EQ(PyLong_AsLong(py_long), 42); auto *py_float = PyTuple_GetItem(value, 4); ASSERT_TRUE(PyFloat_Check(py_float)); EXPECT_EQ(PyFloat_AsDouble(py_float), 0.1); auto *py_str = PyTuple_GetItem(value, 5); ASSERT_TRUE(PyUnicode_Check(py_str)); EXPECT_EQ(std::string(PyUnicode_AsUTF8(py_str)), "some text"); } } // Our _mgp types should not support (by default) pickling and copying. static void AssertPickleAndCopyAreNotSupported(PyObject *py_obj) { ASSERT_TRUE(py_obj); memgraph::py::Object pickle_mod(PyImport_ImportModule("pickle")); ASSERT_TRUE(pickle_mod); ASSERT_FALSE(memgraph::py::FetchError()); memgraph::py::Object dumps_res(pickle_mod.CallMethod("dumps", py_obj)); ASSERT_FALSE(dumps_res); ASSERT_TRUE(memgraph::py::FetchError()); memgraph::py::Object copy_mod(PyImport_ImportModule("copy")); ASSERT_TRUE(copy_mod); ASSERT_FALSE(memgraph::py::FetchError()); memgraph::py::Object copy_res(copy_mod.CallMethod("copy", py_obj)); ASSERT_FALSE(copy_res); ASSERT_TRUE(memgraph::py::FetchError()); // We should have cleared the error state. ASSERT_FALSE(memgraph::py::FetchError()); memgraph::py::Object deepcopy_res(copy_mod.CallMethod("deepcopy", py_obj)); ASSERT_FALSE(deepcopy_res); ASSERT_TRUE(memgraph::py::FetchError()); } TEST(PyModule, PyVertex) { // Initialize the database with 2 vertices and 1 edge. memgraph::storage::Storage db; { auto dba = db.Access(); auto v1 = dba.CreateVertex(); auto v2 = dba.CreateVertex(); ASSERT_TRUE(v1.SetProperty(dba.NameToProperty("key1"), memgraph::storage::PropertyValue("value1")).HasValue()); ASSERT_TRUE(v1.SetProperty(dba.NameToProperty("key2"), memgraph::storage::PropertyValue(1337)).HasValue()); auto e = dba.CreateEdge(&v1, &v2, dba.NameToEdgeType("type")); ASSERT_TRUE(e.HasValue()); ASSERT_FALSE(dba.Commit().HasError()); } // Get the first vertex as an mgp_value. auto storage_dba = db.Access(); memgraph::query::DbAccessor dba(&storage_dba); mgp_memory memory{memgraph::utils::NewDeleteResource()}; mgp_graph graph{&dba, memgraph::storage::View::OLD}; auto *vertex = EXPECT_MGP_NO_ERROR(mgp_vertex *, mgp_graph_get_vertex_by_id, &graph, mgp_vertex_id{0}, &memory); ASSERT_TRUE(vertex); auto *vertex_value = EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_vertex, EXPECT_MGP_NO_ERROR(mgp_vertex *, mgp_vertex_copy, vertex, &memory)); mgp_vertex_destroy(vertex); // Initialize the Python graph object. auto gil = memgraph::py::EnsureGIL(); memgraph::py::Object py_graph(memgraph::query::procedure::MakePyGraph(&graph, &memory)); ASSERT_TRUE(py_graph); // Convert from mgp_value to mgp.Vertex. memgraph::py::Object py_vertex_value(memgraph::query::procedure::MgpValueToPyObject(*vertex_value, py_graph.Ptr())); ASSERT_TRUE(py_vertex_value); AssertPickleAndCopyAreNotSupported(py_vertex_value.GetAttr("_vertex").Ptr()); // Convert from mgp.Vertex to mgp_value. auto *new_vertex_value = memgraph::query::procedure::PyObjectToMgpValue(py_vertex_value.Ptr(), &memory); // Test for equality. ASSERT_TRUE(new_vertex_value); ASSERT_NE(new_vertex_value, vertex_value); // Pointer compare. ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_vertex, new_vertex_value), 1); ASSERT_EQ( EXPECT_MGP_NO_ERROR(int, mgp_vertex_equal, EXPECT_MGP_NO_ERROR(mgp_vertex *, mgp_value_get_vertex, vertex_value), EXPECT_MGP_NO_ERROR(mgp_vertex *, mgp_value_get_vertex, new_vertex_value)), 1); // Clean up. mgp_value_destroy(new_vertex_value); mgp_value_destroy(vertex_value); ASSERT_FALSE(dba.Commit().HasError()); } TEST(PyModule, PyEdge) { // Initialize the database with 2 vertices and 1 edge. memgraph::storage::Storage db; { auto dba = db.Access(); auto v1 = dba.CreateVertex(); auto v2 = dba.CreateVertex(); auto e = dba.CreateEdge(&v1, &v2, dba.NameToEdgeType("type")); ASSERT_TRUE(e.HasValue()); ASSERT_TRUE(e->SetProperty(dba.NameToProperty("key1"), memgraph::storage::PropertyValue("value1")).HasValue()); ASSERT_TRUE(e->SetProperty(dba.NameToProperty("key2"), memgraph::storage::PropertyValue(1337)).HasValue()); ASSERT_FALSE(dba.Commit().HasError()); } // Get the edge as an mgp_value. auto storage_dba = db.Access(); memgraph::query::DbAccessor dba(&storage_dba); mgp_memory memory{memgraph::utils::NewDeleteResource()}; mgp_graph graph{&dba, memgraph::storage::View::OLD}; auto *start_v = EXPECT_MGP_NO_ERROR(mgp_vertex *, mgp_graph_get_vertex_by_id, &graph, mgp_vertex_id{0}, &memory); ASSERT_TRUE(start_v); auto *edges_it = EXPECT_MGP_NO_ERROR(mgp_edges_iterator *, mgp_vertex_iter_out_edges, start_v, &memory); ASSERT_TRUE(edges_it); auto *edge = EXPECT_MGP_NO_ERROR(mgp_edge *, mgp_edge_copy, EXPECT_MGP_NO_ERROR(mgp_edge *, mgp_edges_iterator_get, edges_it), &memory); auto *edge_value = EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_edge, edge); ASSERT_EQ(EXPECT_MGP_NO_ERROR(mgp_edge *, mgp_edges_iterator_next, edges_it), nullptr); ASSERT_EQ(EXPECT_MGP_NO_ERROR(mgp_edge *, mgp_edges_iterator_get, edges_it), nullptr); mgp_edges_iterator_destroy(edges_it); mgp_vertex_destroy(start_v); // Initialize the Python graph object. auto gil = memgraph::py::EnsureGIL(); memgraph::py::Object py_graph(memgraph::query::procedure::MakePyGraph(&graph, &memory)); ASSERT_TRUE(py_graph); // Convert from mgp_value to mgp.Edge. memgraph::py::Object py_edge_value(memgraph::query::procedure::MgpValueToPyObject(*edge_value, py_graph.Ptr())); ASSERT_TRUE(py_edge_value); AssertPickleAndCopyAreNotSupported(py_edge_value.GetAttr("_edge").Ptr()); // Convert from mgp.Edge to mgp_value. auto *new_edge_value = memgraph::query::procedure::PyObjectToMgpValue(py_edge_value.Ptr(), &memory); // Test for equality. ASSERT_TRUE(new_edge_value); ASSERT_NE(new_edge_value, edge_value); // Pointer compare. ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_edge, new_edge_value), 1); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_edge_equal, EXPECT_MGP_NO_ERROR(mgp_edge *, mgp_value_get_edge, edge_value), EXPECT_MGP_NO_ERROR(mgp_edge *, mgp_value_get_edge, new_edge_value)), 1); // Clean up. mgp_value_destroy(new_edge_value); mgp_value_destroy(edge_value); ASSERT_FALSE(dba.Commit().HasError()); } TEST(PyModule, PyPath) { memgraph::storage::Storage db; { auto dba = db.Access(); auto v1 = dba.CreateVertex(); auto v2 = dba.CreateVertex(); ASSERT_TRUE(dba.CreateEdge(&v1, &v2, dba.NameToEdgeType("type")).HasValue()); ASSERT_FALSE(dba.Commit().HasError()); } auto storage_dba = db.Access(); memgraph::query::DbAccessor dba(&storage_dba); mgp_memory memory{memgraph::utils::NewDeleteResource()}; mgp_graph graph{&dba, memgraph::storage::View::OLD}; auto *start_v = EXPECT_MGP_NO_ERROR(mgp_vertex *, mgp_graph_get_vertex_by_id, &graph, mgp_vertex_id{0}, &memory); ASSERT_TRUE(start_v); auto *path = EXPECT_MGP_NO_ERROR(mgp_path *, mgp_path_make_with_start, start_v, &memory); ASSERT_TRUE(path); auto *edges_it = EXPECT_MGP_NO_ERROR(mgp_edges_iterator *, mgp_vertex_iter_out_edges, start_v, &memory); ASSERT_TRUE(edges_it); for (auto *edge = EXPECT_MGP_NO_ERROR(mgp_edge *, mgp_edges_iterator_get, edges_it); edge != nullptr; edge = EXPECT_MGP_NO_ERROR(mgp_edge *, mgp_edges_iterator_next, edges_it)) { ASSERT_EQ(mgp_path_expand(path, edge), mgp_error::MGP_ERROR_NO_ERROR); } ASSERT_EQ(EXPECT_MGP_NO_ERROR(size_t, mgp_path_size, path), 1); mgp_edges_iterator_destroy(edges_it); mgp_vertex_destroy(start_v); auto *path_value = EXPECT_MGP_NO_ERROR(mgp_value *, mgp_value_make_path, path); ASSERT_TRUE(path_value); auto gil = memgraph::py::EnsureGIL(); memgraph::py::Object py_graph(memgraph::query::procedure::MakePyGraph(&graph, &memory)); ASSERT_TRUE(py_graph); // We have setup the C structs, so create convert to PyObject. memgraph::py::Object py_path_value(memgraph::query::procedure::MgpValueToPyObject(*path_value, py_graph.Ptr())); ASSERT_TRUE(py_path_value); AssertPickleAndCopyAreNotSupported(py_path_value.GetAttr("_path").Ptr()); // Convert back to C struct and check equality. auto *new_path_value = memgraph::query::procedure::PyObjectToMgpValue(py_path_value.Ptr(), &memory); ASSERT_TRUE(new_path_value); ASSERT_NE(new_path_value, path_value); // Pointer compare. ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_path, new_path_value), 1); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_path_equal, EXPECT_MGP_NO_ERROR(mgp_path *, mgp_value_get_path, path_value), EXPECT_MGP_NO_ERROR(mgp_path *, mgp_value_get_path, new_path_value)), 1); mgp_value_destroy(new_path_value); mgp_value_destroy(path_value); ASSERT_FALSE(dba.Commit().HasError()); } TEST(PyModule, PyObjectToMgpValue) { mgp_memory memory{memgraph::utils::NewDeleteResource()}; auto gil = memgraph::py::EnsureGIL(); memgraph::py::Object py_value{ Py_BuildValue("[i f s (i f s) {s i s f}]", 1, 1.0, "one", 2, 2.0, "two", "three", 3, "four", 4.0)}; auto *value = memgraph::query::procedure::PyObjectToMgpValue(py_value.Ptr(), &memory); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_list, value), 1); auto *list1 = EXPECT_MGP_NO_ERROR(mgp_list *, mgp_value_get_list, value); EXPECT_EQ(EXPECT_MGP_NO_ERROR(size_t, mgp_list_size, list1), 5); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_int, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 0)), 1); EXPECT_EQ(EXPECT_MGP_NO_ERROR(int64_t, mgp_value_get_int, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 0)), 1); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_double, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 1)), 1); EXPECT_EQ(EXPECT_MGP_NO_ERROR(double, mgp_value_get_double, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 1)), 1.0); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_string, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 2)), 1); EXPECT_STREQ( EXPECT_MGP_NO_ERROR(const char *, mgp_value_get_string, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 2)), "one"); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_list, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 3)), 1); auto *list2 = EXPECT_MGP_NO_ERROR(mgp_list *, mgp_value_get_list, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 3)); EXPECT_EQ(EXPECT_MGP_NO_ERROR(size_t, mgp_list_size, list2), 3); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_int, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list2, 0)), 1); EXPECT_EQ(EXPECT_MGP_NO_ERROR(int64_t, mgp_value_get_int, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list2, 0)), 2); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_double, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list2, 1)), 1); EXPECT_EQ(EXPECT_MGP_NO_ERROR(double, mgp_value_get_double, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list2, 1)), 2.0); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_string, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list2, 2)), 1); EXPECT_STREQ( EXPECT_MGP_NO_ERROR(const char *, mgp_value_get_string, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list2, 2)), "two"); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_map, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 4)), 1); auto *map = EXPECT_MGP_NO_ERROR(mgp_map *, mgp_value_get_map, EXPECT_MGP_NO_ERROR(mgp_value *, mgp_list_at, list1, 4)); EXPECT_EQ(EXPECT_MGP_NO_ERROR(size_t, mgp_map_size, map), 2); mgp_value *v1 = EXPECT_MGP_NO_ERROR(mgp_value *, mgp_map_at, map, "three"); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_int, v1), 1); EXPECT_EQ(EXPECT_MGP_NO_ERROR(int64_t, mgp_value_get_int, v1), 3); mgp_value *v2 = EXPECT_MGP_NO_ERROR(mgp_value *, mgp_map_at, map, "four"); ASSERT_EQ(EXPECT_MGP_NO_ERROR(int, mgp_value_is_double, v2), 1); EXPECT_EQ(EXPECT_MGP_NO_ERROR(double, mgp_value_get_double, v2), 4.0); mgp_value_destroy(value); } int main(int argc, char **argv) { ::testing::InitGoogleTest(&argc, argv); // Initialize Python auto *program_name = Py_DecodeLocale(argv[0], nullptr); MG_ASSERT(program_name); // Set program name, so Python can find its way to runtime libraries relative // to executable. Py_SetProgramName(program_name); PyImport_AppendInittab("_mgp", &memgraph::query::procedure::PyInitMgpModule); Py_InitializeEx(0 /* = initsigs */); PyEval_InitThreads(); int test_result; { // Setup importing 'mgp' module by adding its directory to `sys.path`. std::filesystem::path invocation_path(argv[0]); auto mgp_py_path = invocation_path.parent_path() / "../../../include/mgp.py"; MG_ASSERT(std::filesystem::exists(mgp_py_path)); auto *py_path = PySys_GetObject("path"); MG_ASSERT(py_path); memgraph::py::Object import_dir(PyUnicode_FromString(mgp_py_path.parent_path().c_str())); if (PyList_Append(py_path, import_dir.Ptr()) != 0) { auto exc_info = memgraph::py::FetchError().value(); LOG_FATAL(exc_info); } memgraph::py::Object mgp(PyImport_ImportModule("mgp")); if (!mgp) { auto exc_info = memgraph::py::FetchError().value(); LOG_FATAL(exc_info); } // Now run tests. Py_BEGIN_ALLOW_THREADS; test_result = RUN_ALL_TESTS(); Py_END_ALLOW_THREADS; } // Shutdown Python Py_Finalize(); PyMem_RawFree(program_name); return test_result; }