forked from qt-creator/qt-creator
2d79718ad4
Change-Id: I7e487481ede88d186fb868d595eb96f25afc2fc5 Reviewed-by: <github-actions-qt-creator@cristianadam.eu> Reviewed-by: David Schulz <david.schulz@qt.io>
456 lines
20 KiB
Python
456 lines
20 KiB
Python
# Copyright (C) 2016 The Qt Company Ltd.
|
|
# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
|
|
|
|
def jumpToFirstLine(editor):
|
|
home = "<Home>" if platform.system() == 'Darwin' else "<Ctrl+Home>"
|
|
type(editor, home)
|
|
|
|
# places the cursor inside the given editor into the given line
|
|
# (leading and trailing whitespaces are ignored!)
|
|
# and goes to the end of the line
|
|
# line can be a regex - but if so, remember to set isRegex to True
|
|
# the function returns True if this went fine, False on error
|
|
def placeCursorToLine(editor, line, isRegex=False):
|
|
def getEditor():
|
|
return waitForObject(editor)
|
|
|
|
isDarwin = platform.system() == 'Darwin'
|
|
if not isString(editor):
|
|
editor = objectMap.realName(editor)
|
|
oldPosition = 0
|
|
jumpToFirstLine(getEditor())
|
|
found = False
|
|
if isRegex:
|
|
regex = re.compile(line)
|
|
while not found:
|
|
currentLine = str(lineUnderCursor(getEditor())).strip()
|
|
found = isRegex and regex.match(currentLine) or not isRegex and currentLine == line
|
|
if not found:
|
|
type(getEditor(), "<Down>")
|
|
newPosition = getEditor().textCursor().position()
|
|
if oldPosition == newPosition:
|
|
break
|
|
oldPosition = newPosition
|
|
if not found:
|
|
test.fatal("Couldn't find line matching\n\n%s\n\nLeaving test..." % line)
|
|
return False
|
|
if isDarwin:
|
|
type(getEditor(), "<Ctrl+Right>")
|
|
else:
|
|
type(getEditor(), "<End>")
|
|
return True
|
|
|
|
# returns the number of the text line where the cursor is, starting at line 1
|
|
# param editor is the editor the cursor is in
|
|
def lineNumberWithCursor(editor):
|
|
textPos = editor.textCursor().position()
|
|
line = str(editor.plainText)[:textPos].count("\n") + 1
|
|
return line
|
|
|
|
# this function returns True if a QMenu is
|
|
# popped up above the given editor
|
|
# param editor is the editor where the menu should appear
|
|
# param menuInList is a list containing one item. This item will be assigned the menu if there is one.
|
|
# THIS IS A HACK to get a pass-by-reference
|
|
def menuVisibleAtEditor(editor, menuInList):
|
|
menuInList[0] = None
|
|
try:
|
|
menu = waitForObject("{type='QMenu' unnamed='1' visible='1'}", 500)
|
|
topLeft = menu.mapToGlobal(QPoint(0, 0))
|
|
bottomLeft = menu.mapToGlobal(QPoint(0, menu.height))
|
|
center = menu.mapToGlobal(QPoint(menu.width / 2, menu.height / 2))
|
|
success = menu.visible and (widgetContainsPoint(editor, topLeft)
|
|
or widgetContainsPoint(editor, bottomLeft)
|
|
or widgetContainsPoint(editor, center))
|
|
if success:
|
|
menuInList[0] = menu
|
|
return success
|
|
except:
|
|
t, v = sys.exc_info()[:2]
|
|
test.log("Exception: %s" % str(t), str(v))
|
|
return False
|
|
|
|
# this function checks whether the given global point (QPoint)
|
|
# is contained in the given widget
|
|
def widgetContainsPoint(widget, point):
|
|
return QRect(widget.mapToGlobal(QPoint(0, 0)), widget.size).contains(point)
|
|
|
|
# this function simply opens the context menu inside the given editor
|
|
# at the same position where the text cursor is located at
|
|
def openContextMenuOnTextCursorPosition(editor):
|
|
rect = editor.cursorRect(editor.textCursor())
|
|
openContextMenu(editor, rect.x+rect.width/2, rect.y+rect.height/2, 0)
|
|
menuInList = [None]
|
|
waitFor("menuVisibleAtEditor(editor, menuInList)", 5000)
|
|
return menuInList[0]
|
|
|
|
# this function marks/selects the text inside the given editor from current cursor position
|
|
# param direction is one of "Left", "Right", "Up", "Down", but "End" and combinations work as well
|
|
# param typeCount defines how often the cursor will be moved in the given direction (while marking)
|
|
def markText(editor, direction, typeCount=1):
|
|
for _ in range(typeCount):
|
|
type(editor, "<Shift+%s>" % direction)
|
|
|
|
# works for all standard editors
|
|
def replaceEditorContent(editor, newcontent):
|
|
type(editor, "<Ctrl+a>")
|
|
type(editor, "<Delete>")
|
|
type(editor, newcontent)
|
|
|
|
def typeLines(editor, lines):
|
|
if isString(lines):
|
|
lines = [lines]
|
|
if isinstance(lines, (list, tuple)):
|
|
for line in lines:
|
|
type(editor, line)
|
|
type(editor, "<Return>")
|
|
else:
|
|
test.warning("Illegal parameter passed to typeLines()")
|
|
|
|
# function to verify hoverings on e.g. code inside of the given editor
|
|
# param editor the editor object
|
|
# param lines a list/tuple of regex that indicates which lines should be verified
|
|
# param additionalKeyPresses an array holding the additional typings to do (special chars for cursor movement)
|
|
# to get to the location (inside line) where to trigger the hovering (must be the same for all lines)
|
|
# param expectedTypes list/tuple holding the type of the (tool)tips that should occur (for each line)
|
|
# param expectedValues list/tuple of dict or list/tuple of strings regarding the types that have been used
|
|
# if it's a dict it indicates a property value pair, if it's a string it is type specific (e.g. color value for ColorTip)
|
|
# param alternativeValues same as expectedValues, but here you can submit alternatives - this is for example
|
|
# necessary if you do not add the correct documentation (from where the tip gets its content)
|
|
def verifyHoveringOnEditor(editor, lines, additionalKeyPresses, expectedTypes, expectedValues, alternativeValues=None):
|
|
counter = 0
|
|
for line in lines:
|
|
expectedVals = expectedValues[counter]
|
|
expectedType = expectedTypes[counter]
|
|
altVal = None
|
|
if isinstance(alternativeValues, (list, tuple)):
|
|
altVal = alternativeValues[counter]
|
|
counter += 1
|
|
placeCursorToLine(editor, line, True)
|
|
for ty in additionalKeyPresses:
|
|
type(editor, ty)
|
|
rect = editor.cursorRect(editor.textCursor())
|
|
expectedToolTip = "{type='QLabel' objectName='qcToolTip' visible='1'}"
|
|
# wait for similar tooltips to disappear
|
|
checkIfObjectExists(expectedToolTip, False, 1000, True)
|
|
sendEvent("QMouseEvent", editor, QEvent.MouseMove, rect.x+rect.width/2, rect.y+rect.height/2, Qt.NoButton, 0)
|
|
try:
|
|
tip = waitForObject(expectedToolTip)
|
|
except:
|
|
tip = None
|
|
if tip == None:
|
|
test.warning("Could not get %s for line containing pattern '%s'" % (expectedType,line))
|
|
else:
|
|
if expectedType == "ColorTip":
|
|
__handleColorTips__(tip, expectedVals, altVal)
|
|
elif expectedType == "TextTip":
|
|
__handleTextTips__(tip, expectedVals, altVal)
|
|
elif expectedType == "WidgetTip":
|
|
__handleWidgetTips__(tip, expectedVals)
|
|
sendEvent("QMouseEvent", editor, QEvent.MouseMove, 0, 0, Qt.NoButton, 0)
|
|
waitFor("isNull(tip)", 10000)
|
|
|
|
# helper function that handles verification of TextTip hoverings
|
|
# param textTip the TextTip object
|
|
# param expectedVals a dict holding property value pairs that must match
|
|
def __handleTextTips__(textTip, expectedVals, alternativeVals):
|
|
props = object.properties(textTip)
|
|
expFail = False
|
|
eResult = verifyProperties(props, expectedVals)
|
|
for val in eResult.itervalues():
|
|
if not val:
|
|
expFail = True
|
|
break
|
|
if expFail and alternativeVals != None:
|
|
aResult = verifyProperties(props, alternativeVals)
|
|
else:
|
|
aResult = None
|
|
if not expFail:
|
|
test.passes("TextTip verified")
|
|
else:
|
|
for key,val in eResult.iteritems():
|
|
if val == False:
|
|
if aResult and aResult.get(key):
|
|
test.passes("Property '%s' does not match expected, but alternative value" % key)
|
|
else:
|
|
aVal = None
|
|
if alternativeVals:
|
|
aVal = alternativeVals.get(key, None)
|
|
if aVal:
|
|
test.fail("Property '%s' does not match - expected '%s' or '%s', got '%s'" % (key, expectedVals.get(key), aVal, props.get(key)))
|
|
else:
|
|
test.fail("Property '%s' does not match - expected '%s', got '%s" % (key, expectedVals.get(key), props.get(key)))
|
|
else:
|
|
test.fail("Property '%s' could not be found inside properties" % key)
|
|
|
|
# helper function that handles verification of ColorTip hoverings
|
|
# param colTip the ColorTip object
|
|
# param expectedColor a single string holding the color the ColorTip should have
|
|
# Attention: because of being a non-standard Qt object it's not possible to
|
|
# verify colors which are (semi-)transparent!
|
|
def __handleColorTips__(colTip, expectedColor, alternativeColor):
|
|
def uint(value):
|
|
if value < 0:
|
|
return 0xffffffff + value + 1
|
|
return value
|
|
|
|
cmp = QColor()
|
|
cmp.setNamedColor(QString(expectedColor))
|
|
if alternativeColor:
|
|
alt = QColor()
|
|
alt.setNamedColor(QString(alternativeColor))
|
|
if cmp.alpha() != 255 or alternativeColor and alt.alpha() != 255:
|
|
test.warning("Cannot handle transparent colors - cancelling this verification")
|
|
return
|
|
dPM = colTip.grab(QRect(1, 1, colTip.width - 2, colTip.height - 2))
|
|
img = dPM.toImage()
|
|
rgb = img.pixel(1, 1)
|
|
rgb = QColor(rgb)
|
|
if rgb.rgba() == cmp.rgba() or alternativeColor and rgb.rgba() == alt.rgba():
|
|
test.passes("ColorTip verified")
|
|
else:
|
|
altColorText = ""
|
|
if alternativeColor:
|
|
altColorText = " or '%X'" % uint(alt.rgb())
|
|
test.fail("ColorTip does not match - expected color '%X'%s got '%X'"
|
|
% (uint(cmp.rgb()), altColorText, uint(rgb.rgb())))
|
|
|
|
# helper function that handles verification of WidgetTip hoverings
|
|
# param widgetTip the WidgetTip object
|
|
# param expectedVals a dict holding property value pairs that must match
|
|
def __handleWidgetTips__(widgetTip, expectedVals):
|
|
toplabel = waitForObject("{type='QLabel' objectName='qcWidgetTipTopLabel' visible='1'}")
|
|
foundText = str(toplabel.text)
|
|
try:
|
|
helplabel = waitForObject("{type='QLabel' objectName='qcWidgetTipHelpLabel' visible='1'}", 1000)
|
|
foundText += str(helplabel.text)
|
|
except:
|
|
pass
|
|
test.compare(foundText, expectedVals["text"])
|
|
|
|
# function that checks whether all expected properties (including their values)
|
|
# match the given properties
|
|
# param properties a dict holding the properties to check
|
|
# param expectedProps a dict holding the key value pairs that must be found inside properties
|
|
# this function returns a dict holding the keys of the expectedProps - the value of each key
|
|
# is a boolean that indicates whether this key could have been found inside properties and
|
|
# the values matched or None if the key could not be found
|
|
def verifyProperties(properties, expectedProps):
|
|
if not isinstance(properties, dict) or not isinstance(expectedProps, dict):
|
|
test.warning("Wrong usage - both parameter must be of type dict")
|
|
return {}
|
|
result = {}
|
|
for key,val in expectedProps.iteritems():
|
|
foundVal = properties.get(key, None)
|
|
if foundVal != None:
|
|
result[key] = val == foundVal
|
|
else:
|
|
result[key] = None
|
|
return result
|
|
|
|
def getEditorForFileSuffix(curFile, treeViewSyntax=False):
|
|
cppEditorSuffixes = ["cpp", "cc", "CC", "h", "H", "cp", "cxx", "C", "c++", "inl", "moc", "qdoc",
|
|
"tcc", "tpp", "t++", "c", "cu", "m", "mm", "hh", "hxx", "h++", "hpp", "hp"]
|
|
qmlEditorSuffixes = ["qml", "qmlproject", "js", "qs", "qtt"]
|
|
proEditorSuffixes = ["pro", "pri", "prf"]
|
|
glslEditorSuffixes= ["frag", "vert", "fsh", "vsh", "glsl", "shader", "gsh"]
|
|
pytEditorSuffixes = ["py", "pyw", "wsgi"]
|
|
binEditorSuffixes = ["bin"]
|
|
suffix = __getFileSuffix__(curFile)
|
|
expected = os.path.basename(curFile)
|
|
if treeViewSyntax:
|
|
expected = simpleFileName(curFile)
|
|
mainWindow = waitForObject(":Qt Creator_Core::Internal::MainWindow")
|
|
if not waitFor("str(mainWindow.windowTitle).startswith(expected + ' ')", 5000):
|
|
test.fatal("Window title (%s) did not switch to expected file (%s)."
|
|
% (str(mainWindow.windowTitle), expected))
|
|
try:
|
|
if suffix in cppEditorSuffixes:
|
|
editor = waitForObject(":Qt Creator_CppEditor::Internal::CPPEditorWidget")
|
|
elif suffix in qmlEditorSuffixes:
|
|
editor = waitForObject(":Qt Creator_QmlJSEditor::QmlJSTextEditorWidget")
|
|
elif suffix in proEditorSuffixes or suffix in glslEditorSuffixes or suffix in pytEditorSuffixes:
|
|
editor = waitForObject(":Qt Creator_TextEditor::TextEditorWidget")
|
|
elif suffix in binEditorSuffixes:
|
|
editor = waitForObject(":Qt Creator_BinEditor::BinEditorWidget")
|
|
else:
|
|
test.log("Trying TextEditorWidget (file suffix: %s)" % suffix)
|
|
try:
|
|
editor = waitForObject(":Qt Creator_TextEditor::TextEditorWidget", 3000)
|
|
except:
|
|
test.fatal("Unsupported file suffix for file '%s'" % curFile)
|
|
editor = None
|
|
except:
|
|
f = str(waitForObject(":Qt Creator_Core::Internal::MainWindow").windowTitle).split(" ", 1)[0]
|
|
if os.path.basename(curFile) == f:
|
|
test.fatal("Could not find editor although expected file matches.")
|
|
else:
|
|
test.fatal("Expected (%s) and current file (%s) do not match. Failed to get editor"
|
|
% (os.path.basename(curFile), f))
|
|
editor = None
|
|
return editor
|
|
|
|
# helper that determines the file suffix of the given fileName
|
|
# (doesn't matter if fileName contains the path as well)
|
|
def __getFileSuffix__(fileName):
|
|
suffix = os.path.basename(fileName).rsplit(".", 1)
|
|
if len(suffix) == 1:
|
|
return None
|
|
else:
|
|
return suffix[1]
|
|
|
|
def maskSpecialCharsForSearchResult(filename):
|
|
filename = filename.replace("_", "\\_").replace(".","\\.")
|
|
return filename
|
|
|
|
def waitForSearchResults():
|
|
cancelButton = ("{text='Cancel' type='QToolButton' unnamed='1' visible='1' "
|
|
"window=':Qt Creator_Core::Internal::MainWindow'}")
|
|
|
|
waitFor("object.exists(cancelButton)", 3000)
|
|
waitFor("not object.exists(cancelButton)", 20000)
|
|
|
|
def validateSearchResult(expectedCount):
|
|
searchResult = waitForObject(":Qt Creator_SearchResult_Core::Internal::OutputPaneToggleButton")
|
|
ensureChecked(searchResult)
|
|
resultTreeView = waitForObject(":Qt Creator_Find::Internal::SearchResultTreeView")
|
|
counterLabel = waitForObject("{type='QLabel' unnamed='1' visible='1' text?='*matches found.' "
|
|
"window=':Qt Creator_Core::Internal::MainWindow'}")
|
|
matches = cast((str(counterLabel.text)).split(" ", 1)[0], "int")
|
|
test.compare(matches, expectedCount, "Verified match count.")
|
|
model = resultTreeView.model()
|
|
for index in dumpIndices(model):
|
|
itemText = str(model.data(index).toString())
|
|
doubleClickItem(resultTreeView, maskSpecialCharsForSearchResult(itemText), 5, 5, 0, Qt.LeftButton)
|
|
test.log("%d occurrences in %s" % (model.rowCount(index), itemText))
|
|
for chIndex in dumpIndices(model, index):
|
|
resultTreeView.scrollTo(chIndex)
|
|
text = str(chIndex.data()).rstrip('\r')
|
|
rect = resultTreeView.visualRect(chIndex)
|
|
doubleClick(resultTreeView, rect.x+50, rect.y+5, 0, Qt.LeftButton)
|
|
editor = getEditorForFileSuffix(itemText)
|
|
if not waitFor("lineUnderCursor(editor) == text", 2000):
|
|
test.warning("Jumping to search result '%s' is pretty slow." % text)
|
|
waitFor("lineUnderCursor(editor) == text", 2000)
|
|
test.compare(lineUnderCursor(editor), text)
|
|
|
|
# this function invokes context menu and command from it
|
|
def invokeContextMenuItem(editorArea, command1, command2 = None):
|
|
for _ in range(2):
|
|
ctxtMenu = openContextMenuOnTextCursorPosition(editorArea)
|
|
snooze(1)
|
|
try:
|
|
item1 = waitForObjectItem(objectMap.realName(ctxtMenu), command1, 2000)
|
|
break
|
|
except:
|
|
test.warning("Context menu item not ready (%s) - trying once more." % command1)
|
|
type(editorArea, "<Escape>")
|
|
|
|
if command2 and platform.system() == 'Darwin':
|
|
mouseMove(item1)
|
|
activateItem(item1)
|
|
if command2:
|
|
activateItem(waitForObjectItem("{title='%s' type='QMenu' visible='1' window=%s}"
|
|
% (command1, objectMap.realName(ctxtMenu)), command2, 2000))
|
|
|
|
# this function invokes the "Find Usages" item from context menu
|
|
# param editor an editor object
|
|
# param line a line in editor (content of the line as a string)
|
|
# param typeOperation a key to type
|
|
# param n how often repeat the type operation?
|
|
def invokeFindUsage(editor, line, typeOperation, n=1):
|
|
if not placeCursorToLine(editor, line, True):
|
|
return False
|
|
for _ in range(n):
|
|
type(editor, typeOperation)
|
|
snooze(1)
|
|
invokeContextMenuItem(editor, "Find References to Symbol Under Cursor")
|
|
return True
|
|
|
|
def addBranchWildcardToRoot(rootNode):
|
|
pos = rootNode.find(".")
|
|
if pos == -1:
|
|
return rootNode + " [[]*[]]"
|
|
return rootNode[:pos] + " [[]*[]]" + rootNode[pos:]
|
|
|
|
def openDocument(treeElement):
|
|
# split into tree elements
|
|
treePathElements = re.split(r"(?<!\\)\.", treeElement)
|
|
# 'unmask' the extension delimiter
|
|
treePathElements = list(x.replace("\\.", ".") for x in treePathElements)
|
|
try:
|
|
parentIndex = None
|
|
selectFromCombo(":Qt Creator_Core::Internal::NavComboBox", "Projects")
|
|
navigator = waitForObject(":Qt Creator_Utils::NavigationTreeView")
|
|
|
|
for i, t in enumerate(treePathElements):
|
|
indices = dumpIndices(navigator.model(), parentIndex)
|
|
foundT = False
|
|
for index in indices:
|
|
iText = str(index.text)
|
|
if (iText == t
|
|
or (i == 0 and re.match(t + " [[].+[]]", iText) is not None)):
|
|
foundT = True
|
|
parentIndex = index
|
|
break
|
|
if not foundT:
|
|
raise Exception("Failed to get index '%s' (%d)." % (t, i))
|
|
if not navigator.isExpanded(parentIndex):
|
|
navigator.scrollTo(parentIndex)
|
|
rect = navigator.visualRect(parentIndex)
|
|
doubleClick(navigator, rect.x + 50, rect.y + 5, 0, Qt.LeftButton)
|
|
# now we should have a full expanded tree up to the requested file
|
|
rect = navigator.visualRect(parentIndex)
|
|
doubleClick(navigator, rect.x + 50, rect.y + 5, 0, Qt.LeftButton)
|
|
mainWindow = waitForObject(":Qt Creator_Core::Internal::MainWindow")
|
|
fileNameWithoutLinePrefix = treePathElements[-1]
|
|
matching = re.match("^(.+)(:\\d+)$", fileNameWithoutLinePrefix)
|
|
if matching is not None:
|
|
fileNameWithoutLinePrefix = matching.group(1)
|
|
if waitFor("str(mainWindow.windowTitle).startswith(fileNameWithoutLinePrefix + ' ')", 5000):
|
|
return True
|
|
test.log("Expected file (%s) was not being opened in openDocument()" % treePathElements[-1])
|
|
return False
|
|
except:
|
|
t,v = sys.exc_info()[:2]
|
|
test.log("An exception occurred in openDocument(): %s(%s)" % (str(t), str(v)))
|
|
return False
|
|
|
|
def earlyExit(details="No additional information"):
|
|
test.fail("Something went wrong running this test", details)
|
|
saveAndExit()
|
|
|
|
def openDocumentPlaceCursor(doc, line, additionalFunction=None):
|
|
cppEditorStr = ":Qt Creator_CppEditor::Internal::CPPEditorWidget"
|
|
if openDocument(doc) and placeCursorToLine(cppEditorStr, line):
|
|
if additionalFunction:
|
|
additionalFunction()
|
|
return str(waitForObject(cppEditorStr).plainText)
|
|
else:
|
|
earlyExit("Open %s or placing cursor to line (%s) failed." % (doc, line))
|
|
return None
|
|
|
|
# Replaces a line in the editor with another
|
|
# param fileSpec a string specifying a file in Projects view
|
|
# param oldLine a string holding the line to be replaced
|
|
# param newLine a string holding the line to be inserted
|
|
def replaceLine(fileSpec, oldLine, newLine):
|
|
if openDocumentPlaceCursor(fileSpec, oldLine) == None:
|
|
return False
|
|
editor = waitForObject(":Qt Creator_CppEditor::Internal::CPPEditorWidget")
|
|
for _ in oldLine:
|
|
type(editor, "<Backspace>")
|
|
type(editor, newLine)
|
|
return True
|
|
|
|
def addTestableCodeAfterLine(editorObject, line, newCodeLines):
|
|
if not placeCursorToLine(editorObject, line):
|
|
return False
|
|
type(editorObject, "<Return>")
|
|
typeLines(editorObject, newCodeLines)
|
|
return True
|
|
|
|
def saveAndExit():
|
|
invokeMenuItem("File", "Save All")
|
|
invokeMenuItem("File", "Exit")
|