QTestLib: Disable window state restore on macOS

For test runs we want to start with a clean slate
and ignore previously saved window state.

This also prevents the “previous restore failed” dialog
from from showing and blocking the test run.

Change-Id: I8e5b87a903cf1d937d628c2b062f917c4c37f176
Reviewed-by: Morten Johan Sørvig <morten.sorvig@qt.io>

4 files changed, 124 insertions, 1 deletions

diff --git a/src/testlib/qtestcase.cpp b/src/testlib/qtestcase.cpp
index fe680e19aa..876c573196 100644
--- a/src/testlib/qtestcase.cpp
+++ b/src/testlib/qtestcase.cpp
@@ -65,6 +65,9 @@
 #if defined(HAVE_XCTEST)
 #include <QtTest/private/qxctestlogger_p.h>
 #endif
+#if defined Q_OS_MACOS
+#include <QtTest/private/qtestutil_macos_p.h>
+#endif
 
 #include <numeric>
 #include <algorithm>
@@ -2915,6 +2918,9 @@ int QTest::qExec(QObject *testObject, int argc, char **argv)
 #if defined(Q_OS_MACX)
     bool macNeedsActivate = qApp && (qstrcmp(qApp->metaObject()->className(), "QApplication") == 0);
     IOPMAssertionID powerID;
+
+    // Don't restore saved window state for auto tests.
+    QTestPrivate::disableWindowRestore();
 #endif
 #ifndef QT_NO_EXCEPTIONS
     try {
diff --git a/src/testlib/qtestutil_macos.mm b/src/testlib/qtestutil_macos.mm
new file mode 100644
index 0000000000..852c9f75f2
--- /dev/null
+++ b/src/testlib/qtestutil_macos.mm
@@ -0,0 +1,53 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtTest 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$
+**
+****************************************************************************/
+
+#include "qtestutil_macos_p.h"
+
+#import <AppKit/AppKit.h>
+
+QT_BEGIN_NAMESPACE
+
+namespace QTestPrivate {
+
+    /*! \internal
+
+        Disables restoration of previously saved window state. This causes tests
+        to start with a clean slate and prevents the "previous restore failed"
+        dialog from showing if there was a test crash.
+    */
+    void disableWindowRestore() {
+        [[NSUserDefaults standardUserDefaults] setBool:YES forKey:@"ApplePersistenceIgnoreState"];
+    }
+}
+
+QT_END_NAMESPACE
diff --git a/src/testlib/qtestutil_macos_p.h b/src/testlib/qtestutil_macos_p.h
new file mode 100644
index 0000000000..85f9ace82f
--- /dev/null
+++ b/src/testlib/qtestutil_macos_p.h
@@ -0,0 +1,59 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtTest 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$
+**
+****************************************************************************/
+
+#ifndef QTESTUTIL_MACOS_H
+#define QTESTUTIL_MACOS_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <qglobal.h>
+#import <objc/objc.h>
+
+QT_BEGIN_NAMESPACE
+
+namespace QTestPrivate {
+    void disableWindowRestore();
+}
+
+QT_END_NAMESPACE
+
+#endif
diff --git a/src/testlib/testlib.pro b/src/testlib/testlib.pro
index ff4379f85d..3f16a0ec46 100644
--- a/src/testlib/testlib.pro
+++ b/src/testlib/testlib.pro
@@ -75,7 +75,12 @@ wince: LIBS += \
 
 mac {
     LIBS += -framework Security
-    osx: LIBS += -framework ApplicationServices -framework IOKit
+
+    macos {
+        HEADERS += qtestutil_macos_p.h
+        OBJECTIVE_SOURCES += qtestutil_macos.mm
+        LIBS += -framework Foundation -framework ApplicationServices -framework IOKit
+    }
 
     # XCTest support
     !lessThan(QMAKE_XCODE_VERSION, "6.0") {