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 
108c68837dSPavel Labath #include "Plugins/ScriptInterpreter/Python/lldb-python.h"
11b9c1b51eSKate Stone #include "gtest/gtest.h"
1222c8efcdSZachary Turner 
13b9c1b51eSKate Stone #include "Plugins/ScriptInterpreter/Python/PythonDataObjects.h"
14b9c1b51eSKate Stone #include "Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.h"
159c40264fSZachary Turner #include "lldb/Host/File.h"
169c40264fSZachary Turner #include "lldb/Host/FileSystem.h"
1722c8efcdSZachary Turner #include "lldb/Host/HostInfo.h"
18*5bfee5f1SAbhishek Aggarwal #include "lldb/lldb-enumerations.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 
199b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonBytes) {
2005a72c02bSZachary Turner   static const char *test_bytes = "PythonDataObjectsTest::TestPythonBytes";
2015a72c02bSZachary Turner   PyObject *py_bytes = PyBytes_FromString(test_bytes);
2025a72c02bSZachary Turner   EXPECT_TRUE(PythonBytes::Check(py_bytes));
2035a72c02bSZachary Turner   PythonBytes python_bytes(PyRefType::Owned, py_bytes);
2045a72c02bSZachary Turner 
2055a72c02bSZachary Turner #if PY_MAJOR_VERSION < 3
2065a72c02bSZachary Turner   EXPECT_TRUE(PythonString::Check(py_bytes));
2075a72c02bSZachary Turner   EXPECT_EQ(PyObjectType::String, python_bytes.GetObjectType());
2085a72c02bSZachary Turner #else
2095a72c02bSZachary Turner   EXPECT_FALSE(PythonString::Check(py_bytes));
2105a8453d5SPavel Labath   EXPECT_EQ(PyObjectType::Bytes, python_bytes.GetObjectType());
2115a72c02bSZachary Turner #endif
2125a72c02bSZachary Turner 
2135a72c02bSZachary Turner   llvm::ArrayRef<uint8_t> bytes = python_bytes.GetBytes();
2145a72c02bSZachary Turner   EXPECT_EQ(bytes.size(), strlen(test_bytes));
2155a72c02bSZachary Turner   EXPECT_EQ(0, ::memcmp(bytes.data(), test_bytes, bytes.size()));
2165a72c02bSZachary Turner }
2175a72c02bSZachary Turner 
218b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonByteArray) {
219f9d6d204SZachary Turner   static const char *test_bytes = "PythonDataObjectsTest::TestPythonByteArray";
220f9d6d204SZachary Turner   llvm::StringRef orig_bytes(test_bytes);
221b9c1b51eSKate Stone   PyObject *py_bytes =
222b9c1b51eSKate Stone       PyByteArray_FromStringAndSize(test_bytes, orig_bytes.size());
223f9d6d204SZachary Turner   EXPECT_TRUE(PythonByteArray::Check(py_bytes));
224f9d6d204SZachary Turner   PythonByteArray python_bytes(PyRefType::Owned, py_bytes);
225f9d6d204SZachary Turner   EXPECT_EQ(PyObjectType::ByteArray, python_bytes.GetObjectType());
226f9d6d204SZachary Turner 
227f9d6d204SZachary Turner   llvm::ArrayRef<uint8_t> after_bytes = python_bytes.GetBytes();
228f9d6d204SZachary Turner   EXPECT_EQ(after_bytes.size(), orig_bytes.size());
229f9d6d204SZachary Turner   EXPECT_EQ(0, ::memcmp(orig_bytes.data(), test_bytes, orig_bytes.size()));
230f9d6d204SZachary Turner }
231f9d6d204SZachary Turner 
232b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonString) {
23322c8efcdSZachary Turner   // Test that strings behave correctly when wrapped by a PythonString.
23422c8efcdSZachary Turner 
23518426935SZachary Turner   static const char *test_string = "PythonDataObjectsTest::TestPythonString1";
23618426935SZachary Turner   static const char *test_string2 = "PythonDataObjectsTest::TestPythonString2";
23722c8efcdSZachary Turner 
23822c8efcdSZachary Turner #if PY_MAJOR_VERSION < 3
23922c8efcdSZachary Turner   // Verify that `PythonString` works correctly when given a PyString object.
24022c8efcdSZachary Turner   // Note that PyString doesn't exist in Python 3.x, so this is only for 2.x
24122c8efcdSZachary Turner   PyObject *py_string = PyString_FromString(test_string);
24222c8efcdSZachary Turner   EXPECT_TRUE(PythonString::Check(py_string));
243f8b22f8fSZachary Turner   PythonString python_string(PyRefType::Owned, py_string);
24422c8efcdSZachary Turner 
24522c8efcdSZachary Turner   EXPECT_EQ(PyObjectType::String, python_string.GetObjectType());
24622c8efcdSZachary Turner   EXPECT_STREQ(test_string, python_string.GetString().data());
24718426935SZachary Turner #else
24822c8efcdSZachary Turner   // Verify that `PythonString` works correctly when given a PyUnicode object.
24922c8efcdSZachary Turner   PyObject *py_unicode = PyUnicode_FromString(test_string);
25022c8efcdSZachary Turner   EXPECT_TRUE(PythonString::Check(py_unicode));
251f8b22f8fSZachary Turner   PythonString python_unicode(PyRefType::Owned, py_unicode);
25222c8efcdSZachary Turner   EXPECT_EQ(PyObjectType::String, python_unicode.GetObjectType());
25322c8efcdSZachary Turner   EXPECT_STREQ(test_string, python_unicode.GetString().data());
25418426935SZachary Turner #endif
25522c8efcdSZachary Turner 
25618426935SZachary Turner   // Test that creating a `PythonString` object works correctly with the
25718426935SZachary Turner   // string constructor
258de9dfe78SReid Kleckner   PythonString constructed_string(test_string2);
2596fe867a8SZachary Turner   EXPECT_EQ(test_string2, constructed_string.GetString());
26022c8efcdSZachary Turner }
26122c8efcdSZachary Turner 
262b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonStringToStr) {
2636fe867a8SZachary Turner   const char *GetString = "PythonDataObjectsTest::TestPythonStringToStr";
26418426935SZachary Turner 
2656fe867a8SZachary Turner   PythonString str(GetString);
2666fe867a8SZachary Turner   EXPECT_EQ(GetString, str.GetString());
26718426935SZachary Turner 
26818426935SZachary Turner   PythonString str_str = str.Str();
2696fe867a8SZachary Turner   EXPECT_EQ(GetString, str_str.GetString());
27018426935SZachary Turner }
27118426935SZachary Turner 
272b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonIntegerToStr) {}
27318426935SZachary Turner 
274b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonIntegerToStructuredInteger) {
27518426935SZachary Turner   PythonInteger integer(7);
27618426935SZachary Turner   auto int_sp = integer.CreateStructuredInteger();
277de9dfe78SReid Kleckner   EXPECT_EQ(7U, int_sp->GetValue());
27818426935SZachary Turner }
27918426935SZachary Turner 
280b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonStringToStructuredString) {
281b9c1b51eSKate Stone   static const char *test_string =
282b9c1b51eSKate Stone       "PythonDataObjectsTest::TestPythonStringToStructuredString";
28318426935SZachary Turner   PythonString constructed_string(test_string);
28418426935SZachary Turner   auto string_sp = constructed_string.CreateStructuredString();
2856fe867a8SZachary Turner   EXPECT_EQ(test_string, string_sp->GetStringValue());
28618426935SZachary Turner }
28718426935SZachary Turner 
288b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonListValueEquality) {
28922c8efcdSZachary Turner   // Test that a list which is built through the native
29022c8efcdSZachary Turner   // Python API behaves correctly when wrapped by a PythonList.
291de9dfe78SReid Kleckner   static const unsigned list_size = 2;
29218426935SZachary Turner   static const long long_value0 = 5;
29318426935SZachary Turner   static const char *const string_value1 = "String Index 1";
29422c8efcdSZachary Turner 
29522c8efcdSZachary Turner   PyObject *py_list = PyList_New(2);
296f8b22f8fSZachary Turner   EXPECT_TRUE(PythonList::Check(py_list));
297f8b22f8fSZachary Turner   PythonList list(PyRefType::Owned, py_list);
298f8b22f8fSZachary Turner 
299f8b22f8fSZachary Turner   PythonObject list_items[list_size];
30018426935SZachary Turner   list_items[0].Reset(PythonInteger(long_value0));
30118426935SZachary Turner   list_items[1].Reset(PythonString(string_value1));
30222c8efcdSZachary Turner 
303de9dfe78SReid Kleckner   for (unsigned i = 0; i < list_size; ++i)
304f8b22f8fSZachary Turner     list.SetItemAtIndex(i, list_items[i]);
30522c8efcdSZachary Turner 
30622c8efcdSZachary Turner   EXPECT_EQ(list_size, list.GetSize());
30722c8efcdSZachary Turner   EXPECT_EQ(PyObjectType::List, list.GetObjectType());
30822c8efcdSZachary Turner 
30918426935SZachary Turner   // Verify that the values match
31018426935SZachary Turner   PythonObject chk_value1 = list.GetItemAtIndex(0);
31118426935SZachary Turner   PythonObject chk_value2 = list.GetItemAtIndex(1);
31218426935SZachary Turner   EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
31318426935SZachary Turner   EXPECT_TRUE(PythonString::Check(chk_value2.get()));
31422c8efcdSZachary Turner 
31518426935SZachary Turner   PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
31618426935SZachary Turner   PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
31722c8efcdSZachary Turner 
31818426935SZachary Turner   EXPECT_EQ(long_value0, chk_int.GetInteger());
3196fe867a8SZachary Turner   EXPECT_EQ(string_value1, chk_str.GetString());
32022c8efcdSZachary Turner }
32122c8efcdSZachary Turner 
322b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonListManipulation) {
32322c8efcdSZachary Turner   // Test that manipulation of a PythonList behaves correctly when
32422c8efcdSZachary Turner   // wrapped by a PythonDictionary.
32522c8efcdSZachary Turner 
32618426935SZachary Turner   static const long long_value0 = 5;
32718426935SZachary Turner   static const char *const string_value1 = "String Index 1";
32822c8efcdSZachary Turner 
329f8b22f8fSZachary Turner   PythonList list(PyInitialValue::Empty);
33018426935SZachary Turner   PythonInteger integer(long_value0);
33118426935SZachary Turner   PythonString string(string_value1);
33222c8efcdSZachary Turner 
33322c8efcdSZachary Turner   list.AppendItem(integer);
33422c8efcdSZachary Turner   list.AppendItem(string);
335de9dfe78SReid Kleckner   EXPECT_EQ(2U, list.GetSize());
33622c8efcdSZachary Turner 
33718426935SZachary Turner   // Verify that the values match
33818426935SZachary Turner   PythonObject chk_value1 = list.GetItemAtIndex(0);
33918426935SZachary Turner   PythonObject chk_value2 = list.GetItemAtIndex(1);
34018426935SZachary Turner   EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
34118426935SZachary Turner   EXPECT_TRUE(PythonString::Check(chk_value2.get()));
34218426935SZachary Turner 
34318426935SZachary Turner   PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
34418426935SZachary Turner   PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
34518426935SZachary Turner 
34618426935SZachary Turner   EXPECT_EQ(long_value0, chk_int.GetInteger());
3476fe867a8SZachary Turner   EXPECT_EQ(string_value1, chk_str.GetString());
34818426935SZachary Turner }
34918426935SZachary Turner 
350b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonListToStructuredList) {
35118426935SZachary Turner   static const long long_value0 = 5;
35218426935SZachary Turner   static const char *const string_value1 = "String Index 1";
35318426935SZachary Turner 
35418426935SZachary Turner   PythonList list(PyInitialValue::Empty);
35518426935SZachary Turner   list.AppendItem(PythonInteger(long_value0));
35618426935SZachary Turner   list.AppendItem(PythonString(string_value1));
35718426935SZachary Turner 
35818426935SZachary Turner   auto array_sp = list.CreateStructuredArray();
359*5bfee5f1SAbhishek Aggarwal   EXPECT_EQ(lldb::eStructuredDataTypeInteger,
360b9c1b51eSKate Stone             array_sp->GetItemAtIndex(0)->GetType());
361*5bfee5f1SAbhishek Aggarwal   EXPECT_EQ(lldb::eStructuredDataTypeString,
362b9c1b51eSKate Stone             array_sp->GetItemAtIndex(1)->GetType());
36318426935SZachary Turner 
36418426935SZachary Turner   auto int_sp = array_sp->GetItemAtIndex(0)->GetAsInteger();
36518426935SZachary Turner   auto string_sp = array_sp->GetItemAtIndex(1)->GetAsString();
36618426935SZachary Turner 
367de9dfe78SReid Kleckner   EXPECT_EQ(long_value0, long(int_sp->GetValue()));
3686fe867a8SZachary Turner   EXPECT_EQ(string_value1, string_sp->GetValue());
36918426935SZachary Turner }
37018426935SZachary Turner 
371b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleSize) {
372a1405147SZachary Turner   PythonTuple tuple(PyInitialValue::Empty);
373de9dfe78SReid Kleckner   EXPECT_EQ(0U, tuple.GetSize());
374a1405147SZachary Turner 
375a1405147SZachary Turner   tuple = PythonTuple(3);
376de9dfe78SReid Kleckner   EXPECT_EQ(3U, tuple.GetSize());
377a1405147SZachary Turner }
378a1405147SZachary Turner 
379b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleValues) {
380a1405147SZachary Turner   PythonTuple tuple(3);
381a1405147SZachary Turner 
382a1405147SZachary Turner   PythonInteger int_value(1);
383a1405147SZachary Turner   PythonString string_value("Test");
384a1405147SZachary Turner   PythonObject none_value(PyRefType::Borrowed, Py_None);
385a1405147SZachary Turner 
386a1405147SZachary Turner   tuple.SetItemAtIndex(0, int_value);
387a1405147SZachary Turner   tuple.SetItemAtIndex(1, string_value);
388a1405147SZachary Turner   tuple.SetItemAtIndex(2, none_value);
389a1405147SZachary Turner 
390a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get());
391a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get());
392a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get());
393a1405147SZachary Turner }
394a1405147SZachary Turner 
395b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleInitializerList) {
396a1405147SZachary Turner   PythonInteger int_value(1);
397a1405147SZachary Turner   PythonString string_value("Test");
398a1405147SZachary Turner   PythonObject none_value(PyRefType::Borrowed, Py_None);
399a1405147SZachary Turner   PythonTuple tuple{int_value, string_value, none_value};
400de9dfe78SReid Kleckner   EXPECT_EQ(3U, tuple.GetSize());
401a1405147SZachary Turner 
402a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get());
403a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get());
404a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get());
405a1405147SZachary Turner }
406a1405147SZachary Turner 
407b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleInitializerList2) {
408a1405147SZachary Turner   PythonInteger int_value(1);
409a1405147SZachary Turner   PythonString string_value("Test");
410a1405147SZachary Turner   PythonObject none_value(PyRefType::Borrowed, Py_None);
411a1405147SZachary Turner 
412a1405147SZachary Turner   PythonTuple tuple{int_value.get(), string_value.get(), none_value.get()};
413de9dfe78SReid Kleckner   EXPECT_EQ(3U, tuple.GetSize());
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, TestPythonTupleToStructuredList) {
421a1405147SZachary Turner   PythonInteger int_value(1);
422a1405147SZachary Turner   PythonString string_value("Test");
423a1405147SZachary Turner 
424a1405147SZachary Turner   PythonTuple tuple{int_value.get(), string_value.get()};
425a1405147SZachary Turner 
426a1405147SZachary Turner   auto array_sp = tuple.CreateStructuredArray();
427a1405147SZachary Turner   EXPECT_EQ(tuple.GetSize(), array_sp->GetSize());
428*5bfee5f1SAbhishek Aggarwal   EXPECT_EQ(lldb::eStructuredDataTypeInteger,
429b9c1b51eSKate Stone             array_sp->GetItemAtIndex(0)->GetType());
430*5bfee5f1SAbhishek Aggarwal   EXPECT_EQ(lldb::eStructuredDataTypeString,
431b9c1b51eSKate Stone             array_sp->GetItemAtIndex(1)->GetType());
432a1405147SZachary Turner }
433a1405147SZachary Turner 
434b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonDictionaryValueEquality) {
43518426935SZachary Turner   // Test that a dictionary which is built through the native
43618426935SZachary Turner   // Python API behaves correctly when wrapped by a PythonDictionary.
437de9dfe78SReid Kleckner   static const unsigned dict_entries = 2;
43818426935SZachary Turner   const char *key_0 = "Key 0";
43918426935SZachary Turner   int key_1 = 1;
44018426935SZachary Turner   const int value_0 = 0;
44118426935SZachary Turner   const char *value_1 = "Value 1";
44218426935SZachary Turner 
44318426935SZachary Turner   PythonObject py_keys[dict_entries];
44418426935SZachary Turner   PythonObject py_values[dict_entries];
44518426935SZachary Turner 
44618426935SZachary Turner   py_keys[0].Reset(PythonString(key_0));
44718426935SZachary Turner   py_keys[1].Reset(PythonInteger(key_1));
44818426935SZachary Turner   py_values[0].Reset(PythonInteger(value_0));
44918426935SZachary Turner   py_values[1].Reset(PythonString(value_1));
45018426935SZachary Turner 
45118426935SZachary Turner   PyObject *py_dict = PyDict_New();
45218426935SZachary Turner   EXPECT_TRUE(PythonDictionary::Check(py_dict));
45318426935SZachary Turner   PythonDictionary dict(PyRefType::Owned, py_dict);
45418426935SZachary Turner 
455de9dfe78SReid Kleckner   for (unsigned i = 0; i < dict_entries; ++i)
45618426935SZachary Turner     PyDict_SetItem(py_dict, py_keys[i].get(), py_values[i].get());
45718426935SZachary Turner   EXPECT_EQ(dict.GetSize(), dict_entries);
45818426935SZachary Turner   EXPECT_EQ(PyObjectType::Dictionary, dict.GetObjectType());
45918426935SZachary Turner 
46018426935SZachary Turner   // Verify that the values match
46118426935SZachary Turner   PythonObject chk_value1 = dict.GetItemForKey(py_keys[0]);
46218426935SZachary Turner   PythonObject chk_value2 = dict.GetItemForKey(py_keys[1]);
46318426935SZachary Turner   EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
46418426935SZachary Turner   EXPECT_TRUE(PythonString::Check(chk_value2.get()));
46518426935SZachary Turner 
46618426935SZachary Turner   PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
46718426935SZachary Turner   PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
46818426935SZachary Turner 
46918426935SZachary Turner   EXPECT_EQ(value_0, chk_int.GetInteger());
4706fe867a8SZachary Turner   EXPECT_EQ(value_1, chk_str.GetString());
47122c8efcdSZachary Turner }
47222c8efcdSZachary Turner 
473b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonDictionaryManipulation) {
47422c8efcdSZachary Turner   // Test that manipulation of a dictionary behaves correctly when wrapped
47522c8efcdSZachary Turner   // by a PythonDictionary.
476de9dfe78SReid Kleckner   static const unsigned dict_entries = 2;
47722c8efcdSZachary Turner 
47818426935SZachary Turner   const char *const key_0 = "Key 0";
47918426935SZachary Turner   const char *const key_1 = "Key 1";
48018426935SZachary Turner   const long value_0 = 1;
48118426935SZachary Turner   const char *const value_1 = "Value 1";
48218426935SZachary Turner 
483f8b22f8fSZachary Turner   PythonString keys[dict_entries];
484f8b22f8fSZachary Turner   PythonObject values[dict_entries];
48522c8efcdSZachary Turner 
48618426935SZachary Turner   keys[0].Reset(PythonString(key_0));
48718426935SZachary Turner   keys[1].Reset(PythonString(key_1));
48818426935SZachary Turner   values[0].Reset(PythonInteger(value_0));
48918426935SZachary Turner   values[1].Reset(PythonString(value_1));
49022c8efcdSZachary Turner 
491f8b22f8fSZachary Turner   PythonDictionary dict(PyInitialValue::Empty);
49222c8efcdSZachary Turner   for (int i = 0; i < 2; ++i)
493f8b22f8fSZachary Turner     dict.SetItemForKey(keys[i], values[i]);
49422c8efcdSZachary Turner 
49522c8efcdSZachary Turner   EXPECT_EQ(dict_entries, dict.GetSize());
49622c8efcdSZachary Turner 
49718426935SZachary Turner   // Verify that the keys and values match
49818426935SZachary Turner   PythonObject chk_value1 = dict.GetItemForKey(keys[0]);
49918426935SZachary Turner   PythonObject chk_value2 = dict.GetItemForKey(keys[1]);
50018426935SZachary Turner   EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
50118426935SZachary Turner   EXPECT_TRUE(PythonString::Check(chk_value2.get()));
50218426935SZachary Turner 
50318426935SZachary Turner   PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
50418426935SZachary Turner   PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
50518426935SZachary Turner 
50618426935SZachary Turner   EXPECT_EQ(value_0, chk_int.GetInteger());
5076fe867a8SZachary Turner   EXPECT_EQ(value_1, chk_str.GetString());
50822c8efcdSZachary Turner }
50922c8efcdSZachary Turner 
510b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonDictionaryToStructuredDictionary) {
51118426935SZachary Turner   static const char *const string_key0 = "String Key 0";
51218426935SZachary Turner   static const char *const string_key1 = "String Key 1";
51322c8efcdSZachary Turner 
51418426935SZachary Turner   static const char *const string_value0 = "String Value 0";
51518426935SZachary Turner   static const long int_value1 = 7;
51622c8efcdSZachary Turner 
517f8b22f8fSZachary Turner   PythonDictionary dict(PyInitialValue::Empty);
51818426935SZachary Turner   dict.SetItemForKey(PythonString(string_key0), PythonString(string_value0));
51918426935SZachary Turner   dict.SetItemForKey(PythonString(string_key1), PythonInteger(int_value1));
52022c8efcdSZachary Turner 
52118426935SZachary Turner   auto dict_sp = dict.CreateStructuredDictionary();
522de9dfe78SReid Kleckner   EXPECT_EQ(2U, dict_sp->GetSize());
52322c8efcdSZachary Turner 
52418426935SZachary Turner   EXPECT_TRUE(dict_sp->HasKey(string_key0));
52518426935SZachary Turner   EXPECT_TRUE(dict_sp->HasKey(string_key1));
52622c8efcdSZachary Turner 
52718426935SZachary Turner   auto string_sp = dict_sp->GetValueForKey(string_key0)->GetAsString();
52818426935SZachary Turner   auto int_sp = dict_sp->GetValueForKey(string_key1)->GetAsInteger();
52922c8efcdSZachary Turner 
5306fe867a8SZachary Turner   EXPECT_EQ(string_value0, string_sp->GetValue());
531de9dfe78SReid Kleckner   EXPECT_EQ(int_value1, long(int_sp->GetValue()));
53222c8efcdSZachary Turner }
5339c40264fSZachary Turner 
534b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonCallableCheck) {
535a1405147SZachary Turner   PythonObject sys_exc_info = m_sys_module.ResolveName("exc_info");
536a1405147SZachary Turner   PythonObject none(PyRefType::Borrowed, Py_None);
537a1405147SZachary Turner 
538a1405147SZachary Turner   EXPECT_TRUE(PythonCallable::Check(sys_exc_info.get()));
539a1405147SZachary Turner   EXPECT_FALSE(PythonCallable::Check(none.get()));
540a1405147SZachary Turner }
541a1405147SZachary Turner 
542b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonCallableInvoke) {
543a1405147SZachary Turner   auto list = m_builtins_module.ResolveName("list").AsType<PythonCallable>();
544a1405147SZachary Turner   PythonInteger one(1);
545a1405147SZachary Turner   PythonString two("two");
546a1405147SZachary Turner   PythonTuple three = {one, two};
547a1405147SZachary Turner 
548a1405147SZachary Turner   PythonTuple tuple_to_convert = {one, two, three};
549a1405147SZachary Turner   PythonObject result = list({tuple_to_convert});
550a1405147SZachary Turner 
551a1405147SZachary Turner   EXPECT_TRUE(PythonList::Check(result.get()));
552a1405147SZachary Turner   auto list_result = result.AsType<PythonList>();
553de9dfe78SReid Kleckner   EXPECT_EQ(3U, list_result.GetSize());
554a1405147SZachary Turner   EXPECT_EQ(one.get(), list_result.GetItemAtIndex(0).get());
555a1405147SZachary Turner   EXPECT_EQ(two.get(), list_result.GetItemAtIndex(1).get());
556a1405147SZachary Turner   EXPECT_EQ(three.get(), list_result.GetItemAtIndex(2).get());
557a1405147SZachary Turner }
558a1405147SZachary Turner 
559b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonFile) {
5609c40264fSZachary Turner   File file(FileSystem::DEV_NULL, File::eOpenOptionRead);
5619c40264fSZachary Turner   PythonFile py_file(file, "r");
5629c40264fSZachary Turner   EXPECT_TRUE(PythonFile::Check(py_file.get()));
5639c40264fSZachary Turner }
5647d6d218eSZachary Turner 
565b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestObjectAttributes) {
5667d6d218eSZachary Turner   PythonInteger py_int(42);
5677d6d218eSZachary Turner   EXPECT_TRUE(py_int.HasAttribute("numerator"));
5687d6d218eSZachary Turner   EXPECT_FALSE(py_int.HasAttribute("this_should_not_exist"));
5697d6d218eSZachary Turner 
570b9c1b51eSKate Stone   PythonInteger numerator_attr =
571b9c1b51eSKate Stone       py_int.GetAttributeValue("numerator").AsType<PythonInteger>();
5727d6d218eSZachary Turner   EXPECT_TRUE(numerator_attr.IsAllocated());
5737d6d218eSZachary Turner   EXPECT_EQ(42, numerator_attr.GetInteger());
5747d6d218eSZachary Turner }
575008ec446SGreg Clayton 
576b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestExtractingUInt64ThroughStructuredData) {
577008ec446SGreg Clayton   // Make up a custom dictionary with "sys" pointing to the `sys` module.
578008ec446SGreg Clayton   const char *key_name = "addr";
579008ec446SGreg Clayton   const uint64_t value = 0xf000000000000000ull;
580008ec446SGreg Clayton   PythonDictionary python_dict(PyInitialValue::Empty);
581b9c1b51eSKate Stone   PythonInteger python_ull_value(PyRefType::Owned,
582b9c1b51eSKate Stone                                  PyLong_FromUnsignedLongLong(value));
583008ec446SGreg Clayton   python_dict.SetItemForKey(PythonString(key_name), python_ull_value);
584b9c1b51eSKate Stone   StructuredData::ObjectSP structured_data_sp =
585b9c1b51eSKate Stone       python_dict.CreateStructuredObject();
586008ec446SGreg Clayton   EXPECT_TRUE((bool)structured_data_sp);
587b9c1b51eSKate Stone   if (structured_data_sp) {
588b9c1b51eSKate Stone     StructuredData::Dictionary *structured_dict_ptr =
589b9c1b51eSKate Stone         structured_data_sp->GetAsDictionary();
590008ec446SGreg Clayton     EXPECT_TRUE(structured_dict_ptr != nullptr);
591b9c1b51eSKate Stone     if (structured_dict_ptr) {
592b9c1b51eSKate Stone       StructuredData::ObjectSP structured_addr_value_sp =
593b9c1b51eSKate Stone           structured_dict_ptr->GetValueForKey(key_name);
594008ec446SGreg Clayton       EXPECT_TRUE((bool)structured_addr_value_sp);
595b9c1b51eSKate Stone       const uint64_t extracted_value =
596b9c1b51eSKate Stone           structured_addr_value_sp->GetIntegerValue(123);
597008ec446SGreg Clayton       EXPECT_TRUE(extracted_value == value);
598008ec446SGreg Clayton     }
599008ec446SGreg Clayton   }
600008ec446SGreg Clayton }
601