File 0006-Separate-ktranscript-plugin-test-into-its-... of Package ki18n

Overview Repositories Revisions Requests Users Attributes Meta

File 0006-Separate-ktranscript-plugin-test-into-its-own-autote.patch of Package ki18n (Revision 9c0caec4e5128ca53acd9b3566b455c2)

Currently displaying revision 9c0caec4e5128ca53acd9b3566b455c2 , Show latest

From a51fb0f278f0d58378b90270f242ea96575bc55a Mon Sep 17 00:00:00 2001
From: Kevin Krammer <krammer@kde.org>
Date: Fri, 21 Feb 2014 17:02:15 +0100
Subject: [PATCH 6/7] Separate ktranscript plugin test into its own autotest

The plugin based test of KTranscript performs all tests with a single
instance of KTranscriptImp because the plugin uses Q_GLOBAL_STATIC
to create and access that instance.

The non-plugin test creates a new instance for every test.

Currently all scripting tests are runnable in both situations, but the
non-plugin test allows for tests that need a "clean slate".

REVIEW: 115936
---
 autotests/CMakeLists.txt           | 10 ++++
 autotests/ktranscriptcleantest.cpp | 99 ++++++++++++++++++++++++++++++++++++++
 autotests/ktranscriptcleantest.h   | 60 +++++++++++++++++++++++
 autotests/ktranscripttest.cpp      | 13 +----
 autotests/ktranscripttest.h        | 14 +++++-
 src/ktranscript.cpp                | 28 +++++++++++
 src/ktranscript_p.h                |  5 ++
 7 files changed, 215 insertions(+), 14 deletions(-)
 create mode 100644 autotests/ktranscriptcleantest.cpp
 create mode 100644 autotests/ktranscriptcleantest.h

