Squish: Add test for generic highlighter and MIME types

Task-number: QTCREATORBUG-12097
Task-number: QTCREATORBUG-12149
Change-Id: Iebb5711c437415bcbb2b3bae72aaa7bc98c34905
Reviewed-by: Robert Loehning <robert.loehning@digia.com>

2 files changed, 221 insertions, 1 deletions

diff --git a/tests/system/suite_editors/suite.conf b/tests/system/suite_editors/suite.conf
index cbb4aed981..b6c5a0fdb3 100644
--- a/tests/system/suite_editors/suite.conf
+++ b/tests/system/suite_editors/suite.conf
@@ -7,6 +7,6 @@ HOOK_SUB_PROCESSES=false
 IMPLICITAUTSTART=0
 LANGUAGE=Python
 OBJECTMAP=../objects.map
-TEST_CASES=tst_basic_cpp_support tst_delete_externally tst_edit_externally tst_memberoperator tst_modify_readonly tst_qml_editor tst_qml_indent tst_rename_macros tst_revert_changes tst_select_all
+TEST_CASES=tst_basic_cpp_support tst_delete_externally tst_edit_externally tst_generic_highlighter tst_memberoperator tst_modify_readonly tst_qml_editor tst_qml_indent tst_rename_macros tst_revert_changes tst_select_all
 VERSION=2
 WRAPPERS=Qt
