Filter workspace containers like tools and user's (#12386)

* Filter workspace containers like tools and user's Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com> * Addressed changes. Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com> * Address proposed changes. Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com> * Fixed bug detect during review. Add more tests. Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com> * Fix typo. Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com> * Fix formatter Signed-off-by: Anna Shumilova <ashumilo@redhat.com>
eclipse-che · Jan 30, 2019 · e0b4df0 · e0b4df0
1 parent 610e877
commit e0b4df0
Show file tree

Hide file tree

Showing 5 changed files with 87 additions and 3 deletions.
diff --git a/...e/che/workspace/infrastructure/kubernetes/server/secure/jwtproxy/JwtProxyProvisioner.java b/...e/che/workspace/infrastructure/kubernetes/server/secure/jwtproxy/JwtProxyProvisioner.java
@@ -18,6 +18,8 @@
 import static org.eclipse.che.api.core.model.workspace.config.MachineConfig.MEMORY_REQUEST_ATTRIBUTE;
 import static org.eclipse.che.api.core.model.workspace.config.ServerConfig.SECURE_SERVER_COOKIES_AUTH_ENABLED_ATTRIBUTE;
 import static org.eclipse.che.api.core.model.workspace.config.ServerConfig.UNSECURED_PATHS_ATTRIBUTE;
+import static org.eclipse.che.api.workspace.shared.Constants.CONTAINER_SOURCE_ATTRIBUTE;
+import static org.eclipse.che.api.workspace.shared.Constants.TOOL_CONTAINER_SOURCE;
 import static org.eclipse.che.commons.lang.NameGenerator.generate;
 import static org.eclipse.che.workspace.infrastructure.kubernetes.Constants.CHE_ORIGINAL_NAME_LABEL;
 import static org.eclipse.che.workspace.infrastructure.kubernetes.server.KubernetesServerExposer.SERVER_PREFIX;
@@ -126,7 +128,9 @@ public JwtProxyProvisioner(
             MEMORY_LIMIT_ATTRIBUTE,
             Long.toString(memoryLimitLong),
             MEMORY_REQUEST_ATTRIBUTE,
-            Long.toString(memoryLimitLong));
+            Long.toString(memoryLimitLong),
+            CONTAINER_SOURCE_ATTRIBUTE,
+            TOOL_CONTAINER_SOURCE);
   }
 
   /**

diff --git a/...se/che/workspace/infrastructure/kubernetes/wsplugins/KubernetesPluginsToolingApplier.java b/...se/che/workspace/infrastructure/kubernetes/wsplugins/KubernetesPluginsToolingApplier.java
@@ -14,6 +14,8 @@
 import static java.lang.String.format;
 import static java.util.Collections.emptyList;
 import static org.eclipse.che.api.core.model.workspace.config.Command.WORKING_DIRECTORY_ATTRIBUTE;
+import static org.eclipse.che.api.workspace.shared.Constants.CONTAINER_SOURCE_ATTRIBUTE;
+import static org.eclipse.che.api.workspace.shared.Constants.TOOL_CONTAINER_SOURCE;
 import static org.eclipse.che.workspace.infrastructure.kubernetes.server.secure.SecureServerExposerFactoryProvider.SECURE_EXPOSER_IMPL_PROPERTY;
 
 import com.google.common.annotations.Beta;
@@ -194,6 +196,7 @@ private void addSidecar(
             .build();
 
     InternalMachineConfig machineConfig = machineResolver.resolve();
+    machineConfig.getAttributes().put(CONTAINER_SOURCE_ATTRIBUTE, TOOL_CONTAINER_SOURCE);
     kubernetesEnvironment.getMachines().put(machineName, machineConfig);
 
     sidecarRelatedCommands.forEach(c -> c.getAttributes().put("machineName", machineName));

diff --git a/...re-api-workspace-shared/src/main/java/org/eclipse/che/api/workspace/shared/Constants.java b/...re-api-workspace-shared/src/main/java/org/eclipse/che/api/workspace/shared/Constants.java
@@ -162,5 +162,14 @@ public final class Constants {
 
   public static final String NO_ENVIRONMENT_RECIPE_TYPE = "no-environment";
 
+  /** Attribute to mark source of the container. */
+  public static final String CONTAINER_SOURCE_ATTRIBUTE = "source";
+
+  /** Mark containers applied to workspace with help recipe definition. */
+  public static final String RECIPE_CONTAINER_SOURCE = "recipe";
+
+  /** Mark containers created workspace api like tooling for user development. */
+  public static final String TOOL_CONTAINER_SOURCE = "tool";
+
   private Constants() {}
 }
diff --git a/...java/org/eclipse/che/api/workspace/server/spi/environment/InternalEnvironmentFactory.java b/...java/org/eclipse/che/api/workspace/server/spi/environment/InternalEnvironmentFactory.java
@@ -11,6 +11,9 @@
  */
 package org.eclipse.che.api.workspace.server.spi.environment;
 