diff --git a/autotests/CMakeLists.txt b/autotests/CMakeLists.txt
index eb73d21..c4d6b9b 100644
--- a/autotests/CMakeLists.txt
+++ b/autotests/CMakeLists.txt
@@ -23,5 +23,15 @@ ki18n_unit_tests(
 # installed.
 target_compile_definitions(ktranscripttest PRIVATE "KTRANSCRIPT_PATH=\"$<TARGET_FILE:ktranscript>\"")
 
+# klocalizedstringtest needs some additional libraries
 target_include_directories(klocalizedstringtest PRIVATE ${LibIntl_INCLUDE_DIRS})
 target_link_libraries(klocalizedstringtest ${LibIntl_LIBRARIES})
+
+# ktranscriptcleantest needs to directly compile ktranscript.cpp with an addition DEFINE
+
+add_executable(ktranscriptcleantest ktranscriptcleantest.cpp ../src/ktranscript.cpp ../src/common_helpers.cpp)
+target_compile_definitions(ktranscriptcleantest PRIVATE "KTRANSCRIPT_TESTBUILD")
+target_link_libraries(ktranscriptcleantest KF5::JS Qt5::Test Qt5::Concurrent KF5::I18n)
+target_include_directories(ktranscriptcleantest PRIVATE ..)
+add_test(ki18n-ktranscriptcleantest ktranscriptcleantest)
+ecm_mark_as_test(ktranscriptcleantest)
diff --git a/autotests/ktranscriptcleantest.cpp b/autotests/ktranscriptcleantest.cpp
new file mode 100644
index 0000000..851903f
--- /dev/null
+++ b/autotests/ktranscriptcleantest.cpp
@@ -0,0 +1,99 @@
+/*
+Copyright 2014 Kevin Krammer <krammer@kde.org>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) version 3, or any
+later version accepted by the membership of KDE e.V. (or its
+successor approved by the membership of KDE e.V.), which shall
+act as a proxy defined in Section 6 of version 3 of the license.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include <ktranscriptcleantest.h>
+
+#include <QtTest/QtTest>
+
+#include <QDebug>
+
+#include <ktranscript_p.h>
+
+QTEST_MAIN(KTranscriptCleanTest)
+
+KTranscriptCleanTest::KTranscriptCleanTest()
+    : m_transcript(0)
+{
+}
+
+void KTranscriptCleanTest::init()
+{
+    m_transcript = autotestCreateKTranscriptImp();
+}
+
+void KTranscriptCleanTest::cleanup()
+{
+    autotestDestroyKTranscriptImp();
+    m_transcript = 0;
+}
+
+void KTranscriptCleanTest::test_data()
+{
+    QTest::addColumn<QVariantList>("argv");
+    QTest::addColumn<bool>("fallsBack");
+    QTest::addColumn<QString>("expected");
+
+    // Example test case, replace with first clean-slate test
+    QTest::newRow("test_basic")
+        << (QVariantList() << "test_basic" << "foo")
+        << false
+        << "foo bar";
+}
+
+void KTranscriptCleanTest::test()
+{
+    QFETCH(QVariantList, argv);
+    QFETCH(bool, fallsBack);
+    QFETCH(QString, expected);
+
+    QString language = "fr";
+    QString country = "fr";
+    QString msgctxt = "a-context";
+    QHash<QString, QString> dynamicContext;
+    dynamicContext.insert("origin", "neverwhere");
+    QString msgid = "source-text";
+    QStringList subs;
+    subs << "10" << "qwyx";
+    QList<QVariant> values;
+    values << 10 << "qwyx";
+    QString ordinaryTranslation = "translated-text";
+
+    QString testJs = QFINDTESTDATA("test.js");
+    QList<QStringList> modules;
+    modules << (QStringList() << testJs << language);
+
+    QString error;
+    bool fallback;
+    QString result = m_transcript->eval(
+                         argv, language, country,
+                         msgctxt, dynamicContext, msgid,
+                         subs, values, ordinaryTranslation,
+                         modules, error, fallback);
+
+    if (!error.isEmpty()) {
+        QFAIL(qPrintable(error));
+    }
+    if (!fallsBack) {
+        QVERIFY(!fallback);
+        QCOMPARE(result, expected);
+    } else {
+        QVERIFY(fallback);
+    }
+}
diff --git a/autotests/ktranscriptcleantest.h b/autotests/ktranscriptcleantest.h
new file mode 100644
index 0000000..22e466e
--- /dev/null
+++ b/autotests/ktranscriptcleantest.h
@@ -0,0 +1,60 @@
+/*
+Copyright 2014 Kevin Krammer <krammer@kde.org>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) version 3, or any
+later version accepted by the membership of KDE e.V. (or its
+successor approved by the membership of KDE e.V.), which shall
+act as a proxy defined in Section 6 of version 3 of the license.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef KTRANSCRIPTCLEANTEST_H
+#define KTRANSCRIPTCLEANTEST_H
+
+#include <QLibrary>
+#include <QObject>
+
+class KTranscript;
+
+/**
+ * @brief Test the KTranscript implementation class
+ *
+ * Runs tests on the KTranscriptImp scripting facility.
+ *
+ * The main difference to the test ktranscripttest is that it
+ * creates a new instance of KTranscriptImp for each test while
+ * the main test re-uses one instance due to internal use of
+ * Q_GLOBAL_STATIC
+ *
+ * Test that require a "clean slate" can be added here, tests that do not
+ * should be added to both.
+ */
+class KTranscriptCleanTest : public QObject
+{
+    Q_OBJECT
+public:
+    KTranscriptCleanTest();
+
+private Q_SLOTS:
+    void init();
+    void cleanup();
+
+    void test_data();
+    void test();
+
+private:
+    QLibrary m_library;
+    KTranscript *m_transcript;
+};
+
+#endif /* KTRANSCRIPTCLEANTEST_H */
diff --git a/autotests/ktranscripttest.cpp b/autotests/ktranscripttest.cpp
index 78aecb4..e3a27ff 100644
--- a/autotests/ktranscripttest.cpp
+++ b/autotests/ktranscripttest.cpp
@@ -17,7 +17,7 @@ Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser General Public
 License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */
-#include <ktranscripttest.h>
+#include "ktranscripttest.h"
 
 #include <QtTest/QtTest>
 
@@ -43,10 +43,7 @@ void KTranscriptTest::initTestCase()
     QVERIFY2(QFile::exists(pluginPath), "Could not find ktranscript plugin");
 
     m_library.setFileName(pluginPath);
-}
 
