aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs/devcontainer/devcontainerfeature.cpp
blob: 6806a45dede9c2930006d0423191af10a8280767 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#include "devcontainerfeature.h"

#include "devcontainertr.h"

#include <utils/stringutils.h>

using namespace Utils;

namespace DevContainer {

Result<Feature> Feature::fromJson(
    const QByteArray &data, const JsonStringToString &jsonStringToString)
{
    const QByteArray cleanedInput = cleanJson(data);

    QJsonParseError error;
    QJsonDocument doc = QJsonDocument::fromJson(cleanedInput, &error);
    if (error.error != QJsonParseError::NoError) {
        return ResultError(
            Tr::tr("Failed to parse devcontainer feature file: %1").arg(error.errorString()));
    }

    if (!doc.isObject())
        return ResultError(Tr::tr("Invalid devcontainer feature json file: expected an object"));

    QJsonObject json = doc.object();
    return Feature::fromJson(json, jsonStringToString);
}

Result<Feature> Feature::fromJson(
    const QJsonObject &obj, const JsonStringToString &jsonStringToString)
{
    Feature f;
    f.id = jsonStringToString(obj.value("id"));
    f.version = jsonStringToString(obj.value("version"));

    f.description = jsonStringToString(obj.value("description"));
    f.documentationURL = jsonStringToString(obj.value("documentationURL"));
    f.entrypoint = jsonStringToString(obj.value("entrypoint"));
    f.licenseURL = jsonStringToString(obj.value("licenseURL"));
    f.name = jsonStringToString(obj.value("name"));

    for (const auto &val : obj.value("capAdd").toArray())
        f.capAdd.append(jsonStringToString(val));

    for (const auto &val : obj.value("keywords").toArray())
        f.keywords.append(jsonStringToString(val));

    for (const auto &val : obj.value("installsAfter").toArray())
        f.installsAfter.append(jsonStringToString(val));

    for (const auto &val : obj.value("securityOpt").toArray())
        f.securityOpt.append(jsonStringToString(val));

    for (const auto &val : obj.value("legacyIds").toArray())
        f.legacyIds.append(jsonStringToString(val));

    auto containerEnv = obj.value("containerEnv").toObject();
    for (auto it = containerEnv.begin(); it != containerEnv.end(); ++it)
        f.containerEnv[it.key()] = jsonStringToString(it.value());

    f.customizations = obj.value("customizations").toObject();

    if (obj.contains("dependsOn") && obj["dependsOn"].isObject()) {
        const QJsonObject depsObj = obj["dependsOn"].toObject();
        for (auto it = depsObj.begin(); it != depsObj.end(); ++it) {
            const Result<FeatureDependency> dep
                = FeatureDependency::fromJson(it.key(), it.value().toObject());
            if (!dep)
                return ResultError(dep.error());
            f.dependsOn.push_back(*dep);
        }
    }

    const QJsonObject opts = obj.value("options").toObject();
    for (auto it = opts.begin(); it != opts.end(); ++it)
        f.options[it.key()] = FeatureOption::fromJson(it.value().toObject(), jsonStringToString);

    if (obj.contains("mounts") && obj["mounts"].isArray()) {
        const QJsonArray mountsArray = obj["mounts"].toArray();
        for (const QJsonValue &value : mountsArray) {
            const Result<std::variant<Mount, QString>> mount
                = Mount::fromJsonVariant(value, jsonStringToString);
            if (!mount)
                return ResultError(mount.error());
            f.mounts.push_back(*mount);
        }
    }

    f.init = obj.value("init").toBool();
    f.privileged = obj.value("privileged").toBool();
    f.deprecated = obj.value("deprecated").toBool();

    if (obj.contains("onCreateCommand"))
        f.onCreateCommand = parseCommand(obj["onCreateCommand"], jsonStringToString);
    if (obj.contains("updateContentCommand"))
        f.updateContentCommand = parseCommand(obj["updateContentCommand"], jsonStringToString);
    if (obj.contains("postCreateCommand"))
        f.postCreateCommand = parseCommand(obj["postCreateCommand"], jsonStringToString);
    if (obj.contains("postStartCommand"))
        f.postStartCommand = parseCommand(obj["postStartCommand"], jsonStringToString);
    if (obj.contains("postAttachCommand"))
        f.postAttachCommand = parseCommand(obj["postAttachCommand"], jsonStringToString);

    return f;
}
FeatureOption FeatureOption::fromJson(
    const QJsonObject &obj, const JsonStringToString &jsonStringToString)
{
    FeatureOption opt;
    opt.type = jsonStringToString(obj.value("type"));
    opt.description = jsonStringToString(obj.value("description"));
    opt.defaultValue = obj.value("default").toVariant();

    if (obj.contains("enum")) {
        const QJsonArray enumArray = obj.value("enum").toArray();
        for (const auto &e : enumArray)
            opt.enumValues.append(jsonStringToString(e));
    }
    if (obj.contains("proposals")) {
        const QJsonArray propArray = obj.value("proposals").toArray();
        for (const auto &p : propArray)
            opt.proposals.append(jsonStringToString(p));
    }

    return opt;
}

QJsonObject mergeCustomizations(QJsonObject left, const QJsonObject &right)
{
    for (QJsonObject::const_iterator it = right.constBegin(); it != right.constEnd(); ++it) {
        if (left.contains(it.key())) {
            QJsonValueRef leftMember = left[it.key()];
            if (leftMember.isObject() && it.value().isObject()) {
                leftMember = mergeCustomizations(leftMember.toObject(), it.value().toObject());
            } else if (leftMember.isArray() && it.value().isArray()) {
                QJsonArray leftArray = leftMember.toArray();
                const QJsonArray rightArray = it.value().toArray();
                for (const QJsonValue &value : rightArray)
                    leftArray.append(value);
                leftMember = leftArray;
            } else {
                leftMember = it.value();
            }
        } else {
            left.insert(it.key(), it.value());
        }
    }
    return left;
}

} // namespace DevContainer