diff --git a/tests/system/suite_editors/tst_generic_highlighter/test.py b/tests/system/suite_editors/tst_generic_highlighter/test.py
new file mode 100644
index 0000000000..5c4c235889
--- /dev/null
+++ b/tests/system/suite_editors/tst_generic_highlighter/test.py
@@ -0,0 +1,220 @@
+#############################################################################
+##
+## Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+## Contact: http://www.qt-project.org/legal
+##
+## This file is part of Qt Creator.
+##
+## 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 Digia.  For licensing terms and
+## conditions see http://qt.digia.com/licensing.  For further information
+## use the contact form at http://qt.digia.com/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 as published by the Free Software
+## Foundation and appearing in the file LICENSE.LGPL included in the
+## packaging of this file.  Please review the following information to
+## ensure the GNU Lesser General Public License version 2.1 requirements
+## will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+##
+## In addition, as a special exception, Digia gives you certain additional
+## rights.  These rights are described in the Digia Qt LGPL Exception
+## version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+##
+#############################################################################
+
+source("../../shared/qtcreator.py")
+
+def createFile(folder, filename):
+    __createProjectOrFileSelectType__("  General", "Text File", isProject = False)
+    replaceEditorContent(waitForObject("{name='nameLineEdit' visible='1' "
+                                       "type='Utils::FileNameValidatingLineEdit'}"), filename)
+    replaceEditorContent(waitForObject("{type='Utils::FancyLineEdit' unnamed='1' visible='1' "
+                                       "window=':New Text File_Utils::FileWizardDialog'}"), folder)
+    clickButton(waitForObject(":Next_QPushButton"))
+    __createProjectHandleLastPage__()
+
+def clickTableGetPatternLineEdit(table, row):
+    clickItem(table, "%d/0" % row, 5, 5, 0, Qt.LeftButton)
+    return waitForObject("{name='patternsLineEdit' type='QLineEdit' visible='1'}")
+
+def getOrModifyFilePatternsFor(mimeType, filter='', toBePresent=None):
+    toSuffixArray = lambda x : [pat.replace("*", "") for pat in x.split(";")]
+
+    result = []
+    invokeMenuItem("Tools", "Options...")
+    waitForObjectItem(":Options_QListView", "Environment")
+    clickItem(":Options_QListView", "Environment", 14, 15, 0, Qt.LeftButton)
+    waitForObject("{container=':Options.qt_tabwidget_tabbar_QTabBar' type='TabItem' "
+                  "text='MIME Types'}")
+    clickOnTab(":Options.qt_tabwidget_tabbar_QTabBar", "MIME Types")
+    replaceEditorContent(waitForObject("{name='filterLineEdit' type='QLineEdit' visible='1'}"),
+                         filter)
+    mimeTypeTable = waitForObject("{name='mimeTypesTableView' type='QTableView' visible='1'}")
+    model = mimeTypeTable.model()
+    if filter == '':
+        for row in range(model.rowCount()):
+            if str(model.data(model.index(row, 0)).toString()) == mimeType:
+                result = toSuffixArray(str(clickTableGetPatternLineEdit(mimeTypeTable, row).text))
+                break
+        clickButton(":Options.Cancel_QPushButton")
+        if result == ['']:
+            test.warning("MIME type '%s' seems to have no file patterns." % mimeType)
+        return result
+    waitFor('model.rowCount() == 1', 2000)
+    if model.rowCount() == 1:
+        patternsLineEd = clickTableGetPatternLineEdit(mimeTypeTable, 0)
+        patterns = str(patternsLineEd.text)
+        if toBePresent:
+            actualSuffixes = toSuffixArray(patterns)
+            toBeAddedSet = set(toBePresent).difference(set(actualSuffixes))
+            if toBeAddedSet:
+                patterns += ";*" + ";*".join(toBeAddedSet)
+                replaceEditorContent(patternsLineEd, patterns)
+                clickButton(":Options.OK_QPushButton")
+                try:
+                    mBox = waitForObject("{type='QMessageBox' unnamed='1' visible='1' "
+                                         "text?='Conflicting pattern*'}", 2000)
+                    conflictingSet = set(str(mBox.detailedText).replace("*", "").splitlines())
+                    sendEvent("QCloseEvent", mBox)
+                    if toBeAddedSet.intersection(conflictingSet):
+                        test.fatal("At least one of the patterns to be added is already in use "
+                                   "for another MIME type.",
+                                   "Conflicting patterns: %s" % str(conflictingSet))
+                    if conflictingSet.difference(toBeAddedSet):
+                        test.fail("MIME type handling failed. (QTCREATORBUG-12149?)",
+                                  "Conflicting patterns: %s" % str(conflictingSet))
+                        # re-check the patterns
+                        result = getOrModifyFilePatternsFor(mimeType)
+                except:
+                    result = toSuffixArray(patterns)
+                    test.passes("Added suffixes")
+                return result
+        else:
+            result = toSuffixArray(patterns)
+    elif model.rowCount() > 1:
+        test.warning("MIME type '%s' has ambiguous results." % mimeType)
+    else:
+        test.log("MIME type '%s' seems to be unknown to the system." % mimeType)
+    clickButton(":Options.Cancel_QPushButton")
+    return result
+
+def uncheckGenericHighlighterFallback():
+    invokeMenuItem("Tools", "Options...")
+    waitForObjectItem(":Options_QListView", "Text Editor")
+    clickItem(":Options_QListView", "Text Editor", 14, 15, 0, Qt.LeftButton)
+    waitForObject("{container=':Options.qt_tabwidget_tabbar_QTabBar' type='TabItem' "
+                  "text='Generic Highlighter'}")
+    clickOnTab(":Options.qt_tabwidget_tabbar_QTabBar", "Generic Highlighter")
+    ensureChecked("{name='useFallbackLocation' text='Use fallback location' type='QCheckBox' "
+                  "visible='1'}", False)
+    clickButton(":Options.OK_QPushButton")
+
+def addHighlighterDefinition(language):
+    global tmpSettingsDir
+    test.log("Adding highlighter definitions for '%s'." % language)
+    invokeMenuItem("Tools", "Options...")
+    waitForObjectItem(":Options_QListView", "Text Editor")
+    clickItem(":Options_QListView", "Text Editor", 14, 15, 0, Qt.LeftButton)
+    waitForObject("{container=':Options.qt_tabwidget_tabbar_QTabBar' type='TabItem' "
+                  "text='Generic Highlighter'}")
+    clickOnTab(":Options.qt_tabwidget_tabbar_QTabBar", "Generic Highlighter")
+    clickButton("{text='Download Definitions...' type='QPushButton' unnamed='1' visible='1'}")
+    table = waitForObject("{name='definitionsTable' type='QTableWidget' visible='1'}")
+    model = table.model()
+    for row in range(model.rowCount()):
+        if str(model.data(model.index(row, 0)).toString()) == language:
+            clickItem(table, "%d/0" % row, 5, 5, 0, Qt.LeftButton)
+            clickButton("{name='downloadButton' text='Download Selected Definitions' "
+                        "type='QPushButton' visible='1'}")
+            # downloading happens asynchronously
+            languageFile = os.path.join(tmpSettingsDir, "QtProject", "qtcreator",
+                                        "generic-highlighter", "%s.xml" % language.lower())
+            test.verify(waitFor("os.path.exists(languageFile)", 10000),
+                        "Verifying whether file has been downloaded and placed to settings.")
+            clickButton("{text='Download Definitions...' type='QPushButton' unnamed='1' "
+                        "visible='1'}")
+            table = waitForObject("{name='definitionsTable' type='QTableWidget' visible='1'}")
+            model = table.model()
+            test.verify(str(model.data(model.index(row, 1))) != "",
+                        "Verifying a definition has been downloaded.")
+            clickButton("{text='Close' type='QPushButton' unnamed='1' visible='1'}")
+            clickButton(":Options.OK_QPushButton")
+            return True
+    test.fail("Could not find the specified language (%s) to download a highlighter definition"
+              % language)
+    clickButton("{text='Close' type='QPushButton' unnamed='1' visible='1'}")
+    clickButton(":Options.OK_QPushButton")
+    return False
+
+def hasSuffix(fileName, suffixPatterns):
+    for suffix in suffixPatterns:
+        if fileName.endswith(suffix):
+            return True
+    return False
+
+def main():
+    miss = "A highlight definition was not found for this file. Would you like to try to find one?"
+    startApplication("qtcreator" + SettingsPath)
+    if not startedWithoutPluginError():
+        return
+    uncheckGenericHighlighterFallback()
+    patterns = getOrModifyFilePatternsFor("text/x-haskell", "haskell")
+    folder = tempDir()
+    filesToTest = ["Main.lhs", "Main.hs"]
+    code = ['module Main where', '', 'main :: IO ()', '', 'main = putStrLn "Hello World!"']
+
+    mainWindow = waitForObject(':Qt Creator_Core::Internal::MainWindow')
+    for current in filesToTest:
+        createFile(folder, current)
+        editor = getEditorForFileSuffix(current)
+        test.verify(waitFor("current in str(mainWindow.windowTitle)", 5000),
+                    "Window title changed to current file.")
+        expectHint = hasSuffix(current, patterns)
+        mssg = "Verifying whether hint for missing highlight definition is present. (expected: %s)"
+        try:
+            waitForObject("{text='%s' type='QLabel' unnamed='1' visible='1' "
+                          "window=':Qt Creator_Core::Internal::MainWindow'}" % miss, 2000)
+            test.verify(expectHint, mssg % str(expectHint))
+        except:
+            test.verify(not expectHint, mssg % str(expectHint))
+        # literate haskell: first character must be '>' otherwise it's a comment
+        if current.endswith(".lhs"):
+            typeLines(editor, [">" + line for line in code])
+        else:
+            typeLines(editor, code)
+
+    invokeMenuItem("File", "Save All")
+    invokeMenuItem("File", "Close All")
+    addedHighlighterDefinition = addHighlighterDefinition("Haskell")
+    patterns = getOrModifyFilePatternsFor('text/x-haskell', 'haskell', ['.lhs', '.hs'])
+
+    home = os.path.expanduser("~")
+    for current in filesToTest:
+        recentFile = os.path.join(folder, current)
+        if recentFile.startswith(home) and platform.system() in ('Linux', 'Darwin'):
+            recentFile = recentFile.replace(home, "~", 1)
+        invokeMenuItem("File", "Recent Files", recentFile)
+        editor = getEditorForFileSuffix(current)
+        try:
+            waitForObject("{text='%s' type='QLabel' unnamed='1' visible='1' "
+                          "window=':Qt Creator_Core::Internal::MainWindow'}" % miss, 2000)
+            test.verify(not addedHighlighterDefinition and hasSuffix(current, patterns),
+                        "Hint for missing highlight definition was present.")
+        except:
+            test.verify(addedHighlighterDefinition or not hasSuffix(current, patterns),
+                        "Hint for missing highlight definition is not shown.")
+        placeCursorToLine(editor, '.*%s' % code[-1], True)
+        for _ in range(23):
+            type(editor, "<Left>")
+        type(editor, "<Return>")
+        if current.endswith(".lhs"):
+            type(editor, ">")
+        type(editor, "<Tab>")
+
+    invokeMenuItem("File", "Save All")
+    invokeMenuItem("File", "Exit")