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"
1822c8efcdSZachary Turner 
19c946d462SZachary Turner #include "PythonTestSuite.h"
20c946d462SZachary Turner 
2122c8efcdSZachary Turner using namespace lldb_private;
2222c8efcdSZachary Turner 
23b9c1b51eSKate Stone class PythonDataObjectsTest : public PythonTestSuite {
2422c8efcdSZachary Turner public:
25b9c1b51eSKate Stone   void SetUp() override {
26c946d462SZachary Turner     PythonTestSuite::SetUp();
27a1405147SZachary Turner 
28a1405147SZachary Turner     PythonString sys_module("sys");
29a1405147SZachary Turner     m_sys_module.Reset(PyRefType::Owned, PyImport_Import(sys_module.get()));
30a1405147SZachary Turner     m_main_module = PythonModule::MainModule();
31a1405147SZachary Turner     m_builtins_module = PythonModule::BuiltinsModule();
3222c8efcdSZachary Turner   }
3322c8efcdSZachary Turner 
34b9c1b51eSKate Stone   void TearDown() override {
35a1405147SZachary Turner     m_sys_module.Reset();
36a1405147SZachary Turner     m_main_module.Reset();
37a1405147SZachary Turner     m_builtins_module.Reset();
38f8b22f8fSZachary Turner 
39c946d462SZachary Turner     PythonTestSuite::TearDown();
4022c8efcdSZachary Turner   }
41f8b22f8fSZachary Turner 
42a1405147SZachary Turner protected:
43a1405147SZachary Turner   PythonModule m_sys_module;
44a1405147SZachary Turner   PythonModule m_main_module;
45a1405147SZachary Turner   PythonModule m_builtins_module;
4622c8efcdSZachary Turner };
4722c8efcdSZachary Turner 
48b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestOwnedReferences) {
4918426935SZachary Turner   // After creating a new object, the refcount should be >= 1
50f8b22f8fSZachary Turner   PyObject *obj = PyLong_FromLong(3);
5118426935SZachary Turner   Py_ssize_t original_refcnt = obj->ob_refcnt;
5218426935SZachary Turner   EXPECT_LE(1, original_refcnt);
53f8b22f8fSZachary Turner 
5418426935SZachary Turner   // If we take an owned reference, the refcount should be the same
55f8b22f8fSZachary Turner   PythonObject owned_long(PyRefType::Owned, obj);
5618426935SZachary Turner   EXPECT_EQ(original_refcnt, owned_long.get()->ob_refcnt);
57f8b22f8fSZachary Turner 
5818426935SZachary Turner   // Take another reference and verify that the refcount increases by 1
59f8b22f8fSZachary Turner   PythonObject strong_ref(owned_long);
6018426935SZachary Turner   EXPECT_EQ(original_refcnt + 1, strong_ref.get()->ob_refcnt);
61f8b22f8fSZachary Turner 
6218426935SZachary Turner   // If we reset the first one, the refcount should be the original value.
63f8b22f8fSZachary Turner   owned_long.Reset();
6418426935SZachary Turner   EXPECT_EQ(original_refcnt, strong_ref.get()->ob_refcnt);
65f8b22f8fSZachary Turner }
66f8b22f8fSZachary Turner 
67b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestResetting) {
68f8b22f8fSZachary Turner   PythonDictionary dict(PyInitialValue::Empty);
69f8b22f8fSZachary Turner 
70f8b22f8fSZachary Turner   PyObject *new_dict = PyDict_New();
71f8b22f8fSZachary Turner   dict.Reset(PyRefType::Owned, new_dict);
72f8b22f8fSZachary Turner   EXPECT_EQ(new_dict, dict.get());
73f8b22f8fSZachary Turner 
74f8b22f8fSZachary Turner   dict.Reset(PyRefType::Owned, nullptr);
75f8b22f8fSZachary Turner   EXPECT_EQ(nullptr, dict.get());
76f8b22f8fSZachary Turner 
77f8b22f8fSZachary Turner   dict.Reset(PyRefType::Owned, PyDict_New());
78f8b22f8fSZachary Turner   EXPECT_NE(nullptr, dict.get());
79f8b22f8fSZachary Turner   dict.Reset();
80f8b22f8fSZachary Turner   EXPECT_EQ(nullptr, dict.get());
81f8b22f8fSZachary Turner }
82f8b22f8fSZachary Turner 
83b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestBorrowedReferences) {
84f8b22f8fSZachary Turner   PythonInteger long_value(PyRefType::Owned, PyLong_FromLong(3));
8518426935SZachary Turner   Py_ssize_t original_refcnt = long_value.get()->ob_refcnt;
8618426935SZachary Turner   EXPECT_LE(1, original_refcnt);
87f8b22f8fSZachary Turner 
88f8b22f8fSZachary Turner   PythonInteger borrowed_long(PyRefType::Borrowed, long_value.get());
8918426935SZachary Turner   EXPECT_EQ(original_refcnt + 1, borrowed_long.get()->ob_refcnt);
90f8b22f8fSZachary Turner }
91f8b22f8fSZachary Turner 
92b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestGlobalNameResolutionNoDot) {
93a1405147SZachary Turner   PythonObject sys_module = m_main_module.ResolveName("sys");
94a1405147SZachary Turner   EXPECT_EQ(m_sys_module.get(), sys_module.get());
957841efbbSZachary Turner   EXPECT_TRUE(sys_module.IsAllocated());
967841efbbSZachary Turner   EXPECT_TRUE(PythonModule::Check(sys_module.get()));
977841efbbSZachary Turner }
987841efbbSZachary Turner 
99b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestModuleNameResolutionNoDot) {
100a1405147SZachary Turner   PythonObject sys_path = m_sys_module.ResolveName("path");
101a1405147SZachary Turner   PythonObject sys_version_info = m_sys_module.ResolveName("version_info");
1027841efbbSZachary Turner   EXPECT_TRUE(sys_path.IsAllocated());
1037841efbbSZachary Turner   EXPECT_TRUE(sys_version_info.IsAllocated());
1047841efbbSZachary Turner 
1057841efbbSZachary Turner   EXPECT_TRUE(PythonList::Check(sys_path.get()));
1067841efbbSZachary Turner }
1077841efbbSZachary Turner 
108b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestTypeNameResolutionNoDot) {
109a1405147SZachary Turner   PythonObject sys_version_info = m_sys_module.ResolveName("version_info");
1107841efbbSZachary Turner 
111b9c1b51eSKate Stone   PythonObject version_info_type(PyRefType::Owned,
112b9c1b51eSKate Stone                                  PyObject_Type(sys_version_info.get()));
1137841efbbSZachary Turner   EXPECT_TRUE(version_info_type.IsAllocated());
1147841efbbSZachary Turner   PythonObject major_version_field = version_info_type.ResolveName("major");
1157841efbbSZachary Turner   EXPECT_TRUE(major_version_field.IsAllocated());
1167841efbbSZachary Turner }
1177841efbbSZachary Turner 
118b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestInstanceNameResolutionNoDot) {
119a1405147SZachary Turner   PythonObject sys_version_info = m_sys_module.ResolveName("version_info");
1207841efbbSZachary Turner   PythonObject major_version_field = sys_version_info.ResolveName("major");
1217841efbbSZachary Turner   PythonObject minor_version_field = sys_version_info.ResolveName("minor");
1227841efbbSZachary Turner 
1237841efbbSZachary Turner   EXPECT_TRUE(major_version_field.IsAllocated());
1247841efbbSZachary Turner   EXPECT_TRUE(minor_version_field.IsAllocated());
1257841efbbSZachary Turner 
126b9c1b51eSKate Stone   PythonInteger major_version_value =
127b9c1b51eSKate Stone       major_version_field.AsType<PythonInteger>();
128b9c1b51eSKate Stone   PythonInteger minor_version_value =
129b9c1b51eSKate Stone       minor_version_field.AsType<PythonInteger>();
1307841efbbSZachary Turner 
1317841efbbSZachary Turner   EXPECT_EQ(PY_MAJOR_VERSION, major_version_value.GetInteger());
1327841efbbSZachary Turner   EXPECT_EQ(PY_MINOR_VERSION, minor_version_value.GetInteger());
1337841efbbSZachary Turner }
1347841efbbSZachary Turner 
135b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestGlobalNameResolutionWithDot) {
136a1405147SZachary Turner   PythonObject sys_path = m_main_module.ResolveName("sys.path");
1377841efbbSZachary Turner   EXPECT_TRUE(sys_path.IsAllocated());
1387841efbbSZachary Turner   EXPECT_TRUE(PythonList::Check(sys_path.get()));
1397841efbbSZachary Turner 
140b9c1b51eSKate Stone   PythonInteger version_major =
141b9c1b51eSKate Stone       m_main_module.ResolveName("sys.version_info.major")
142b9c1b51eSKate Stone           .AsType<PythonInteger>();
143b9c1b51eSKate Stone   PythonInteger version_minor =
144b9c1b51eSKate Stone       m_main_module.ResolveName("sys.version_info.minor")
145b9c1b51eSKate Stone           .AsType<PythonInteger>();
1467841efbbSZachary Turner   EXPECT_TRUE(version_major.IsAllocated());
1477841efbbSZachary Turner   EXPECT_TRUE(version_minor.IsAllocated());
1487841efbbSZachary Turner   EXPECT_EQ(PY_MAJOR_VERSION, version_major.GetInteger());
1497841efbbSZachary Turner   EXPECT_EQ(PY_MINOR_VERSION, version_minor.GetInteger());
1507841efbbSZachary Turner }
1517841efbbSZachary Turner 
152b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestDictionaryResolutionWithDot) {
153a1405147SZachary Turner   // Make up a custom dictionary with "sys" pointing to the `sys` module.
154a1405147SZachary Turner   PythonDictionary dict(PyInitialValue::Empty);
155a1405147SZachary Turner   dict.SetItemForKey(PythonString("sys"), m_sys_module);
156a1405147SZachary Turner 
157a1405147SZachary Turner   // Now use that dictionary to resolve `sys.version_info.major`
158b9c1b51eSKate Stone   PythonInteger version_major =
159b9c1b51eSKate Stone       PythonObject::ResolveNameWithDictionary("sys.version_info.major", dict)
160b9c1b51eSKate Stone           .AsType<PythonInteger>();
161b9c1b51eSKate Stone   PythonInteger version_minor =
162b9c1b51eSKate Stone       PythonObject::ResolveNameWithDictionary("sys.version_info.minor", dict)
163b9c1b51eSKate Stone           .AsType<PythonInteger>();
164a1405147SZachary Turner   EXPECT_EQ(PY_MAJOR_VERSION, version_major.GetInteger());
165a1405147SZachary Turner   EXPECT_EQ(PY_MINOR_VERSION, version_minor.GetInteger());
166a1405147SZachary Turner }
167a1405147SZachary Turner 
168b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonInteger) {
16922c8efcdSZachary Turner // Test that integers behave correctly when wrapped by a PythonInteger.
17022c8efcdSZachary Turner 
17122c8efcdSZachary Turner #if PY_MAJOR_VERSION < 3
17222c8efcdSZachary Turner   // Verify that `PythonInt` works correctly when given a PyInt object.
17322c8efcdSZachary Turner   // Note that PyInt doesn't exist in Python 3.x, so this is only for 2.x
17422c8efcdSZachary Turner   PyObject *py_int = PyInt_FromLong(12);
17522c8efcdSZachary Turner   EXPECT_TRUE(PythonInteger::Check(py_int));
176f8b22f8fSZachary Turner   PythonInteger python_int(PyRefType::Owned, py_int);
17722c8efcdSZachary Turner 
17822c8efcdSZachary Turner   EXPECT_EQ(PyObjectType::Integer, python_int.GetObjectType());
17922c8efcdSZachary Turner   EXPECT_EQ(12, python_int.GetInteger());
18022c8efcdSZachary Turner #endif
18122c8efcdSZachary Turner 
18218426935SZachary Turner   // Verify that `PythonInteger` works correctly when given a PyLong object.
18322c8efcdSZachary Turner   PyObject *py_long = PyLong_FromLong(12);
18422c8efcdSZachary Turner   EXPECT_TRUE(PythonInteger::Check(py_long));
185f8b22f8fSZachary Turner   PythonInteger python_long(PyRefType::Owned, py_long);
18622c8efcdSZachary Turner   EXPECT_EQ(PyObjectType::Integer, python_long.GetObjectType());
18722c8efcdSZachary Turner 
18822c8efcdSZachary Turner   // Verify that you can reset the value and that it is reflected properly.
18922c8efcdSZachary Turner   python_long.SetInteger(40);
19022c8efcdSZachary Turner   EXPECT_EQ(40, python_long.GetInteger());
19118426935SZachary Turner 
19218426935SZachary Turner   // Test that creating a `PythonInteger` object works correctly with the
19318426935SZachary Turner   // int constructor.
19418426935SZachary Turner   PythonInteger constructed_int(7);
19518426935SZachary Turner   EXPECT_EQ(7, constructed_int.GetInteger());
19622c8efcdSZachary Turner }
19722c8efcdSZachary Turner 
198b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonBytes) {
1995a72c02bSZachary Turner   static const char *test_bytes = "PythonDataObjectsTest::TestPythonBytes";
2005a72c02bSZachary Turner   PyObject *py_bytes = PyBytes_FromString(test_bytes);
2015a72c02bSZachary Turner   EXPECT_TRUE(PythonBytes::Check(py_bytes));
2025a72c02bSZachary Turner   PythonBytes python_bytes(PyRefType::Owned, py_bytes);
2035a72c02bSZachary Turner 
2045a72c02bSZachary Turner #if PY_MAJOR_VERSION < 3
2055a72c02bSZachary Turner   EXPECT_TRUE(PythonString::Check(py_bytes));
2065a72c02bSZachary Turner   EXPECT_EQ(PyObjectType::String, python_bytes.GetObjectType());
2075a72c02bSZachary Turner #else
2085a72c02bSZachary Turner   EXPECT_FALSE(PythonString::Check(py_bytes));
2095a8453d5SPavel Labath   EXPECT_EQ(PyObjectType::Bytes, python_bytes.GetObjectType());
2105a72c02bSZachary Turner #endif
2115a72c02bSZachary Turner 
2125a72c02bSZachary Turner   llvm::ArrayRef<uint8_t> bytes = python_bytes.GetBytes();
2135a72c02bSZachary Turner   EXPECT_EQ(bytes.size(), strlen(test_bytes));
2145a72c02bSZachary Turner   EXPECT_EQ(0, ::memcmp(bytes.data(), test_bytes, bytes.size()));
2155a72c02bSZachary Turner }
2165a72c02bSZachary Turner 
217b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonByteArray) {
218f9d6d204SZachary Turner   static const char *test_bytes = "PythonDataObjectsTest::TestPythonByteArray";
219f9d6d204SZachary Turner   llvm::StringRef orig_bytes(test_bytes);
220b9c1b51eSKate Stone   PyObject *py_bytes =
221b9c1b51eSKate Stone       PyByteArray_FromStringAndSize(test_bytes, orig_bytes.size());
222f9d6d204SZachary Turner   EXPECT_TRUE(PythonByteArray::Check(py_bytes));
223f9d6d204SZachary Turner   PythonByteArray python_bytes(PyRefType::Owned, py_bytes);
224f9d6d204SZachary Turner   EXPECT_EQ(PyObjectType::ByteArray, python_bytes.GetObjectType());
225f9d6d204SZachary Turner 
226f9d6d204SZachary Turner   llvm::ArrayRef<uint8_t> after_bytes = python_bytes.GetBytes();
227f9d6d204SZachary Turner   EXPECT_EQ(after_bytes.size(), orig_bytes.size());
228f9d6d204SZachary Turner   EXPECT_EQ(0, ::memcmp(orig_bytes.data(), test_bytes, orig_bytes.size()));
229f9d6d204SZachary Turner }
230f9d6d204SZachary Turner 
231b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonString) {
23222c8efcdSZachary Turner   // Test that strings behave correctly when wrapped by a PythonString.
23322c8efcdSZachary Turner 
23418426935SZachary Turner   static const char *test_string = "PythonDataObjectsTest::TestPythonString1";
23518426935SZachary Turner   static const char *test_string2 = "PythonDataObjectsTest::TestPythonString2";
23622c8efcdSZachary Turner 
23722c8efcdSZachary Turner #if PY_MAJOR_VERSION < 3
23822c8efcdSZachary Turner   // Verify that `PythonString` works correctly when given a PyString object.
23922c8efcdSZachary Turner   // Note that PyString doesn't exist in Python 3.x, so this is only for 2.x
24022c8efcdSZachary Turner   PyObject *py_string = PyString_FromString(test_string);
24122c8efcdSZachary Turner   EXPECT_TRUE(PythonString::Check(py_string));
242f8b22f8fSZachary Turner   PythonString python_string(PyRefType::Owned, py_string);
24322c8efcdSZachary Turner 
24422c8efcdSZachary Turner   EXPECT_EQ(PyObjectType::String, python_string.GetObjectType());
24522c8efcdSZachary Turner   EXPECT_STREQ(test_string, python_string.GetString().data());
24618426935SZachary Turner #else
24722c8efcdSZachary Turner   // Verify that `PythonString` works correctly when given a PyUnicode object.
24822c8efcdSZachary Turner   PyObject *py_unicode = PyUnicode_FromString(test_string);
24922c8efcdSZachary Turner   EXPECT_TRUE(PythonString::Check(py_unicode));
250f8b22f8fSZachary Turner   PythonString python_unicode(PyRefType::Owned, py_unicode);
25122c8efcdSZachary Turner   EXPECT_EQ(PyObjectType::String, python_unicode.GetObjectType());
25222c8efcdSZachary Turner   EXPECT_STREQ(test_string, python_unicode.GetString().data());
25318426935SZachary Turner #endif
25422c8efcdSZachary Turner 
25518426935SZachary Turner   // Test that creating a `PythonString` object works correctly with the
25618426935SZachary Turner   // string constructor
257de9dfe78SReid Kleckner   PythonString constructed_string(test_string2);
258*6fe867a8SZachary Turner   EXPECT_EQ(test_string2, constructed_string.GetString());
25922c8efcdSZachary Turner }
26022c8efcdSZachary Turner 
261b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonStringToStr) {
262*6fe867a8SZachary Turner   const char *GetString = "PythonDataObjectsTest::TestPythonStringToStr";
26318426935SZachary Turner 
264*6fe867a8SZachary Turner   PythonString str(GetString);
265*6fe867a8SZachary Turner   EXPECT_EQ(GetString, str.GetString());
26618426935SZachary Turner 
26718426935SZachary Turner   PythonString str_str = str.Str();
268*6fe867a8SZachary Turner   EXPECT_EQ(GetString, str_str.GetString());
26918426935SZachary Turner }
27018426935SZachary Turner 
271b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonIntegerToStr) {}
27218426935SZachary Turner 
273b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonIntegerToStructuredInteger) {
27418426935SZachary Turner   PythonInteger integer(7);
27518426935SZachary Turner   auto int_sp = integer.CreateStructuredInteger();
276de9dfe78SReid Kleckner   EXPECT_EQ(7U, int_sp->GetValue());
27718426935SZachary Turner }
27818426935SZachary Turner 
279b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonStringToStructuredString) {
280b9c1b51eSKate Stone   static const char *test_string =
281b9c1b51eSKate Stone       "PythonDataObjectsTest::TestPythonStringToStructuredString";
28218426935SZachary Turner   PythonString constructed_string(test_string);
28318426935SZachary Turner   auto string_sp = constructed_string.CreateStructuredString();
284*6fe867a8SZachary Turner   EXPECT_EQ(test_string, string_sp->GetStringValue());
28518426935SZachary Turner }
28618426935SZachary Turner 
287b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonListValueEquality) {
28822c8efcdSZachary Turner   // Test that a list which is built through the native
28922c8efcdSZachary Turner   // Python API behaves correctly when wrapped by a PythonList.
290de9dfe78SReid Kleckner   static const unsigned list_size = 2;
29118426935SZachary Turner   static const long long_value0 = 5;
29218426935SZachary Turner   static const char *const string_value1 = "String Index 1";
29322c8efcdSZachary Turner 
29422c8efcdSZachary Turner   PyObject *py_list = PyList_New(2);
295f8b22f8fSZachary Turner   EXPECT_TRUE(PythonList::Check(py_list));
296f8b22f8fSZachary Turner   PythonList list(PyRefType::Owned, py_list);
297f8b22f8fSZachary Turner 
298f8b22f8fSZachary Turner   PythonObject list_items[list_size];
29918426935SZachary Turner   list_items[0].Reset(PythonInteger(long_value0));
30018426935SZachary Turner   list_items[1].Reset(PythonString(string_value1));
30122c8efcdSZachary Turner 
302de9dfe78SReid Kleckner   for (unsigned i = 0; i < list_size; ++i)
303f8b22f8fSZachary Turner     list.SetItemAtIndex(i, list_items[i]);
30422c8efcdSZachary Turner 
30522c8efcdSZachary Turner   EXPECT_EQ(list_size, list.GetSize());
30622c8efcdSZachary Turner   EXPECT_EQ(PyObjectType::List, list.GetObjectType());
30722c8efcdSZachary Turner 
30818426935SZachary Turner   // Verify that the values match
30918426935SZachary Turner   PythonObject chk_value1 = list.GetItemAtIndex(0);
31018426935SZachary Turner   PythonObject chk_value2 = list.GetItemAtIndex(1);
31118426935SZachary Turner   EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
31218426935SZachary Turner   EXPECT_TRUE(PythonString::Check(chk_value2.get()));
31322c8efcdSZachary Turner 
31418426935SZachary Turner   PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
31518426935SZachary Turner   PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
31622c8efcdSZachary Turner 
31718426935SZachary Turner   EXPECT_EQ(long_value0, chk_int.GetInteger());
318*6fe867a8SZachary Turner   EXPECT_EQ(string_value1, chk_str.GetString());
31922c8efcdSZachary Turner }
32022c8efcdSZachary Turner 
321b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonListManipulation) {
32222c8efcdSZachary Turner   // Test that manipulation of a PythonList behaves correctly when
32322c8efcdSZachary Turner   // wrapped by a PythonDictionary.
32422c8efcdSZachary Turner 
32518426935SZachary Turner   static const long long_value0 = 5;
32618426935SZachary Turner   static const char *const string_value1 = "String Index 1";
32722c8efcdSZachary Turner 
328f8b22f8fSZachary Turner   PythonList list(PyInitialValue::Empty);
32918426935SZachary Turner   PythonInteger integer(long_value0);
33018426935SZachary Turner   PythonString string(string_value1);
33122c8efcdSZachary Turner 
33222c8efcdSZachary Turner   list.AppendItem(integer);
33322c8efcdSZachary Turner   list.AppendItem(string);
334de9dfe78SReid Kleckner   EXPECT_EQ(2U, list.GetSize());
33522c8efcdSZachary Turner 
33618426935SZachary Turner   // Verify that the values match
33718426935SZachary Turner   PythonObject chk_value1 = list.GetItemAtIndex(0);
33818426935SZachary Turner   PythonObject chk_value2 = list.GetItemAtIndex(1);
33918426935SZachary Turner   EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
34018426935SZachary Turner   EXPECT_TRUE(PythonString::Check(chk_value2.get()));
34118426935SZachary Turner 
34218426935SZachary Turner   PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
34318426935SZachary Turner   PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
34418426935SZachary Turner 
34518426935SZachary Turner   EXPECT_EQ(long_value0, chk_int.GetInteger());
346*6fe867a8SZachary Turner   EXPECT_EQ(string_value1, chk_str.GetString());
34718426935SZachary Turner }
34818426935SZachary Turner 
349b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonListToStructuredList) {
35018426935SZachary Turner   static const long long_value0 = 5;
35118426935SZachary Turner   static const char *const string_value1 = "String Index 1";
35218426935SZachary Turner 
35318426935SZachary Turner   PythonList list(PyInitialValue::Empty);
35418426935SZachary Turner   list.AppendItem(PythonInteger(long_value0));
35518426935SZachary Turner   list.AppendItem(PythonString(string_value1));
35618426935SZachary Turner 
35718426935SZachary Turner   auto array_sp = list.CreateStructuredArray();
358b9c1b51eSKate Stone   EXPECT_EQ(StructuredData::Type::eTypeInteger,
359b9c1b51eSKate Stone             array_sp->GetItemAtIndex(0)->GetType());
360b9c1b51eSKate Stone   EXPECT_EQ(StructuredData::Type::eTypeString,
361b9c1b51eSKate Stone             array_sp->GetItemAtIndex(1)->GetType());
36218426935SZachary Turner 
36318426935SZachary Turner   auto int_sp = array_sp->GetItemAtIndex(0)->GetAsInteger();
36418426935SZachary Turner   auto string_sp = array_sp->GetItemAtIndex(1)->GetAsString();
36518426935SZachary Turner 
366de9dfe78SReid Kleckner   EXPECT_EQ(long_value0, long(int_sp->GetValue()));
367*6fe867a8SZachary Turner   EXPECT_EQ(string_value1, string_sp->GetValue());
36818426935SZachary Turner }
36918426935SZachary Turner 
370b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleSize) {
371a1405147SZachary Turner   PythonTuple tuple(PyInitialValue::Empty);
372de9dfe78SReid Kleckner   EXPECT_EQ(0U, tuple.GetSize());
373a1405147SZachary Turner 
374a1405147SZachary Turner   tuple = PythonTuple(3);
375de9dfe78SReid Kleckner   EXPECT_EQ(3U, tuple.GetSize());
376a1405147SZachary Turner }
377a1405147SZachary Turner 
378b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleValues) {
379a1405147SZachary Turner   PythonTuple tuple(3);
380a1405147SZachary Turner 
381a1405147SZachary Turner   PythonInteger int_value(1);
382a1405147SZachary Turner   PythonString string_value("Test");
383a1405147SZachary Turner   PythonObject none_value(PyRefType::Borrowed, Py_None);
384a1405147SZachary Turner 
385a1405147SZachary Turner   tuple.SetItemAtIndex(0, int_value);
386a1405147SZachary Turner   tuple.SetItemAtIndex(1, string_value);
387a1405147SZachary Turner   tuple.SetItemAtIndex(2, none_value);
388a1405147SZachary Turner 
389a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get());
390a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get());
391a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get());
392a1405147SZachary Turner }
393a1405147SZachary Turner 
394b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleInitializerList) {
395a1405147SZachary Turner   PythonInteger int_value(1);
396a1405147SZachary Turner   PythonString string_value("Test");
397a1405147SZachary Turner   PythonObject none_value(PyRefType::Borrowed, Py_None);
398a1405147SZachary Turner   PythonTuple tuple{int_value, string_value, none_value};
399de9dfe78SReid Kleckner   EXPECT_EQ(3U, tuple.GetSize());
400a1405147SZachary Turner 
401a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get());
402a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get());
403a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get());
404a1405147SZachary Turner }
405a1405147SZachary Turner 
406b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleInitializerList2) {
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   PythonTuple tuple{int_value.get(), string_value.get(), none_value.get()};
412de9dfe78SReid Kleckner   EXPECT_EQ(3U, tuple.GetSize());
413a1405147SZachary Turner 
414a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(0).get(), int_value.get());
415a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(1).get(), string_value.get());
416a1405147SZachary Turner   EXPECT_EQ(tuple.GetItemAtIndex(2).get(), none_value.get());
417a1405147SZachary Turner }
418a1405147SZachary Turner 
419b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonTupleToStructuredList) {
420a1405147SZachary Turner   PythonInteger int_value(1);
421a1405147SZachary Turner   PythonString string_value("Test");
422a1405147SZachary Turner 
423a1405147SZachary Turner   PythonTuple tuple{int_value.get(), string_value.get()};
424a1405147SZachary Turner 
425a1405147SZachary Turner   auto array_sp = tuple.CreateStructuredArray();
426a1405147SZachary Turner   EXPECT_EQ(tuple.GetSize(), array_sp->GetSize());
427b9c1b51eSKate Stone   EXPECT_EQ(StructuredData::Type::eTypeInteger,
428b9c1b51eSKate Stone             array_sp->GetItemAtIndex(0)->GetType());
429b9c1b51eSKate Stone   EXPECT_EQ(StructuredData::Type::eTypeString,
430b9c1b51eSKate Stone             array_sp->GetItemAtIndex(1)->GetType());
431a1405147SZachary Turner }
432a1405147SZachary Turner 
433b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonDictionaryValueEquality) {
43418426935SZachary Turner   // Test that a dictionary which is built through the native
43518426935SZachary Turner   // Python API behaves correctly when wrapped by a PythonDictionary.
436de9dfe78SReid Kleckner   static const unsigned dict_entries = 2;
43718426935SZachary Turner   const char *key_0 = "Key 0";
43818426935SZachary Turner   int key_1 = 1;
43918426935SZachary Turner   const int value_0 = 0;
44018426935SZachary Turner   const char *value_1 = "Value 1";
44118426935SZachary Turner 
44218426935SZachary Turner   PythonObject py_keys[dict_entries];
44318426935SZachary Turner   PythonObject py_values[dict_entries];
44418426935SZachary Turner 
44518426935SZachary Turner   py_keys[0].Reset(PythonString(key_0));
44618426935SZachary Turner   py_keys[1].Reset(PythonInteger(key_1));
44718426935SZachary Turner   py_values[0].Reset(PythonInteger(value_0));
44818426935SZachary Turner   py_values[1].Reset(PythonString(value_1));
44918426935SZachary Turner 
45018426935SZachary Turner   PyObject *py_dict = PyDict_New();
45118426935SZachary Turner   EXPECT_TRUE(PythonDictionary::Check(py_dict));
45218426935SZachary Turner   PythonDictionary dict(PyRefType::Owned, py_dict);
45318426935SZachary Turner 
454de9dfe78SReid Kleckner   for (unsigned i = 0; i < dict_entries; ++i)
45518426935SZachary Turner     PyDict_SetItem(py_dict, py_keys[i].get(), py_values[i].get());
45618426935SZachary Turner   EXPECT_EQ(dict.GetSize(), dict_entries);
45718426935SZachary Turner   EXPECT_EQ(PyObjectType::Dictionary, dict.GetObjectType());
45818426935SZachary Turner 
45918426935SZachary Turner   // Verify that the values match
46018426935SZachary Turner   PythonObject chk_value1 = dict.GetItemForKey(py_keys[0]);
46118426935SZachary Turner   PythonObject chk_value2 = dict.GetItemForKey(py_keys[1]);
46218426935SZachary Turner   EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
46318426935SZachary Turner   EXPECT_TRUE(PythonString::Check(chk_value2.get()));
46418426935SZachary Turner 
46518426935SZachary Turner   PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
46618426935SZachary Turner   PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
46718426935SZachary Turner 
46818426935SZachary Turner   EXPECT_EQ(value_0, chk_int.GetInteger());
469*6fe867a8SZachary Turner   EXPECT_EQ(value_1, chk_str.GetString());
47022c8efcdSZachary Turner }
47122c8efcdSZachary Turner 
472b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonDictionaryManipulation) {
47322c8efcdSZachary Turner   // Test that manipulation of a dictionary behaves correctly when wrapped
47422c8efcdSZachary Turner   // by a PythonDictionary.
475de9dfe78SReid Kleckner   static const unsigned dict_entries = 2;
47622c8efcdSZachary Turner 
47718426935SZachary Turner   const char *const key_0 = "Key 0";
47818426935SZachary Turner   const char *const key_1 = "Key 1";
47918426935SZachary Turner   const long value_0 = 1;
48018426935SZachary Turner   const char *const value_1 = "Value 1";
48118426935SZachary Turner 
482f8b22f8fSZachary Turner   PythonString keys[dict_entries];
483f8b22f8fSZachary Turner   PythonObject values[dict_entries];
48422c8efcdSZachary Turner 
48518426935SZachary Turner   keys[0].Reset(PythonString(key_0));
48618426935SZachary Turner   keys[1].Reset(PythonString(key_1));
48718426935SZachary Turner   values[0].Reset(PythonInteger(value_0));
48818426935SZachary Turner   values[1].Reset(PythonString(value_1));
48922c8efcdSZachary Turner 
490f8b22f8fSZachary Turner   PythonDictionary dict(PyInitialValue::Empty);
49122c8efcdSZachary Turner   for (int i = 0; i < 2; ++i)
492f8b22f8fSZachary Turner     dict.SetItemForKey(keys[i], values[i]);
49322c8efcdSZachary Turner 
49422c8efcdSZachary Turner   EXPECT_EQ(dict_entries, dict.GetSize());
49522c8efcdSZachary Turner 
49618426935SZachary Turner   // Verify that the keys and values match
49718426935SZachary Turner   PythonObject chk_value1 = dict.GetItemForKey(keys[0]);
49818426935SZachary Turner   PythonObject chk_value2 = dict.GetItemForKey(keys[1]);
49918426935SZachary Turner   EXPECT_TRUE(PythonInteger::Check(chk_value1.get()));
50018426935SZachary Turner   EXPECT_TRUE(PythonString::Check(chk_value2.get()));
50118426935SZachary Turner 
50218426935SZachary Turner   PythonInteger chk_int(PyRefType::Borrowed, chk_value1.get());
50318426935SZachary Turner   PythonString chk_str(PyRefType::Borrowed, chk_value2.get());
50418426935SZachary Turner 
50518426935SZachary Turner   EXPECT_EQ(value_0, chk_int.GetInteger());
506*6fe867a8SZachary Turner   EXPECT_EQ(value_1, chk_str.GetString());
50722c8efcdSZachary Turner }
50822c8efcdSZachary Turner 
509b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonDictionaryToStructuredDictionary) {
51018426935SZachary Turner   static const char *const string_key0 = "String Key 0";
51118426935SZachary Turner   static const char *const string_key1 = "String Key 1";
51222c8efcdSZachary Turner 
51318426935SZachary Turner   static const char *const string_value0 = "String Value 0";
51418426935SZachary Turner   static const long int_value1 = 7;
51522c8efcdSZachary Turner 
516f8b22f8fSZachary Turner   PythonDictionary dict(PyInitialValue::Empty);
51718426935SZachary Turner   dict.SetItemForKey(PythonString(string_key0), PythonString(string_value0));
51818426935SZachary Turner   dict.SetItemForKey(PythonString(string_key1), PythonInteger(int_value1));
51922c8efcdSZachary Turner 
52018426935SZachary Turner   auto dict_sp = dict.CreateStructuredDictionary();
521de9dfe78SReid Kleckner   EXPECT_EQ(2U, dict_sp->GetSize());
52222c8efcdSZachary Turner 
52318426935SZachary Turner   EXPECT_TRUE(dict_sp->HasKey(string_key0));
52418426935SZachary Turner   EXPECT_TRUE(dict_sp->HasKey(string_key1));
52522c8efcdSZachary Turner 
52618426935SZachary Turner   auto string_sp = dict_sp->GetValueForKey(string_key0)->GetAsString();
52718426935SZachary Turner   auto int_sp = dict_sp->GetValueForKey(string_key1)->GetAsInteger();
52822c8efcdSZachary Turner 
529*6fe867a8SZachary Turner   EXPECT_EQ(string_value0, string_sp->GetValue());
530de9dfe78SReid Kleckner   EXPECT_EQ(int_value1, long(int_sp->GetValue()));
53122c8efcdSZachary Turner }
5329c40264fSZachary Turner 
533b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonCallableCheck) {
534a1405147SZachary Turner   PythonObject sys_exc_info = m_sys_module.ResolveName("exc_info");
535a1405147SZachary Turner   PythonObject none(PyRefType::Borrowed, Py_None);
536a1405147SZachary Turner 
537a1405147SZachary Turner   EXPECT_TRUE(PythonCallable::Check(sys_exc_info.get()));
538a1405147SZachary Turner   EXPECT_FALSE(PythonCallable::Check(none.get()));
539a1405147SZachary Turner }
540a1405147SZachary Turner 
541b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonCallableInvoke) {
542a1405147SZachary Turner   auto list = m_builtins_module.ResolveName("list").AsType<PythonCallable>();
543a1405147SZachary Turner   PythonInteger one(1);
544a1405147SZachary Turner   PythonString two("two");
545a1405147SZachary Turner   PythonTuple three = {one, two};
546a1405147SZachary Turner 
547a1405147SZachary Turner   PythonTuple tuple_to_convert = {one, two, three};
548a1405147SZachary Turner   PythonObject result = list({tuple_to_convert});
549a1405147SZachary Turner 
550a1405147SZachary Turner   EXPECT_TRUE(PythonList::Check(result.get()));
551a1405147SZachary Turner   auto list_result = result.AsType<PythonList>();
552de9dfe78SReid Kleckner   EXPECT_EQ(3U, list_result.GetSize());
553a1405147SZachary Turner   EXPECT_EQ(one.get(), list_result.GetItemAtIndex(0).get());
554a1405147SZachary Turner   EXPECT_EQ(two.get(), list_result.GetItemAtIndex(1).get());
555a1405147SZachary Turner   EXPECT_EQ(three.get(), list_result.GetItemAtIndex(2).get());
556a1405147SZachary Turner }
557a1405147SZachary Turner 
558b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestPythonFile) {
5599c40264fSZachary Turner   File file(FileSystem::DEV_NULL, File::eOpenOptionRead);
5609c40264fSZachary Turner   PythonFile py_file(file, "r");
5619c40264fSZachary Turner   EXPECT_TRUE(PythonFile::Check(py_file.get()));
5629c40264fSZachary Turner }
5637d6d218eSZachary Turner 
564b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestObjectAttributes) {
5657d6d218eSZachary Turner   PythonInteger py_int(42);
5667d6d218eSZachary Turner   EXPECT_TRUE(py_int.HasAttribute("numerator"));
5677d6d218eSZachary Turner   EXPECT_FALSE(py_int.HasAttribute("this_should_not_exist"));
5687d6d218eSZachary Turner 
569b9c1b51eSKate Stone   PythonInteger numerator_attr =
570b9c1b51eSKate Stone       py_int.GetAttributeValue("numerator").AsType<PythonInteger>();
5717d6d218eSZachary Turner   EXPECT_TRUE(numerator_attr.IsAllocated());
5727d6d218eSZachary Turner   EXPECT_EQ(42, numerator_attr.GetInteger());
5737d6d218eSZachary Turner }
574008ec446SGreg Clayton 
575b9c1b51eSKate Stone TEST_F(PythonDataObjectsTest, TestExtractingUInt64ThroughStructuredData) {
576008ec446SGreg Clayton   // Make up a custom dictionary with "sys" pointing to the `sys` module.
577008ec446SGreg Clayton   const char *key_name = "addr";
578008ec446SGreg Clayton   const uint64_t value = 0xf000000000000000ull;
579008ec446SGreg Clayton   PythonDictionary python_dict(PyInitialValue::Empty);
580b9c1b51eSKate Stone   PythonInteger python_ull_value(PyRefType::Owned,
581b9c1b51eSKate Stone                                  PyLong_FromUnsignedLongLong(value));
582008ec446SGreg Clayton   python_dict.SetItemForKey(PythonString(key_name), python_ull_value);
583b9c1b51eSKate Stone   StructuredData::ObjectSP structured_data_sp =
584b9c1b51eSKate Stone       python_dict.CreateStructuredObject();
585008ec446SGreg Clayton   EXPECT_TRUE((bool)structured_data_sp);
586b9c1b51eSKate Stone   if (structured_data_sp) {
587b9c1b51eSKate Stone     StructuredData::Dictionary *structured_dict_ptr =
588b9c1b51eSKate Stone         structured_data_sp->GetAsDictionary();
589008ec446SGreg Clayton     EXPECT_TRUE(structured_dict_ptr != nullptr);
590b9c1b51eSKate Stone     if (structured_dict_ptr) {
591b9c1b51eSKate Stone       StructuredData::ObjectSP structured_addr_value_sp =
592b9c1b51eSKate Stone           structured_dict_ptr->GetValueForKey(key_name);
593008ec446SGreg Clayton       EXPECT_TRUE((bool)structured_addr_value_sp);
594b9c1b51eSKate Stone       const uint64_t extracted_value =
595b9c1b51eSKate Stone           structured_addr_value_sp->GetIntegerValue(123);
596008ec446SGreg Clayton       EXPECT_TRUE(extracted_value == value);
597008ec446SGreg Clayton     }
598008ec446SGreg Clayton   }
599008ec446SGreg Clayton }
600