controller-server/src/main/java/com/yahoo/vespa/hosted/controller/application/DeploymentSpecValidator.java


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

// Copyright 2019 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.application;

import com.yahoo.config.application.api.DeploymentSpec;
import com.yahoo.config.provision.CloudName;
import com.yahoo.config.provision.Environment;
import com.yahoo.config.provision.zone.ZoneApi;
import com.yahoo.config.provision.zone.ZoneId;
import com.yahoo.vespa.hosted.controller.Controller;
import com.yahoo.vespa.hosted.controller.deployment.DeploymentSteps;

import java.util.HashSet;
import java.util.Objects;
import java.util.stream.Collectors;

/**
 * This contains validators for a {@link DeploymentSpec} that depend on a {@link Controller} to perform validation.
 *
 * @author mpolden
 */
public class DeploymentSpecValidator {

    private final Controller controller;

    public DeploymentSpecValidator(Controller controller) {
        this.controller = Objects.requireNonNull(controller, "controller must be non-null");
    }

    /**
     * Validate the given deploymentSpec
     *
     * @throws IllegalArgumentException if any validations fail
     */
    public void validate(DeploymentSpec deploymentSpec) {
        validateSteps(deploymentSpec);
        validateEndpoints(deploymentSpec);
    }

    /** Verify that each of the production zones listed in the deployment spec exist in this system */
    private void validateSteps(DeploymentSpec deploymentSpec) {
        new DeploymentSteps(deploymentSpec, controller::system).jobs();
        deploymentSpec.instances().stream().flatMap(instance -> instance.zones().stream())
                      .filter(zone -> zone.environment() == Environment.prod)
                      .forEach(zone -> {
                          if ( ! controller.zoneRegistry().hasZone(ZoneId.from(zone.environment(),
                                                                               zone.region().orElse(null)))) {
                              throw new IllegalArgumentException("Zone " + zone + " in deployment spec was not found in this system!");
                          }
                      });
    }

    /** Verify that no single endpoint contains regions in different clouds */
    private void validateEndpoints(DeploymentSpec deploymentSpec) {
        for (var instance : deploymentSpec.instances()) {
            for (var endpoint : instance.endpoints()) {
                var clouds = new HashSet<CloudName>();
                for (var region : endpoint.regions()) {
                    for (ZoneApi zone : controller.zoneRegistry().zones().all().in(region).zones()) {
                        clouds.add(zone.getCloudName());
                    }
                }
                if (clouds.size() != 1) {
                    throw new IllegalArgumentException("Endpoint '" + endpoint.endpointId() + "' in " + instance +
                                                       " cannot contain regions in different clouds: " +
                                                       endpoint.regions().stream().sorted().collect(Collectors.toList()));
                }
            }
        }
    }

}