Differential D12197 Diff 32559 autotests/multivaluetest.cpp

Changeset View

Standalone View

View Options

autotests/multivaluetest.cpp

  • This file was added.
1​/*
2​ * This file is part of the KFileMetaData project
3​ * Copyright (C) 2018 Michael Heidelbach <ottwolt@gmail.com>
4​ *
5​ * This program is free software; you can redistribute it and/or modify
6​ * it under the terms of the GNU General Public License as published by
7​ * the Free Software Foundation; either version 2 of the License, or
8​ * (at your option) any later version.
9​ *
10​ * This program is distributed in the hope that it will be useful,
11​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
12​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13​ * GNU General Public License for more details.
14​ *
15​ * You should have received a copy of the GNU General Public License along
16​ * with this program; if not, write to the Free Software Foundation, Inc.,
17​ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18​ */
19​
20​#include "multivaluetest.h"
21​#include "indexerextractortestsconfig.h"
22​#include "simpleextractionresult.h"
23​#include "propertyinfo.h"
24​#include "extractorcollection.h"
25​
26​#include "indexerextractortestsconfig.h"
27​#include "extractors/epubextractor.h"
28​#include "extractors/odfextractor.h"
29​
30​#include <QtTest>
31​QTEST_GUILESS_MAIN(MultiValueTest)
32​Q_DECLARE_METATYPE(KFileMetaData::Property::Property)
33​Q_DECLARE_METATYPE(QVariant::Type)
34​
35​using namespace KFileMetaData;
36​
37​void MultiValueTest::testKeywords_data()
38​{
39​
40​ QTest::addColumn<QString>("filePath");
41​ QTest::addColumn<QString>("mimeType");
42​ QTest::addColumn<Property::Property>("extractedProperty");
43​ QTest::addColumn<QVariantList>("expectedResult");
44​ QTest::addColumn<QString>("failmessage");
45​
46​ const QVariantList expectedResult{
47​ QVariant(QStringLiteral("Keyword 3")),
48​ QVariant(QStringLiteral("Keyword 2")),
49​ QVariant(QStringLiteral("Keyword 1")),
50​ };
51​
52​ QTest::newRow("odt")
53​ << QFINDTESTDATA("samplefiles/multi/test.odt")
54​ << QStringLiteral("application/vnd.oasis.opendocument.text")
55​ << Property::Keywords
56​ << expectedResult
57​ << QString()
58​ ;
59​
60​ QTest::newRow("docx")
61​ << QFINDTESTDATA("samplefiles/multi/test.odp")
62​ << QStringLiteral("application/vnd.oasis.opendocument.presentation")
63​ << Property::Keywords
64​ << expectedResult
65​ << QString()
66​ ;
67​
68​ QTest::newRow("pdf")
69​ << QFINDTESTDATA("samplefiles/multi/test.pdf")
70​ << QStringLiteral("application/pdf")
71​ << Property::Keywords
72​ << expectedResult
73​ << QStringLiteral("Fails for unknow reason")
74​ ;
75​
76​ QTest::newRow("docx")
77​ << QFINDTESTDATA("samplefiles/multi/test_libreoffice.docx")
78​ << QStringLiteral("application/vnd.openxmlformats-officedocument.wordprocessingml.document")
79​ << Property::Keywords
80​ << expectedResult
81​ << QStringLiteral("Keywords should be split with ', '")
82​ ;
83​
84​ // Provide Property::Subject only when there is exactly one dc:subject
85​ QTest::newRow("epub/1 subject")
86​ << QFINDTESTDATA("samplefiles/test.epub")
87​ << QStringLiteral("application/epub+zip")
michaelhAuthorUnsubmitted
Not Done

The following behaviours need to be discussed. They are just suggestions.

michaelh: The following behaviours need to be discussed. They are just suggestions.
88​ << Property::Subject
89​ << QVariantList{QStringLiteral("Baloo KFileMetaData")}
90​ << QString()
91​ ;
brunsUnsubmitted
Done

Here you use the property value directly, while in other places you use the property variable - I think using the value directly is much easier to read.

bruns: Here you use the property value directly, while in other places you use the `property` variable…
92​
brunsUnsubmitted
Not Done

Again, I prefer this notation versus expectedresult
You can make this somewhat shorter by using QVariantList{QStringLiteral{"Baloo KFileMetaData"}}, i.e. omit the extra QVariant

bruns: Again, I prefer this notation versus `expectedresult` You can make this somewhat shorter by…
michaelhAuthorUnsubmitted
Not Done

I want defend expectedresult a little. The background: testXXX_data functions tend to be very long and it is easy (for me) to get confused about what is tested against which value. expectedresult tries to make clear that it is always the same value.
If you can't/don't agree with that. I'll follow your lead :-)

michaelh: I want defend `expectedresult` a little. The background: `testXXX_data` functions tend to be…
93​ QTest::newRow("epub/subjects")
94​ << QFINDTESTDATA("samplefiles/multi/test.epub")
95​ << QStringLiteral("application/epub+zip")
96​ << Property::Subject
97​ << QVariantList{}
98​ << QStringLiteral("Subject should not be valid when there is more than one")
99​ ;
100​ // Always provide Property::Keywords
101​ QTest::newRow("epub/1 keyword")
102​ << QFINDTESTDATA("samplefiles/test.epub")
103​ << QStringLiteral("application/epub+zip")
104​ << Property::Keywords
105​ << QVariantList{QStringLiteral("Baloo KFileMetaData")}
106​ << QStringLiteral("keywords not implemented")
107​ ;
108​
109​ QTest::newRow("epub/keywords")
110​ << QFINDTESTDATA("samplefiles/multi/test.epub")
111​ << QStringLiteral("application/epub+zip")
112​ << Property::Keywords
113​ << expectedResult
114​ << QStringLiteral("keywords not implemented")
115​ ;
116​
117​
118​}
119​
120​void MultiValueTest::testKeywords()
121​{
122​ QFETCH(QString, filePath);
123​ QFETCH(QString, mimeType);
124​ QFETCH(Property::Property, extractedProperty);
125​ QFETCH(QVariantList, expectedResult);
126​ QFETCH(QString, failmessage);
127​
128​ ExtractorCollection extractors;
129​ const auto plugins = extractors.fetchExtractors(mimeType);
130​ QVERIFY2(plugins.size() > 0, "No extractors found");
131​
132​ SimpleExtractionResult result(filePath, mimeType);
133​ for (const auto& plugin : plugins) {
134​ plugin->extract(&result);
135​ }
136​
137​ // qDebug() << "result: " << result.properties().values(extractedProperty);
138​ // qDebug() << "expected:" << expectedResult;
139​ if (!failmessage.isEmpty()) {
140​ qDebug() << "result: " << result.properties().values(extractedProperty);
141​ qDebug() << "expected:" << expectedResult;
142​ QEXPECT_FAIL("", qPrintable(failmessage), Abort);
143​ }
144​ QCOMPARE(result.properties().values(extractedProperty), expectedResult);
145​
146​}
147​
148​void MultiValueTest::testArtists_data()
149​{
150​
151​ QTest::addColumn<QString>("filePath");
152​ QTest::addColumn<QString>("mimeType");
153​ QTest::addColumn<Property::Property>("extractedProperty");
154​ QTest::addColumn<QVariantList>("expectedResult");
155​ QTest::addColumn<QString>("failmessage");
156​
157​ const QVariantList expectedResult{
158​ QVariant(QStringLiteral("Bartist")),
159​ QVariant(QStringLiteral("Artist")),
160​ };
161​
162​ QTest::newRow("mp3")
163​ << QFINDTESTDATA("samplefiles/multi/test.mp3")
164​ << QStringLiteral("audio/mpeg3")
165​ << Property::Artist
166​ << expectedResult
167​ << QString()
168​ ;
169​
170​ QTest::newRow("m4a")
171​ << QFINDTESTDATA("samplefiles/multi/test.m4a")
172​ << QStringLiteral("audio/mp4")
173​ << Property::Artist
174​ << expectedResult
175​ << QString()
176​ ;
177​
178​ QTest::newRow("ogg")
179​ << QFINDTESTDATA("samplefiles/multi/test.ogg")
180​ << QStringLiteral("audio/ogg")
181​ << Property::Artist
182​ << expectedResult
183​ << QString()
184​ ;
185​
186​ QTest::newRow("flac")
187​ << QFINDTESTDATA("samplefiles/multi/test.flac")
188​ << QStringLiteral("audio/flac")
189​ << Property::Artist
190​ << expectedResult
191​ << QString()
192​ ;
193​
194​ QTest::newRow("opus")
195​ << QFINDTESTDATA("samplefiles/multi/test.opus")
196​ << QStringLiteral("audio/opus")
197​ << Property::Artist
198​ << expectedResult
199​ << QString()
200​ ;
201​}
202​
203​void MultiValueTest::testArtists()
204​{
205​ QFETCH(QString, filePath);
206​ QFETCH(QString, mimeType);
207​ QFETCH(Property::Property, extractedProperty);
208​ QFETCH(QVariantList, expectedResult);
209​ QFETCH(QString, failmessage);
210​
211​ ExtractorCollection extractors;
212​ const auto plugins = extractors.fetchExtractors(mimeType);
213​ QVERIFY2(plugins.size() > 0, "No extractors found");
214​
215​ SimpleExtractionResult result(filePath, mimeType);
216​ for (const auto& plugin : plugins) {
217​ plugin->extract(&result);
218​ }
219​
220​ // qDebug() << "result: " << result.properties().values(extractedProperty);
221​ // qDebug() << "expected:" << expectedResult;
222​ if (!failmessage.isEmpty()) {
223​ qDebug() << "result: " << result.properties().values(extractedProperty);
224​ qDebug() << "expected:" << expectedResult;
225​ QEXPECT_FAIL("", qPrintable(failmessage), Abort);
226​ }
227​ QCOMPARE(result.properties().values(extractedProperty), expectedResult);
228​}
229​