aboutsummaryrefslogtreecommitdiffstats
path: root/packaging-tools/test_runCommand.py
blob: ede5414980b13cd5a0d1c101c3408d8d541854b6 (plain)
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
#############################################################################
##
## Copyright (C) 2015 The Qt Company Ltd.
## Contact: http://www.qt.io/licensing/
##
## This file is part of the QtCore module of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:LGPL21$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see http://www.qt.io/terms-conditions. For further
## information use the contact form at http://www.qt.io/contact-us.
##
## GNU Lesser General Public License Usage
## Alternatively, this file may be used under the terms of the GNU Lesser
## General Public License version 2.1 or version 3 as published by the Free
## Software Foundation and appearing in the file LICENSE.LGPLv21 and
## LICENSE.LGPLv3 included in the packaging of this file. Please review the
## following information to ensure the GNU Lesser General Public License
## requirements will be met: https://www.gnu.org/licenses/lgpl.html and
## http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
##
## As a special exception, The Qt Company gives you certain additional
## rights. These rights are described in The Qt Company LGPL Exception
## version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
##
## $QT_END_LICENSE$
##
#############################################################################
# import the print function which is used in python 3.x
from __future__ import print_function

from bld_utils import runCommand
from threadedwork import Task, ThreadedWork

import ctypes
import time
import sys
import unittest
import argparse # commandline argument parser
import os

if sys.platform.startswith("win"):
    # Don't display the Windows GPF dialog if the invoked program dies.
    # See comp.os.ms-windows.programmer.win32
    # How to suppress crash notification dialog?, Jan 14,2004 -
    # Raymond Chen's response [1]

    SEM_NOGPFAULTERRORBOX = 0x0002 # From MSDN
    ctypes.windll.kernel32.SetErrorMode(SEM_NOGPFAULTERRORBOX);
    subprocess_flags = 0x8000000 #win32con.CREATE_NO_WINDOW?

def baseCommand():
    return " ".join([sys.executable,os.path.abspath(__file__)])

def crash():
        '''\
        crash the Python interpreter...
        '''
        i = ctypes.c_char('a')
        j = ctypes.pointer(i)
        c = 0
        while True:
                j[c] = 'a'
                c += 1
        j

def printLines(count):
    for lineNumber in range(count):
        print("{0} printed line".format(lineNumber))

def useRunCommand(testArguments, *arguments):
    return runCommand("{0} {1}".format(baseCommand(), testArguments), *arguments)

