122c8efcdSZachary Turner //===-- PythonDataObjectsTests.cpp ------------------------------*- C++ -*-===//
222c8efcdSZachary Turner //
322c8efcdSZachary Turner //                     The LLVM Compiler Infrastructure
422c8efcdSZachary Turner //
522c8efcdSZachary Turner // This file is distributed under the University of Illinois Open Source
622c8efcdSZachary Turner // License. See LICENSE.TXT for details.
722c8efcdSZachary Turner //
822c8efcdSZachary Turner //===----------------------------------------------------------------------===//
922c8efcdSZachary Turner 
1022c8efcdSZachary Turner #include "gtest/gtest.h"
11*8c68837dSPavel Labath #include "Plugins/ScriptInterpreter/Python/lldb-python.h"
1222c8efcdSZachary Turner 
139c40264fSZachary Turner #include "lldb/Host/File.h"
149c40264fSZachary Turner #include "lldb/Host/FileSystem.h"
1522c8efcdSZachary Turner #include "lldb/Host/HostInfo.h"
1622c8efcdSZachary Turner #include "Plugins/ScriptInterpreter/Python/PythonDataObjects.h"
1722c8efcdSZachary Turner #include "Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.h"
1822c8efcdSZachary Turner 
19c946d462SZachary Turner #include "PythonTestSuite.h"
20c946d462SZachary Turner 
2122c8efcdSZachary Turner using namespace lldb_private;
2222c8efcdSZachary Turner 
23c946d462SZachary Turner class PythonDataObjectsTest : public PythonTestSuite
2422c8efcdSZachary Turner {
2522c8efcdSZachary Turner   public:
2622c8efcdSZachary Turner     void
2722c8efcdSZachary Turner     SetUp() override
2822c8efcdSZachary Turner     {
29c946d462SZachary Turner         PythonTestSuite::SetUp();
30a1405147SZachary Turner 
31a1405147SZachary Turner         PythonString sys_module("sys");
32a1405147SZachary Turner         m_sys_module.Reset(PyRefType::Owned, PyImport_Import(sys_module.get()));
33a1405147SZachary Turner         m_main_module = PythonModule::MainModule();
34a1405147SZachary Turner         m_builtins_module = PythonModule::BuiltinsModule();
3522c8efcdSZachary Turner     }
3622c8efcdSZachary Turner 
3722c8efcdSZachary Turner     void
3822c8efcdSZachary Turner     TearDown() override
3922c8efcdSZachary Turner     {
40a1405147SZachary Turner         m_sys_module.Reset();
41a1405147SZachary Turner         m_main_module.Reset();
42a1405147SZachary Turner         m_builtins_module.Reset();
43f8b22f8fSZachary Turner 
44c946d462SZachary Turner         PythonTestSuite::TearDown();
4522c8efcdSZachary Turner     }
46f8b22f8fSZachary Turner 
47a1405147SZachary Turner   protected:
48a1405147SZachary Turner     PythonModule m_sys_module;
49a1405147SZachary Turner     PythonModule m_main_module;
50a1405147SZachary Turner     PythonModule m_builtins_module;
5122c8efcdSZachary Turner };
5222c8efcdSZachary Turner 
53f8b22f8fSZachary Turner TEST_F(PythonDataObjectsTest, TestOwnedReferences)
54f8b22f8fSZachary Turner {
5518426935SZachary Turner     // After creating a new object, the refcount should be >= 1
56f8b22f8fSZachary Turner     PyObject *obj = PyLong_FromLong(3);
5718426935SZachary Turner     Py_ssize_t original_refcnt = obj->ob_refcnt;
5818426935SZachary Turner     EXPECT_LE(1, original_refcnt);
59f8b22f8fSZachary Turner 
6018426935SZachary Turner     // If we take an owned reference, the refcount should be the same
61f8b22f8fSZachary Turner     PythonObject owned_long(PyRefType::Owned, obj);
6218426935SZachary Turner     EXPECT_EQ(original_refcnt, owned_long.get()->ob_refcnt);
63f8b22f8fSZachary Turner 
6418426935SZachary Turner     // Take another reference and verify that the refcount increases by 1
65f8b22f8fSZachary Turner     PythonObject strong_ref(owned_long);
6618426935SZachary Turner     EXPECT_EQ(original_refcnt + 1, strong_ref.get()->ob_refcnt);
67f8b22f8fSZachary Turner 
6818426935SZachary Turner     // If we reset the first one, the refcount should be the original value.
69f8b22f8fSZachary Turner     owned_long.Reset();
7018426935SZachary Turner     EXPECT_EQ(original_refcnt, strong_ref.get()->ob_refcnt);
71f8b22f8fSZachary Turner }
72f8b22f8fSZachary Turner 
73f8b22f8fSZachary Turner TEST_F(PythonDataObjectsTest, TestResetting)
74f8b22f8fSZachary Turner {
75f8b22f8fSZachary Turner     PythonDictionary dict(PyInitialValue::Empty);
76f8b22f8fSZachary Turner 
77f8b22f8fSZachary Turner     PyObject *new_dict = PyDict_New();
78f8b22f8fSZachary Turner     dict.Reset(PyRefType::Owned, new_dict);
79f8b22f8fSZachary Turner     EXPECT_EQ(new_dict, dict.get());
80f8b22f8fSZachary Turner 
81f8b22f8fSZachary Turner     dict.Reset(PyRefType::Owned, nullptr);
82f8b22f8fSZachary Turner     EXPECT_EQ(nullptr, dict.get());
83f8b22f8fSZachary Turner 
84f8b22f8fSZachary Turner     dict.Reset(PyRefType::Owned, PyDict_New());
85f8b22f8fSZachary Turner     EXPECT_NE(nullptr, dict.get());
86f8b22f8fSZachary Turner     dict.Reset();
87f8b22f8fSZachary Turner     EXPECT_EQ(nullptr, dict.get());
88f8b22f8fSZachary Turner }
89f8b22f8fSZachary Turner 
90f8b22f8fSZachary Turner TEST_F(PythonDataObjectsTest, TestBorrowedReferences)
91f8b22f8fSZachary Turner {
92f8b22f8fSZachary Turner     PythonInteger long_value(PyRefType::Owned, PyLong_FromLong(3));
9318426935SZachary Turner     Py_ssize_t original_refcnt = long_value.get()->ob_refcnt;
9418426935SZachary Turner     EXPECT_LE(1, original_refcnt);
95f8b22f8fSZachary Turner 
96f8b22f8fSZachary Turner     PythonInteger borrowed_long(PyRefType::Borrowed, long_value.get());
9718426935SZachary Turner     EXPECT_EQ(original_refcnt + 1, borrowed_long.get()->ob_refcnt);
98f8b22f8fSZachary Turner }
99f8b22f8fSZachary Turner 
1007841efbbSZachary Turner TEST_F(PythonDataObjectsTest, TestGlobalNameResolutionNoDot)
1017841efbbSZachary Turner {
102a1405147SZachary Turner     PythonObject sys_module = m_main_module.ResolveName("sys");
103a1405147SZachary Turner     EXPECT_EQ(m_sys_module.get(), sys_module.get());
1047841efbbSZachary Turner     EXPECT_TRUE(sys_module.IsAllocated());
1057841efbbSZachary Turner     EXPECT_TRUE(PythonModule::Check(sys_module.get()));
1067841efbbSZachary Turner }
1077841efbbSZachary Turner 
1087841efbbSZachary Turner TEST_F(PythonDataObjectsTest, TestModuleNameResolutionNoDot)
1097841efbbSZachary Turner {
110a1405147SZachary Turner     PythonObject sys_path = m_sys_module.ResolveName("path");
111a1405147SZachary Turner     PythonObject sys_version_info = m_sys_module.ResolveName("version_info");
1127841efbbSZachary Turner     EXPECT_TRUE(sys_path.IsAllocated());
1137841efbbSZachary Turner     EXPECT_TRUE(sys_version_info.IsAllocated());
1147841efbbSZachary Turner 
1157841efbbSZachary Turner     EXPECT_TRUE(PythonList::Check(sys_path.get()));
1167841efbbSZachary Turner }
1177841efbbSZachary Turner 
1187841efbbSZachary Turner TEST_F(PythonDataObjectsTest, TestTypeNameResolutionNoDot)
1197841efbbSZachary Turner {
120a1405147SZachary Turner     PythonObject sys_version_info = m_sys_module.ResolveName("version_info");
1217841efbbSZachary Turner 
1227841efbbSZachary Turner     PythonObject version_info_type(PyRefType::Owned, PyObject_Type(sys_version_info.get()));
1237841efbbSZachary Turner     EXPECT_TRUE(version_info_type.IsAllocated());
1247841efbbSZachary Turner     PythonObject major_version_field = version_info_type.ResolveName("major");
1257841efbbSZachary Turner     EXPECT_TRUE(major_version_field.IsAllocated());
1267841efbbSZachary Turner }
1277841efbbSZachary Turner 
1287841efbbSZachary Turner TEST_F(PythonDataObjectsTest, TestInstanceNameResolutionNoDot)
1297841efbbSZachary Turner {
130a1405147SZachary Turner     PythonObject sys_version_info = m_sys_module.ResolveName("version_info");
1317841efbbSZachary Turner     PythonObject major_version_field = sys_version_info.ResolveName("major");
1327841efbbSZachary Turner     PythonObject minor_version_field = sys_version_info.ResolveName("minor");
1337841efbbSZachary Turner 
1347841efbbSZachary Turner     EXPECT_TRUE(major_version_field.IsAllocated());
1357841efbbSZachary Turner     EXPECT_TRUE(minor_version_field.IsAllocated());
1367841efbbSZachary Turner 
1377841efbbSZachary Turner     PythonInteger major_version_value = major_version_field.AsType<PythonInteger>();
1387841efbbSZachary Turner     PythonInteger minor_version_value = minor_version_field.AsType<PythonInteger>();
1397841efbbSZachary Turner 
1407841efbbSZachary Turner     EXPECT_EQ(PY_MAJOR_VERSION, major_version_value.GetInteger());
1417841efbbSZachary Turner     EXPECT_EQ(PY_MINOR_VERSION, minor_version_value.GetInteger());
1427841efbbSZachary Turner }
1437841efbbSZachary Turner 
1447841efbbSZachary Turner TEST_F(PythonDataObjectsTest, TestGlobalNameResolutionWithDot)
1457841efbbSZachary Turner {
146a1405147SZachary Turner     PythonObject sys_path = m_main_module.ResolveName("sys.path");
1477841efbbSZachary Turner     EXPECT_TRUE(sys_path.IsAllocated());
1487841efbbSZachary Turner     EXPECT_TRUE(PythonList::Check(sys_path.get()));
1497841efbbSZachary Turner 
150a1405147SZachary Turner     PythonInteger version_major = m_main_module.ResolveName(
151a1405147SZachary Turner         "sys.version_info.major").AsType<PythonInteger>();
152a1405147SZachary Turner     PythonInteger version_minor = m_main_module.ResolveName(
153a1405147SZachary Turner         "sys.version_info.minor").AsType<PythonInteger>();
1547841efbbSZachary Turner     EXPECT_TRUE(version_major.IsAllocated());
1557841efbbSZachary Turner     EXPECT_TRUE(version_minor.IsAllocated());
1567841efbbSZachary Turner     EXPECT_EQ(PY_MAJOR_VERSION, version_major.GetInteger());
1577841efbbSZachary Turner     EXPECT_EQ(PY_MINOR_VERSION, version_minor.GetInteger());
1587841efbbSZachary Turner }
1597841efbbSZachary Turner 
160a1405147SZachary Turner TEST_F(PythonDataObjectsTest, TestDictionaryResolutionWithDot)
161a1405147SZachary Turner {
162a1405147SZachary Turner     // Make up a custom dictionary with "sys" pointing to the `sys` module.
163a1405147SZachary Turner     PythonDictionary dict(PyInitialValue::Empty);
164a1405147SZachary Turner     dict.SetItemForKey(PythonString("sys"), m_sys_module);
165a1405147SZachary Turner 
166a1405147SZachary Turner     // Now use that dictionary to resolve `sys.version_info.major`
167a1405147SZachary Turner     PythonInteger version_major = PythonObject::ResolveNameWithDictionary(
168a1405147SZachary Turner         "sys.version_info.major", dict).AsType<PythonInteger>();
169a1405147SZachary Turner     PythonInteger version_minor = PythonObject::ResolveNameWithDictionary(
170a1405147SZachary Turner         "sys.version_info.minor", dict).AsType<PythonInteger>();
171a1405147SZachary Turner     EXPECT_EQ(PY_MAJOR_VERSION, version_major.GetInteger());
172a1405147SZachary Turner     EXPECT_EQ(PY_MINOR_VERSION, version_minor.GetInteger());
173a1405147SZachary Turner }
174a1405147SZachary Turner 
17522c8efcdSZachary Turner TEST_F(PythonDataObjectsTest, TestPythonInteger)
17622c8efcdSZachary Turner {
17722c8efcdSZachary Turner // Test that integers behave correctly when wrapped by a PythonInteger.
17822c8efcdSZachary Turner 
17922c8efcdSZachary Turner #if PY_MAJOR_VERSION < 3
18022c8efcdSZachary Turner     // Verify that `PythonInt` works correctly when given a PyInt object.
18122c8efcdSZachary Turner     // Note that PyInt doesn't exist in Python 3.x, so this is only for 2.x
18222c8efcdSZachary Turner     PyObject *py_int = PyInt_FromLong(12);
18322c8efcdSZachary Turner     EXPECT_TRUE(PythonInteger::Check(py_int));
184f8b22f8fSZachary Turner     PythonInteger python_int(PyRefType::Owned, py_int);
18522c8efcdSZachary Turner 
18622c8efcdSZachary Turner     EXPECT_EQ(PyObjectType::Integer, python_int.GetObjectType());
18722c8efcdSZachary Turner     EXPECT_EQ(12, python_int.GetInteger());
18822c8efcdSZachary Turner #endif
18922c8efcdSZachary Turner 
19018426935SZachary Turner     // Verify that `PythonInteger` works correctly when given a PyLong object.
19122c8efcdSZachary Turner     PyObject *py_long = PyLong_FromLong(12);
19222c8efcdSZachary Turner     EXPECT_TRUE(PythonInteger::Check(py_long));
193f8b22f8fSZachary Turner     PythonInteger python_long(PyRefType::Owned, py_long);
19422c8efcdSZachary Turner     EXPECT_EQ(PyObjectType::Integer, python_long.GetObjectType());
19522c8efcdSZachary Turner 
19622c8efcdSZachary Turner     // Verify that you can reset the value and that it is reflected properly.
19722c8efcdSZachary Turner     python_long.SetInteger(40);
19822c8efcdSZachary Turner     EXPECT_EQ(40, python_long.GetInteger());
19918426935SZachary Turner 
20018426935SZachary Turner     // Test that creating a `PythonInteger` object works correctly with the
20118426935SZachary Turner     // int constructor.
20218426935SZachary Turner     PythonInteger constructed_int(7);
20318426935SZachary Turner     EXPECT_EQ(7, constructed_int.GetInteger());
20422c8efcdSZachary Turner }
20522c8efcdSZachary Turner 
2065a72c02bSZachary Turner TEST_F(PythonDataObjectsTest, TestPythonBytes)
2075a72c02bSZachary Turner {
2085a72c02bSZachary Turner     static const char *test_bytes = "PythonDataObjectsTest::TestPythonBytes";
2095a72c02bSZachary Turner     PyObject *py_bytes = PyBytes_FromString(test_bytes);
2105a72c02bSZachary Turner     EXPECT_TRUE(PythonBytes::Check(py_bytes));
2115a72c02bSZachary Turner     PythonBytes python_bytes(PyRefType::Owned, py_bytes);
2125a72c02bSZachary Turner 
2135a72c02bSZachary Turner #if PY_MAJOR_VERSION < 3
2145a72c02bSZachary Turner     EXPECT_TRUE(PythonString::Check(py_bytes));
2155a72c02bSZachary Turner     EXPECT_EQ(PyObjectType::String, python_bytes.GetObjectType());
2165a72c02bSZachary Turner #else
2175a72c02bSZachary Turner     EXPECT_FALSE(PythonString::Check(py_bytes));
2185a8453d5SPavel Labath     EXPECT_EQ(PyObjectType::Bytes, python_bytes.GetObjectType());
2195a72c02bSZachary Turner #endif
2205a72c02bSZachary Turner 
2215a72c02bSZachary Turner     llvm::ArrayRef<uint8_t> bytes = python_bytes.GetBytes();
2225a72c02bSZachary Turner     EXPECT_EQ(bytes.size(), strlen(test_bytes));
2235a72c02bSZachary Turner     EXPECT_EQ(0, ::memcmp(bytes.data(), test_bytes, bytes.size()));
2245a72c02bSZachary Turner }
2255a72c02bSZachary Turner 
226f9d6d204SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonByteArray)
227f9d6d204SZachary Turner {
228f9d6d204SZachary Turner     static const char *test_bytes = "PythonDataObjectsTest::TestPythonByteArray";
229f9d6d204SZachary Turner     llvm::StringRef orig_bytes(test_bytes);
230f9d6d204SZachary Turner     PyObject *py_bytes = PyByteArray_FromStringAndSize(test_bytes, orig_bytes.size());
231f9d6d204SZachary Turner     EXPECT_TRUE(PythonByteArray::Check(py_bytes));
232f9d6d204SZachary Turner     PythonByteArray python_bytes(PyRefType::Owned, py_bytes);
233f9d6d204SZachary Turner     EXPECT_EQ(PyObjectType::ByteArray, python_bytes.GetObjectType());
234f9d6d204SZachary Turner 
235f9d6d204SZachary Turner     llvm::ArrayRef<uint8_t> after_bytes = python_bytes.GetBytes();
236f9d6d204SZachary Turner     EXPECT_EQ(after_bytes.size(), orig_bytes.size());
237f9d6d204SZachary Turner     EXPECT_EQ(0, ::memcmp(orig_bytes.data(), test_bytes, orig_bytes.size()));
238f9d6d204SZachary Turner }
239f9d6d204SZachary Turner 
24022c8efcdSZachary Turner TEST_F(PythonDataObjectsTest, TestPythonString)
24122c8efcdSZachary Turner {
24222c8efcdSZachary Turner     // Test that strings behave correctly when wrapped by a PythonString.
24322c8efcdSZachary Turner 
24418426935SZachary Turner     static const char *test_string = "PythonDataObjectsTest::TestPythonString1";
24518426935SZachary Turner     static const char *test_string2 = "PythonDataObjectsTest::TestPythonString2";
24622c8efcdSZachary Turner 
24722c8efcdSZachary Turner #if PY_MAJOR_VERSION < 3
24822c8efcdSZachary Turner     // Verify that `PythonString` works correctly when given a PyString object.
24922c8efcdSZachary Turner     // Note that PyString doesn't exist in Python 3.x, so this is only for 2.x
25022c8efcdSZachary Turner     PyObject *py_string = PyString_FromString(test_string);
25122c8efcdSZachary Turner     EXPECT_TRUE(PythonString::Check(py_string));
252f8b22f8fSZachary Turner     PythonString python_string(PyRefType::Owned, py_string);
25322c8efcdSZachary Turner 
25422c8efcdSZachary Turner     EXPECT_EQ(PyObjectType::String, python_string.GetObjectType());
25522c8efcdSZachary Turner     EXPECT_STREQ(test_string, python_string.GetString().data());
25618426935SZachary Turner #else
25722c8efcdSZachary Turner     // Verify that `PythonString` works correctly when given a PyUnicode object.
25822c8efcdSZachary Turner     PyObject *py_unicode = PyUnicode_FromString(test_string);
25922c8efcdSZachary Turner     EXPECT_TRUE(PythonString::Check(py_unicode));
260f8b22f8fSZachary Turner     PythonString python_unicode(PyRefType::Owned, py_unicode);
26122c8efcdSZachary Turner     EXPECT_EQ(PyObjectType::String, python_unicode.GetObjectType());
26222c8efcdSZachary Turner     EXPECT_STREQ(test_string, python_unicode.GetString().data());
26318426935SZachary Turner #endif
26422c8efcdSZachary Turner 
26518426935SZachary Turner     // Test that creating a `PythonString` object works correctly with the
26618426935SZachary Turner     // string constructor
267de9dfe78SReid Kleckner     PythonString constructed_string(test_string2);
268de9dfe78SReid Kleckner     EXPECT_STREQ(test_string2, constructed_string.GetString().str().c_str());
26922c8efcdSZachary Turner }
27022c8efcdSZachary Turner 
27118426935SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonStringToStr)
27218426935SZachary Turner {
27318426935SZachary Turner     const char *c_str = "PythonDataObjectsTest::TestPythonStringToStr";
27418426935SZachary Turner 
27518426935SZachary Turner     PythonString str(c_str);
27618426935SZachary Turner     EXPECT_STREQ(c_str, str.GetString().str().c_str());
27718426935SZachary Turner 
27818426935SZachary Turner     PythonString str_str = str.Str();
27918426935SZachary Turner     EXPECT_STREQ(c_str, str_str.GetString().str().c_str());
28018426935SZachary Turner }
28118426935SZachary Turner 
28218426935SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonIntegerToStr)
28318426935SZachary Turner {
28418426935SZachary Turner }
28518426935SZachary Turner 
28618426935SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonIntegerToStructuredInteger)
28718426935SZachary Turner {
28818426935SZachary Turner     PythonInteger integer(7);
28918426935SZachary Turner     auto int_sp = integer.CreateStructuredInteger();
290de9dfe78SReid Kleckner     EXPECT_EQ(7U, int_sp->GetValue());
29118426935SZachary Turner }
29218426935SZachary Turner 
29318426935SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonStringToStructuredString)
29418426935SZachary Turner {
29518426935SZachary Turner     static const char *test_string = "PythonDataObjectsTest::TestPythonStringToStructuredString";
29618426935SZachary Turner     PythonString constructed_string(test_string);
29718426935SZachary Turner     auto string_sp = constructed_string.CreateStructuredString();
29818426935SZachary Turner     EXPECT_STREQ(test_string, string_sp->GetStringValue().c_str());
29918426935SZachary Turner }
30018426935SZachary Turner 
30118426935SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonListValueEquality)
30222c8efcdSZachary Turner {
30322c8efcdSZachary Turner     // Test that a list which is built through the native
30422c8efcdSZachary Turner     // Python API behaves correctly when wrapped by a PythonList.
305de9dfe78SReid Kleckner     static const unsigned list_size = 2;
30618426935SZachary Turner     static const long long_value0 = 5;
30718426935SZachary Turner     static const char *const string_value1 = "String Index 1";
30822c8efcdSZachary Turner 
30922c8efcdSZachary Turner     PyObject *py_list = PyList_New(2);
310f8b22f8fSZachary Turner     EXPECT_TRUE(PythonList::Check(py_list));
311f8b22f8fSZachary Turner     PythonList list(PyRefType::Owned, py_list);
312f8b22f8fSZachary Turner 
313f8b22f8fSZachary Turner     PythonObject list_items[list_size];
31418426935SZachary Turner     list_items[0].Reset(PythonInteger(long_value0));
31518426935SZachary Turner     list_items[1].Reset(PythonString(string_value1));
31622c8efcdSZachary Turner 
317de9dfe78SReid Kleckner     for (unsigned i = 0; i < list_size; ++i)
318f8b22f8fSZachary Turner         list.SetItemAtIndex(i, list_items[i]);
31922c8efcdSZachary Turner 
32022c8efcdSZachary Turner     EXPECT_EQ(list_size, list.GetSize());
32122c8efcdSZachary Turner     EXPECT_EQ(PyObjectType::List, list.GetObjectType());
32222c8efcdSZachary Turner 
32318426935SZachary Turner     // Verify that the values match
32418426935SZachary Turner     PythonObject chk_value1 = list.GetItemAtIndex(0);
32518426935SZachary Turner     PythonObject chk_value2 = list.GetItemAtIndex(1);
32618426935SZachary Turner     EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
32718426935SZachary Turner     EXPECT_TRUE(PythonString::Check(chk_value2.get()));
32822c8efcdSZachary Turner 
32918426935SZachary Turner     PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
33018426935SZachary Turner     PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
33122c8efcdSZachary Turner 
33218426935SZachary Turner     EXPECT_EQ(long_value0, chk_int.GetInteger());
33318426935SZachary Turner     EXPECT_STREQ(string_value1, chk_str.GetString().str().c_str());
33422c8efcdSZachary Turner }
33522c8efcdSZachary Turner 
33622c8efcdSZachary Turner TEST_F(PythonDataObjectsTest, TestPythonListManipulation)
33722c8efcdSZachary Turner {
33822c8efcdSZachary Turner     // Test that manipulation of a PythonList behaves correctly when
33922c8efcdSZachary Turner     // wrapped by a PythonDictionary.
34022c8efcdSZachary Turner 
34118426935SZachary Turner     static const long long_value0 = 5;
34218426935SZachary Turner     static const char *const string_value1 = "String Index 1";
34322c8efcdSZachary Turner 
344f8b22f8fSZachary Turner     PythonList list(PyInitialValue::Empty);
34518426935SZachary Turner     PythonInteger integer(long_value0);
34618426935SZachary Turner     PythonString string(string_value1);
34722c8efcdSZachary Turner 
34822c8efcdSZachary Turner     list.AppendItem(integer);
34922c8efcdSZachary Turner     list.AppendItem(string);
350de9dfe78SReid Kleckner     EXPECT_EQ(2U, list.GetSize());
35122c8efcdSZachary Turner 
35218426935SZachary Turner     // Verify that the values match
35318426935SZachary Turner     PythonObject chk_value1 = list.GetItemAtIndex(0);
35418426935SZachary Turner     PythonObject chk_value2 = list.GetItemAtIndex(1);
35518426935SZachary Turner     EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
35618426935SZachary Turner     EXPECT_TRUE(PythonString::Check(chk_value2.get()));
35718426935SZachary Turner 
35818426935SZachary Turner     PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
35918426935SZachary Turner     PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
36018426935SZachary Turner 
36118426935SZachary Turner     EXPECT_EQ(long_value0, chk_int.GetInteger());
36218426935SZachary Turner     EXPECT_STREQ(string_value1, chk_str.GetString().str().c_str());
36318426935SZachary Turner }
36418426935SZachary Turner 
36518426935SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonListToStructuredList)
36618426935SZachary Turner {
36718426935SZachary Turner     static const long long_value0 = 5;
36818426935SZachary Turner     static const char *const string_value1 = "String Index 1";
36918426935SZachary Turner 
37018426935SZachary Turner     PythonList list(PyInitialValue::Empty);
37118426935SZachary Turner     list.AppendItem(PythonInteger(long_value0));
37218426935SZachary Turner     list.AppendItem(PythonString(string_value1));
37318426935SZachary Turner 
37418426935SZachary Turner     auto array_sp = list.CreateStructuredArray();
37518426935SZachary Turner     EXPECT_EQ(StructuredData::Type::eTypeInteger, array_sp->GetItemAtIndex(0)->GetType());
37618426935SZachary Turner     EXPECT_EQ(StructuredData::Type::eTypeString, array_sp->GetItemAtIndex(1)->GetType());
37718426935SZachary Turner 
37818426935SZachary Turner     auto int_sp = array_sp->GetItemAtIndex(0)->GetAsInteger();
37918426935SZachary Turner     auto string_sp = array_sp->GetItemAtIndex(1)->GetAsString();
38018426935SZachary Turner 
381de9dfe78SReid Kleckner     EXPECT_EQ(long_value0, long(int_sp->GetValue()));
38218426935SZachary Turner     EXPECT_STREQ(string_value1, string_sp->GetValue().c_str());
38318426935SZachary Turner }
38418426935SZachary Turner 
385a1405147SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonTupleSize)
386a1405147SZachary Turner {
387a1405147SZachary Turner     PythonTuple tuple(PyInitialValue::Empty);
388de9dfe78SReid Kleckner     EXPECT_EQ(0U, tuple.GetSize());
389a1405147SZachary Turner 
390a1405147SZachary Turner     tuple = PythonTuple(3);
391de9dfe78SReid Kleckner     EXPECT_EQ(3U, tuple.GetSize());
392a1405147SZachary Turner }
393a1405147SZachary Turner 
394a1405147SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonTupleValues)
395a1405147SZachary Turner {
396a1405147SZachary Turner     PythonTuple tuple(3);
397a1405147SZachary Turner 
398a1405147SZachary Turner     PythonInteger int_value(1);
399a1405147SZachary Turner     PythonString string_value("Test");
400a1405147SZachary Turner     PythonObject none_value(PyRefType::Borrowed, Py_None);
401a1405147SZachary Turner 
402a1405147SZachary Turner     tuple.SetItemAtIndex(0, int_value);
403a1405147SZachary Turner     tuple.SetItemAtIndex(1, string_value);
404a1405147SZachary Turner     tuple.SetItemAtIndex(2, none_value);
405a1405147SZachary Turner 
406a1405147SZachary Turner     EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get());
407a1405147SZachary Turner     EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get());
408a1405147SZachary Turner     EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get());
409a1405147SZachary Turner }
410a1405147SZachary Turner 
411a1405147SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonTupleInitializerList)
412a1405147SZachary Turner {
413a1405147SZachary Turner     PythonInteger int_value(1);
414a1405147SZachary Turner     PythonString string_value("Test");
415a1405147SZachary Turner     PythonObject none_value(PyRefType::Borrowed, Py_None);
416a1405147SZachary Turner     PythonTuple tuple{ int_value, string_value, none_value };
417de9dfe78SReid Kleckner     EXPECT_EQ(3U, tuple.GetSize());
418a1405147SZachary Turner 
419a1405147SZachary Turner     EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get());
420a1405147SZachary Turner     EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get());
421a1405147SZachary Turner     EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get());
422a1405147SZachary Turner }
423a1405147SZachary Turner 
424a1405147SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonTupleInitializerList2)
425a1405147SZachary Turner {
426a1405147SZachary Turner     PythonInteger int_value(1);
427a1405147SZachary Turner     PythonString string_value("Test");
428a1405147SZachary Turner     PythonObject none_value(PyRefType::Borrowed, Py_None);
429a1405147SZachary Turner 
430a1405147SZachary Turner     PythonTuple tuple{ int_value.get(), string_value.get(), none_value.get() };
431de9dfe78SReid Kleckner     EXPECT_EQ(3U, tuple.GetSize());
432a1405147SZachary Turner 
433a1405147SZachary Turner     EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get());
434a1405147SZachary Turner     EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get());
435a1405147SZachary Turner     EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get());
436a1405147SZachary Turner }
437a1405147SZachary Turner 
438a1405147SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonTupleToStructuredList)
439a1405147SZachary Turner {
440a1405147SZachary Turner     PythonInteger int_value(1);
441a1405147SZachary Turner     PythonString string_value("Test");
442a1405147SZachary Turner 
443a1405147SZachary Turner     PythonTuple tuple{ int_value.get(), string_value.get() };
444a1405147SZachary Turner 
445a1405147SZachary Turner     auto array_sp = tuple.CreateStructuredArray();
446a1405147SZachary Turner     EXPECT_EQ(tuple.GetSize(), array_sp->GetSize());
447a1405147SZachary Turner     EXPECT_EQ(StructuredData::Type::eTypeInteger, array_sp->GetItemAtIndex(0)->GetType());
448a1405147SZachary Turner     EXPECT_EQ(StructuredData::Type::eTypeString, array_sp->GetItemAtIndex(1)->GetType());
449a1405147SZachary Turner }
450a1405147SZachary Turner 
45118426935SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonDictionaryValueEquality)
45218426935SZachary Turner {
45318426935SZachary Turner     // Test that a dictionary which is built through the native
45418426935SZachary Turner     // Python API behaves correctly when wrapped by a PythonDictionary.
455de9dfe78SReid Kleckner     static const unsigned dict_entries = 2;
45618426935SZachary Turner     const char *key_0 = "Key 0";
45718426935SZachary Turner     int key_1 = 1;
45818426935SZachary Turner     const int value_0 = 0;
45918426935SZachary Turner     const char *value_1 = "Value 1";
46018426935SZachary Turner 
46118426935SZachary Turner     PythonObject py_keys[dict_entries];
46218426935SZachary Turner     PythonObject py_values[dict_entries];
46318426935SZachary Turner 
46418426935SZachary Turner     py_keys[0].Reset(PythonString(key_0));
46518426935SZachary Turner     py_keys[1].Reset(PythonInteger(key_1));
46618426935SZachary Turner     py_values[0].Reset(PythonInteger(value_0));
46718426935SZachary Turner     py_values[1].Reset(PythonString(value_1));
46818426935SZachary Turner 
46918426935SZachary Turner     PyObject *py_dict = PyDict_New();
47018426935SZachary Turner     EXPECT_TRUE(PythonDictionary::Check(py_dict));
47118426935SZachary Turner     PythonDictionary dict(PyRefType::Owned, py_dict);
47218426935SZachary Turner 
473de9dfe78SReid Kleckner     for (unsigned i = 0; i < dict_entries; ++i)
47418426935SZachary Turner         PyDict_SetItem(py_dict, py_keys[i].get(), py_values[i].get());
47518426935SZachary Turner     EXPECT_EQ(dict.GetSize(), dict_entries);
47618426935SZachary Turner     EXPECT_EQ(PyObjectType::Dictionary, dict.GetObjectType());
47718426935SZachary Turner 
47818426935SZachary Turner     // Verify that the values match
47918426935SZachary Turner     PythonObject chk_value1 = dict.GetItemForKey(py_keys[0]);
48018426935SZachary Turner     PythonObject chk_value2 = dict.GetItemForKey(py_keys[1]);
48118426935SZachary Turner     EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
48218426935SZachary Turner     EXPECT_TRUE(PythonString::Check(chk_value2.get()));
48318426935SZachary Turner 
48418426935SZachary Turner     PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
48518426935SZachary Turner     PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
48618426935SZachary Turner 
48718426935SZachary Turner     EXPECT_EQ(value_0, chk_int.GetInteger());
48818426935SZachary Turner     EXPECT_STREQ(value_1, chk_str.GetString().str().c_str());
48922c8efcdSZachary Turner }
49022c8efcdSZachary Turner 
49122c8efcdSZachary Turner TEST_F(PythonDataObjectsTest, TestPythonDictionaryManipulation)
49222c8efcdSZachary Turner {
49322c8efcdSZachary Turner     // Test that manipulation of a dictionary behaves correctly when wrapped
49422c8efcdSZachary Turner     // by a PythonDictionary.
495de9dfe78SReid Kleckner     static const unsigned dict_entries = 2;
49622c8efcdSZachary Turner 
49718426935SZachary Turner     const char *const key_0 = "Key 0";
49818426935SZachary Turner     const char *const key_1 = "Key 1";
49918426935SZachary Turner     const long value_0 = 1;
50018426935SZachary Turner     const char *const value_1 = "Value 1";
50118426935SZachary Turner 
502f8b22f8fSZachary Turner     PythonString keys[dict_entries];
503f8b22f8fSZachary Turner     PythonObject values[dict_entries];
50422c8efcdSZachary Turner 
50518426935SZachary Turner     keys[0].Reset(PythonString(key_0));
50618426935SZachary Turner     keys[1].Reset(PythonString(key_1));
50718426935SZachary Turner     values[0].Reset(PythonInteger(value_0));
50818426935SZachary Turner     values[1].Reset(PythonString(value_1));
50922c8efcdSZachary Turner 
510f8b22f8fSZachary Turner     PythonDictionary dict(PyInitialValue::Empty);
51122c8efcdSZachary Turner     for (int i = 0; i < 2; ++i)
512f8b22f8fSZachary Turner         dict.SetItemForKey(keys[i], values[i]);
51322c8efcdSZachary Turner 
51422c8efcdSZachary Turner     EXPECT_EQ(dict_entries, dict.GetSize());
51522c8efcdSZachary Turner 
51618426935SZachary Turner     // Verify that the keys and values match
51718426935SZachary Turner     PythonObject chk_value1 = dict.GetItemForKey(keys[0]);
51818426935SZachary Turner     PythonObject chk_value2 = dict.GetItemForKey(keys[1]);
51918426935SZachary Turner     EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
52018426935SZachary Turner     EXPECT_TRUE(PythonString::Check(chk_value2.get()));
52118426935SZachary Turner 
52218426935SZachary Turner     PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
52318426935SZachary Turner     PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
52418426935SZachary Turner 
52518426935SZachary Turner     EXPECT_EQ(value_0, chk_int.GetInteger());
52618426935SZachary Turner     EXPECT_STREQ(value_1, chk_str.GetString().str().c_str());
52722c8efcdSZachary Turner }
52822c8efcdSZachary Turner 
52918426935SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonDictionaryToStructuredDictionary)
53022c8efcdSZachary Turner {
53118426935SZachary Turner     static const char *const string_key0 = "String Key 0";
53218426935SZachary Turner     static const char *const string_key1 = "String Key 1";
53322c8efcdSZachary Turner 
53418426935SZachary Turner     static const char *const string_value0 = "String Value 0";
53518426935SZachary Turner     static const long int_value1 = 7;
53622c8efcdSZachary Turner 
537f8b22f8fSZachary Turner     PythonDictionary dict(PyInitialValue::Empty);
53818426935SZachary Turner     dict.SetItemForKey(PythonString(string_key0), PythonString(string_value0));
53918426935SZachary Turner     dict.SetItemForKey(PythonString(string_key1), PythonInteger(int_value1));
54022c8efcdSZachary Turner 
54118426935SZachary Turner     auto dict_sp = dict.CreateStructuredDictionary();
542de9dfe78SReid Kleckner     EXPECT_EQ(2U, dict_sp->GetSize());
54322c8efcdSZachary Turner 
54418426935SZachary Turner     EXPECT_TRUE(dict_sp->HasKey(string_key0));
54518426935SZachary Turner     EXPECT_TRUE(dict_sp->HasKey(string_key1));
54622c8efcdSZachary Turner 
54718426935SZachary Turner     auto string_sp = dict_sp->GetValueForKey(string_key0)->GetAsString();
54818426935SZachary Turner     auto int_sp = dict_sp->GetValueForKey(string_key1)->GetAsInteger();
54922c8efcdSZachary Turner 
55018426935SZachary Turner     EXPECT_STREQ(string_value0, string_sp->GetValue().c_str());
551de9dfe78SReid Kleckner     EXPECT_EQ(int_value1, long(int_sp->GetValue()));
55222c8efcdSZachary Turner }
5539c40264fSZachary Turner 
554a1405147SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonCallableCheck)
555a1405147SZachary Turner {
556a1405147SZachary Turner     PythonObject sys_exc_info = m_sys_module.ResolveName("exc_info");
557a1405147SZachary Turner     PythonObject none(PyRefType::Borrowed, Py_None);
558a1405147SZachary Turner 
559a1405147SZachary Turner     EXPECT_TRUE(PythonCallable::Check(sys_exc_info.get()));
560a1405147SZachary Turner     EXPECT_FALSE(PythonCallable::Check(none.get()));
561a1405147SZachary Turner }
562a1405147SZachary Turner 
563a1405147SZachary Turner TEST_F(PythonDataObjectsTest, TestPythonCallableInvoke)
564a1405147SZachary Turner {
565a1405147SZachary Turner     auto list = m_builtins_module.ResolveName("list").AsType<PythonCallable>();
566a1405147SZachary Turner     PythonInteger one(1);
567a1405147SZachary Turner     PythonString two("two");
568a1405147SZachary Turner     PythonTuple three = { one, two };
569a1405147SZachary Turner 
570a1405147SZachary Turner     PythonTuple tuple_to_convert = { one, two, three };
571a1405147SZachary Turner     PythonObject result = list({ tuple_to_convert });
572a1405147SZachary Turner 
573a1405147SZachary Turner     EXPECT_TRUE(PythonList::Check(result.get()));
574a1405147SZachary Turner     auto list_result = result.AsType<PythonList>();
575de9dfe78SReid Kleckner     EXPECT_EQ(3U, list_result.GetSize());
576a1405147SZachary Turner     EXPECT_EQ(one.get(), list_result.GetItemAtIndex(0).get());
577a1405147SZachary Turner     EXPECT_EQ(two.get(), list_result.GetItemAtIndex(1).get());
578a1405147SZachary Turner     EXPECT_EQ(three.get(), list_result.GetItemAtIndex(2).get());
579a1405147SZachary Turner }
580a1405147SZachary Turner 
5819c40264fSZachary Turner TEST_F(PythonDataObjectsTest, TestPythonFile)
5829c40264fSZachary Turner {
5839c40264fSZachary Turner     File file(FileSystem::DEV_NULL, File::eOpenOptionRead);
5849c40264fSZachary Turner     PythonFile py_file(file, "r");
5859c40264fSZachary Turner     EXPECT_TRUE(PythonFile::Check(py_file.get()));
5869c40264fSZachary Turner }
5877d6d218eSZachary Turner 
5887d6d218eSZachary Turner TEST_F(PythonDataObjectsTest, TestObjectAttributes)
5897d6d218eSZachary Turner {
5907d6d218eSZachary Turner     PythonInteger py_int(42);
5917d6d218eSZachary Turner     EXPECT_TRUE(py_int.HasAttribute("numerator"));
5927d6d218eSZachary Turner     EXPECT_FALSE(py_int.HasAttribute("this_should_not_exist"));
5937d6d218eSZachary Turner 
5947d6d218eSZachary Turner     PythonInteger numerator_attr = py_int.GetAttributeValue("numerator").AsType<PythonInteger>();
5957d6d218eSZachary Turner     EXPECT_TRUE(numerator_attr.IsAllocated());
5967d6d218eSZachary Turner     EXPECT_EQ(42, numerator_attr.GetInteger());
5977d6d218eSZachary Turner }
598008ec446SGreg Clayton 
599008ec446SGreg Clayton TEST_F(PythonDataObjectsTest, TestExtractingUInt64ThroughStructuredData)
600008ec446SGreg Clayton {
601008ec446SGreg Clayton     // Make up a custom dictionary with "sys" pointing to the `sys` module.
602008ec446SGreg Clayton     const char *key_name = "addr";
603008ec446SGreg Clayton     const uint64_t value = 0xf000000000000000ull;
604008ec446SGreg Clayton     PythonDictionary python_dict(PyInitialValue::Empty);
605008ec446SGreg Clayton     PythonInteger python_ull_value(PyRefType::Owned, PyLong_FromUnsignedLongLong(value));
606008ec446SGreg Clayton     python_dict.SetItemForKey(PythonString(key_name), python_ull_value);
607008ec446SGreg Clayton     StructuredData::ObjectSP structured_data_sp = python_dict.CreateStructuredObject();
608008ec446SGreg Clayton     EXPECT_TRUE((bool)structured_data_sp);
609008ec446SGreg Clayton     if (structured_data_sp)
610008ec446SGreg Clayton     {
611008ec446SGreg Clayton         StructuredData::Dictionary *structured_dict_ptr = structured_data_sp->GetAsDictionary();
612008ec446SGreg Clayton         EXPECT_TRUE(structured_dict_ptr != nullptr);
613008ec446SGreg Clayton         if (structured_dict_ptr)
614008ec446SGreg Clayton         {
615008ec446SGreg Clayton             StructuredData::ObjectSP structured_addr_value_sp = structured_dict_ptr->GetValueForKey(key_name);
616008ec446SGreg Clayton             EXPECT_TRUE((bool)structured_addr_value_sp);
617008ec446SGreg Clayton             const uint64_t extracted_value = structured_addr_value_sp->GetIntegerValue(123);
618008ec446SGreg Clayton             EXPECT_TRUE(extracted_value == value);
619008ec446SGreg Clayton         }
620008ec446SGreg Clayton     }
621008ec446SGreg Clayton }
622