+import static org.eclipse.che.api.workspace.shared.Constants.CONTAINER_SOURCE_ATTRIBUTE;
+import static org.eclipse.che.api.workspace.shared.Constants.RECIPE_CONTAINER_SOURCE;
+
 import com.google.common.annotations.VisibleForTesting;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -113,7 +116,14 @@ public T create(@Nullable final Environment sourceEnv)
       machinesValidator.validate(machines);
     }
 
-    return doCreate(recipe, machines, warnings);
+    T internalEnv = doCreate(recipe, machines, warnings);
+
+    internalEnv
+        .getMachines()
+        .values()
+        .forEach(m -> m.getAttributes().put(CONTAINER_SOURCE_ATTRIBUTE, RECIPE_CONTAINER_SOURCE));
+
+    return internalEnv;
   }
 
   /**

diff --git a/.../org/eclipse/che/api/workspace/server/spi/environment/InternalEnvironmentFactoryTest.java b/.../org/eclipse/che/api/workspace/server/spi/environment/InternalEnvironmentFactoryTest.java
@@ -16,6 +16,8 @@
 import static java.util.Collections.singletonList;
 import static java.util.Collections.singletonMap;
 import static org.eclipse.che.api.core.model.workspace.config.MachineConfig.MEMORY_LIMIT_ATTRIBUTE;
+import static org.eclipse.che.api.workspace.shared.Constants.CONTAINER_SOURCE_ATTRIBUTE;
+import static org.eclipse.che.api.workspace.shared.Constants.RECIPE_CONTAINER_SOURCE;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyList;
 import static org.mockito.ArgumentMatchers.anyMap;
@@ -196,13 +198,69 @@ public void testDoNotOverrideRamLimitAttributeWhenMachineAlreadyContainsIt() thr
     final InternalMachineConfig machine = mock(InternalMachineConfig.class);
     when(environmentFactory.doCreate(any(), any(), any())).thenReturn(internalEnv);
     when(internalEnv.getMachines()).thenReturn(ImmutableMap.of("testMachine", machine));
-    when(machine.getAttributes()).thenReturn(ImmutableMap.of(MEMORY_LIMIT_ATTRIBUTE, ramLimit));
+
+    Map<String, String> machineAttr = new HashMap<>();
+    machineAttr.put(MEMORY_LIMIT_ATTRIBUTE, ramLimit);
+    when(machine.getAttributes()).thenReturn(machineAttr);
 
     environmentFactory.create(mock(Environment.class));
 
     assertEquals(machine.getAttributes().get(MEMORY_LIMIT_ATTRIBUTE), ramLimit);
   }
 
+  @Test
+  public void testApplyContainerSourceAttributeToTheMachineSpecifiedInEnv() throws Exception {
+    // given
+    final Environment sourceEnv = mock(Environment.class);
+
+    MachineConfigImpl machineConfig = mock(MachineConfigImpl.class);
+    final Map<String, MachineConfigImpl> machineConfigMap =
+        ImmutableMap.of("envMachine", machineConfig);
+    doReturn(machineConfigMap).when(sourceEnv).getMachines();
+
+    when(environmentFactory.doCreate(any(), any(), any()))
+        .thenAnswer(
+            invocation -> {
+              Map<String, InternalMachineConfig> envMachines = invocation.getArgument(1);
+
+              final InternalEnvironment internalEnv = mock(InternalEnvironment.class);
+              when(internalEnv.getMachines()).thenReturn(envMachines);
+              return internalEnv;
+            });
+
+    // when
+    InternalEnvironment resultEnv = environmentFactory.create(sourceEnv);
+
+    // then
+    assertEquals(
+        resultEnv.getMachines().get("envMachine").getAttributes().get(CONTAINER_SOURCE_ATTRIBUTE),
+        RECIPE_CONTAINER_SOURCE);
+  }
+
+  @Test
+  public void testApplyContainerSourceAttributeToTheMachineThatComesFromRecipe() throws Exception {
+    // given
+    final Environment sourceEnv = mock(Environment.class);
+
+    final InternalEnvironment internalEnv = mock(InternalEnvironment.class);
+    final InternalMachineConfig internalMachine = new InternalMachineConfig();
+    when(internalEnv.getMachines()).thenReturn(ImmutableMap.of("internalMachine", internalMachine));
+
+    when(environmentFactory.doCreate(any(), any(), any())).thenReturn(internalEnv);
+
+    // when
+    InternalEnvironment resultEnv = environmentFactory.create(sourceEnv);
+
+    // then
+    assertEquals(
+        resultEnv
+            .getMachines()
+            .get("internalMachine")
+            .getAttributes()
+            .get(CONTAINER_SOURCE_ATTRIBUTE),
+        RECIPE_CONTAINER_SOURCE);
+  }
+
   private InstallerImpl createInstaller(String id, String script) {
     return new InstallerImpl(id, "any", "any", "any", emptyList(), emptyMap(), script, emptyMap());
   }