summaryrefslogtreecommitdiffstats
path: root/config-model/src/main/java/com/yahoo/vespa/model/VespaModelFactory.java
blob: adbd4d7bae1b51d937c341273b6068e183489612 (plain) (blame)
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model;

import com.google.inject.Inject;
import com.yahoo.component.provider.ComponentRegistry;
import com.yahoo.config.application.api.ApplicationPackage;
import com.yahoo.config.model.ConfigModelRegistry;
import com.yahoo.config.model.MapConfigModelRegistry;
import com.yahoo.config.model.NullConfigModelRegistry;
import com.yahoo.config.model.api.ConfigChangeAction;
import com.yahoo.config.model.api.ConfigModelPlugin;
import com.yahoo.config.model.api.HostProvisioner;
import com.yahoo.config.model.api.Model;
import com.yahoo.config.model.api.ModelContext;
import com.yahoo.config.model.api.ModelCreateResult;
import com.yahoo.config.model.api.ModelFactory;
import com.yahoo.config.model.application.provider.ApplicationPackageXmlFilesValidator;
import com.yahoo.config.model.builder.xml.ConfigModelBuilder;
import com.yahoo.config.model.deploy.DeployProperties;
import com.yahoo.config.model.deploy.DeployState;
import com.yahoo.config.model.provision.HostsXmlProvisioner;
import com.yahoo.config.provision.ApplicationId;
import com.yahoo.config.provision.Version;
import com.yahoo.config.provision.Zone;
import com.yahoo.vespa.config.VespaVersion;
import com.yahoo.vespa.model.application.validation.Validation;

import org.xml.sax.SAXException;

import java.io.IOException;
import java.io.Reader;
import java.time.Clock;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Logger;

/**
 * Factory for creating {@link VespaModel} instances.
 *
 * @author lulf
 */
public class VespaModelFactory implements ModelFactory {

    private static final Logger log = Logger.getLogger(VespaModelFactory.class.getName());
    private final ConfigModelRegistry configModelRegistry;
    private final Zone zone;
    private final Clock clock;

    @Inject
    public VespaModelFactory(ComponentRegistry<ConfigModelPlugin> pluginRegistry, Zone zone) {
        List<ConfigModelBuilder> modelBuilders = new ArrayList<>();
        for (ConfigModelPlugin plugin : pluginRegistry.allComponents()) {
            if (plugin instanceof ConfigModelBuilder) {
                modelBuilders.add((ConfigModelBuilder) plugin);
            }
        }
        this.configModelRegistry = new MapConfigModelRegistry(modelBuilders);
        this.zone = zone;
        this.clock = Clock.systemUTC();
    }

    public VespaModelFactory(ConfigModelRegistry configModelRegistry) {
        this(configModelRegistry, Clock.systemUTC());
    }
    public VespaModelFactory(ConfigModelRegistry configModelRegistry, Clock clock) {
        if (configModelRegistry == null) {
            this.configModelRegistry = new NullConfigModelRegistry();
            log.info("Will not load config models from plugins, as no registry is available");
        } else {
            this.configModelRegistry = configModelRegistry;
        }
        this.zone = Zone.defaultZone();
        this.clock = clock;
    }

    @Override
    public Version getVersion() {
        return Version.fromIntValues(VespaVersion.major, VespaVersion.minor, VespaVersion.micro);
    }

    @Override
    public Model createModel(ModelContext modelContext) {
        return buildModel(createDeployState(modelContext));
    }

    @Override
    public ModelCreateResult createAndValidateModel(ModelContext modelContext, boolean ignoreValidationErrors) {
        if (modelContext.appDir().isPresent()) {
            ApplicationPackageXmlFilesValidator validator =
                    ApplicationPackageXmlFilesValidator.createDefaultXMLValidator(modelContext.appDir().get(),
                                                                                  modelContext.vespaVersion());
            try {
                validator.checkApplication();
                ApplicationPackageXmlFilesValidator.checkIncludedDirs(modelContext.applicationPackage());
            } catch (IllegalArgumentException e) {
                rethrowUnlessIgnoreErrors(e, ignoreValidationErrors);
            } catch (Exception e) {
                throw new RuntimeException(e);
            }

        } else {
            validateXML(modelContext.applicationPackage(), ignoreValidationErrors);
        }
        DeployState deployState = createDeployState(modelContext);
        VespaModel model = buildModel(deployState);
        List<ConfigChangeAction> changeActions = validateModel(model, deployState, ignoreValidationErrors);
        return new ModelCreateResult(model, changeActions);
    }

