Skip to content

Commit

Permalink
fixup! Add SecureServerExposer
Browse files Browse the repository at this point in the history
  • Loading branch information
@sleshchenko
sleshchenko committed Jul 5, 2018
1 parent 4e8ca26 commit 113344a
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 53 deletions.
8 changes: 8 additions & 0 deletions ...api-model/src/main/java/org/eclipse/che/api/core/model/workspace/config/ServerConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ public interface ServerConfig {
*/
String INTERNAL_SERVER_ATTRIBUTE = "internal";

/**
* {@link ServerConfig} and {@link Server} attribute name which can identify server as secure or
* non-secure. Requests to secure servers will be authenticated and must contain machine token.
* Attribute value {@code true} makes a server secure, any other value or lack of the
* attribute makes the server non-secure.
*/
String SECURE_SERVER_ATTRIBUTE = "secure";

/**
* Port used by server.
*
Expand Down
2 changes: 1 addition & 1 deletion ...a/org/eclipse/che/workspace/infrastructure/kubernetes/server/KubernetesServerExposer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ public void expose(Map<String, ? extends ServerConfig> servers) throws Infrastru
internalServers.put(key, value);
} else {
// Server is external. Check if it should be secure or not
if ("true".equals(value.getAttributes().get("secure"))) {
if ("true".equals(value.getAttributes().get(ServerConfig.SECURE_SERVER_ATTRIBUTE))) {
secureServers.put(key, value);
} else {
externalServers.put(key, value);
Expand Down
130 changes: 78 additions & 52 deletions ...g/eclipse/che/workspace/infrastructure/kubernetes/server/KubernetesServerExposerTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,15 @@
public class KubernetesServerExposerTest {

@Mock private ExternalServerExposerStrategy<KubernetesEnvironment> externalServerExposerStrategy;
// TODO Add tests
@Mock private SecureServerExposer<KubernetesEnvironment> secureServerExposer;

private static final Map<String, String> ATTRIBUTES_MAP = singletonMap("key", "value");
private static final Map<String, String> INTERNAL_SERVER_ATTRIBUTE_MAP =
singletonMap(ServerConfig.INTERNAL_SERVER_ATTRIBUTE, Boolean.TRUE.toString());

private static final Map<String, String> SECURE_SERVER_ATTRIBUTE_MAP =
singletonMap(ServerConfig.SECURE_SERVER_ATTRIBUTE, Boolean.TRUE.toString());

private static final Pattern SERVER_PREFIX_REGEX =
Pattern.compile('^' + SERVER_PREFIX + "[A-z0-9]{" + SERVER_UNIQUE_PART_SIZE + "}-pod-main$");
private static final String MACHINE_NAME = "pod/main";
Expand Down Expand Up @@ -278,33 +280,36 @@ public void shouldExposeContainerPortAndCreateServiceForInternalServer() throws
}

@Test
public void shouldExposeInternalAndExternalServers() throws Exception {
public void shouldExposeInternalAndExternalAndSecureServers() throws Exception {
// given
ServerConfigImpl secureServerConfig =
new ServerConfigImpl("8282/tcp", "http", "/api", SECURE_SERVER_ATTRIBUTE_MAP);
ServerConfigImpl internalServerConfig =
new ServerConfigImpl("8080/tcp", "http", "/api", INTERNAL_SERVER_ATTRIBUTE_MAP);
ServerConfigImpl externalServerConfig =
new ServerConfigImpl("9090/tcp", "http", "/api", ATTRIBUTES_MAP);
Map<String, ServerConfigImpl> serversToExpose =
ImmutableMap.of("int-server", internalServerConfig, "ext-server", externalServerConfig);
ImmutableMap.of(
"int-server",
internalServerConfig,
"ext-server",
externalServerConfig,
"secure-server",
secureServerConfig);

// when
serverExposer.expose(serversToExpose);

// then
assertThatInternalServerIsExposed(
MACHINE_NAME,
"int-server",
"tcp",
8080,
new ServerConfigImpl(internalServerConfig).withAttributes(INTERNAL_SERVER_ATTRIBUTE_MAP));
MACHINE_NAME, "int-server", "tcp", 8080, new ServerConfigImpl(internalServerConfig));
assertThatExternalServerIsExposed(
MACHINE_NAME,
"tcp",
9090,
"ext-server",
new ServerConfigImpl(externalServerConfig).withAttributes(ATTRIBUTES_MAP));
MACHINE_NAME, "tcp", 9090, "ext-server", new ServerConfigImpl(externalServerConfig));
assertThatSecureServerIsExposed(
MACHINE_NAME, "tcp", 8282, "secure-server", new ServerConfigImpl(secureServerConfig));
}

@SuppressWarnings("SameParameterValue")
private void assertThatExternalServerIsExposed(
String machineName,
String portProtocol,
Expand All @@ -322,38 +327,14 @@ private void assertThatExternalServersAreExposed(
Integer port,
Map<String, ServerConfig> expectedServers) {
// then
assertTrue(
container
.getPorts()
.stream()
.anyMatch(
p ->
p.getContainerPort().equals(port)
&& p.getProtocol().equals(portProtocol.toUpperCase())));
assertThatContainerPortIsExposed(portProtocol, port);
// ensure that service is created

Service service = null;
for (Entry<String, Service> entry : kubernetesEnvironment.getServices().entrySet()) {
if (SERVER_PREFIX_REGEX.matcher(entry.getKey()).matches()) {
service = entry.getValue();
break;
}
}
Service service = findContainerRelatedService();
assertNotNull(service);

// ensure that required service port is exposed
Optional<ServicePort> servicePortOpt =
service
.getSpec()
.getPorts()
.stream()
.filter(p -> p.getTargetPort().getIntVal().equals(port))
.findAny();
assertTrue(servicePortOpt.isPresent());
ServicePort servicePort = servicePortOpt.get();
assertEquals(servicePort.getTargetPort().getIntVal(), port);
assertEquals(servicePort.getPort(), port);
assertEquals(servicePort.getName(), SERVER_PREFIX + "-" + port);
ServicePort servicePort = assertThatServicePortIsExposed(port, service);

Annotations.Deserializer serviceAnnotations =
Annotations.newDeserializer(service.getMetadata().getAnnotations());
Expand All @@ -368,14 +349,64 @@ private void assertThatExternalServersAreExposed(
expectedServers);
}

@SuppressWarnings("SameParameterValue")
private void assertThatSecureServerIsExposed(
String machineName,
String portProtocol,
Integer port,
String serverName,
ServerConfig serverConfig)
throws Exception {
// then
assertThatContainerPortIsExposed(portProtocol, port);
// ensure that service is created

Service service = findContainerRelatedService();
assertNotNull(service);

// ensure that required service port is exposed
ServicePort servicePort = assertThatServicePortIsExposed(port, service);

Annotations.Deserializer serviceAnnotations =
Annotations.newDeserializer(service.getMetadata().getAnnotations());
assertEquals(serviceAnnotations.machineName(), machineName);

verify(secureServerExposer)
.expose(
kubernetesEnvironment,
machineName,
service.getMetadata().getName(),
servicePort,
ImmutableMap.of(serverName, serverConfig));
}

@SuppressWarnings("SameParameterValue")
private void assertThatInternalServerIsExposed(
String machineName,
String serverNameRegex,
String portProtocol,
Integer port,
ServerConfigImpl expected) {
// then
assertThatContainerPortIsExposed(portProtocol, port);

// ensure that service is created

Service service = findContainerRelatedService();
assertNotNull(service);

// ensure that required service port is exposed
assertThatServicePortIsExposed(port, service);

Annotations.Deserializer serviceAnnotations =
Annotations.newDeserializer(service.getMetadata().getAnnotations());
assertEquals(serviceAnnotations.machineName(), machineName);

Map<String, ServerConfigImpl> servers = serviceAnnotations.servers();
ServerConfig serverConfig = servers.get(serverNameRegex);
assertEquals(serverConfig, expected);
}

private void assertThatContainerPortIsExposed(String portProtocol, Integer port) {
assertTrue(
container
.getPorts()
Expand All @@ -384,18 +415,20 @@ private void assertThatInternalServerIsExposed(
p ->
p.getContainerPort().equals(port)
&& p.getProtocol().equals(portProtocol.toUpperCase())));
// ensure that service is created
}

private Service findContainerRelatedService() {
Service service = null;
for (Entry<String, Service> entry : kubernetesEnvironment.getServices().entrySet()) {
if (SERVER_PREFIX_REGEX.matcher(entry.getKey()).matches()) {
service = entry.getValue();
break;
}
}
assertNotNull(service);
return service;
}

// ensure that required service port is exposed
private ServicePort assertThatServicePortIsExposed(Integer port, Service service) {
Optional<ServicePort> servicePortOpt =
service
.getSpec()
Expand All @@ -408,13 +441,6 @@ private void assertThatInternalServerIsExposed(
assertEquals(servicePort.getTargetPort().getIntVal(), port);
assertEquals(servicePort.getPort(), port);
assertEquals(servicePort.getName(), SERVER_PREFIX + "-" + port);

Annotations.Deserializer serviceAnnotations =
Annotations.newDeserializer(service.getMetadata().getAnnotations());
assertEquals(serviceAnnotations.machineName(), machineName);

Map<String, ServerConfigImpl> servers = serviceAnnotations.servers();
ServerConfig serverConfig = servers.get(serverNameRegex);
assertEquals(serverConfig, expected);
return servicePort;
}
}

0 comments on commit 113344a

Please sign in to comment.