forked from qt-creator/qt-creator
7dc72c533e
Instead of coding some arguments to extraId(state) we provide now a std::variant there extra arguments can be saved. Because it's a std::variant it can be easlily extended by new structs. There is a new synchronous interface too. It has an extra method for QIcon which saves icons in an extra table. It would be even nicer if we would have a mipmap image too. So we could do it asynchonously too but so far it works only in the main thread. Task-number: QDS-3579 Fixes: QDS-3584 Change-Id: If368d84d82308a91a5f4f037021e749c9ef868ed Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
468 lines
19 KiB
C++
468 lines
19 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** 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 The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "googletest.h"
|
|
|
|
#include "mockimagecachegenerator.h"
|
|
#include "mockimagecachestorage.h"
|
|
#include "mocktimestampprovider.h"
|
|
#include "notification.h"
|
|
|
|
#include <asynchronousimagecache.h>
|
|
|
|
namespace {
|
|
|
|
class AsynchronousImageCache : public testing::Test
|
|
{
|
|
protected:
|
|
Notification notification;
|
|
Notification waitInThread;
|
|
NiceMock<MockFunction<void()>> mockAbortCallback;
|
|
NiceMock<MockFunction<void(const QImage &image)>> mockCaptureCallback;
|
|
NiceMock<MockImageCacheStorage> mockStorage;
|
|
NiceMock<MockImageCacheGenerator> mockGenerator;
|
|
NiceMock<MockTimeStampProvider> mockTimeStampProvider;
|
|
QmlDesigner::AsynchronousImageCache cache{mockStorage, mockGenerator, mockTimeStampProvider};
|
|
QImage image1{10, 10, QImage::Format_ARGB32};
|
|
QImage smallImage1{1, 1, QImage::Format_ARGB32};
|
|
};
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageFetchesImageFromStorage)
|
|
{
|
|
EXPECT_CALL(mockStorage, fetchImage(Eq("/path/to/Component.qml"), _))
|
|
.WillRepeatedly([&](Utils::SmallStringView, auto) {
|
|
notification.notify();
|
|
return QmlDesigner::ImageCacheStorageInterface::ImageEntry{{}, false};
|
|
});
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageFetchesImageFromStorageWithTimeStamp)
|
|
{
|
|
EXPECT_CALL(mockTimeStampProvider, timeStamp(Eq("/path/to/Component.qml")))
|
|
.WillRepeatedly(Return(Sqlite::TimeStamp{123}));
|
|
EXPECT_CALL(mockStorage, fetchImage(Eq("/path/to/Component.qml"), Eq(Sqlite::TimeStamp{123})))
|
|
.WillRepeatedly([&](Utils::SmallStringView, auto) {
|
|
notification.notify();
|
|
return QmlDesigner::ImageCacheStorageInterface::ImageEntry{QImage{}, false};
|
|
});
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageCallsCaptureCallbackWithImageFromStorage)
|
|
{
|
|
ON_CALL(mockStorage, fetchImage(Eq("/path/to/Component.qml"), _))
|
|
.WillByDefault(Return(QmlDesigner::ImageCacheStorageInterface::ImageEntry{image1, true}));
|
|
|
|
EXPECT_CALL(mockCaptureCallback, Call(Eq(image1))).WillRepeatedly([&](const QImage &) {
|
|
notification.notify();
|
|
});
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageCallsAbortCallbackWithoutImage)
|
|
{
|
|
ON_CALL(mockStorage, fetchImage(Eq("/path/to/Component.qml"), _))
|
|
.WillByDefault(Return(QmlDesigner::ImageCacheStorageInterface::ImageEntry{QImage{}, true}));
|
|
|
|
EXPECT_CALL(mockAbortCallback, Call()).WillRepeatedly([&] { notification.notify(); });
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageRequestImageFromGenerator)
|
|
{
|
|
ON_CALL(mockTimeStampProvider, timeStamp(Eq("/path/to/Component.qml")))
|
|
.WillByDefault(Return(Sqlite::TimeStamp{123}));
|
|
|
|
EXPECT_CALL(mockGenerator,
|
|
generateImage(Eq("/path/to/Component.qml"), _, Eq(Sqlite::TimeStamp{123}), _, _, _))
|
|
.WillRepeatedly([&](auto, auto, auto, auto &&callback, auto, auto) { notification.notify(); });
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageCallsCaptureCallbackWithImageFromGenerator)
|
|
{
|
|
ON_CALL(mockGenerator, generateImage(Eq("/path/to/Component.qml"), _, _, _, _, _))
|
|
.WillByDefault([&](auto, auto, auto, auto &&callback, auto, auto) {
|
|
callback(QImage{image1}, QImage{smallImage1});
|
|
notification.notify();
|
|
});
|
|
|
|
EXPECT_CALL(mockCaptureCallback, Call(Eq(image1)));
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageCallsAbortCallbackFromGenerator)
|
|
{
|
|
ON_CALL(mockGenerator, generateImage(Eq("/path/to/Component.qml"), _, _, _, _, _))
|
|
.WillByDefault([&](auto, auto, auto, auto &&, auto &&abortCallback, auto) {
|
|
abortCallback();
|
|
notification.notify();
|
|
});
|
|
|
|
EXPECT_CALL(mockAbortCallback, Call());
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageFetchesSmallImageFromStorage)
|
|
{
|
|
EXPECT_CALL(mockStorage, fetchSmallImage(Eq("/path/to/Component.qml"), _))
|
|
.WillRepeatedly([&](Utils::SmallStringView, auto) {
|
|
notification.notify();
|
|
return QmlDesigner::ImageCacheStorageInterface::ImageEntry{{}, false};
|
|
});
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageFetchesSmallImageFromStorageWithTimeStamp)
|
|
{
|
|
EXPECT_CALL(mockTimeStampProvider, timeStamp(Eq("/path/to/Component.qml")))
|
|
.WillRepeatedly(Return(Sqlite::TimeStamp{123}));
|
|
EXPECT_CALL(mockStorage, fetchSmallImage(Eq("/path/to/Component.qml"), Eq(Sqlite::TimeStamp{123})))
|
|
.WillRepeatedly([&](Utils::SmallStringView, auto) {
|
|
notification.notify();
|
|
return QmlDesigner::ImageCacheStorageInterface::ImageEntry{QImage{}, false};
|
|
});
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageCallsCaptureCallbackWithImageFromStorage)
|
|
{
|
|
ON_CALL(mockStorage, fetchSmallImage(Eq("/path/to/Component.qml"), _))
|
|
.WillByDefault(Return(QmlDesigner::ImageCacheStorageInterface::ImageEntry{smallImage1, true}));
|
|
|
|
EXPECT_CALL(mockCaptureCallback, Call(Eq(smallImage1))).WillRepeatedly([&](const QImage &) {
|
|
notification.notify();
|
|
});
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageCallsAbortCallbackWithoutSmallImage)
|
|
{
|
|
ON_CALL(mockStorage, fetchSmallImage(Eq("/path/to/Component.qml"), _))
|
|
.WillByDefault(Return(QmlDesigner::ImageCacheStorageInterface::ImageEntry{QImage{}, true}));
|
|
|
|
EXPECT_CALL(mockAbortCallback, Call()).WillRepeatedly([&] { notification.notify(); });
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageRequestImageFromGenerator)
|
|
{
|
|
ON_CALL(mockTimeStampProvider, timeStamp(Eq("/path/to/Component.qml")))
|
|
.WillByDefault(Return(Sqlite::TimeStamp{123}));
|
|
|
|
EXPECT_CALL(mockGenerator,
|
|
generateImage(Eq("/path/to/Component.qml"), _, Eq(Sqlite::TimeStamp{123}), _, _, _))
|
|
.WillRepeatedly([&](auto, auto, auto, auto &&callback, auto, auto) { notification.notify(); });
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageCallsCaptureCallbackWithImageFromGenerator)
|
|
{
|
|
ON_CALL(mockGenerator, generateImage(Eq("/path/to/Component.qml"), _, _, _, _, _))
|
|
.WillByDefault([&](auto, auto, auto, auto &&callback, auto, auto) {
|
|
callback(QImage{image1}, QImage{smallImage1});
|
|
notification.notify();
|
|
});
|
|
|
|
EXPECT_CALL(mockCaptureCallback, Call(Eq(smallImage1)));
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageCallsAbortCallbackFromGenerator)
|
|
{
|
|
ON_CALL(mockGenerator, generateImage(Eq("/path/to/Component.qml"), _, _, _, _, _))
|
|
.WillByDefault([&](auto, auto, auto, auto &&, auto &&abortCallback, auto) {
|
|
abortCallback();
|
|
notification.notify();
|
|
});
|
|
|
|
EXPECT_CALL(mockAbortCallback, Call());
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, CleanRemovesEntries)
|
|
{
|
|
EXPECT_CALL(mockGenerator, generateImage(_, _, _, _, _, _))
|
|
.WillRepeatedly([&](auto, auto, auto, auto &&captureCallback, auto &&, auto) {
|
|
captureCallback(QImage{}, QImage{});
|
|
waitInThread.wait();
|
|
});
|
|
cache.requestSmallImage("/path/to/Component1.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
|
|
EXPECT_CALL(mockCaptureCallback, Call(_)).Times(AtMost(1));
|
|
|
|
cache.requestSmallImage("/path/to/Component3.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
cache.clean();
|
|
waitInThread.notify();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, CleanCallsAbort)
|
|
{
|
|
ON_CALL(mockGenerator, generateImage(_, _, _, _, _, _))
|
|
.WillByDefault([&](auto, auto, auto, auto &&mockCaptureCallback, auto &&, auto) {
|
|
waitInThread.wait();
|
|
});
|
|
cache.requestSmallImage("/path/to/Component1.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
cache.requestSmallImage("/path/to/Component2.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
|
|
EXPECT_CALL(mockAbortCallback, Call()).Times(AtLeast(2));
|
|
|
|
cache.requestSmallImage("/path/to/Component3.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
cache.clean();
|
|
waitInThread.notify();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, CleanCallsGeneratorClean)
|
|
{
|
|
EXPECT_CALL(mockGenerator, clean()).Times(AtLeast(1));
|
|
|
|
cache.clean();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, AfterCleanNewJobsWorks)
|
|
{
|
|
cache.clean();
|
|
|
|
EXPECT_CALL(mockGenerator, generateImage(Eq("/path/to/Component.qml"), _, _, _, _, _))
|
|
.WillRepeatedly([&](auto, auto, auto, auto &&, auto &&, auto) { notification.notify(); });
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, WaitForFinished)
|
|
{
|
|
ON_CALL(mockStorage, fetchImage(_, _))
|
|
.WillByDefault(Return(QmlDesigner::ImageCacheStorageInterface::ImageEntry{image1, true}));
|
|
cache.requestImage("/path/to/Component1.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
cache.requestImage("/path/to/Component2.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction());
|
|
|
|
EXPECT_CALL(mockCaptureCallback, Call(_)).Times(2);
|
|
|
|
cache.waitForFinished();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, WaitForFinishedInGenerator)
|
|
{
|
|
EXPECT_CALL(mockGenerator, waitForFinished());
|
|
|
|
cache.waitForFinished();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageWithExtraIdFetchesImageFromStorage)
|
|
{
|
|
EXPECT_CALL(mockStorage, fetchImage(Eq("/path/to/Component.qml+extraId1"), _))
|
|
.WillRepeatedly([&](Utils::SmallStringView, auto) {
|
|
notification.notify();
|
|
return QmlDesigner::ImageCacheStorageInterface::ImageEntry{{}, false};
|
|
});
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction(),
|
|
"extraId1");
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageWithExtraIdFetchesImageFromStorage)
|
|
{
|
|
EXPECT_CALL(mockStorage, fetchSmallImage(Eq("/path/to/Component.qml+extraId1"), _))
|
|
.WillRepeatedly([&](Utils::SmallStringView, auto) {
|
|
notification.notify();
|
|
return QmlDesigner::ImageCacheStorageInterface::ImageEntry{{}, false};
|
|
});
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction(),
|
|
"extraId1");
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageWithExtraIdRequestImageFromGenerator)
|
|
{
|
|
ON_CALL(mockTimeStampProvider, timeStamp(Eq("/path/to/Component.qml")))
|
|
.WillByDefault(Return(Sqlite::TimeStamp{123}));
|
|
|
|
EXPECT_CALL(mockGenerator,
|
|
generateImage(
|
|
Eq("/path/to/Component.qml"), Eq("extraId1"), Eq(Sqlite::TimeStamp{123}), _, _, _))
|
|
.WillRepeatedly([&](auto, auto, auto, auto &&, auto, auto) { notification.notify(); });
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction(),
|
|
"extraId1");
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageWithExtraIdRequestImageFromGenerator)
|
|
{
|
|
ON_CALL(mockTimeStampProvider, timeStamp(Eq("/path/to/Component.qml")))
|
|
.WillByDefault(Return(Sqlite::TimeStamp{123}));
|
|
|
|
EXPECT_CALL(mockGenerator,
|
|
generateImage(
|
|
Eq("/path/to/Component.qml"), Eq("extraId1"), Eq(Sqlite::TimeStamp{123}), _, _, _))
|
|
.WillRepeatedly([&](auto, auto, auto, auto &&, auto, auto) { notification.notify(); });
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction(),
|
|
"extraId1");
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestImageWithAuxiliaryDataRequestImageFromGenerator)
|
|
{
|
|
using QmlDesigner::ImageCache::FontCollectorSizesAuxiliaryData;
|
|
std::vector<QSize> sizes{{20, 11}};
|
|
ON_CALL(mockTimeStampProvider, timeStamp(Eq("/path/to/Component.qml")))
|
|
.WillByDefault(Return(Sqlite::TimeStamp{123}));
|
|
|
|
EXPECT_CALL(mockGenerator,
|
|
generateImage(Eq("/path/to/Component.qml"),
|
|
Eq("extraId1"),
|
|
Eq(Sqlite::TimeStamp{123}),
|
|
_,
|
|
_,
|
|
VariantWith<FontCollectorSizesAuxiliaryData>(
|
|
AllOf(Field(&FontCollectorSizesAuxiliaryData::sizes,
|
|
ElementsAre(QSize{20, 11})),
|
|
Field(&FontCollectorSizesAuxiliaryData::colorName,
|
|
Eq(u"color"))))))
|
|
.WillRepeatedly([&](auto, auto, auto, auto &&, auto, auto) { notification.notify(); });
|
|
|
|
cache.requestImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction(),
|
|
"extraId1",
|
|
FontCollectorSizesAuxiliaryData{sizes, "color"});
|
|
notification.wait();
|
|
}
|
|
|
|
TEST_F(AsynchronousImageCache, RequestSmallImageWithAuxiliaryDataRequestImageFromGenerator)
|
|
{
|
|
using QmlDesigner::ImageCache::FontCollectorSizesAuxiliaryData;
|
|
std::vector<QSize> sizes{{20, 11}};
|
|
ON_CALL(mockTimeStampProvider, timeStamp(Eq("/path/to/Component.qml")))
|
|
.WillByDefault(Return(Sqlite::TimeStamp{123}));
|
|
|
|
EXPECT_CALL(mockGenerator,
|
|
generateImage(Eq("/path/to/Component.qml"),
|
|
Eq("extraId1"),
|
|
Eq(Sqlite::TimeStamp{123}),
|
|
_,
|
|
_,
|
|
VariantWith<FontCollectorSizesAuxiliaryData>(
|
|
AllOf(Field(&FontCollectorSizesAuxiliaryData::sizes,
|
|
ElementsAre(QSize{20, 11})),
|
|
Field(&FontCollectorSizesAuxiliaryData::colorName,
|
|
Eq(u"color"))))))
|
|
.WillRepeatedly([&](auto, auto, auto, auto &&, auto, auto) { notification.notify(); });
|
|
|
|
cache.requestSmallImage("/path/to/Component.qml",
|
|
mockCaptureCallback.AsStdFunction(),
|
|
mockAbortCallback.AsStdFunction(),
|
|
"extraId1",
|
|
FontCollectorSizesAuxiliaryData{sizes, "color"});
|
|
notification.wait();
|
|
}
|
|
|
|
} // namespace
|