    private VespaModel buildModel(DeployState deployState) {
        try {
            return new VespaModel(configModelRegistry, deployState);
        } catch (IOException | SAXException e) {
            throw new RuntimeException(e);
        }
    }

    private DeployState createDeployState(ModelContext modelContext) {
        DeployState.Builder builder = new DeployState.Builder()
            .applicationPackage(modelContext.applicationPackage())
            .deployLogger(modelContext.deployLogger())
            .configDefinitionRepo(modelContext.configDefinitionRepo())
            .fileRegistry(modelContext.getFileRegistry())
            .permanentApplicationPackage(modelContext.permanentApplicationPackage())
            .properties(createDeployProperties(modelContext.properties()))
            .modelHostProvisioner(createHostProvisioner(modelContext))
            .rotations(modelContext.properties().rotations())
            .zone(zone)
            .now(clock.instant());
        modelContext.previousModel().ifPresent(builder::previousModel);
        return builder.build();
    }

    private DeployProperties createDeployProperties(ModelContext.Properties properties) {
        return new DeployProperties.Builder()
                .applicationId(properties.applicationId())
                .configServerSpecs(properties.configServerSpecs())
                .multitenant(properties.multitenant())
                .hostedVespa(properties.hostedVespa())
                .vespaVersion(getVersion())
                .zone(properties.zone())
                .build();
    }


    private static HostProvisioner createHostProvisioner(ModelContext modelContext) {
        if (isHostedVespaRoutingApplication(modelContext)) {
            //TODO: This belongs in HostedVespaProvisioner.
            //Added here for now since com.yahoo.config.model.api.HostProvisioner is not created per application,
            //and allocation is independent of ApplicationPackage.
            return new HostsXmlProvisioner(hostsXml(modelContext));
        } else {
            return modelContext.hostProvisioner().orElse(
                    DeployState.getDefaultModelHostProvisioner(modelContext.applicationPackage()));
        }
    }

    private static Reader hostsXml(ModelContext modelContext) {
        Reader hosts = modelContext.applicationPackage().getHosts();
        if (hosts == null) {
            //TODO: throw InvalidApplicationException directly. Not possible now, as it resides in the configserver module.
            //SessionPreparer maps IllegalArgumentException -> InvalidApplicationException
            throw new IllegalArgumentException("Hosted vespa routing application must use " + ApplicationPackage.HOSTS
                                               + " to allocate hosts.");
        }
        return hosts;
    }

    private static boolean isHostedVespaRoutingApplication(ModelContext modelContext) {
        ApplicationId id = modelContext.properties().applicationId();
        return modelContext.properties().hostedVespa() && id.isHostedVespaRoutingApplication();
    }

    private void validateXML(ApplicationPackage applicationPackage, boolean ignoreValidationErrors) {
        try {
            applicationPackage.validateXML();
        } catch (IllegalArgumentException e) {
            rethrowUnlessIgnoreErrors(e, ignoreValidationErrors);
        } catch (Exception e) {
             throw new RuntimeException(e);
        }
    }

    private List<ConfigChangeAction> validateModel(VespaModel model, DeployState deployState, boolean ignoreValidationErrors) {
        try {
            deployState.getApplicationPackage().validateXML();
            return Validation.validate(model, ignoreValidationErrors, deployState);
        } catch (IllegalArgumentException e) {
            rethrowUnlessIgnoreErrors(e, ignoreValidationErrors);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
        return new ArrayList<>();
    }

    private static void rethrowUnlessIgnoreErrors(IllegalArgumentException e, boolean ignoreValidationErrors) {
        if (!ignoreValidationErrors) {
            throw e;
        }
    }

}