Fix issue eclipse-che#6953 ... (eclipse-che#7004)

... by restoring the previous `WsAgentPingRequestFactory` behavior, and
providing a new custom server evaluation template strategy when both
internal *and* external addresses should be based on the custom
template. 

Signed-off-by: David Festal <dfestal@redhat.com>

Author: davidfestal

assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/codenvy/che.properties

@@ -214,7 +214,9 @@ che.docker.ip.external=NULL
 #   - 'custom': The evaluation strategy may be customized through a template property.
 #   - 'docker-local-custom':  internal address is set as in docker-local strategy, external address is composed
 #                     as in the custom strategy with the 'template' and the 'external.protocol' properties.
-
+#   - 'always-external-custom':  similar to 'docker-local-custom' strategy, but both the internal and external addresses
+#                     are composed strategy with the 'template' and the 'external.protocol' properties.
+#
 # The 'docker-local' strategy may be useful if a firewall prevents communication between che-server and
 # workspace containers, but will prevent communication when che-server and workspace containers are not
 # on the same Docker network.

dockerfiles/init/modules/openshift/files/scripts/deploy_che.sh

@@ -404,7 +404,7 @@ if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then
           - name: \"CHE_WORKSPACE_CHE__SERVER__ENDPOINT\"
             value: \"\"
 $MULTI_USER_REPLACEMENT_STRING"
-  
+  MULTITENANT_CUSTOM_STRATEGY_REPLACEMENT="s/    che-server-evaluation-strategy: .*/    che-server-evaluation-strategy: always-external-custom/"
   MULTITENANT_CUSTOM_TEMPLATE_REPLACEMENT="s/    che.docker.server_evaluation_strategy.custom.template: .*/    che.docker.server_evaluation_strategy.custom.template: <serverName>-<if(isDevMachine)><workspaceIdWithoutPrefix><else><machineName><endif>-<if(workspacesRoutingSuffix)><user>-che.<workspacesRoutingSuffix><else><externalAddress><endif>/"
   MULTITENANT_IDLING_REPLACEMENT="s/    che-server-timeout-ms: .*/    che-server-timeout-ms: '0'/"
 fi
@@ -436,6 +436,7 @@ if [ "${OPENSHIFT_FLAVOR}" == "minishift" ]; then
     if [ "${CHE_KEYCLOAK_DISABLED}" == "true" ]; then sed "s/    keycloak-disabled: \"false\"/    keycloak-disabled: \"true\"/" ; else cat -; fi | \
     sed "$MULTI_USER_HEALTH_CHECK_REPLACEMENT_STRING" | \
     append_after_match "env:" "${MULTI_USER_REPLACEMENT_STRING}" | \
+    if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then sed "$MULTITENANT_CUSTOM_STRATEGY_REPLACEMENT" ; else cat -; fi | \
     if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then sed "$MULTITENANT_CUSTOM_TEMPLATE_REPLACEMENT" ; else cat -; fi | \
     if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then sed "$MULTITENANT_IDLING_REPLACEMENT" ; else cat -; fi | \
     oc apply --force=true -f -
@@ -450,6 +451,7 @@ elif [ "${OPENSHIFT_FLAVOR}" == "osio" ]; then
     if [ "${CHE_KEYCLOAK_DISABLED}" == "true" ]; then sed "s/    keycloak-disabled: \"false\"/    keycloak-disabled: \"true\"/" ; else cat -; fi | \
     sed "$MULTI_USER_HEALTH_CHECK_REPLACEMENT_STRING" | \
     append_after_match "env:" "${MULTI_USER_REPLACEMENT_STRING}" | \
+    if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then sed "$MULTITENANT_CUSTOM_STRATEGY_REPLACEMENT" ; else cat -; fi | \
     if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then sed "$MULTITENANT_CUSTOM_TEMPLATE_REPLACEMENT" ; else cat -; fi | \
     if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then sed "$MULTITENANT_IDLING_REPLACEMENT" ; else cat -; fi | \
     oc apply --force=true -f -
@@ -470,6 +472,7 @@ else
     if [ "${K8S_VERSION_PRIOR_TO_1_6}" == "true" ]; then sed "s/    che-openshift-precreate-subpaths: \"false\"/    che-openshift-precreate-subpaths: \"true\"/"  ; else cat -; fi | \
     sed "$MULTI_USER_HEALTH_CHECK_REPLACEMENT_STRING" | \
     append_after_match "env:" "${MULTI_USER_REPLACEMENT_STRING}" | \
+    if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then sed "$MULTITENANT_CUSTOM_STRATEGY_REPLACEMENT" ; else cat -; fi | \
     if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then sed "$MULTITENANT_CUSTOM_TEMPLATE_REPLACEMENT" ; else cat -; fi | \
     if [ "${CHE_FABRIC8_MULTITENANT}" == "true" ]; then sed "$MULTITENANT_IDLING_REPLACEMENT" ; else cat -; fi | \
     oc apply --force=true -f -

