unittests/ScriptInterpreter/Python/PythonExceptionStateTests.cpp


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

//===-- PythonExceptionStateTest.cpp ------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#include "gtest/gtest.h"

#include "Plugins/ScriptInterpreter/Python/lldb-python.h"
#include "Plugins/ScriptInterpreter/Python/PythonDataObjects.h"
#include "Plugins/ScriptInterpreter/Python/PythonExceptionState.h"
#include "Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.h"

#include "PythonTestSuite.h"

using namespace lldb_private;

class PythonExceptionStateTest : public PythonTestSuite
{
  public:
  protected:
    void
    RaiseException()
    {
        PyErr_SetString(PyExc_RuntimeError, "PythonExceptionStateTest test error");
    }
};

TEST_F(PythonExceptionStateTest, TestExceptionStateChecking)
{
    PyErr_Clear();
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());

    RaiseException();
    EXPECT_TRUE(PythonExceptionState::HasErrorOccurred());

    PyErr_Clear();
}

TEST_F(PythonExceptionStateTest, TestAcquisitionSemantics)
{
    PyErr_Clear();
    PythonExceptionState no_error(false);
    EXPECT_FALSE(no_error.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());

    PyErr_Clear();
    RaiseException();
    PythonExceptionState error(false);
    EXPECT_TRUE(error.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());
    error.Discard();

    PyErr_Clear();
    RaiseException();
    error.Acquire(false);
    EXPECT_TRUE(error.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());

    PyErr_Clear();
}

TEST_F(PythonExceptionStateTest, TestDiscardSemantics)
{
    PyErr_Clear();

    // Test that discarding an exception does not restore the exception
    // state even when auto-restore==true is set
    RaiseException();
    PythonExceptionState error(true);
    EXPECT_TRUE(error.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());

    error.Discard();
    EXPECT_FALSE(error.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());
}

TEST_F(PythonExceptionStateTest, TestResetSemantics)
{
    PyErr_Clear();

    // Resetting when auto-restore is true should restore.
    RaiseException();
    PythonExceptionState error(true);
    EXPECT_TRUE(error.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());
    error.Reset();
    EXPECT_FALSE(error.IsError());
    EXPECT_TRUE(PythonExceptionState::HasErrorOccurred());

    PyErr_Clear();

    // Resetting when auto-restore is false should discard.
    RaiseException();
    PythonExceptionState error2(false);
    EXPECT_TRUE(error2.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());
    error2.Reset();
    EXPECT_FALSE(error2.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());

    PyErr_Clear();
}

TEST_F(PythonExceptionStateTest, TestManualRestoreSemantics)
{
    PyErr_Clear();
    RaiseException();
    PythonExceptionState error(false);
    EXPECT_TRUE(error.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());

    error.Restore();
    EXPECT_FALSE(error.IsError());
    EXPECT_TRUE(PythonExceptionState::HasErrorOccurred());

    PyErr_Clear();
}

TEST_F(PythonExceptionStateTest, TestAutoRestoreSemantics)
{
    PyErr_Clear();
    // Test that using the auto-restore flag correctly restores the exception
    // state on destruction, and not using the auto-restore flag correctly
    // does NOT restore the state on destruction.
    {
        RaiseException();
        PythonExceptionState error(false);
        EXPECT_TRUE(error.IsError());
        EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());
    }
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());

    PyErr_Clear();
    {
        RaiseException();
        PythonExceptionState error(true);
        EXPECT_TRUE(error.IsError());
        EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());
    }
    EXPECT_TRUE(PythonExceptionState::HasErrorOccurred());

    PyErr_Clear();
}

TEST_F(PythonExceptionStateTest, TestAutoRestoreChanged)
{
    // Test that if we re-acquire with different auto-restore semantics,
    // that the new semantics are respected.
    PyErr_Clear();

    RaiseException();
    PythonExceptionState error(false);
    EXPECT_TRUE(error.IsError());

    error.Reset();
    EXPECT_FALSE(error.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());

    RaiseException();
    error.Acquire(true);
    EXPECT_TRUE(error.IsError());
    EXPECT_FALSE(PythonExceptionState::HasErrorOccurred());

    error.Reset();
    EXPECT_FALSE(error.IsError());
    EXPECT_TRUE(PythonExceptionState::HasErrorOccurred());

    PyErr_Clear();
}