122c8efcdSZachary Turner //===-- PythonDataObjectsTests.cpp ------------------------------*- C++ -*-===// 222c8efcdSZachary Turner // 32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information. 52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 622c8efcdSZachary Turner // 722c8efcdSZachary Turner //===----------------------------------------------------------------------===// 822c8efcdSZachary Turner 98c68837dSPavel Labath #include "Plugins/ScriptInterpreter/Python/lldb-python.h" 10b9c1b51eSKate Stone #include "gtest/gtest.h" 1122c8efcdSZachary Turner 12b9c1b51eSKate Stone #include "Plugins/ScriptInterpreter/Python/PythonDataObjects.h" 13b9c1b51eSKate Stone #include "Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.h" 149c40264fSZachary Turner #include "lldb/Host/File.h" 159c40264fSZachary Turner #include "lldb/Host/FileSystem.h" 1622c8efcdSZachary Turner #include "lldb/Host/HostInfo.h" 175bfee5f1SAbhishek Aggarwal #include "lldb/lldb-enumerations.h" 18*2fce1137SLawrence D'Anna #include "llvm/Testing/Support/Error.h" 1922c8efcdSZachary Turner 20c946d462SZachary Turner #include "PythonTestSuite.h" 21c946d462SZachary Turner 2222c8efcdSZachary Turner using namespace lldb_private; 2322c8efcdSZachary Turner 24b9c1b51eSKate Stone class PythonDataObjectsTest : public PythonTestSuite { 2522c8efcdSZachary Turner public: 26b9c1b51eSKate Stone void SetUp() override { 27c946d462SZachary Turner PythonTestSuite::SetUp(); 28a1405147SZachary Turner 29a1405147SZachary Turner PythonString sys_module("sys"); 30a1405147SZachary Turner m_sys_module.Reset(PyRefType::Owned, PyImport_Import(sys_module.get())); 31a1405147SZachary Turner m_main_module = PythonModule::MainModule(); 32a1405147SZachary Turner m_builtins_module = PythonModule::BuiltinsModule(); 3322c8efcdSZachary Turner } 3422c8efcdSZachary Turner 35b9c1b51eSKate Stone void TearDown() override { 36a1405147SZachary Turner m_sys_module.Reset(); 37a1405147SZachary Turner m_main_module.Reset(); 38a1405147SZachary Turner m_builtins_module.Reset(); 39f8b22f8fSZachary Turner 40c946d462SZachary Turner PythonTestSuite::TearDown(); 4122c8efcdSZachary Turner } 42f8b22f8fSZachary Turner 43a1405147SZachary Turner protected: 44a1405147SZachary Turner PythonModule m_sys_module; 45a1405147SZachary Turner PythonModule m_main_module; 46a1405147SZachary Turner PythonModule m_builtins_module; 4722c8efcdSZachary Turner }; 4822c8efcdSZachary Turner 49b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestOwnedReferences) { 5018426935SZachary Turner // After creating a new object, the refcount should be >= 1 51f8b22f8fSZachary Turner PyObject *obj = PyLong_FromLong(3); 5218426935SZachary Turner Py_ssize_t original_refcnt = obj->ob_refcnt; 5318426935SZachary Turner EXPECT_LE(1, original_refcnt); 54f8b22f8fSZachary Turner 5518426935SZachary Turner // If we take an owned reference, the refcount should be the same 56f8b22f8fSZachary Turner PythonObject owned_long(PyRefType::Owned, obj); 5718426935SZachary Turner EXPECT_EQ(original_refcnt, owned_long.get()->ob_refcnt); 58f8b22f8fSZachary Turner 5918426935SZachary Turner // Take another reference and verify that the refcount increases by 1 60f8b22f8fSZachary Turner PythonObject strong_ref(owned_long); 6118426935SZachary Turner EXPECT_EQ(original_refcnt + 1, strong_ref.get()->ob_refcnt); 62f8b22f8fSZachary Turner 6318426935SZachary Turner // If we reset the first one, the refcount should be the original value. 64f8b22f8fSZachary Turner owned_long.Reset(); 6518426935SZachary Turner EXPECT_EQ(original_refcnt, strong_ref.get()->ob_refcnt); 66f8b22f8fSZachary Turner } 67f8b22f8fSZachary Turner 68b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestResetting) { 69f8b22f8fSZachary Turner PythonDictionary dict(PyInitialValue::Empty); 70f8b22f8fSZachary Turner 71f8b22f8fSZachary Turner PyObject *new_dict = PyDict_New(); 72f8b22f8fSZachary Turner dict.Reset(PyRefType::Owned, new_dict); 73f8b22f8fSZachary Turner EXPECT_EQ(new_dict, dict.get()); 74f8b22f8fSZachary Turner 75f8b22f8fSZachary Turner dict.Reset(PyRefType::Owned, nullptr); 76f8b22f8fSZachary Turner EXPECT_EQ(nullptr, dict.get()); 77f8b22f8fSZachary Turner 78f8b22f8fSZachary Turner dict.Reset(PyRefType::Owned, PyDict_New()); 79f8b22f8fSZachary Turner EXPECT_NE(nullptr, dict.get()); 80f8b22f8fSZachary Turner dict.Reset(); 81f8b22f8fSZachary Turner EXPECT_EQ(nullptr, dict.get()); 82f8b22f8fSZachary Turner } 83f8b22f8fSZachary Turner 84b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestBorrowedReferences) { 85f8b22f8fSZachary Turner PythonInteger long_value(PyRefType::Owned, PyLong_FromLong(3)); 8618426935SZachary Turner Py_ssize_t original_refcnt = long_value.get()->ob_refcnt; 8718426935SZachary Turner EXPECT_LE(1, original_refcnt); 88f8b22f8fSZachary Turner 89f8b22f8fSZachary Turner PythonInteger borrowed_long(PyRefType::Borrowed, long_value.get()); 9018426935SZachary Turner EXPECT_EQ(original_refcnt + 1, borrowed_long.get()->ob_refcnt); 91f8b22f8fSZachary Turner } 92f8b22f8fSZachary Turner 93b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestGlobalNameResolutionNoDot) { 94a1405147SZachary Turner PythonObject sys_module = m_main_module.ResolveName("sys"); 95a1405147SZachary Turner EXPECT_EQ(m_sys_module.get(), sys_module.get()); 967841efbbSZachary Turner EXPECT_TRUE(sys_module.IsAllocated()); 977841efbbSZachary Turner EXPECT_TRUE(PythonModule::Check(sys_module.get())); 987841efbbSZachary Turner } 997841efbbSZachary Turner 100b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestModuleNameResolutionNoDot) { 101a1405147SZachary Turner PythonObject sys_path = m_sys_module.ResolveName("path"); 102a1405147SZachary Turner PythonObject sys_version_info = m_sys_module.ResolveName("version_info"); 1037841efbbSZachary Turner EXPECT_TRUE(sys_path.IsAllocated()); 1047841efbbSZachary Turner EXPECT_TRUE(sys_version_info.IsAllocated()); 1057841efbbSZachary Turner 1067841efbbSZachary Turner EXPECT_TRUE(PythonList::Check(sys_path.get())); 1077841efbbSZachary Turner } 1087841efbbSZachary Turner 109b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestTypeNameResolutionNoDot) { 110a1405147SZachary Turner PythonObject sys_version_info = m_sys_module.ResolveName("version_info"); 1117841efbbSZachary Turner 112b9c1b51eSKate Stone PythonObject version_info_type(PyRefType::Owned, 113b9c1b51eSKate Stone PyObject_Type(sys_version_info.get())); 1147841efbbSZachary Turner EXPECT_TRUE(version_info_type.IsAllocated()); 1157841efbbSZachary Turner PythonObject major_version_field = version_info_type.ResolveName("major"); 1167841efbbSZachary Turner EXPECT_TRUE(major_version_field.IsAllocated()); 1177841efbbSZachary Turner } 1187841efbbSZachary Turner 119b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestInstanceNameResolutionNoDot) { 120a1405147SZachary Turner PythonObject sys_version_info = m_sys_module.ResolveName("version_info"); 1217841efbbSZachary Turner PythonObject major_version_field = sys_version_info.ResolveName("major"); 1227841efbbSZachary Turner PythonObject minor_version_field = sys_version_info.ResolveName("minor"); 1237841efbbSZachary Turner 1247841efbbSZachary Turner EXPECT_TRUE(major_version_field.IsAllocated()); 1257841efbbSZachary Turner EXPECT_TRUE(minor_version_field.IsAllocated()); 1267841efbbSZachary Turner 127b9c1b51eSKate Stone PythonInteger major_version_value = 128b9c1b51eSKate Stone major_version_field.AsType<PythonInteger>(); 129b9c1b51eSKate Stone PythonInteger minor_version_value = 130b9c1b51eSKate Stone minor_version_field.AsType<PythonInteger>(); 1317841efbbSZachary Turner 1327841efbbSZachary Turner EXPECT_EQ(PY_MAJOR_VERSION, major_version_value.GetInteger()); 1337841efbbSZachary Turner EXPECT_EQ(PY_MINOR_VERSION, minor_version_value.GetInteger()); 1347841efbbSZachary Turner } 1357841efbbSZachary Turner 136b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestGlobalNameResolutionWithDot) { 137a1405147SZachary Turner PythonObject sys_path = m_main_module.ResolveName("sys.path"); 1387841efbbSZachary Turner EXPECT_TRUE(sys_path.IsAllocated()); 1397841efbbSZachary Turner EXPECT_TRUE(PythonList::Check(sys_path.get())); 1407841efbbSZachary Turner 141b9c1b51eSKate Stone PythonInteger version_major = 142b9c1b51eSKate Stone m_main_module.ResolveName("sys.version_info.major") 143b9c1b51eSKate Stone .AsType<PythonInteger>(); 144b9c1b51eSKate Stone PythonInteger version_minor = 145b9c1b51eSKate Stone m_main_module.ResolveName("sys.version_info.minor") 146b9c1b51eSKate Stone .AsType<PythonInteger>(); 1477841efbbSZachary Turner EXPECT_TRUE(version_major.IsAllocated()); 1487841efbbSZachary Turner EXPECT_TRUE(version_minor.IsAllocated()); 1497841efbbSZachary Turner EXPECT_EQ(PY_MAJOR_VERSION, version_major.GetInteger()); 1507841efbbSZachary Turner EXPECT_EQ(PY_MINOR_VERSION, version_minor.GetInteger()); 1517841efbbSZachary Turner } 1527841efbbSZachary Turner 153b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestDictionaryResolutionWithDot) { 154a1405147SZachary Turner // Make up a custom dictionary with "sys" pointing to the `sys` module. 155a1405147SZachary Turner PythonDictionary dict(PyInitialValue::Empty); 156a1405147SZachary Turner dict.SetItemForKey(PythonString("sys"), m_sys_module); 157a1405147SZachary Turner 158a1405147SZachary Turner // Now use that dictionary to resolve `sys.version_info.major` 159b9c1b51eSKate Stone PythonInteger version_major = 160b9c1b51eSKate Stone PythonObject::ResolveNameWithDictionary("sys.version_info.major", dict) 161b9c1b51eSKate Stone .AsType<PythonInteger>(); 162b9c1b51eSKate Stone PythonInteger version_minor = 163b9c1b51eSKate Stone PythonObject::ResolveNameWithDictionary("sys.version_info.minor", dict) 164b9c1b51eSKate Stone .AsType<PythonInteger>(); 165a1405147SZachary Turner EXPECT_EQ(PY_MAJOR_VERSION, version_major.GetInteger()); 166a1405147SZachary Turner EXPECT_EQ(PY_MINOR_VERSION, version_minor.GetInteger()); 167a1405147SZachary Turner } 168a1405147SZachary Turner 169b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonInteger) { 17022c8efcdSZachary Turner // Test that integers behave correctly when wrapped by a PythonInteger. 17122c8efcdSZachary Turner 17222c8efcdSZachary Turner #if PY_MAJOR_VERSION < 3 17322c8efcdSZachary Turner // Verify that `PythonInt` works correctly when given a PyInt object. 17422c8efcdSZachary Turner // Note that PyInt doesn't exist in Python 3.x, so this is only for 2.x 17522c8efcdSZachary Turner PyObject *py_int = PyInt_FromLong(12); 17622c8efcdSZachary Turner EXPECT_TRUE(PythonInteger::Check(py_int)); 177f8b22f8fSZachary Turner PythonInteger python_int(PyRefType::Owned, py_int); 17822c8efcdSZachary Turner 17922c8efcdSZachary Turner EXPECT_EQ(PyObjectType::Integer, python_int.GetObjectType()); 18022c8efcdSZachary Turner EXPECT_EQ(12, python_int.GetInteger()); 18122c8efcdSZachary Turner #endif 18222c8efcdSZachary Turner 18318426935SZachary Turner // Verify that `PythonInteger` works correctly when given a PyLong object. 18422c8efcdSZachary Turner PyObject *py_long = PyLong_FromLong(12); 18522c8efcdSZachary Turner EXPECT_TRUE(PythonInteger::Check(py_long)); 186f8b22f8fSZachary Turner PythonInteger python_long(PyRefType::Owned, py_long); 18722c8efcdSZachary Turner EXPECT_EQ(PyObjectType::Integer, python_long.GetObjectType()); 18822c8efcdSZachary Turner 18922c8efcdSZachary Turner // Verify that you can reset the value and that it is reflected properly. 19022c8efcdSZachary Turner python_long.SetInteger(40); 19122c8efcdSZachary Turner EXPECT_EQ(40, python_long.GetInteger()); 19218426935SZachary Turner 19318426935SZachary Turner // Test that creating a `PythonInteger` object works correctly with the 19418426935SZachary Turner // int constructor. 19518426935SZachary Turner PythonInteger constructed_int(7); 19618426935SZachary Turner EXPECT_EQ(7, constructed_int.GetInteger()); 19722c8efcdSZachary Turner } 19822c8efcdSZachary Turner 199b81d715cSTatyana Krasnukha TEST_F(PythonDataObjectsTest, TestPythonBoolean) { 200b81d715cSTatyana Krasnukha // Test PythonBoolean constructed from Py_True 201b81d715cSTatyana Krasnukha EXPECT_TRUE(PythonBoolean::Check(Py_True)); 202b81d715cSTatyana Krasnukha PythonBoolean python_true(PyRefType::Owned, Py_True); 203b81d715cSTatyana Krasnukha EXPECT_EQ(PyObjectType::Boolean, python_true.GetObjectType()); 204b81d715cSTatyana Krasnukha 205b81d715cSTatyana Krasnukha // Test PythonBoolean constructed from Py_False 206b81d715cSTatyana Krasnukha EXPECT_TRUE(PythonBoolean::Check(Py_False)); 207b81d715cSTatyana Krasnukha PythonBoolean python_false(PyRefType::Owned, Py_False); 208b81d715cSTatyana Krasnukha EXPECT_EQ(PyObjectType::Boolean, python_false.GetObjectType()); 209b81d715cSTatyana Krasnukha 210b81d715cSTatyana Krasnukha auto test_from_long = [](long value) { 211b81d715cSTatyana Krasnukha PyObject *py_bool = PyBool_FromLong(value); 212b81d715cSTatyana Krasnukha EXPECT_TRUE(PythonBoolean::Check(py_bool)); 213b81d715cSTatyana Krasnukha PythonBoolean python_boolean(PyRefType::Owned, py_bool); 214b81d715cSTatyana Krasnukha EXPECT_EQ(PyObjectType::Boolean, python_boolean.GetObjectType()); 215b81d715cSTatyana Krasnukha EXPECT_EQ(bool(value), python_boolean.GetValue()); 216b81d715cSTatyana Krasnukha }; 217b81d715cSTatyana Krasnukha 218b81d715cSTatyana Krasnukha // Test PythonBoolean constructed from long integer values. 219b81d715cSTatyana Krasnukha test_from_long(0); // Test 'false' value. 220b81d715cSTatyana Krasnukha test_from_long(1); // Test 'true' value. 221b81d715cSTatyana Krasnukha test_from_long(~0); // Any value != 0 is 'true'. 222b81d715cSTatyana Krasnukha } 223b81d715cSTatyana Krasnukha 224b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonBytes) { 2255a72c02bSZachary Turner static const char *test_bytes = "PythonDataObjectsTest::TestPythonBytes"; 2265a72c02bSZachary Turner PyObject *py_bytes = PyBytes_FromString(test_bytes); 2275a72c02bSZachary Turner EXPECT_TRUE(PythonBytes::Check(py_bytes)); 2285a72c02bSZachary Turner PythonBytes python_bytes(PyRefType::Owned, py_bytes); 2295a72c02bSZachary Turner 2305a72c02bSZachary Turner #if PY_MAJOR_VERSION < 3 2315a72c02bSZachary Turner EXPECT_TRUE(PythonString::Check(py_bytes)); 2325a72c02bSZachary Turner EXPECT_EQ(PyObjectType::String, python_bytes.GetObjectType()); 2335a72c02bSZachary Turner #else 2345a72c02bSZachary Turner EXPECT_FALSE(PythonString::Check(py_bytes)); 2355a8453d5SPavel Labath EXPECT_EQ(PyObjectType::Bytes, python_bytes.GetObjectType()); 2365a72c02bSZachary Turner #endif 2375a72c02bSZachary Turner 2385a72c02bSZachary Turner llvm::ArrayRef<uint8_t> bytes = python_bytes.GetBytes(); 2395a72c02bSZachary Turner EXPECT_EQ(bytes.size(), strlen(test_bytes)); 2405a72c02bSZachary Turner EXPECT_EQ(0, ::memcmp(bytes.data(), test_bytes, bytes.size())); 2415a72c02bSZachary Turner } 2425a72c02bSZachary Turner 243b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonByteArray) { 244f9d6d204SZachary Turner static const char *test_bytes = "PythonDataObjectsTest::TestPythonByteArray"; 245f9d6d204SZachary Turner llvm::StringRef orig_bytes(test_bytes); 246b9c1b51eSKate Stone PyObject *py_bytes = 247b9c1b51eSKate Stone PyByteArray_FromStringAndSize(test_bytes, orig_bytes.size()); 248f9d6d204SZachary Turner EXPECT_TRUE(PythonByteArray::Check(py_bytes)); 249f9d6d204SZachary Turner PythonByteArray python_bytes(PyRefType::Owned, py_bytes); 250f9d6d204SZachary Turner EXPECT_EQ(PyObjectType::ByteArray, python_bytes.GetObjectType()); 251f9d6d204SZachary Turner 252f9d6d204SZachary Turner llvm::ArrayRef<uint8_t> after_bytes = python_bytes.GetBytes(); 253f9d6d204SZachary Turner EXPECT_EQ(after_bytes.size(), orig_bytes.size()); 254f9d6d204SZachary Turner EXPECT_EQ(0, ::memcmp(orig_bytes.data(), test_bytes, orig_bytes.size())); 255f9d6d204SZachary Turner } 256f9d6d204SZachary Turner 257b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonString) { 25822c8efcdSZachary Turner // Test that strings behave correctly when wrapped by a PythonString. 25922c8efcdSZachary Turner 26018426935SZachary Turner static const char *test_string = "PythonDataObjectsTest::TestPythonString1"; 26118426935SZachary Turner static const char *test_string2 = "PythonDataObjectsTest::TestPythonString2"; 26222c8efcdSZachary Turner 26322c8efcdSZachary Turner #if PY_MAJOR_VERSION < 3 26422c8efcdSZachary Turner // Verify that `PythonString` works correctly when given a PyString object. 26522c8efcdSZachary Turner // Note that PyString doesn't exist in Python 3.x, so this is only for 2.x 26622c8efcdSZachary Turner PyObject *py_string = PyString_FromString(test_string); 26722c8efcdSZachary Turner EXPECT_TRUE(PythonString::Check(py_string)); 268f8b22f8fSZachary Turner PythonString python_string(PyRefType::Owned, py_string); 26922c8efcdSZachary Turner 27022c8efcdSZachary Turner EXPECT_EQ(PyObjectType::String, python_string.GetObjectType()); 27122c8efcdSZachary Turner EXPECT_STREQ(test_string, python_string.GetString().data()); 27218426935SZachary Turner #else 27322c8efcdSZachary Turner // Verify that `PythonString` works correctly when given a PyUnicode object. 27422c8efcdSZachary Turner PyObject *py_unicode = PyUnicode_FromString(test_string); 27522c8efcdSZachary Turner EXPECT_TRUE(PythonString::Check(py_unicode)); 276f8b22f8fSZachary Turner PythonString python_unicode(PyRefType::Owned, py_unicode); 27722c8efcdSZachary Turner EXPECT_EQ(PyObjectType::String, python_unicode.GetObjectType()); 27822c8efcdSZachary Turner EXPECT_STREQ(test_string, python_unicode.GetString().data()); 27918426935SZachary Turner #endif 28022c8efcdSZachary Turner 28118426935SZachary Turner // Test that creating a `PythonString` object works correctly with the 28218426935SZachary Turner // string constructor 283de9dfe78SReid Kleckner PythonString constructed_string(test_string2); 2846fe867a8SZachary Turner EXPECT_EQ(test_string2, constructed_string.GetString()); 28522c8efcdSZachary Turner } 28622c8efcdSZachary Turner 287b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonStringToStr) { 2886fe867a8SZachary Turner const char *GetString = "PythonDataObjectsTest::TestPythonStringToStr"; 28918426935SZachary Turner 2906fe867a8SZachary Turner PythonString str(GetString); 2916fe867a8SZachary Turner EXPECT_EQ(GetString, str.GetString()); 29218426935SZachary Turner 29318426935SZachary Turner PythonString str_str = str.Str(); 2946fe867a8SZachary Turner EXPECT_EQ(GetString, str_str.GetString()); 29518426935SZachary Turner } 29618426935SZachary Turner 297b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonIntegerToStr) {} 29818426935SZachary Turner 299b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonIntegerToStructuredInteger) { 30018426935SZachary Turner PythonInteger integer(7); 30118426935SZachary Turner auto int_sp = integer.CreateStructuredInteger(); 302de9dfe78SReid Kleckner EXPECT_EQ(7U, int_sp->GetValue()); 30318426935SZachary Turner } 30418426935SZachary Turner 305b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonStringToStructuredString) { 306b9c1b51eSKate Stone static const char *test_string = 307b9c1b51eSKate Stone "PythonDataObjectsTest::TestPythonStringToStructuredString"; 30818426935SZachary Turner PythonString constructed_string(test_string); 30918426935SZachary Turner auto string_sp = constructed_string.CreateStructuredString(); 3106fe867a8SZachary Turner EXPECT_EQ(test_string, string_sp->GetStringValue()); 31118426935SZachary Turner } 31218426935SZachary Turner 313b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonListValueEquality) { 31422c8efcdSZachary Turner // Test that a list which is built through the native 31522c8efcdSZachary Turner // Python API behaves correctly when wrapped by a PythonList. 316de9dfe78SReid Kleckner static const unsigned list_size = 2; 31718426935SZachary Turner static const long long_value0 = 5; 31818426935SZachary Turner static const char *const string_value1 = "String Index 1"; 31922c8efcdSZachary Turner 32022c8efcdSZachary Turner PyObject *py_list = PyList_New(2); 321f8b22f8fSZachary Turner EXPECT_TRUE(PythonList::Check(py_list)); 322f8b22f8fSZachary Turner PythonList list(PyRefType::Owned, py_list); 323f8b22f8fSZachary Turner 324f8b22f8fSZachary Turner PythonObject list_items[list_size]; 32518426935SZachary Turner list_items[0].Reset(PythonInteger(long_value0)); 32618426935SZachary Turner list_items[1].Reset(PythonString(string_value1)); 32722c8efcdSZachary Turner 328de9dfe78SReid Kleckner for (unsigned i = 0; i < list_size; ++i) 329f8b22f8fSZachary Turner list.SetItemAtIndex(i, list_items[i]); 33022c8efcdSZachary Turner 33122c8efcdSZachary Turner EXPECT_EQ(list_size, list.GetSize()); 33222c8efcdSZachary Turner EXPECT_EQ(PyObjectType::List, list.GetObjectType()); 33322c8efcdSZachary Turner 33418426935SZachary Turner // Verify that the values match 33518426935SZachary Turner PythonObject chk_value1 = list.GetItemAtIndex(0); 33618426935SZachary Turner PythonObject chk_value2 = list.GetItemAtIndex(1); 33718426935SZachary Turner EXPECT_TRUE(PythonInteger::Check(chk_value1.get())); 33818426935SZachary Turner EXPECT_TRUE(PythonString::Check(chk_value2.get())); 33922c8efcdSZachary Turner 34018426935SZachary Turner PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get()); 34118426935SZachary Turner PythonString chk_str(PyRefType::Borrowed, chk_value2.get()); 34222c8efcdSZachary Turner 34318426935SZachary Turner EXPECT_EQ(long_value0, chk_int.GetInteger()); 3446fe867a8SZachary Turner EXPECT_EQ(string_value1, chk_str.GetString()); 34522c8efcdSZachary Turner } 34622c8efcdSZachary Turner 347b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonListManipulation) { 34822c8efcdSZachary Turner // Test that manipulation of a PythonList behaves correctly when 34922c8efcdSZachary Turner // wrapped by a PythonDictionary. 35022c8efcdSZachary Turner 35118426935SZachary Turner static const long long_value0 = 5; 35218426935SZachary Turner static const char *const string_value1 = "String Index 1"; 35322c8efcdSZachary Turner 354f8b22f8fSZachary Turner PythonList list(PyInitialValue::Empty); 35518426935SZachary Turner PythonInteger integer(long_value0); 35618426935SZachary Turner PythonString string(string_value1); 35722c8efcdSZachary Turner 35822c8efcdSZachary Turner list.AppendItem(integer); 35922c8efcdSZachary Turner list.AppendItem(string); 360de9dfe78SReid Kleckner EXPECT_EQ(2U, list.GetSize()); 36122c8efcdSZachary Turner 36218426935SZachary Turner // Verify that the values match 36318426935SZachary Turner PythonObject chk_value1 = list.GetItemAtIndex(0); 36418426935SZachary Turner PythonObject chk_value2 = list.GetItemAtIndex(1); 36518426935SZachary Turner EXPECT_TRUE(PythonInteger::Check(chk_value1.get())); 36618426935SZachary Turner EXPECT_TRUE(PythonString::Check(chk_value2.get())); 36718426935SZachary Turner 36818426935SZachary Turner PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get()); 36918426935SZachary Turner PythonString chk_str(PyRefType::Borrowed, chk_value2.get()); 37018426935SZachary Turner 37118426935SZachary Turner EXPECT_EQ(long_value0, chk_int.GetInteger()); 3726fe867a8SZachary Turner EXPECT_EQ(string_value1, chk_str.GetString()); 37318426935SZachary Turner } 37418426935SZachary Turner 375b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonListToStructuredList) { 37618426935SZachary Turner static const long long_value0 = 5; 37718426935SZachary Turner static const char *const string_value1 = "String Index 1"; 37818426935SZachary Turner 37918426935SZachary Turner PythonList list(PyInitialValue::Empty); 38018426935SZachary Turner list.AppendItem(PythonInteger(long_value0)); 38118426935SZachary Turner list.AppendItem(PythonString(string_value1)); 38218426935SZachary Turner 38318426935SZachary Turner auto array_sp = list.CreateStructuredArray(); 3845bfee5f1SAbhishek Aggarwal EXPECT_EQ(lldb::eStructuredDataTypeInteger, 385b9c1b51eSKate Stone array_sp->GetItemAtIndex(0)->GetType()); 3865bfee5f1SAbhishek Aggarwal EXPECT_EQ(lldb::eStructuredDataTypeString, 387b9c1b51eSKate Stone array_sp->GetItemAtIndex(1)->GetType()); 38818426935SZachary Turner 38918426935SZachary Turner auto int_sp = array_sp->GetItemAtIndex(0)->GetAsInteger(); 39018426935SZachary Turner auto string_sp = array_sp->GetItemAtIndex(1)->GetAsString(); 39118426935SZachary Turner 392de9dfe78SReid Kleckner EXPECT_EQ(long_value0, long(int_sp->GetValue())); 3936fe867a8SZachary Turner EXPECT_EQ(string_value1, string_sp->GetValue()); 39418426935SZachary Turner } 39518426935SZachary Turner 396b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleSize) { 397a1405147SZachary Turner PythonTuple tuple(PyInitialValue::Empty); 398de9dfe78SReid Kleckner EXPECT_EQ(0U, tuple.GetSize()); 399a1405147SZachary Turner 400a1405147SZachary Turner tuple = PythonTuple(3); 401de9dfe78SReid Kleckner EXPECT_EQ(3U, tuple.GetSize()); 402a1405147SZachary Turner } 403a1405147SZachary Turner 404b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleValues) { 405a1405147SZachary Turner PythonTuple tuple(3); 406a1405147SZachary Turner 407a1405147SZachary Turner PythonInteger int_value(1); 408a1405147SZachary Turner PythonString string_value("Test"); 409a1405147SZachary Turner PythonObject none_value(PyRefType::Borrowed, Py_None); 410a1405147SZachary Turner 411a1405147SZachary Turner tuple.SetItemAtIndex(0, int_value); 412a1405147SZachary Turner tuple.SetItemAtIndex(1, string_value); 413a1405147SZachary Turner tuple.SetItemAtIndex(2, none_value); 414a1405147SZachary Turner 415a1405147SZachary Turner EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get()); 416a1405147SZachary Turner EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get()); 417a1405147SZachary Turner EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get()); 418a1405147SZachary Turner } 419a1405147SZachary Turner 420b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleInitializerList) { 421a1405147SZachary Turner PythonInteger int_value(1); 422a1405147SZachary Turner PythonString string_value("Test"); 423a1405147SZachary Turner PythonObject none_value(PyRefType::Borrowed, Py_None); 424a1405147SZachary Turner PythonTuple tuple{int_value, string_value, none_value}; 425de9dfe78SReid Kleckner EXPECT_EQ(3U, tuple.GetSize()); 426a1405147SZachary Turner 427a1405147SZachary Turner EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get()); 428a1405147SZachary Turner EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get()); 429a1405147SZachary Turner EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get()); 430a1405147SZachary Turner } 431a1405147SZachary Turner 432b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleInitializerList2) { 433a1405147SZachary Turner PythonInteger int_value(1); 434a1405147SZachary Turner PythonString string_value("Test"); 435a1405147SZachary Turner PythonObject none_value(PyRefType::Borrowed, Py_None); 436a1405147SZachary Turner 437a1405147SZachary Turner PythonTuple tuple{int_value.get(), string_value.get(), none_value.get()}; 438de9dfe78SReid Kleckner EXPECT_EQ(3U, tuple.GetSize()); 439a1405147SZachary Turner 440a1405147SZachary Turner EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get()); 441a1405147SZachary Turner EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get()); 442a1405147SZachary Turner EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get()); 443a1405147SZachary Turner } 444a1405147SZachary Turner 445b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleToStructuredList) { 446a1405147SZachary Turner PythonInteger int_value(1); 447a1405147SZachary Turner PythonString string_value("Test"); 448a1405147SZachary Turner 449a1405147SZachary Turner PythonTuple tuple{int_value.get(), string_value.get()}; 450a1405147SZachary Turner 451a1405147SZachary Turner auto array_sp = tuple.CreateStructuredArray(); 452a1405147SZachary Turner EXPECT_EQ(tuple.GetSize(), array_sp->GetSize()); 4535bfee5f1SAbhishek Aggarwal EXPECT_EQ(lldb::eStructuredDataTypeInteger, 454b9c1b51eSKate Stone array_sp->GetItemAtIndex(0)->GetType()); 4555bfee5f1SAbhishek Aggarwal EXPECT_EQ(lldb::eStructuredDataTypeString, 456b9c1b51eSKate Stone array_sp->GetItemAtIndex(1)->GetType()); 457a1405147SZachary Turner } 458a1405147SZachary Turner 459b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonDictionaryValueEquality) { 46018426935SZachary Turner // Test that a dictionary which is built through the native 46118426935SZachary Turner // Python API behaves correctly when wrapped by a PythonDictionary. 462de9dfe78SReid Kleckner static const unsigned dict_entries = 2; 46318426935SZachary Turner const char *key_0 = "Key 0"; 46418426935SZachary Turner int key_1 = 1; 46518426935SZachary Turner const int value_0 = 0; 46618426935SZachary Turner const char *value_1 = "Value 1"; 46718426935SZachary Turner 46818426935SZachary Turner PythonObject py_keys[dict_entries]; 46918426935SZachary Turner PythonObject py_values[dict_entries]; 47018426935SZachary Turner 47118426935SZachary Turner py_keys[0].Reset(PythonString(key_0)); 47218426935SZachary Turner py_keys[1].Reset(PythonInteger(key_1)); 47318426935SZachary Turner py_values[0].Reset(PythonInteger(value_0)); 47418426935SZachary Turner py_values[1].Reset(PythonString(value_1)); 47518426935SZachary Turner 47618426935SZachary Turner PyObject *py_dict = PyDict_New(); 47718426935SZachary Turner EXPECT_TRUE(PythonDictionary::Check(py_dict)); 47818426935SZachary Turner PythonDictionary dict(PyRefType::Owned, py_dict); 47918426935SZachary Turner 480de9dfe78SReid Kleckner for (unsigned i = 0; i < dict_entries; ++i) 48118426935SZachary Turner PyDict_SetItem(py_dict, py_keys[i].get(), py_values[i].get()); 48218426935SZachary Turner EXPECT_EQ(dict.GetSize(), dict_entries); 48318426935SZachary Turner EXPECT_EQ(PyObjectType::Dictionary, dict.GetObjectType()); 48418426935SZachary Turner 48518426935SZachary Turner // Verify that the values match 48618426935SZachary Turner PythonObject chk_value1 = dict.GetItemForKey(py_keys[0]); 48718426935SZachary Turner PythonObject chk_value2 = dict.GetItemForKey(py_keys[1]); 48818426935SZachary Turner EXPECT_TRUE(PythonInteger::Check(chk_value1.get())); 48918426935SZachary Turner EXPECT_TRUE(PythonString::Check(chk_value2.get())); 49018426935SZachary Turner 49118426935SZachary Turner PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get()); 49218426935SZachary Turner PythonString chk_str(PyRefType::Borrowed, chk_value2.get()); 49318426935SZachary Turner 49418426935SZachary Turner EXPECT_EQ(value_0, chk_int.GetInteger()); 4956fe867a8SZachary Turner EXPECT_EQ(value_1, chk_str.GetString()); 49622c8efcdSZachary Turner } 49722c8efcdSZachary Turner 498b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonDictionaryManipulation) { 49922c8efcdSZachary Turner // Test that manipulation of a dictionary behaves correctly when wrapped 50022c8efcdSZachary Turner // by a PythonDictionary. 501de9dfe78SReid Kleckner static const unsigned dict_entries = 2; 50222c8efcdSZachary Turner 50318426935SZachary Turner const char *const key_0 = "Key 0"; 50418426935SZachary Turner const char *const key_1 = "Key 1"; 50518426935SZachary Turner const long value_0 = 1; 50618426935SZachary Turner const char *const value_1 = "Value 1"; 50718426935SZachary Turner 508f8b22f8fSZachary Turner PythonString keys[dict_entries]; 509f8b22f8fSZachary Turner PythonObject values[dict_entries]; 51022c8efcdSZachary Turner 51118426935SZachary Turner keys[0].Reset(PythonString(key_0)); 51218426935SZachary Turner keys[1].Reset(PythonString(key_1)); 51318426935SZachary Turner values[0].Reset(PythonInteger(value_0)); 51418426935SZachary Turner values[1].Reset(PythonString(value_1)); 51522c8efcdSZachary Turner 516f8b22f8fSZachary Turner PythonDictionary dict(PyInitialValue::Empty); 51722c8efcdSZachary Turner for (int i = 0; i < 2; ++i) 518f8b22f8fSZachary Turner dict.SetItemForKey(keys[i], values[i]); 51922c8efcdSZachary Turner 52022c8efcdSZachary Turner EXPECT_EQ(dict_entries, dict.GetSize()); 52122c8efcdSZachary Turner 52218426935SZachary Turner // Verify that the keys and values match 52318426935SZachary Turner PythonObject chk_value1 = dict.GetItemForKey(keys[0]); 52418426935SZachary Turner PythonObject chk_value2 = dict.GetItemForKey(keys[1]); 52518426935SZachary Turner EXPECT_TRUE(PythonInteger::Check(chk_value1.get())); 52618426935SZachary Turner EXPECT_TRUE(PythonString::Check(chk_value2.get())); 52718426935SZachary Turner 52818426935SZachary Turner PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get()); 52918426935SZachary Turner PythonString chk_str(PyRefType::Borrowed, chk_value2.get()); 53018426935SZachary Turner 53118426935SZachary Turner EXPECT_EQ(value_0, chk_int.GetInteger()); 5326fe867a8SZachary Turner EXPECT_EQ(value_1, chk_str.GetString()); 53322c8efcdSZachary Turner } 53422c8efcdSZachary Turner 535b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonDictionaryToStructuredDictionary) { 53618426935SZachary Turner static const char *const string_key0 = "String Key 0"; 53718426935SZachary Turner static const char *const string_key1 = "String Key 1"; 53822c8efcdSZachary Turner 53918426935SZachary Turner static const char *const string_value0 = "String Value 0"; 54018426935SZachary Turner static const long int_value1 = 7; 54122c8efcdSZachary Turner 542f8b22f8fSZachary Turner PythonDictionary dict(PyInitialValue::Empty); 54318426935SZachary Turner dict.SetItemForKey(PythonString(string_key0), PythonString(string_value0)); 54418426935SZachary Turner dict.SetItemForKey(PythonString(string_key1), PythonInteger(int_value1)); 54522c8efcdSZachary Turner 54618426935SZachary Turner auto dict_sp = dict.CreateStructuredDictionary(); 547de9dfe78SReid Kleckner EXPECT_EQ(2U, dict_sp->GetSize()); 54822c8efcdSZachary Turner 54918426935SZachary Turner EXPECT_TRUE(dict_sp->HasKey(string_key0)); 55018426935SZachary Turner EXPECT_TRUE(dict_sp->HasKey(string_key1)); 55122c8efcdSZachary Turner 55218426935SZachary Turner auto string_sp = dict_sp->GetValueForKey(string_key0)->GetAsString(); 55318426935SZachary Turner auto int_sp = dict_sp->GetValueForKey(string_key1)->GetAsInteger(); 55422c8efcdSZachary Turner 5556fe867a8SZachary Turner EXPECT_EQ(string_value0, string_sp->GetValue()); 556de9dfe78SReid Kleckner EXPECT_EQ(int_value1, long(int_sp->GetValue())); 55722c8efcdSZachary Turner } 5589c40264fSZachary Turner 559b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonCallableCheck) { 560a1405147SZachary Turner PythonObject sys_exc_info = m_sys_module.ResolveName("exc_info"); 561a1405147SZachary Turner PythonObject none(PyRefType::Borrowed, Py_None); 562a1405147SZachary Turner 563a1405147SZachary Turner EXPECT_TRUE(PythonCallable::Check(sys_exc_info.get())); 564a1405147SZachary Turner EXPECT_FALSE(PythonCallable::Check(none.get())); 565a1405147SZachary Turner } 566a1405147SZachary Turner 567b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonCallableInvoke) { 568a1405147SZachary Turner auto list = m_builtins_module.ResolveName("list").AsType<PythonCallable>(); 569a1405147SZachary Turner PythonInteger one(1); 570a1405147SZachary Turner PythonString two("two"); 571a1405147SZachary Turner PythonTuple three = {one, two}; 572a1405147SZachary Turner 573a1405147SZachary Turner PythonTuple tuple_to_convert = {one, two, three}; 574a1405147SZachary Turner PythonObject result = list({tuple_to_convert}); 575a1405147SZachary Turner 576a1405147SZachary Turner EXPECT_TRUE(PythonList::Check(result.get())); 577a1405147SZachary Turner auto list_result = result.AsType<PythonList>(); 578de9dfe78SReid Kleckner EXPECT_EQ(3U, list_result.GetSize()); 579a1405147SZachary Turner EXPECT_EQ(one.get(), list_result.GetItemAtIndex(0).get()); 580a1405147SZachary Turner EXPECT_EQ(two.get(), list_result.GetItemAtIndex(1).get()); 581a1405147SZachary Turner EXPECT_EQ(three.get(), list_result.GetItemAtIndex(2).get()); 582a1405147SZachary Turner } 583a1405147SZachary Turner 584b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonFile) { 585*2fce1137SLawrence D'Anna auto file = FileSystem::Instance().Open(FileSpec(FileSystem::DEV_NULL), 58650bc1ed2SJonas Devlieghere File::eOpenOptionRead); 587*2fce1137SLawrence D'Anna ASSERT_THAT_EXPECTED(file, llvm::Succeeded()); 588*2fce1137SLawrence D'Anna PythonFile py_file(*file.get(), "r"); 5899c40264fSZachary Turner EXPECT_TRUE(PythonFile::Check(py_file.get())); 5909c40264fSZachary Turner } 5917d6d218eSZachary Turner 592b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestObjectAttributes) { 5937d6d218eSZachary Turner PythonInteger py_int(42); 5947d6d218eSZachary Turner EXPECT_TRUE(py_int.HasAttribute("numerator")); 5957d6d218eSZachary Turner EXPECT_FALSE(py_int.HasAttribute("this_should_not_exist")); 5967d6d218eSZachary Turner 597b9c1b51eSKate Stone PythonInteger numerator_attr = 598b9c1b51eSKate Stone py_int.GetAttributeValue("numerator").AsType<PythonInteger>(); 5997d6d218eSZachary Turner EXPECT_TRUE(numerator_attr.IsAllocated()); 6007d6d218eSZachary Turner EXPECT_EQ(42, numerator_attr.GetInteger()); 6017d6d218eSZachary Turner } 602008ec446SGreg Clayton 603b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestExtractingUInt64ThroughStructuredData) { 604008ec446SGreg Clayton // Make up a custom dictionary with "sys" pointing to the `sys` module. 605008ec446SGreg Clayton const char *key_name = "addr"; 606008ec446SGreg Clayton const uint64_t value = 0xf000000000000000ull; 607008ec446SGreg Clayton PythonDictionary python_dict(PyInitialValue::Empty); 608b9c1b51eSKate Stone PythonInteger python_ull_value(PyRefType::Owned, 609b9c1b51eSKate Stone PyLong_FromUnsignedLongLong(value)); 610008ec446SGreg Clayton python_dict.SetItemForKey(PythonString(key_name), python_ull_value); 611b9c1b51eSKate Stone StructuredData::ObjectSP structured_data_sp = 612b9c1b51eSKate Stone python_dict.CreateStructuredObject(); 613008ec446SGreg Clayton EXPECT_TRUE((bool)structured_data_sp); 614b9c1b51eSKate Stone if (structured_data_sp) { 615b9c1b51eSKate Stone StructuredData::Dictionary *structured_dict_ptr = 616b9c1b51eSKate Stone structured_data_sp->GetAsDictionary(); 617008ec446SGreg Clayton EXPECT_TRUE(structured_dict_ptr != nullptr); 618b9c1b51eSKate Stone if (structured_dict_ptr) { 619b9c1b51eSKate Stone StructuredData::ObjectSP structured_addr_value_sp = 620b9c1b51eSKate Stone structured_dict_ptr->GetValueForKey(key_name); 621008ec446SGreg Clayton EXPECT_TRUE((bool)structured_addr_value_sp); 622b9c1b51eSKate Stone const uint64_t extracted_value = 623b9c1b51eSKate Stone structured_addr_value_sp->GetIntegerValue(123); 624008ec446SGreg Clayton EXPECT_TRUE(extracted_value == value); 625008ec446SGreg Clayton } 626008ec446SGreg Clayton } 627008ec446SGreg Clayton } 628