plugins/plugin-docker/che-plugin-docker-machine/src/main/java/org/eclipse/che/plugin/docker/machine/AlwaysExternalCustomServerEvaluationStrategy.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2012-2017 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.plugin.docker.machine;
+
+import com.google.inject.Inject;
+import com.google.inject.name.Named;
+import java.util.Map;
+import org.eclipse.che.api.machine.server.model.impl.ServerImpl;
+import org.eclipse.che.commons.annotation.Nullable;
+import org.eclipse.che.plugin.docker.client.WorkspacesRoutingSuffixProvider;
+import org.eclipse.che.plugin.docker.client.json.ContainerInfo;
+
+/**
+ * This server evaluation strategy will return a completed {@link ServerImpl} with internal
+ * addresses and external addresses managed by the `custom` evaluation strategy,and its template
+ * property `che.docker.server_evaluation_strategy.custom.template`
+ *
+ * <p>cheExternalAddress can be set using property {@code che.docker.ip.external}. This strategy is
+ * useful when Che and the workspace servers need to be exposed on the same single TCP port
+ *
+ * @author David Festal <dfestal@redhat.com>
+ * @see ServerEvaluationStrategy
+ */
+public class AlwaysExternalCustomServerEvaluationStrategy extends BaseServerEvaluationStrategy {
+
+  @Inject
+  public AlwaysExternalCustomServerEvaluationStrategy(
+      @Nullable @Named("che.docker.ip") String internalAddress,
+      @Nullable @Named("che.docker.ip.external") String externalAddress,
+      @Nullable @Named("che.docker.server_evaluation_strategy.custom.template")
+          String cheDockerCustomExternalTemplate,
+      @Nullable @Named("che.docker.server_evaluation_strategy.custom.external.protocol")
+          String cheDockerCustomExternalProtocol,
+      @Named("che.port") String chePort,
+      WorkspacesRoutingSuffixProvider cheWorkspacesRoutingSuffixProvider) {
+    super(
+        internalAddress,
+        externalAddress,
+        cheDockerCustomExternalTemplate,
+        cheDockerCustomExternalProtocol,
+        chePort,
+        true,
+        cheWorkspacesRoutingSuffixProvider);
+  }
+
+  @Override
+  protected Map<String, String> getInternalAddressesAndPorts(
+      ContainerInfo containerInfo, String internalHost) {
+    return super.getExternalAddressesAndPorts(containerInfo, internalHost);
+  }
+}

plugins/plugin-docker/che-plugin-docker-machine/src/main/java/org/eclipse/che/plugin/docker/machine/local/LocalDockerModule.java

@@ -20,6 +20,7 @@
 import org.eclipse.che.api.machine.server.spi.Instance;
 import org.eclipse.che.api.machine.server.spi.InstanceProcess;
 import org.eclipse.che.plugin.docker.client.DockerConnector;
+import org.eclipse.che.plugin.docker.machine.AlwaysExternalCustomServerEvaluationStrategy;
 import org.eclipse.che.plugin.docker.machine.DockerInstance;
 import org.eclipse.che.plugin.docker.machine.DockerInstanceRuntimeInfo;
 import org.eclipse.che.plugin.docker.machine.DockerProcess;
@@ -62,6 +63,9 @@ protected void configure() {
     strategies
         .addBinding("custom")
         .to(org.eclipse.che.plugin.docker.machine.CustomServerEvaluationStrategy.class);
+    strategies
+        .addBinding("always-external-custom")
+        .to(AlwaysExternalCustomServerEvaluationStrategy.class);
 
     bind(org.eclipse.che.plugin.docker.machine.node.WorkspaceFolderPathProvider.class)
         .to(

wsmaster/che-core-api-workspace/src/main/java/org/eclipse/che/api/agent/server/WsAgentPingRequestFactory.java

@@ -70,13 +70,10 @@ public HttpJsonRequest createRequest(Machine machine) throws ServerException {
           servers);
       throw new ServerException(WS_AGENT_SERVER_NOT_FOUND_ERROR);
     }
-    String wsAgentPingUrl = wsAgentServer.getUrl();
+    String wsAgentPingUrl = wsAgentServer.getProperties().getInternalUrl();
     if (isNullOrEmpty(wsAgentPingUrl)) {
-      wsAgentPingUrl = wsAgentServer.getProperties().getInternalUrl();
-      if (isNullOrEmpty(wsAgentPingUrl)) {
-        LOG.error(WS_AGENT_URL_IS_NULL_OR_EMPTY_ERROR);
-        throw new ServerException(WS_AGENT_URL_IS_NULL_OR_EMPTY_ERROR);
-      }
+      LOG.error(WS_AGENT_URL_IS_NULL_OR_EMPTY_ERROR);
+      throw new ServerException(WS_AGENT_URL_IS_NULL_OR_EMPTY_ERROR);
     }
     // since everrest mapped on the slash in case of it absence
     // we will always obtain not found response