Fix up issues with parsing Route XML in Nokia plugin

This fixes some long-standing issues with route XML parsing in the
Nokia plugin, as well as adding a new autotest to verify that these
and other faults do not develop again in future.

The faulty logic in this case was to attempt to handle the final
maneuver in the route in the same manner as a link-less intermediate
point, which alternately caused the final maneuver to either be
dropped or a subsequent "empty" maneuver to be generated with the
remaining links at the end. The final maneuver is now handled
separately.

Task-number: QTBUG-24341
Task-number: QTBUG-20563
Change-Id: Iefc37c84170d23b4c4a9203f12f33994c7fa4a88
Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>

1 files changed, 167 insertions, 0 deletions

diff --git a/tests/auto/qgeoroutexmlparser/tst_qgeoroutexmlparser.cpp b/tests/auto/qgeoroutexmlparser/tst_qgeoroutexmlparser.cpp
new file mode 100644
index 00000000..8fa4f21d
--- /dev/null
+++ b/tests/auto/qgeoroutexmlparser/tst_qgeoroutexmlparser.cpp
@@ -0,0 +1,167 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <qgeoroutexmlparser.h>
+#include <qgeocoordinate.h>
+#include <qtest.h>
+
+#include <QMetaType>
+#include <QDebug>
+#include <QFile>
+
+QT_USE_NAMESPACE
+
+class tst_QGeoRouteXmlParser : public QObject
+{
+    Q_OBJECT
+
+public:
+    tst_QGeoRouteXmlParser()
+        : start(0.0, 0.0),
+          end(1.0, 1.0)
+    {}
+
+private:
+    // dummy values for creating the request object
+    QGeoCoordinate start;
+    QGeoCoordinate end;
+
+private slots:
+    void test_realData1()
+    {
+        QFile f(":/route1.xml");
+        if (!f.open(QIODevice::ReadOnly))
+            QFAIL("could not open route1.xml");
+
+        QGeoRouteRequest req(start, end);
+        QGeoRouteXmlParser xp(req);
+
+        QVERIFY(xp.parse(&f));
+
+        // xml contains exactly 1 route
+        QList<QGeoRoute> results = xp.results();
+        QCOMPARE(results.size(), 1);
+        QGeoRoute route = results.first();
+
+        QList<QGeoRouteSegment> segments;
+        // get all the segments on the route
+        segments << route.firstRouteSegment();
+        while (segments.last().isValid())
+            segments << segments.last().nextRouteSegment();
+
+        // should be 9 segments in the list (last one invalid)
+        QCOMPARE(segments.size(), 9);
+
+        // check the first maneuver is correct
+        QGeoManeuver first = segments.at(0).maneuver();
+        QCOMPARE(first.instructionText(), QLatin1String("Head toward Logan Rd (95) on Padstow Rd (56). Go for 0.3 miles."));
+        QCOMPARE(first.position(), QGeoCoordinate(-27.5752144, 153.0879669));
+
+        QEXPECT_FAIL("", "Maneuver timeToNextInstruction is not populated", Continue);
+        QCOMPARE(first.timeToNextInstruction(), 24);
+        QCOMPARE(first.distanceToNextInstruction(), 403.0);
+
+        // check the last two maneuvers -- route1.xml has a directionless final maneuver
+        QGeoManeuver secondLast = segments.at(6).maneuver();
+        QVERIFY(secondLast.instructionText().contains("Turn right onto Bartley St"));
+        QCOMPARE(secondLast.position(), QGeoCoordinate(-27.4655991, 153.0231628));
+        QCOMPARE(secondLast.distanceToNextInstruction(), 181.0);
+        QEXPECT_FAIL("", "Maneuver timeToNextInstruction is not populated", Continue);
+        QCOMPARE(secondLast.timeToNextInstruction(), 41);
+
+        QGeoManeuver last = segments.at(7).maneuver();
+        QVERIFY(last.instructionText().contains("Arrive at Bartley St"));
+        QCOMPARE(last.position(), QGeoCoordinate(-27.4650097, 153.0230255));
+        QCOMPARE(last.distanceToNextInstruction(), 0.0);
+        QCOMPARE(last.timeToNextInstruction(), 0);
+    }
+
+    void test_realData2()
+    {
+        QFile f(":/route2.xml");
+        if (!f.open(QIODevice::ReadOnly))
+            QFAIL("could not open route2.xml");
+
+        QGeoRouteRequest req(start, end);
+        QGeoRouteXmlParser xp(req);
+
+        QVERIFY(xp.parse(&f));
+
+        // xml contains exactly 1 route
+        QList<QGeoRoute> results = xp.results();
+        QCOMPARE(results.size(), 1);
+        QGeoRoute route = results.first();
+
+        QList<QGeoRouteSegment> segments;
+        // get all the segments on the route
+        segments << route.firstRouteSegment();
+        while (segments.last().isValid())
+            segments << segments.last().nextRouteSegment();
+
+        // should be 14 segments in the list (last one invalid)
+        QCOMPARE(segments.size(), 14);
+
+        QCOMPARE(route.path().size(), 284);
+        QCOMPARE(route.path().at(57), QGeoCoordinate(-27.5530605, 153.0691223));
+        QCOMPARE(route.path().at(283), QGeoCoordinate(-27.4622307, 153.0397949));
+
+        QVERIFY(segments.at(0).maneuver().instructionText().contains("Head toward Electronics St"));
+        QCOMPARE(segments.at(0).maneuver().direction(), QGeoManeuver::DirectionForward);
+        QVERIFY(segments.at(1).maneuver().instructionText().contains("Turn left onto Miles Platting"));
+        QCOMPARE(segments.at(1).maneuver().direction(), QGeoManeuver::DirectionLeft);
+        QVERIFY(segments.at(2).maneuver().instructionText().contains("Turn right onto Logan Rd"));
+        QCOMPARE(segments.at(2).maneuver().direction(), QGeoManeuver::DirectionRight);
+        QVERIFY(segments.at(3).maneuver().instructionText().contains("Take exit #14/M3/City"));
+        QCOMPARE(segments.at(3).maneuver().direction(), QGeoManeuver::DirectionLightLeft);
+        QVERIFY(segments.at(4).maneuver().instructionText().contains("Take exit #2/41"));
+        QCOMPARE(segments.at(4).maneuver().direction(), QGeoManeuver::DirectionLightLeft);
+        QVERIFY(segments.at(5).maneuver().instructionText().contains("Turn right onto Allen St"));
+        QCOMPARE(segments.at(5).maneuver().direction(), QGeoManeuver::DirectionRight);
+        QVERIFY(segments.at(6).maneuver().instructionText().contains("Bear right to stay on"));
+        QCOMPARE(segments.at(6).maneuver().direction(), QGeoManeuver::DirectionLightRight);
+        QVERIFY(segments.at(7).maneuver().instructionText().contains("Bear right onto Vulture St"));
+        QCOMPARE(segments.at(7).maneuver().direction(), QGeoManeuver::DirectionLightRight);
+    }
+};
+
+QTEST_GUILESS_MAIN(tst_QGeoRouteXmlParser)
+#include "tst_qgeoroutexmlparser.moc"
+