// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.config.application.api;
import com.google.common.collect.ImmutableSet;
import com.yahoo.config.provision.Environment;
import com.yahoo.config.provision.RegionName;
import org.junit.Test;
import java.io.StringReader;
import java.time.Instant;
import java.time.ZoneId;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import static com.yahoo.config.application.api.Notifications.Role.author;
import static com.yahoo.config.application.api.Notifications.When.failing;
import static com.yahoo.config.application.api.Notifications.When.failingCommit;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
/**
* @author bratseth
*/
// TODO: Remove after November 2019
public class DeploymentSpecDeprecatedAPITest {
@Test
public void testSpec() {
String specXml = "" +
" " +
"";
StringReader r = new StringReader(specXml);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals(specXml, spec.xmlForm());
assertEquals(1, spec.steps().size());
assertFalse(spec.majorVersion().isPresent());
assertTrue(spec.steps().get(0).deploysTo(Environment.test));
assertTrue(spec.includes(Environment.test, Optional.empty()));
assertFalse(spec.includes(Environment.test, Optional.of(RegionName.from("region1"))));
assertFalse(spec.includes(Environment.staging, Optional.empty()));
assertFalse(spec.includes(Environment.prod, Optional.empty()));
}
@Test
public void testSpecPinningMajorVersion() {
String specXml = "" +
" " +
"";
StringReader r = new StringReader(specXml);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals(specXml, spec.xmlForm());
assertEquals(1, spec.steps().size());
assertTrue(spec.majorVersion().isPresent());
assertEquals(6, (int)spec.majorVersion().get());
}
@Test
public void stagingSpec() {
StringReader r = new StringReader(
"" +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals(2, spec.steps().size());
assertTrue(spec.steps().get(0).deploysTo(Environment.test));
assertTrue(spec.steps().get(1).deploysTo(Environment.staging));
assertTrue(spec.includes(Environment.test, Optional.empty()));
assertFalse(spec.includes(Environment.test, Optional.of(RegionName.from("region1"))));
assertTrue(spec.includes(Environment.staging, Optional.empty()));
assertFalse(spec.includes(Environment.prod, Optional.empty()));
}
@Test
public void minimalProductionSpec() {
StringReader r = new StringReader(
"" +
" " +
" us-east1" +
" us-west1" +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals(4, spec.steps().size());
assertTrue(spec.steps().get(0).deploysTo(Environment.test));
assertTrue(spec.steps().get(1).deploysTo(Environment.staging));
assertTrue(spec.steps().get(2).deploysTo(Environment.prod, Optional.of(RegionName.from("us-east1"))));
assertFalse(((DeploymentSpec.DeclaredZone)spec.steps().get(2)).active());
assertTrue(spec.steps().get(3).deploysTo(Environment.prod, Optional.of(RegionName.from("us-west1"))));
assertTrue(((DeploymentSpec.DeclaredZone)spec.steps().get(3)).active());
assertTrue(spec.includes(Environment.test, Optional.empty()));
assertFalse(spec.includes(Environment.test, Optional.of(RegionName.from("region1"))));
assertTrue(spec.includes(Environment.staging, Optional.empty()));
assertTrue(spec.includes(Environment.prod, Optional.of(RegionName.from("us-east1"))));
assertTrue(spec.includes(Environment.prod, Optional.of(RegionName.from("us-west1"))));
assertFalse(spec.includes(Environment.prod, Optional.of(RegionName.from("no-such-region"))));
}
@Test
public void deploymentSpecWithTest() {
StringReader r = new StringReader(
"" +
" " +
" " +
" " +
" us-east1" +
" us-west1" +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals("[test, staging, prod.us-east1, prod.us-west1]", spec.steps().toString());
}
@Test
public void deploymentSpecWithTestInsideInstance() {
StringReader r = new StringReader(
"" +
" " +
" " +
" " +
" " +
" us-east1" +
" us-west1" +
" " +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals("[test, staging, prod.us-east1, prod.us-west1]", spec.steps().toString());
}
@Test
public void deploymentSpecWithTestOutsideInstance() {
StringReader r = new StringReader(
"" +
" " +
" " +
" " +
" " +
" us-east1" +
" us-west1" +
" " +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals("[test, staging, prod.us-east1, prod.us-west1]", spec.steps().toString());
}
@Test
public void maximalProductionSpec() {
StringReader r = new StringReader(
"" +
" " +
" " +
" " +
" us-east1" +
" " +
" us-west1" +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals(5, spec.steps().size());
assertEquals(4, spec.zones().size());
assertTrue(spec.steps().get(0).deploysTo(Environment.test));
assertTrue(spec.steps().get(1).deploysTo(Environment.staging));
assertTrue(spec.steps().get(2).deploysTo(Environment.prod, Optional.of(RegionName.from("us-east1"))));
assertFalse(((DeploymentSpec.DeclaredZone)spec.steps().get(2)).active());
assertTrue(spec.steps().get(3) instanceof DeploymentSpec.Delay);
assertEquals(3 * 60 * 60 + 30 * 60, ((DeploymentSpec.Delay)spec.steps().get(3)).duration().getSeconds());
assertTrue(spec.steps().get(4).deploysTo(Environment.prod, Optional.of(RegionName.from("us-west1"))));
assertTrue(((DeploymentSpec.DeclaredZone)spec.steps().get(4)).active());
assertTrue(spec.includes(Environment.test, Optional.empty()));
assertFalse(spec.includes(Environment.test, Optional.of(RegionName.from("region1"))));
assertTrue(spec.includes(Environment.staging, Optional.empty()));
assertTrue(spec.includes(Environment.prod, Optional.of(RegionName.from("us-east1"))));
assertTrue(spec.includes(Environment.prod, Optional.of(RegionName.from("us-west1"))));
assertFalse(spec.includes(Environment.prod, Optional.of(RegionName.from("no-such-region"))));
}
@Test
public void productionSpecWithGlobalServiceId() {
StringReader r = new StringReader(
"" +
" " +
" us-east-1" +
" us-west-1" +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
}
@Test(expected=IllegalArgumentException.class)
public void globalServiceIdInTest() {
StringReader r = new StringReader(
"" +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
}
@Test(expected=IllegalArgumentException.class)
public void globalServiceIdInStaging() {
StringReader r = new StringReader(
"" +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
}
@Test
public void maxDelayExceeded() {
try {
StringReader r = new StringReader(
"" +
" " +
" " +
" us-west-1" +
" " +
" us-central-1" +
" " +
" us-east-3" +
" " +
""
);
DeploymentSpec.fromXml(r);
fail("Expected exception due to exceeding the max total delay");
}
catch (IllegalArgumentException e) {
// success
assertEquals("The total delay specified is PT24H1S but max 24 hours is allowed", e.getMessage());
}
}
@Test
public void testEmpty() {
assertTrue(DeploymentSpec.empty.steps().isEmpty());
assertEquals("", DeploymentSpec.empty.xmlForm());
}
@Test
public void productionSpecWithParallelDeployments() {
StringReader r = new StringReader(
"\n" +
" \n" +
" us-west-1\n" +
" \n" +
" us-central-1\n" +
" us-east-3\n" +
" \n" +
" \n" +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
DeploymentSpec.ParallelZones parallelZones = ((DeploymentSpec.ParallelZones) spec.steps().get(3));
assertEquals(2, parallelZones.zones().size());
assertEquals(RegionName.from("us-central-1"), parallelZones.zones().get(0).region().get());
assertEquals(RegionName.from("us-east-3"), parallelZones.zones().get(1).region().get());
}
@Test
public void productionSpecWithDuplicateRegions() {
StringReader r = new StringReader(
"\n" +
" \n" +
" us-west-1\n" +
" \n" +
" us-west-1\n" +
" us-central-1\n" +
" us-east-3\n" +
" \n" +
" \n" +
""
);
try {
DeploymentSpec.fromXml(r);
fail("Expected exception");
} catch (IllegalArgumentException e) {
assertEquals("prod.us-west-1 is listed twice in deployment.xml", e.getMessage());
}
}
@Test(expected = IllegalArgumentException.class)
public void deploymentSpecWithIllegallyOrderedDeploymentSpec1() {
StringReader r = new StringReader(
"\n" +
" \n" +
" \n" +
" us-west-1\n" +
" \n" +
" \n" +
""
);
DeploymentSpec.fromXml(r);
}
@Test(expected = IllegalArgumentException.class)
public void deploymentSpecWithIllegallyOrderedDeploymentSpec2() {
StringReader r = new StringReader(
"\n" +
" \n" +
" \n" +
" \n" +
" us-west-1\n" +
" \n" +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
}
@Test
public void deploymentSpecWithChangeBlocker() {
StringReader r = new StringReader(
"\n" +
" \n" +
" \n" +
" \n" +
" us-west-1\n" +
" \n" +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals(2, spec.changeBlocker().size());
assertTrue(spec.changeBlocker().get(0).blocksVersions());
assertFalse(spec.changeBlocker().get(0).blocksRevisions());
assertEquals(ZoneId.of("UTC"), spec.changeBlocker().get(0).window().zone());
assertTrue(spec.changeBlocker().get(1).blocksVersions());
assertTrue(spec.changeBlocker().get(1).blocksRevisions());
assertEquals(ZoneId.of("CET"), spec.changeBlocker().get(1).window().zone());
assertTrue(spec.canUpgradeAt(Instant.parse("2017-09-18T14:15:30.00Z")));
assertFalse(spec.canUpgradeAt(Instant.parse("2017-09-18T15:15:30.00Z")));
assertFalse(spec.canUpgradeAt(Instant.parse("2017-09-18T16:15:30.00Z")));
assertTrue(spec.canUpgradeAt(Instant.parse("2017-09-18T17:15:30.00Z")));
assertTrue(spec.canUpgradeAt(Instant.parse("2017-09-23T09:15:30.00Z")));
assertFalse(spec.canUpgradeAt(Instant.parse("2017-09-23T08:15:30.00Z"))); // 10 in CET
assertTrue(spec.canUpgradeAt(Instant.parse("2017-09-23T10:15:30.00Z")));
}
@Test
public void athenz_config_is_read_from_deployment() {
StringReader r = new StringReader(
"\n" +
" \n" +
" us-west-1\n" +
" \n" +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals(spec.athenzDomain().get().value(), "domain");
assertEquals(spec.athenzService(Environment.prod, RegionName.from("us-west-1")).get().value(), "service");
}
@Test
public void athenz_config_is_propagated_through_parallel_zones() {
StringReader r = new StringReader(
"" +
" " +
" us-central-1" +
" " +
" us-west-1" +
" us-east-3" +
" " +
" " +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals("domain", spec.athenzDomain().get().value());
assertEquals("prod-service", spec.athenzService(Environment.prod,
RegionName.from("us-central-1")).get().value());
assertEquals("prod-service", spec.athenzService(Environment.prod,
RegionName.from("us-west-1")).get().value());
assertEquals("prod-service", spec.athenzService(Environment.prod,
RegionName.from("us-east-3")).get().value());
assertEquals("domain", spec.athenzDomain().get().value());
}
@Test
public void athenz_service_is_overridden_from_environment() {
StringReader r = new StringReader(
"\n" +
" \n" +
" \n" +
" us-west-1\n" +
" \n" +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
assertEquals(spec.athenzDomain().get().value(), "domain");
assertEquals(spec.athenzService(Environment.prod, RegionName.from("us-west-1")).get().value(), "prod-service");
}
@Test(expected = IllegalArgumentException.class)
public void it_fails_when_athenz_service_is_not_defined() {
StringReader r = new StringReader(
"\n" +
" \n" +
" us-west-1\n" +
" \n" +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
}
@Test(expected = IllegalArgumentException.class)
public void it_fails_when_athenz_service_is_configured_but_not_athenz_domain() {
StringReader r = new StringReader(
"\n" +
" \n" +
" us-west-1\n" +
" \n" +
""
);
DeploymentSpec spec = DeploymentSpec.fromXml(r);
}
@Test
public void noNotifications() {
assertEquals(Notifications.none(),
DeploymentSpec.fromXml("").notifications());
}
@Test
public void emptyNotifications() {
DeploymentSpec spec = DeploymentSpec.fromXml("\n" +
" " +
"");
assertEquals(Notifications.none(),
spec.notifications());
}
@Test
public void someNotifications() {
DeploymentSpec spec = DeploymentSpec.fromXml("\n" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
"");
assertEquals(ImmutableSet.of(author), spec.notifications().emailRolesFor(failing));
assertEquals(ImmutableSet.of(author), spec.notifications().emailRolesFor(failingCommit));
assertEquals(ImmutableSet.of("john@dev", "jane@dev"), spec.notifications().emailAddressesFor(failingCommit));
assertEquals(ImmutableSet.of("jane@dev"), spec.notifications().emailAddressesFor(failing));
}
@Test
public void customTesterFlavor() {
DeploymentSpec spec = DeploymentSpec.fromXml("\n" +
" \n" +
" \n" +
" us-north-7\n" +
" \n" +
"");
assertEquals(Optional.of("d-1-4-20"), spec.steps().get(0).zones().get(0).testerFlavor());
assertEquals(Optional.empty(), spec.steps().get(1).zones().get(0).testerFlavor());
assertEquals(Optional.of("d-2-8-50"), spec.steps().get(2).zones().get(0).testerFlavor());
}
@Test
public void noEndpoints() {
assertEquals(Collections.emptyList(), DeploymentSpec.fromXml("").endpoints());
}
@Test
public void emptyEndpoints() {
final var spec = DeploymentSpec.fromXml("");
assertEquals(Collections.emptyList(), spec.endpoints());
}
@Test
public void someEndpoints() {
final var spec = DeploymentSpec.fromXml("" +
"" +
" " +
" us-east" +
" " +
" " +
" " +
" us-east" +
" " +
" " +
" " +
" " +
"");
assertEquals(
List.of("foo", "nalle", "default"),
spec.endpoints().stream().map(Endpoint::endpointId).collect(Collectors.toList())
);
assertEquals(
List.of("bar", "frosk", "quux"),
spec.endpoints().stream().map(Endpoint::containerId).collect(Collectors.toList())
);
assertEquals(Set.of(RegionName.from("us-east")), spec.endpoints().get(0).regions());
}
@Test
public void invalidEndpoints() {
assertInvalid(""); // Uppercase
assertInvalid(""); // Starting with non-character
assertInvalid(""); // Non-alphanumeric
assertInvalid("");
assertInvalid(""); // Multiple consecutive dashes
assertInvalid(""); // Trailing dash
assertInvalid(""); // Too long
assertInvalid(""); // Duplicate
}
@Test
public void validEndpoints() {
assertEquals(List.of("default"), endpointIds(""));
assertEquals(List.of("default"), endpointIds(""));
assertEquals(List.of("f"), endpointIds(""));
assertEquals(List.of("foo"), endpointIds(""));
assertEquals(List.of("foo-bar"), endpointIds(""));
assertEquals(List.of("foo", "bar"), endpointIds(""));
assertEquals(List.of("fooooooooooo"), endpointIds(""));
}
@Test
public void endpointDefaultRegions() {
var spec = DeploymentSpec.fromXml("" +
"" +
" " +
" us-east" +
" us-west" +
" " +
" " +
" " +
" us-east" +
" " +
" " +
" " +
" " +
"");
assertEquals(Set.of("us-east"), endpointRegions("foo", spec));
assertEquals(Set.of("us-east", "us-west"), endpointRegions("nalle", spec));
assertEquals(Set.of("us-east", "us-west"), endpointRegions("default", spec));
}
private static void assertInvalid(String endpointTag) {
try {
endpointIds(endpointTag);
fail("Expected exception for input '" + endpointTag + "'");
} catch (IllegalArgumentException ignored) {}
}
private static Set endpointRegions(String endpointId, DeploymentSpec spec) {
return spec.endpoints().stream()
.filter(endpoint -> endpoint.endpointId().equals(endpointId))
.flatMap(endpoint -> endpoint.regions().stream())
.map(RegionName::value)
.collect(Collectors.toSet());
}
private static List endpointIds(String endpointTag) {
var xml = "" +
" " +
" us-east" +
" " +
" " +
endpointTag +
" " +
"";
return DeploymentSpec.fromXml(xml).endpoints().stream()
.map(Endpoint::endpointId)
.collect(Collectors.toList());
}
}