Files
qt-creator/tests/system/suite_general/tst_new_class/test.py
Christian Stenger 23828a1d9c SquishTests: Adapt to changed behavior
We nowadays use pragma once by default for include guards.
Enhance former check to be able to check for both later on.

Change-Id: I0955158f53e056fed2e3751cf42f51855ff95515
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-09-29 09:09:21 +00:00

84 lines
4.0 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
source("../../shared/qtcreator.py")
def main():
newClassName = "MyNewClass"
headerFileName = newClassName.lower() + ".h"
sourceFileName = newClassName.lower() + ".cpp"
basePath = tempDir()
notOverwrittenComment = "// If you can read this, the file was not overwritten."
startQC()
if not startedWithoutPluginError():
return
addCPlusPlusFile(newClassName, "C++ Class", None, newBasePath=basePath,
expectedSourceName=sourceFileName,
expectedHeaderName=headerFileName)
mainWindow = waitForObject(":Qt Creator_Core::Internal::MainWindow")
if test.verify(waitFor("str(mainWindow.windowTitle).startswith(sourceFileName + ' ')", 1000),
"Source file was opened on time?"):
editor = waitForObject(":Qt Creator_CppEditor::Internal::CPPEditorWidget")
editorText = str(editor.plainText)
mouseClick(editor) # enable menu items for file
test.verify('#include "%s"' % headerFileName in editorText,
"Header included in source file?")
test.verify(newClassName + "::" + newClassName + "()" in editorText,
"Ctor implementation in source file?")
type(editor, notOverwrittenComment)
type(editor, "<Return>")
invokeMenuItem("File", "Save All")
clickButton(waitForObject(":Qt Creator.CloseDoc_QToolButton"))
if test.verify(waitFor("str(mainWindow.windowTitle).startswith(headerFileName + ' ')", 2000),
"Header file was shown after closing source?"):
editor = waitForObject(":Qt Creator_CppEditor::Internal::CPPEditorWidget")
editorText = str(editor.plainText)
includeGuard = newClassName.upper().replace(".", "_")
guardCount = 0
if "#pragma once" in editorText:
guardCount += 1
test.passes("Include guard in header file.")
if "#ifndef " + includeGuard in editorText:
guardCount += 1
test.passes("Include guard check in header file.")
test.verify("#define " + includeGuard in editorText,
"Include guard definition in header file.")
test.compare(guardCount, 1, "Either pragma once or conventional include guard present.")
test.verify("class " + newClassName in editorText,
"Class definition in header file?")
test.verify(" " + newClassName + "();" in editorText,
"Ctor declaration in header file?")
test.verify("signals" not in editorText, # QTCREATORBUG-14949
"No signals in non-Qt header file?")
test.verify("slots" not in editorText, # QTCREATORBUG-14949
"No slots in non-Qt header file?")
type(editor, notOverwrittenComment)
type(editor, "<Return>")
invokeMenuItem("File", "Save All")
invokeMenuItem("File", "Close All")
def overwritten(filename):
return notOverwrittenComment not in readFile(os.path.join(basePath, filename))
addCPlusPlusFile(newClassName, "C++ Class", None, False,
newBasePath=basePath, expectedSourceName=sourceFileName,
expectedHeaderName=headerFileName)
test.verify(not waitFor("overwritten(sourceFileName)", 2000),
"Source file should not be overwritten.")
test.verify(not waitFor("overwritten(headerFileName)", 500),
"Header file should not be overwritten.")
addCPlusPlusFile(newClassName, "C++ Class", None, True,
newBasePath=basePath, expectedSourceName=sourceFileName,
expectedHeaderName=headerFileName)
test.verify(waitFor("overwritten(sourceFileName)", 2000),
"Source file should be overwritten.")
test.verify(waitFor("overwritten(headerFileName)", 500),
"Header file should be overwritten.")
invokeMenuItem("File", "Exit")
return