McuSupport: Introduce new implementation stub

New/legacy implementation will be chosen based on contents
of input json file.

Change-Id: I989fa667c43123f831cc77320684413cab7652df
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
This commit is contained in:
Piotr Mućko
2022-03-09 17:29:07 +01:00
parent 2d33425cd5
commit 8c04c2ea55
25 changed files with 755 additions and 311 deletions

View File

@@ -29,10 +29,13 @@
#include "armgcc_stm32f769i_freertos_json.h"
#include "armgcc_stm32h750b_metal_json.h"
#include "iar_stm32f469i_metal_json.h"
#include "mcuhelpers.h"
#include "mcukitmanager.h"
#include "mcusupportconstants.h"
#include "mcusupportsdk.h"
#include "mcutargetdescription.h"
#include "mcutargetfactory.h"
#include "mcutargetfactorylegacy.h"
#include <utils/algorithm.h>
#include <utils/filepath.h>
@@ -42,35 +45,35 @@
#include <QJsonArray>
#include <QJsonDocument>
#include <qtestcase.h>
#include <algorithm>
#include <ciso646>
namespace McuSupport::Internal::Test {
namespace {
// clazy:excludeall=non-pod-global-static
static const QString nxp1050FreeRtosEnvVar{"IMXRT1050_FREERTOS_DIR"};
static const QString nxp1064FreeRtosEnvVar{"IMXRT1064_FREERTOS_DIR"};
static const QString nxp1170FreeRtosEnvVar{"EVK_MIMXRT1170_FREERTOS_PATH"};
static const QString stm32f7FreeRtosEnvVar{"STM32F7_FREERTOS_DIR"};
static const QString stm32f7{"STM32F7"};
static const QString nxp1170{"EVK_MIMXRT1170"};
static const QString nxp1050{"IMXRT1050"};
static const QString nxp1064{"IMXRT1064"};
static const QStringList jsonFiles{QString::fromUtf8(armgcc_nxp_1050_json),
QString::fromUtf8(armgcc_nxp_1064_json)};
const QString freeRtosCMakeVar{"FREERTOS_DIR"};
const QString nxp1050FreeRtosEnvVar{"IMXRT1050_FREERTOS_DIR"};
const QString nxp1064FreeRtosEnvVar{"IMXRT1064_FREERTOS_DIR"};
const QString nxp1170FreeRtosEnvVar{"EVK_MIMXRT1170_FREERTOS_PATH"};
const QString stm32f7FreeRtosEnvVar{"STM32F7_FREERTOS_DIR"};
const QString stm32f7{"STM32F7"};
const QString nxp1170{"EVK_MIMXRT1170_"};
const QString nxp1050{"IMXRT1050"};
const QString nxp1064{"IMXRT1064"};
const QStringList jsonFiles{armgcc_nxp_1050_json, armgcc_nxp_1064_json};
constexpr bool RUN_LEGACY{true};
constexpr int colorDepth{32};
const QString id{"id"};
} // namespace
using CMakeProjectManager::CMakeConfigItem;
using CMakeProjectManager::CMakeConfigurationKitAspect;
using ProjectExplorer::EnvironmentKitAspect;
using ProjectExplorer::KitManager;
using testing::Return;
using testing::ReturnRef;
using Utils::FilePath;
void McuSupportTest::initTestCase()
{
}
void McuSupportTest::initTestCase() {}
void McuSupportTest::test_parseBasicInfoFromJson()
{
@@ -80,31 +83,40 @@ void McuSupportTest::test_parseBasicInfoFromJson()
QVERIFY(description.freeRTOS.boardSdkSubDir.isEmpty());
}
void McuSupportTest::test_parseCmakeEntries()
{
const auto description{Sdk::parseDescriptionJson(armgcc_nxp_1064_json)};
QVERIFY(not description.freeRTOS.packages.isEmpty());
auto &freeRtosPackage = description.freeRTOS.packages[0];
QCOMPARE(freeRtosPackage.envVar, nxp1064FreeRtosEnvVar);
}
void McuSupportTest::test_addNewKit()
{
const QString cmakeVar = "CMAKE_SDK";
McuPackage sdkPackage{"sdk", // label
{}, // defaultPath
{}, // detectionPath
"sdk", // settingsKey
McuPackage sdkPackage{"sdk", // label
{}, // defaultPath
{}, // detectionPath
"sdk", // settingsKey
cmakeVar, // cmake var
{}}; // env var
Kit kit;
{}}; // env var
ProjectExplorer::Kit kit;
McuToolChainPackage toolchainPackage{
{}, // label
{}, // defaultPath
{}, // detectionPath
{}, // settingsKey
McuToolChainPackage::ToolChainType::Unsupported, // toolchain type
{}, // cmake var name
{}}; // env var name
McuToolChainPackage
toolchainPackage{{}, // label
{}, // defaultPath
{}, // detectionPath
{}, // settingsKey
McuToolChainPackage::ToolChainType::Unsupported, // toolchain type
{}, // cmake var name
{}}; // env var name
const McuTarget::Platform platform{id, name, vendor};
McuTarget mcuTarget{currentQulVersion, // version
platform, // platform
McuTarget mcuTarget{currentQulVersion, // version
platform, // platform
McuTarget::OS::FreeRTOS, // os
{&sdkPackage}, // packages
&toolchainPackage}; // toolchain packages
{&sdkPackage}, // packages
&toolchainPackage}; // toolchain packages
auto &kitManager{*KitManager::instance()};
@@ -115,15 +127,17 @@ void McuSupportTest::test_addNewKit()
QCOMPARE(kitAddedSpy.count(), 1);
QList<QVariant> arguments = kitAddedSpy.takeFirst();
auto *createdKit = qvariant_cast<Kit *>(arguments.at(0));
auto *createdKit = qvariant_cast<ProjectExplorer::Kit *>(arguments.at(0));
QVERIFY(createdKit != nullptr);
QCOMPARE(createdKit, newKit);
const auto config = CMakeConfigurationKitAspect::configuration(newKit);
QVERIFY(config.size() > 0);
QVERIFY(Utils::indexOf(config.toVector(), [&cmakeVar](const CMakeConfigItem &item) {
return item.key == cmakeVar.toUtf8();
}) != -1);
QVERIFY(Utils::indexOf(config.toVector(),
[&cmakeVar](const CMakeConfigItem &item) {
return item.key == cmakeVar.toUtf8();
})
!= -1);
}
void McuSupportTest::test_createPackagesWithCorrespondingSettings_data()
@@ -164,9 +178,8 @@ void McuSupportTest::test_createPackagesWithCorrespondingSettings_data()
void McuSupportTest::test_createPackagesWithCorrespondingSettings()
{
QFETCH(QString, json);
const auto description = Sdk::parseDescriptionJson(json.toLocal8Bit());
QVector<McuAbstractPackage *> packages;
const auto targets = Sdk::targetsFromDescriptions({description}, &packages);
const Sdk::McuTargetDescription description = Sdk::parseDescriptionJson(json.toLocal8Bit());
const auto [targets, packages]{Sdk::targetsFromDescriptions({description}, RUN_LEGACY)};
Q_UNUSED(targets);
QSet<QString> settings = Utils::transform<QSet<QString>>(packages, [](const auto &package) {
@@ -176,4 +189,111 @@ void McuSupportTest::test_createPackagesWithCorrespondingSettings()
QVERIFY(settings.contains(expectedSettings));
}
void McuSupportTest::test_createFreeRtosPackageWithCorrectSetting_data()
{
QTest::addColumn<QString>("freeRtosEnvVar");
QTest::addColumn<QString>("expectedSettingsKey");
QTest::newRow("nxp1050") << nxp1050FreeRtosEnvVar
<< QString{Constants::SETTINGS_KEY_FREERTOS_PREFIX}.append(nxp1050);
QTest::newRow("nxp1064") << nxp1064FreeRtosEnvVar
<< QString{Constants::SETTINGS_KEY_FREERTOS_PREFIX}.append(nxp1064);
QTest::newRow("nxp1170") << nxp1170FreeRtosEnvVar
<< QString{Constants::SETTINGS_KEY_FREERTOS_PREFIX}.append(nxp1170);
QTest::newRow("stm32f7") << stm32f7FreeRtosEnvVar
<< QString{Constants::SETTINGS_KEY_FREERTOS_PREFIX}.append(stm32f7);
}
//TODO(piotr.mucko): Enable when mcutargetfactory is delivered.
void McuSupportTest::test_createFreeRtosPackageWithCorrectSetting()
{
// Sdk::targetsAndPackages(jsonFile, &mcuSdkRepo);
//
// QVector<Package *> mcuPackages;
// auto mcuTargets = Sdk::targetsFromDescriptions({description}, &mcuPackages);
// QVERIFY(mcuPackages contains freertos package)
// QVERIFY(freertos package is not empty & has proper value)
// McuSupportOptions mcuSuportOptions{};
// mcuSuportOptions.createAutomaticKits();
QFETCH(QString, freeRtosEnvVar);
QFETCH(QString, expectedSettingsKey);
auto *package{Sdk::createFreeRTOSSourcesPackage(freeRtosEnvVar, FilePath{}, QString{})};
QVERIFY(package != nullptr);
QCOMPARE(package->settingsKey(), expectedSettingsKey);
// QVERIFY(freertos package is not empty & has proper value)
// static McuPackage *createFreeRTOSSourcesPackage(const QString &envVar,
// const FilePath &boardSdkDir,
// const QString &freeRTOSBoardSdkSubDir)
// createFreeRtosPackage
// verify that package's setting is Package_FreeRTOSSourcePackage_IMXRT1064.
//TODO(me): write settings
// auto *freeRtosPackage
// = new McuPackage;
// freeRtosPackage->writeToSettings();
//TODO(me): verify that setting is the same as in 2.0.0
}
void McuSupportTest::test_createTargetsTheNewWay_data() {}
void McuSupportTest::test_createTargetsTheNewWay()
{
Sdk::PackageDescription packageDescription{id,
nxp1064FreeRtosEnvVar,
freeRtosCMakeVar,
"setting",
"Freertos directory",
"/opt/freertos/1064",
"",
{},
true};
Sdk::McuTargetDescription description{
"2.0.1",
"2",
{id, "", "", {colorDepth}, Sdk::McuTargetDescription::TargetType::MCU},
{}, // toolchain
{}, // boardSDK
{"", "", {packageDescription}}, //freertos
};
Sdk::McuTargetFactory targetFactory{};
const auto [targets, packages]{targetFactory.createTargets(description)};
QVERIFY(not targets.empty());
QCOMPARE(targets.at(0)->colorDepth(), colorDepth);
const auto &tgtPackages{targets.at(0)->packages()};
QVERIFY(not tgtPackages.empty());
const auto rtosPackage{tgtPackages.first()};
QCOMPARE(rtosPackage->environmentVariableName(), nxp1064FreeRtosEnvVar);
}
void McuSupportTest::test_createPackages()
{
Sdk::PackageDescription packageDescription{id,
nxp1064FreeRtosEnvVar,
freeRtosCMakeVar,
"Freertos directory",
"setting",
"/opt/freertos/1064",
"",
{},
true};
Sdk::McuTargetDescription targetDescription{
"2.0.1",
"2",
{id, id, id, {colorDepth}, Sdk::McuTargetDescription::TargetType::MCU},
{}, // toolchain
{}, // boardSDK
{"", "", {packageDescription}}, //freertos
};
Sdk::McuTargetFactory targetFactory;
const auto packages{targetFactory.createPackages(targetDescription)};
QVERIFY(not packages.empty());
}
} // namespace McuSupport::Internal::Test