aboutsummaryrefslogtreecommitdiffstats
path: root/configserver/src/test/java/com/yahoo/vespa/config/server/session/PrepareParamsTest.java
blob: 9f2ddafd0285157ca06f0a18c713e598549e6d80 (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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.config.server.session;

import com.yahoo.config.model.api.ApplicationClusterEndpoint;
import com.yahoo.config.model.api.ContainerEndpoint;
import com.yahoo.config.model.api.EndpointCertificateMetadata;
import com.yahoo.config.model.api.TenantSecretStore;
import com.yahoo.config.provision.ApplicationId;
import com.yahoo.config.provision.CloudAccount;
import com.yahoo.config.provision.TenantName;
import com.yahoo.container.jdisc.HttpRequest;
import com.yahoo.security.X509CertificateUtils;
import com.yahoo.slime.Cursor;
import com.yahoo.slime.Injector;
import com.yahoo.slime.ObjectInserter;
import com.yahoo.slime.Slime;
import com.yahoo.slime.SlimeUtils;
import com.yahoo.vespa.config.server.tenant.ContainerEndpointSerializer;
import com.yahoo.vespa.config.server.tenant.EndpointCertificateMetadataSerializer;
import com.yahoo.vespa.config.server.tenant.TenantSecretStoreSerializer;
import org.junit.Test;

import java.io.IOException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.security.cert.X509Certificate;
import java.time.Duration;
import java.util.List;
import java.util.OptionalInt;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

/**
 * @author hmusum
 */
public class PrepareParamsTest {

    private static final String vespaVersion = "6.37.49";
    private static final String baseRequest = "http://foo:19071/application/v2/tenant/foo/application/bar";
    private static final String request = baseRequest + "?" +
                                          PrepareParams.DRY_RUN_PARAM_NAME + "=true&" +
                                          PrepareParams.VERBOSE_PARAM_NAME+ "=true&" +
                                          PrepareParams.IGNORE_VALIDATION_PARAM_NAME + "=false&" +
                                          PrepareParams.APPLICATION_NAME_PARAM_NAME + "=baz&" +
                                          PrepareParams.VESPA_VERSION_PARAM_NAME + "=" + vespaVersion;

    private static final String json = "{\n" +
                                       "\"" + PrepareParams.DRY_RUN_PARAM_NAME + "\": true,\n" +
                                       "\"" + PrepareParams.VERBOSE_PARAM_NAME+ "\": true,\n" +
                                       "\"" + PrepareParams.IGNORE_VALIDATION_PARAM_NAME + "\": false,\n" +
                                       "\"" + PrepareParams.APPLICATION_NAME_PARAM_NAME + "\":\"baz\",\n" +
                                       "\"" + PrepareParams.VESPA_VERSION_PARAM_NAME + "\":\"" + vespaVersion + "\"\n" +
                                       "}";

    @Test
    public void testCorrectParsing() {
        PrepareParams prepareParams = createParams("http://foo:19071/application/v2/", TenantName.defaultName());

        assertEquals(ApplicationId.defaultId(), prepareParams.getApplicationId());
        assertFalse(prepareParams.isDryRun());
        assertFalse(prepareParams.isVerbose());
        assertFalse(prepareParams.ignoreValidationErrors());
        assertTrue(prepareParams.vespaVersion().isEmpty());
        assertTrue(prepareParams.getTimeoutBudget().hasTimeLeft());
        assertTrue(prepareParams.containerEndpoints().isEmpty());
        assertTrue(prepareParams.cloudAccount().isEmpty());
    }

    @Test
    public void testCorrectParsingWithContainerEndpoints() throws IOException {
        var endpoints = List.of(new ContainerEndpoint("qrs1", ApplicationClusterEndpoint.Scope.global,
                                                      List.of("c1.example.com",
                                                              "c2.example.com"), OptionalInt.of(3)),
                                new ContainerEndpoint("qrs2",ApplicationClusterEndpoint.Scope.global,
                                                      List.of("c3.example.com",
                                                              "c4.example.com")));
        var param = "[\n" +
                    "  {\n" +
                    "    \"clusterId\": \"qrs1\",\n" +
                    "    \"names\": [\"c1.example.com\", \"c2.example.com\"],\n" +
                    "    \"scope\": \"global\",\n" +
                    "    \"weight\": 3\n" +
                    "  },\n" +
                    "  {\n" +
                    "    \"clusterId\": \"qrs2\",\n" +
                    "    \"names\": [\"c3.example.com\", \"c4.example.com\"],\n" +
                    "    \"scope\": \"global\"\n" +
                    "  }\n" +
                    "]";

        var encoded = URLEncoder.encode(param, StandardCharsets.UTF_8);
        var prepareParams = createParams(request + "&" + PrepareParams.CONTAINER_ENDPOINTS_PARAM_NAME +
                                                   "=" + encoded, TenantName.from("foo"));
        assertEquals(endpoints, prepareParams.containerEndpoints());

        // Verify using json object
        var slime = SlimeUtils.jsonToSlime(json);
        new Injector().inject(ContainerEndpointSerializer.endpointListToSlime(endpoints).get(), new ObjectInserter(slime.get(), PrepareParams.CONTAINER_ENDPOINTS_PARAM_NAME));
        PrepareParams prepareParamsJson = PrepareParams.fromJson(SlimeUtils.toJsonBytes(slime), TenantName.from("foo"), Duration.ofSeconds(60));
        assertPrepareParamsEqual(prepareParams, prepareParamsJson);
    }

    @Test
    public void testQuotaParsing() throws IOException {
        var quotaParam = "{\"clusterSize\": 23, \"budget\": 23232323}";
        var quotaEncoded = URLEncoder.encode(quotaParam, StandardCharsets.UTF_8);
        var prepareParams = createParams(request + "&" + PrepareParams.QUOTA_PARAM_NAME + "=" + quotaEncoded, TenantName.from("foo"));
        assertEquals(23, (int) prepareParams.quota().get().maxClusterSize().get());
        assertEquals(23232323, (int) prepareParams.quota().get().budget().get());

        // Verify using json object
        var slime = SlimeUtils.jsonToSlime(json);
        new Injector().inject(SlimeUtils.jsonToSlime(quotaParam).get(), new ObjectInserter(slime.get(), PrepareParams.QUOTA_PARAM_NAME));
        PrepareParams prepareParamsJson = PrepareParams.fromJson(SlimeUtils.toJsonBytes(slime), TenantName.from("foo"), Duration.ofSeconds(60));
        assertPrepareParamsEqual(prepareParams, prepareParamsJson);
    }

    @Test
    public void testEndpointCertificateParsing() throws IOException {
        var certMeta = new EndpointCertificateMetadata("key", "cert", 3);
        var slime = new Slime();
        EndpointCertificateMetadataSerializer.toSlime(certMeta, slime.setObject());
        String encoded = URLEncoder.encode(new String(SlimeUtils.toJsonBytes(slime), StandardCharsets.UTF_8), StandardCharsets.UTF_8);
        var prepareParams = createParams(request + "&" + PrepareParams.ENDPOINT_CERTIFICATE_METADATA_PARAM_NAME + "=" + encoded, TenantName.from("foo"));
        assertTrue(prepareParams.endpointCertificateMetadata().isPresent());
        assertEquals("key", prepareParams.endpointCertificateMetadata().get().keyName());
        assertEquals("cert", prepareParams.endpointCertificateMetadata().get().certName());
        assertEquals(3, prepareParams.endpointCertificateMetadata().get().version());

        // Verify using json object
        var root = SlimeUtils.jsonToSlime(json);
        new Injector().inject(slime.get(), new ObjectInserter(root.get(), PrepareParams.ENDPOINT_CERTIFICATE_METADATA_PARAM_NAME));
        PrepareParams prepareParamsJson = PrepareParams.fromJson(SlimeUtils.toJsonBytes(root), TenantName.from("foo"), Duration.ofSeconds(60));
        assertPrepareParamsEqual(prepareParams, prepareParamsJson);
    }

    @Test
    public void compareEmptyUrlparamsVsJson() {
        TenantName tenantName = TenantName.from("foo");
        Duration barrierTimeout = Duration.ofSeconds(60);
        HttpRequest httpRequest = HttpRequest.createTestRequest(baseRequest, com.yahoo.jdisc.http.HttpRequest.Method.POST);
        PrepareParams urlPrepareParams = PrepareParams.fromHttpRequest(httpRequest, tenantName, barrierTimeout);
        PrepareParams jsonPrepareParams = PrepareParams.fromJson("{}".getBytes(StandardCharsets.UTF_8), tenantName, barrierTimeout);

        assertPrepareParamsEqual(urlPrepareParams, jsonPrepareParams);
    }

    @Test
    public void compareStandardUrlparamsVsJson() {
        TenantName tenantName = TenantName.from("foo");
        Duration barrierTimeout = Duration.ofSeconds(60);
        HttpRequest httpRequest = HttpRequest.createTestRequest(request, com.yahoo.jdisc.http.HttpRequest.Method.POST);
        PrepareParams urlPrepareParams = PrepareParams.fromHttpRequest(httpRequest, tenantName, barrierTimeout);
        PrepareParams jsonPrepareParams = PrepareParams.fromJson(json.getBytes(StandardCharsets.UTF_8), tenantName, barrierTimeout);
        assertPrepareParamsEqual(urlPrepareParams, jsonPrepareParams);
    }

    @Test
    public void testOperatorCertificates() throws IOException {
        Slime slime = SlimeUtils.jsonToSlime(json);
        Cursor cursor = slime.get();
        Cursor array = cursor.setArray(PrepareParams.OPERATOR_CERTIFICATES);
        X509Certificate certificate = X509CertificateUtils.createSelfSigned("cn=myservice", Duration.ofDays(1)).certificate();
        array.addString(X509CertificateUtils.toPem(certificate));
        PrepareParams prepareParams = PrepareParams.fromJson(SlimeUtils.toJsonBytes(slime), TenantName.from("foo"), Duration.ofSeconds(60));
        assertEquals(1, prepareParams.operatorCertificates().size());
        assertEquals(certificate, prepareParams.operatorCertificates().get(0));
    }

    @Test
    public void testSecretStores() throws  IOException {
        List<TenantSecretStore> secretStores = List.of(new TenantSecretStore("name", "awsId", "role"));
        Slime secretStoreSlime = TenantSecretStoreSerializer.toSlime(secretStores);
        String secretStoreParam = new String(SlimeUtils.toJsonBytes(secretStoreSlime), StandardCharsets.UTF_8);

        var prepareParams = createParams(request + "&" + PrepareParams.TENANT_SECRET_STORES_PARAM_NAME + "=" + URLEncoder.encode(secretStoreParam, StandardCharsets.UTF_8), TenantName.from("foo"));
        assertEquals(1, prepareParams.tenantSecretStores().size());
        TenantSecretStore tenantSecretStore = prepareParams.tenantSecretStores().get(0);
        assertEquals("name", tenantSecretStore.getName());
        assertEquals("awsId", tenantSecretStore.getAwsId());
        assertEquals("role", tenantSecretStore.getRole());

        // Verify using json object
        var root = SlimeUtils.jsonToSlime(json);
        new Injector().inject(secretStoreSlime.get(), new ObjectInserter(root.get(), PrepareParams.TENANT_SECRET_STORES_PARAM_NAME));
        PrepareParams prepareParamsJson = PrepareParams.fromJson(SlimeUtils.toJsonBytes(root), TenantName.from("foo"), Duration.ofSeconds(60));
        assertPrepareParamsEqual(prepareParams, prepareParamsJson);
    }

    @Test
    public void testCloudAccount() {
        String json = "{\"cloudAccount\": {\"id\": \"012345678912\"}}";
        PrepareParams params = PrepareParams.fromJson(json.getBytes(StandardCharsets.UTF_8), TenantName.defaultName(), Duration.ZERO);
        assertEquals(CloudAccount.from("012345678912"), params.cloudAccount().get());
    }

    private void assertPrepareParamsEqual(PrepareParams urlParams, PrepareParams jsonParams) {
        assertEquals(urlParams.ignoreValidationErrors(), jsonParams.ignoreValidationErrors());
        assertEquals(urlParams.isDryRun(), jsonParams.isDryRun());
        assertEquals(urlParams.isVerbose(), jsonParams.isVerbose());
        assertEquals(urlParams.isBootstrap(), jsonParams.isBootstrap());
        assertEquals(urlParams.force(), jsonParams.force());
        assertEquals(urlParams.waitForResourcesInPrepare(), jsonParams.waitForResourcesInPrepare());
        assertEquals(urlParams.getApplicationId(), jsonParams.getApplicationId());
        assertEquals(urlParams.getTimeoutBudget().timeout(), jsonParams.getTimeoutBudget().timeout());
        assertEquals(urlParams.vespaVersion(), jsonParams.vespaVersion());
        assertEquals(urlParams.containerEndpoints(), jsonParams.containerEndpoints());
        assertEquals(urlParams.endpointCertificateMetadata(), jsonParams.endpointCertificateMetadata());
        assertEquals(urlParams.dockerImageRepository(), jsonParams.dockerImageRepository());
        assertEquals(urlParams.athenzDomain(), jsonParams.athenzDomain());
        assertEquals(urlParams.quota(), jsonParams.quota());
        assertEquals(urlParams.tenantSecretStores(), jsonParams.tenantSecretStores());
    }

    // Create PrepareParams from a request (based on uri and tenant name)
    private static PrepareParams createParams(String uri, TenantName tenantName) {
        return PrepareParams.fromHttpRequest(
                HttpRequest.createTestRequest(uri, com.yahoo.jdisc.http.HttpRequest.Method.PUT),
                tenantName,
                Duration.ofSeconds(60));
    }

}