CHE-6730 Rename user token to machine token (eclipse-che#7036)

sleshchenko · web-flow · commit e90eaa97fe06 · 2017-10-27T16:23:47.000+03:00
diff --git a/agents/git-credentials/src/main/resources/installers/1.0.0/org.eclipse.che.git.script.sh b/agents/git-credentials/src/main/resources/installers/1.0.0/org.eclipse.che.git.script.sh
@@ -11,7 +11,7 @@
 
 SCRIPT_FILE=~/.ssh/git.sh
 
-token=$(if [ "$USER_TOKEN" != "dummy_token" ]; then echo "$USER_TOKEN"; fi)
+token=$(if [ "$CHE_MACHINE_TOKEN" != "dummy_token" ]; then echo "$CHE_MACHINE_TOKEN"; fi)
 che_host=$(cat /etc/hosts | grep che-host | awk '{print $1;}')
 api_url=$(if [ "$CHE_API" != "http://che-host:8080/api" ]; then echo "$CHE_API"; else echo "$che_host:8080/api"; fi)
 
diff --git a/agents/go-agents/bootstrapper/cfg/cfg.go b/agents/go-agents/bootstrapper/cfg/cfg.go
@@ -136,9 +136,9 @@ func Parse() {
 		log.Fatal("Push logs endpoint protocol must be either ws or wss")
 	}
 
-	// auth-enabled - fetch USER_TOKEN
+	// auth-enabled - fetch CHE_MACHINE_TOKEN
 	if AuthEnabled {
-		Token = os.Getenv("USER_TOKEN")
+		Token = os.Getenv("CHE_MACHINE_TOKEN")
 	}
 
 	// runtime-id
diff --git a/assembly-multiuser/assembly-wsagent-war/src/main/java/org/eclipse/che/wsagent/server/AgentHttpJsonRequestFactory.java b/assembly-multiuser/assembly-wsagent-war/src/main/java/org/eclipse/che/wsagent/server/AgentHttpJsonRequestFactory.java
@@ -20,25 +20,25 @@
 
 /**
  * Implementation of {@link org.eclipse.che.api.core.rest.HttpJsonRequestFactory} that add
- * ```user.token``` as authorization header. Used to make request from ws-agent to ws-master.
+ * ```machine.token``` as authorization header. Used to make request from ws-agent to ws-master.
  */
 @Singleton
 public class AgentHttpJsonRequestFactory extends DefaultHttpJsonRequestFactory {
 
-  private final String TOKEN;
+  private final String machineToken;
 
   @Inject
-  public AgentHttpJsonRequestFactory(@Named("user.token") String token) {
-    this.TOKEN = token;
+  public AgentHttpJsonRequestFactory(@Named("machine.token") String machineToken) {
+    this.machineToken = machineToken;
   }
 
   @Override
   public HttpJsonRequest fromUrl(@NotNull String url) {
-    return super.fromUrl(url).setAuthorizationHeader(TOKEN);
+    return super.fromUrl(url).setAuthorizationHeader(machineToken);
   }
 
   @Override
   public HttpJsonRequest fromLink(@NotNull Link link) {
-    return super.fromLink(link).setAuthorizationHeader(TOKEN);
+    return super.fromLink(link).setAuthorizationHeader(machineToken);
   }
 }
diff --git a/dashboard/src/app/diagnostics/test/diagnostics-workspace-start-check.factory.ts b/dashboard/src/app/diagnostics/test/diagnostics-workspace-start-check.factory.ts
@@ -210,7 +210,7 @@ export class DiagnosticsWorkspaceStartCheck {
             this.cheWorkspace.fetchWorkspaceDetails(workspace.id).then(() => {
               let workspace = this.cheWorkspace.getWorkspaceById(workspaceId);
               diagnosticCallback.shared('workspace', workspace);
-              diagnosticCallback.shared('machineToken', workspace.runtime.devMachine.runtime.envVariables['USER_TOKEN']);
+              diagnosticCallback.shared('machineToken', workspace.runtime.devMachine.runtime.envVariables['CHE_MACHINE_TOKEN']);
               diagnosticCallback.success('Starting workspace OK');
             })
           });
@@ -255,7 +255,7 @@ export class DiagnosticsWorkspaceStartCheck {
             this.cheWorkspace.fetchWorkspaceDetails(workspace.id).then(() => {
               let workspace = this.cheWorkspace.getWorkspaceById(workspaceId);
               diagnosticCallback.shared('workspace', workspace);
-              diagnosticCallback.shared('machineToken', workspace.runtime.devMachine.runtime.envVariables['USER_TOKEN']);
+              diagnosticCallback.shared('machineToken', workspace.runtime.devMachine.runtime.envVariables['CHE_MACHINE_TOKEN']);
               let newCallback : DiagnosticCallback = diagnosticCallback.newCallback('Test connection from browser to workspace agent by using Workspace Agent IP');
               this.diagnosticsRunningWorkspaceCheck.checkWsAgent(newCallback, false);
               let websocketCallback : DiagnosticCallback = diagnosticCallback.newCallback('Test connection from browser to workspace agent with websocket');
diff --git a/infrastructures/docker/infrastructure/src/main/java/org/eclipse/che/workspace/infrastructure/docker/DockerMachine.java b/infrastructures/docker/infrastructure/src/main/java/org/eclipse/che/workspace/infrastructure/docker/DockerMachine.java
@@ -68,8 +68,8 @@ public class DockerMachine implements Machine {
    */
   public static final String CHE_HOST = "che-host";
 
-  /** Environment variable that will be setup in developer machine and contains user token. */
-  public static final String USER_TOKEN = "USER_TOKEN";
+  /** Environment variable that will be setup in developer machine and contains machine token. */
+  public static final String CHE_MACHINE_TOKEN = "CHE_MACHINE_TOKEN";
 
   private final String container;
   private final DockerConnector docker;
diff --git a/infrastructures/docker/infrastructure/src/main/java/org/eclipse/che/workspace/infrastructure/docker/provisioner/server/MachineTokenEnvVarProvider.java b/infrastructures/docker/infrastructure/src/main/java/org/eclipse/che/workspace/infrastructure/docker/provisioner/server/MachineTokenEnvVarProvider.java
@@ -10,7 +10,7 @@
  */
 package org.eclipse.che.workspace.infrastructure.docker.provisioner.server;
 
-import static org.eclipse.che.workspace.infrastructure.docker.DockerMachine.USER_TOKEN;
+import static org.eclipse.che.workspace.infrastructure.docker.DockerMachine.CHE_MACHINE_TOKEN;
 
 import javax.inject.Inject;
 import org.eclipse.che.api.core.model.workspace.runtime.RuntimeIdentity;
@@ -25,18 +25,19 @@
  * @author Alexander Garagatyi
  * @author Sergii Leshchenko
  */
-public class UserTokenEnvVarProvider implements ServerEnvironmentVariableProvider {
+public class MachineTokenEnvVarProvider implements ServerEnvironmentVariableProvider {
   private final MachineTokenProvider machineTokenProvider;
 
   @Inject
-  public UserTokenEnvVarProvider(MachineTokenProvider machineTokenProvider) {
+  public MachineTokenEnvVarProvider(MachineTokenProvider machineTokenProvider) {
     this.machineTokenProvider = machineTokenProvider;
   }
 
   @Override
   public Pair<String, String> get(RuntimeIdentity runtimeIdentity) {
     try {
-      return Pair.of(USER_TOKEN, machineTokenProvider.getToken(runtimeIdentity.getWorkspaceId()));
+      return Pair.of(
+          CHE_MACHINE_TOKEN, machineTokenProvider.getToken(runtimeIdentity.getWorkspaceId()));
     } catch (InfrastructureException e) {
       return null;
     }
diff --git a/infrastructures/docker/infrastructure/src/main/java/org/eclipse/che/workspace/infrastructure/docker/provisioner/server/ServersEnvVarsProvisioningModule.java b/infrastructures/docker/infrastructure/src/main/java/org/eclipse/che/workspace/infrastructure/docker/provisioner/server/ServersEnvVarsProvisioningModule.java
@@ -23,7 +23,7 @@ protected void configure() {
     mb.addBinding().to(JavaOptsEnvVariableProvider.class);
     mb.addBinding().to(MavenOptsEnvVariableProvider.class);
     mb.addBinding().to(ProjectsRootEnvVariableProvider.class);
-    mb.addBinding().to(UserTokenEnvVarProvider.class);
+    mb.addBinding().to(MachineTokenEnvVarProvider.class);
     mb.addBinding().to(WorkspaceIdEnvVarProvider.class);
   }
 }
diff --git a/infrastructures/openshift/src/main/java/org/eclipse/che/workspace/infrastructure/openshift/provision/installer/InstallerConfigProvisioner.java b/infrastructures/openshift/src/main/java/org/eclipse/che/workspace/infrastructure/openshift/provision/installer/InstallerConfigProvisioner.java
@@ -56,7 +56,9 @@ public void provision(
       // CHE_API is used by installers for agent binary downloading
       config.getEnv().put("CHE_API", cheServerEndpoint);
 
-      config.getEnv().put("USER_TOKEN", machineTokenProvider.getToken(identity.getWorkspaceId()));
+      config
+          .getEnv()
+          .put("CHE_MACHINE_TOKEN", machineTokenProvider.getToken(identity.getWorkspaceId()));
 
       // TODO incorrect place for env variable addition. workspace ID is needed for wsagent
       // server, not installer
diff --git a/infrastructures/openshift/src/test/java/org/eclipse/che/workspace/infrastructure/openshift/provision/installer/InstallerConfigProvisionerTest.java b/infrastructures/openshift/src/test/java/org/eclipse/che/workspace/infrastructure/openshift/provision/installer/InstallerConfigProvisionerTest.java
@@ -79,12 +79,12 @@ public void provisionWithAgentsRequiredEnvs() throws Exception {
     // then
     Map<String, String> env = machine1.getEnv();
     verifyContainsEnv(env, "CHE_API", CHE_SERVER_ENDPOINT);
-    verifyContainsEnv(env, "USER_TOKEN", "superToken");
+    verifyContainsEnv(env, "CHE_MACHINE_TOKEN", "superToken");
     verifyContainsEnv(env, "CHE_WORKSPACE_ID", WORKSPACE_ID);
 
     env = machine2.getEnv();
     verifyContainsEnv(env, "CHE_API", CHE_SERVER_ENDPOINT);
-    verifyContainsEnv(env, "USER_TOKEN", "superToken");
+    verifyContainsEnv(env, "CHE_MACHINE_TOKEN", "superToken");
     assertFalse(
         env.containsKey("CHE_WORKSPACE_ID"), "Environment variable '%s' found CHE_WORKSPACE_ID");
   }
diff --git a/wsagent/che-core-api-project/src/main/java/org/eclipse/che/api/project/server/WorkspaceHolder.java b/wsagent/che-core-api-project/src/main/java/org/eclipse/che/api/project/server/WorkspaceHolder.java
@@ -41,7 +41,7 @@ public class WorkspaceHolder extends WorkspaceProjectsSyncer {
 
   private String workspaceId;
 
-  private final String userToken;
+  private final String machineToken;
 
   private HttpJsonRequestFactory httpJsonRequestFactory;
 
@@ -54,11 +54,11 @@ public WorkspaceHolder(
     this.httpJsonRequestFactory = httpJsonRequestFactory;
 
     this.workspaceId = System.getenv("CHE_WORKSPACE_ID");
-    this.userToken = System.getenv("USER_TOKEN");
+    this.machineToken = System.getenv("CHE_MACHINE_TOKEN");
 
     LOG.info("Workspace ID: " + workspaceId);
     LOG.info("API Endpoint: " + apiEndpoint);
-    LOG.info("User Token  : " + (userToken != null));
+    LOG.info("Machine Token  : " + (machineToken != null));
 
     // check connection
     try {
@@ -92,7 +92,7 @@ protected void addProject(ProjectConfig project) throws ServerException {
         UriBuilder.fromUri(apiEndpoint)
             .path(WorkspaceService.class)
             .path(WorkspaceService.class, "addProject");
-    if (userToken != null) builder.queryParam("token", userToken);
+    if (machineToken != null) builder.queryParam("token", machineToken);
     final String href = builder.build(workspaceId).toString();
     try {
       httpJsonRequestFactory.fromUrl(href).usePostMethod().setBody(asDto(project)).request();
@@ -113,7 +113,7 @@ protected void updateProject(ProjectConfig project) throws ServerException {
         UriBuilder.fromUri(apiEndpoint)
             .path(WorkspaceService.class)
             .path(WorkspaceService.class, "updateProject");
-    if (userToken != null) builder.queryParam("token", userToken);
+    if (machineToken != null) builder.queryParam("token", machineToken);
     final String href =
         builder.build(new String[] {workspaceId, project.getPath()}, false).toString();
     try {
@@ -129,7 +129,7 @@ protected void removeProject(ProjectConfig project) throws ServerException {
         UriBuilder.fromUri(apiEndpoint)
             .path(WorkspaceService.class)
             .path(WorkspaceService.class, "deleteProject");
-    if (userToken != null) builder.queryParam("token", userToken);
+    if (machineToken != null) builder.queryParam("token", machineToken);
     final String href =
         builder.build(new String[] {workspaceId, project.getPath()}, false).toString();
     try {
@@ -149,7 +149,7 @@ private WorkspaceDto workspaceDto() throws ServerException {
         UriBuilder.fromUri(apiEndpoint)
             .path(WorkspaceService.class)
             .path(WorkspaceService.class, "getByKey");
-    if (userToken != null) builder.queryParam("token", userToken);
+    if (machineToken != null) builder.queryParam("token", machineToken);
     final String href = builder.build(workspaceId).toString();
     try {
       return httpJsonRequestFactory
diff --git a/wsagent/che-wsagent-core/src/main/java/org/eclipse/che/wsagent/server/CheWsAgentModule.java b/wsagent/che-wsagent-core/src/main/java/org/eclipse/che/wsagent/server/CheWsAgentModule.java
@@ -13,8 +13,8 @@
 import com.google.inject.AbstractModule;
 import com.google.inject.name.Names;
 import java.net.URI;
+import org.eclipse.che.MachineTokenProvider;
 import org.eclipse.che.UriApiEndpointProvider;
-import org.eclipse.che.UserTokenProvider;
 import org.eclipse.che.inject.DynaModule;
 
 /**
@@ -27,7 +27,9 @@ public class CheWsAgentModule extends AbstractModule {
   @Override
   protected void configure() {
     bind(URI.class).annotatedWith(Names.named("che.api")).toProvider(UriApiEndpointProvider.class);
-    bind(String.class).annotatedWith(Names.named("user.token")).toProvider(UserTokenProvider.class);
+    bind(String.class)
+        .annotatedWith(Names.named("machine.token"))
+        .toProvider(MachineTokenProvider.class);
 
     bind(WsAgentAnalyticsAddresser.class);
 
diff --git a/wsagent/wsagent-local/src/main/java/org/eclipse/che/MachineTokenProvider.java b/wsagent/wsagent-local/src/main/java/org/eclipse/che/MachineTokenProvider.java
@@ -15,12 +15,12 @@
 import com.google.inject.Provider;
 
 /** @author Anton Korneta */
-public class UserTokenProvider implements Provider<String> {
+public class MachineTokenProvider implements Provider<String> {
 
-  public static final String USER_TOKEN = "USER_TOKEN";
+  public static final String CHE_MACHINE_TOKEN = "CHE_MACHINE_TOKEN";
 
   @Override
   public String get() {
-    return nullToEmpty(System.getenv(USER_TOKEN));
+    return nullToEmpty(System.getenv(CHE_MACHINE_TOKEN));
   }
 }
diff --git a/wsmaster/che-core-api-workspace-shared/src/main/java/org/eclipse/che/api/workspace/shared/dto/RuntimeDto.java b/wsmaster/che-core-api-workspace-shared/src/main/java/org/eclipse/che/api/workspace/shared/dto/RuntimeDto.java
@@ -40,11 +40,11 @@ public interface RuntimeDto extends Runtime, Hyperlinks {
 
   RuntimeDto withOwner(String owner);
 
-  String getUserToken();
+  String getMachineToken();
 
-  RuntimeDto withUserToken(String userToken);
+  RuntimeDto withMachineToken(String machineToken);
 
-  void setUserToken(String userToken);
+  void setMachineToken(String machineToken);
 
   @Override
   List<WarningDto> getWarnings();
diff --git a/wsmaster/che-core-api-workspace/src/main/java/org/eclipse/che/api/workspace/server/WorkspaceService.java b/wsmaster/che-core-api-workspace/src/main/java/org/eclipse/che/api/workspace/server/WorkspaceService.java
@@ -798,7 +798,7 @@ private WorkspaceDto asDtoWithLinksAndToken(Workspace workspace) throws ServerEx
     RuntimeDto runtimeDto = workspaceDto.getRuntime();
     if (runtimeDto != null) {
       try {
-        runtimeDto.setUserToken(machineTokenProvider.getToken(workspace.getId()));
+        runtimeDto.setMachineToken(machineTokenProvider.getToken(workspace.getId()));
       } catch (MachineTokenException e) {
         throw new ServerException(e.getMessage(), e);
       }
diff --git a/wsmaster/che-core-api-workspace/src/test/java/org/eclipse/che/api/workspace/server/WorkspaceServiceTest.java b/wsmaster/che-core-api-workspace/src/test/java/org/eclipse/che/api/workspace/server/WorkspaceServiceTest.java
@@ -326,7 +326,7 @@ public void shouldReturnWorkspaceWithTokenIfRuntimeExists() throws Exception {
 
     assertEquals(response.getStatusCode(), 200);
     WorkspaceDto retrievedWorkspace = unwrapDto(response, WorkspaceDto.class);
-    assertEquals(retrievedWorkspace.getRuntime().getUserToken(), "superToken");
+    assertEquals(retrievedWorkspace.getRuntime().getMachineToken(), "superToken");
     verify(machineTokenProvider).getToken(workspace.getId());
   }
 

Original file line number	Diff line number	Diff line change
`@@ -136,9 +136,9 @@ func Parse() {`
`136`	`136`	`log.Fatal("Push logs endpoint protocol must be either ws or wss")`
`137`	`137`	`}`
`138`	`138`
`139`		`- // auth-enabled - fetch USER_TOKEN`
	`139`	`+ // auth-enabled - fetch CHE_MACHINE_TOKEN`
`140`	`140`	`if AuthEnabled {`
`141`		`- Token = os.Getenv("USER_TOKEN")`
	`141`	`+ Token = os.Getenv("CHE_MACHINE_TOKEN")`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`// runtime-id`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ protected void configure() {`
`23`	`23`	`mb.addBinding().to(JavaOptsEnvVariableProvider.class);`
`24`	`24`	`mb.addBinding().to(MavenOptsEnvVariableProvider.class);`
`25`	`25`	`mb.addBinding().to(ProjectsRootEnvVariableProvider.class);`
`26`		`- mb.addBinding().to(UserTokenEnvVarProvider.class);`
	`26`	`+ mb.addBinding().to(MachineTokenEnvVarProvider.class);`
`27`	`27`	`mb.addBinding().to(WorkspaceIdEnvVarProvider.class);`
`28`	`28`	`}`
`29`	`29`	`}`