class TestRunCommand(unittest.TestCase):
    def test_ExitValue_0(self):
        self.assertEqual(useRunCommand("--printLines 10", os.getcwd()), 0)

    def test_Crash(self):
        with self.assertRaises(Exception) as contextManager:
            useRunCommand("--printLines 10 --crash", os.getcwd())

        self.assertIsNotNone(contextManager)
        self.assertIsNotNone(contextManager.exception)
        expectedMessageStart = "Different exit code then expected"
        messageStart = contextManager.exception.message[:len(expectedMessageStart)]
        self.assertEqual(expectedMessageStart, messageStart)

    def test_Crash_onlyErrorCaseOutput(self):
        with self.assertRaises(Exception) as contextManager:
            crashedExitCode = useRunCommand("--printLines 10 --crash", os.getcwd(),
            #callerArguments=
            None,
            #init_environment=
            None,
            #onlyErrorCaseOutput=
            True,
            #expectedExitCodes=
            [0])
        self.assertIsNotNone(contextManager)
        self.assertIsNotNone(contextManager.exception)
        expectedMessageStart = "Different exit code then expected"
        messageStart = contextManager.exception.message[:len(expectedMessageStart)]
        self.assertEqual(expectedMessageStart, messageStart)
        expectedMessageEnd = "9 printed line"
        messageEnd = contextManager.exception.message.splitlines()[-1]
        self.assertEqual(expectedMessageEnd, messageEnd)

    def test_differentExitCode_onlyErrorCaseOutput(self):
        self.assertEqual(useRunCommand("--printLines 10 --exitCode 5", os.getcwd(),
            #callerArguments=
            None,
            #init_environment=
            None,
            #onlyErrorCaseOutput=
            True,
            #expectedExitCodes=
            [0,5]), 5)

    def test_withThreadedWork(self):
        currentMethodName = sys._getframe().f_code.co_name
        testWork = ThreadedWork("{} - run some command threaded".format(currentMethodName))
        taskStringList = []
        taskStringList.append("--sleep 1 --printLines 10")
        taskStringList.append("--sleep 2 --printLines 30")
        taskStringList.append("--sleep 1 --printLines 40")
        taskStringList.append("--sleep 2 --printLines 50")
        taskStringList.append("--sleep 1 --printLines 100")
        for taskString in taskStringList:
            testWork.addTask(taskString, useRunCommand, taskString, os.getcwd())
        testWork.run()
    def test_withThreadedWork_unexpected_exitCode(self):
        currentMethodName = sys._getframe().f_code.co_name
        testWork = ThreadedWork("{} - run some command threaded".format(currentMethodName))
        # this exchange the current os._exit(-1) implementation only for this testing case
        separatorLine = "{0}>>>>>>>>>>>>>>>>>>>>>>>>>>>>>{0}".format(os.linesep)
        separatorText = "the complete python application would stop here"
        testWork.setExitFailFunction(sys.__stdout__.write, ''.join([separatorLine, separatorText, separatorLine]))
        taskStringList = []
        taskStringList.append("--sleep 1 --printLines 10")
        taskStringList.append("--sleep 2 --printLines 30")
        taskStringList.append("--sleep 1 --printLines 40")
        taskStringList.append("--sleep 2 --printLines 3 --exitCode 5")
        taskStringList.append("--sleep 1 --printLines 100")
        for taskString in taskStringList:
            testWork.addTask(taskString, useRunCommand, taskString, os.getcwd())
        testWork.run()
    def test_withThreadedWork_crash(self):
        currentMethodName = sys._getframe().f_code.co_name
        testWork = ThreadedWork("{} - run some command threaded".format(currentMethodName))
        # this exchange the current os._exit(-1) implementation only for this testing case
        separatorLine = "{0}>>>>>>>>>>>>>>>>>>>>>>>>>>>>>{0}".format(os.linesep)
        separatorText = "the complete python application would stop here"
        testWork.setExitFailFunction(sys.__stdout__.write, ''.join([separatorLine, separatorText, separatorLine]))
        taskStringList = []
        taskStringList.append("--sleep 1 --printLines 10")
        taskStringList.append("--sleep 2 --printLines 30")
        taskStringList.append("--sleep 1 --printLines 40")
        taskStringList.append("--sleep 2 --printLines 3 --crash")
        taskStringList.append("--sleep 1 --printLines 100")
        for taskString in taskStringList:
            testWork.addTask(taskString, useRunCommand, taskString, os.getcwd())
        testWork.run()

if __name__ == '__main__':
    # no args means we are calling the tests
    if not sys.argv[1:]:
        unittest.main()
    else:
        parser = argparse.ArgumentParser(prog = os.path.basename(sys.argv[0]))
        parser.add_argument('--sleep', type=int)
        parser.add_argument('--printLines', type=int)
        parser.add_argument('--crash', action='store_true', default=False)
        parser.add_argument('--exitCode', type=int)
        parser.add_argument('--testMethod')
        callerArguments = parser.parse_args()
        if callerArguments.sleep:
            time.sleep(callerArguments.sleep)
        if callerArguments.printLines:
            printLines(callerArguments.printLines)
        if callerArguments.crash:
            sys.__stdout__.flush()
            sys.__stderr__.flush()
            crash()
        if callerArguments.exitCode:
            os._exit(callerArguments.exitCode)
        if callerArguments.testMethod:
            #python test_runCommand.py --testMethod test_Crash_onlyErrorCaseOutput
            TestRunCommand(methodName=callerArguments.testMethod).debug()