Do not fetch git username and email if the gitconfig configmap contains the data (#777) (#778)

Check the workspace-userdata-gitconfig-configmap configmap if it contains gitconfig with username and email and the data is not empty. Only then, try to fetch username and email from a git provider.

Author: vinokurig

infrastructures/kubernetes/src/main/java/org/eclipse/che/workspace/infrastructure/kubernetes/namespace/configurator/GitconfigConfigurator.java

@@ -75,25 +75,26 @@ public void configure(NamespaceResolutionContext namespaceResolutionContext, Str
       throws InfrastructureException {
     KubernetesClient client = cheServerKubernetesClientFactory.create();
     Optional<String> gitconfigOptional = getGitconfig(client, namespaceName);
-    Optional<Pair<String, String>> usernameAndEmailFromGitconfigOptional = Optional.empty();
-    Optional<Pair<String, String>> usernameAndEmailFromFetcherOptional =
-        getUsernameAndEmailFromFetcher(namespaceName);
-    if (gitconfigOptional.isPresent()) {
-      String gitconfig = gitconfigOptional.get();
-      usernameAndEmailFromGitconfigOptional = getUsernameAndEmailFromGitconfig(gitconfig);
-    }
-    if (needUpdateGitconfigConfigmap(
-        usernameAndEmailFromGitconfigOptional, usernameAndEmailFromFetcherOptional)) {
-      ConfigMap gitconfigConfigmap = buildGitconfigConfigmap();
-      Optional<Pair<String, String>> usernameAndEmailOptional =
-          usernameAndEmailFromGitconfigOptional.isPresent()
-              ? usernameAndEmailFromGitconfigOptional
-              : usernameAndEmailFromFetcherOptional;
-      Optional<String> gitconfigSectionsOptional =
-          generateGitconfigSections(gitconfigOptional, usernameAndEmailOptional);
-      gitconfigConfigmap.setData(
-          ImmutableMap.of(CONFIGMAP_DATA_KEY, gitconfigSectionsOptional.orElse("")));
-      client.configMaps().inNamespace(namespaceName).createOrReplace(gitconfigConfigmap);
+    // Try to get username and email from the gitconfig configmap if present.
+    Optional<Pair<String, String>> usernameAndEmailFromGitconfigOptional =
+        gitconfigOptional.isPresent()
+            ? getUsernameAndEmailFromGitconfig(gitconfigOptional.get())
+            : Optional.empty();
+    // If username and email are not present in the gitconfig configmap, or the values are empty, or
+    // the gitconfig configmap is empty, try to get them from the fetcher.
+    if (usernameAndEmailFromGitconfigOptional.isEmpty()) {
+      Optional<Pair<String, String>> usernameAndEmailFromFetcher =
+          // Fetch username and email from a token secret if it is present.
+          getUsernameAndEmailFromFetcher(namespaceName);
+      // If username and email are present, create or update the gitconfig configmap.
+      if (usernameAndEmailFromFetcher.isPresent()) {
+        ConfigMap gitconfigConfigmap = buildGitconfigConfigmap();
+        Optional<String> gitconfigSectionsOptional =
+            generateGitconfigSections(gitconfigOptional, usernameAndEmailFromFetcher);
+        gitconfigConfigmap.setData(
+            ImmutableMap.of(CONFIGMAP_DATA_KEY, gitconfigSectionsOptional.orElse("")));
+        client.configMaps().inNamespace(namespaceName).createOrReplace(gitconfigConfigmap);
+      }
     }
   }
 
@@ -107,13 +108,6 @@ private ConfigMap buildGitconfigConfigmap() {
         .build();
   }
 
-  private boolean needUpdateGitconfigConfigmap(
-      Optional<Pair<String, String>> usernameAndEmailFromGitconfigOptional,
-      Optional<Pair<String, String>> usernameAndEmailFromFetcher) {
-    return usernameAndEmailFromGitconfigOptional.isEmpty()
-        && usernameAndEmailFromFetcher.isPresent();
-  }
-
   private Optional<String> generateGitconfigSections(
       Optional<String> gitconfigOptional, Optional<Pair<String, String>> usernameAndEmailOptional) {
     Optional<String> userSectionOptional =

infrastructures/kubernetes/src/test/java/org/eclipse/che/workspace/infrastructure/kubernetes/namespace/configurator/GitconfigConfiguratorTest.java

@@ -12,7 +12,9 @@
 package org.eclipse.che.workspace.infrastructure.kubernetes.namespace.configurator;
 
 import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
 import com.google.common.collect.ImmutableMap;
@@ -193,8 +195,6 @@ public void shouldNotUpdateGitconfigConfigmapWithUserSection()
     serverMock.getClient().configMaps().inNamespace(TEST_NAMESPACE_NAME).create(gitconfigConfigmap);
     configurator =
         new GitconfigConfigurator(cheServerKubernetesClientFactory, Set.of(gitUserDataFetcher));
-    when(gitUserDataFetcher.fetchGitUserData(anyString()))
-        .thenReturn(new GitUserData("fetcher-username", "fetcher-userEmail"));
     // when
     configurator.configure(namespaceResolutionContext, TEST_NAMESPACE_NAME);
     // then
@@ -204,5 +204,7 @@ public void shouldNotUpdateGitconfigConfigmapWithUserSection()
     Assert.assertEquals(configMaps.size(), 1);
     String expected = "[user]\n\tname = gitconfig-username\n\temail = gitconfig-email";
     Assert.assertEquals(configMaps.get(0).getData().get("gitconfig"), expected);
+    // Check that fetchGitUserData was not called.
+    verify(gitUserDataFetcher, never()).fetchGitUserData(anyString());
   }
 }