-void KTranscriptTest::init()
-{
     QVERIFY(m_library.load());
     InitFunc initf = (InitFunc) m_library.resolve("load_transcript");
     QVERIFY(initf);
@@ -54,14 +51,6 @@ void KTranscriptTest::init()
     QVERIFY(m_transcript);
 }
 
-void KTranscriptTest::cleanup()
-{
-    // load_transcript() returns a Q_GLOBAL_STATIC instance. The only way to
-    // ensure we get a new instance is to unload the library.
-    QVERIFY(m_library.unload());
-    m_transcript = 0;
-}
-
 void KTranscriptTest::test_data()
 {
     QTest::addColumn<QVariantList>("argv");
diff --git a/autotests/ktranscripttest.h b/autotests/ktranscripttest.h
index 53f3ce0..7ea7818 100644
--- a/autotests/ktranscripttest.h
+++ b/autotests/ktranscripttest.h
@@ -25,6 +25,18 @@ License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
 class KTranscript;
 
+/**
+ * @brief Test the KTranscript plugin
+ *
+ * Loads the KTranscript plugin and runs tests on its scripting capabilities.
+ *
+ * The main difference to the test ktranscriptcleantest is that it does so using
+ * a single instance of the KTranscript implementation due to the plugin
+ * using Q_GLOBAL_STATIC
+ *
+ * ktranscriptcleantest on the other hand creates and destroys the instance between
+ * tests. Test that require a "clean slate" can be added there.
+ */
 class KTranscriptTest : public QObject
 {
     Q_OBJECT
@@ -33,8 +45,6 @@ public:
 
 private Q_SLOTS:
     void initTestCase();
-    void init();
-    void cleanup();
 
     void test_data();
     void test();
diff --git a/src/ktranscript.cpp b/src/ktranscript.cpp
index c922e91..b9e0551 100644
--- a/src/ktranscript.cpp
+++ b/src/ktranscript.cpp
@@ -451,6 +451,33 @@ TsConfig readConfig(const QString &fname)
     return config;
 }
 
+#ifdef KTRANSCRIPT_TESTBUILD
+
+// ----------------------------------------------------------------------
+// Test build creation/destruction hooks
+static KTranscriptImp *s_transcriptInstance = 0;
+
+KTranscriptImp *globalKTI()
+{
+    return s_transcriptInstance;
+}
+
+KTranscript *autotestCreateKTranscriptImp()
+{
+    Q_ASSERT(s_transcriptInstance == 0);
+    s_transcriptInstance = new KTranscriptImp;
+    return s_transcriptInstance;
+}
+
+void autotestDestroyKTranscriptImp()
+{
+    Q_ASSERT(s_transcriptInstance != 0);
+    delete s_transcriptInstance;
+    s_transcriptInstance = 0;
+}
+
+#else
+
 // ----------------------------------------------------------------------
 // Dynamic loading.
 Q_GLOBAL_STATIC(KTranscriptImp, globalKTI)
@@ -461,6 +488,7 @@ extern "C"
         return globalKTI();
     }
 }
+#endif
 
 // ----------------------------------------------------------------------
 // KTranscript definitions.
diff --git a/src/ktranscript_p.h b/src/ktranscript_p.h
index f1cc132..cfbf2dc 100644
--- a/src/ktranscript_p.h
+++ b/src/ktranscript_p.h
@@ -87,4 +87,9 @@ public:
     virtual ~KTranscript() {}
 };
 
+#ifdef KTRANSCRIPT_TESTBUILD
+KTranscript *autotestCreateKTranscriptImp();
+void autotestDestroyKTranscriptImp();
+#endif
+
 #endif
-- 
1.8.5.2

Places

File 0006-Separate-ktranscript-plugin-test-into-its-own-autote.patch of Package ki18n (Revision 9c0caec4e5128ca53acd9b3566b455c2)

Places