-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Provision git configuration into each container #14402
+307
−3
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
159 changes: 159 additions & 0 deletions
159
.../eclipse/che/workspace/infrastructure/kubernetes/provision/GitUserProfileProvisioner.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| /* | ||
| * Copyright (c) 2012-2018 Red Hat, Inc. | ||
| * This program and the accompanying materials are made | ||
| * available under the terms of the Eclipse Public License 2.0 | ||
| * which is available at https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Red Hat, Inc. - initial API and implementation | ||
| */ | ||
| package org.eclipse.che.workspace.infrastructure.kubernetes.provision; | ||
|
|
||
| import static com.google.common.base.Strings.isNullOrEmpty; | ||
| import static java.util.Collections.singletonMap; | ||
| import static java.util.Optional.empty; | ||
| import static java.util.Optional.of; | ||
| import static java.util.Optional.ofNullable; | ||
|
|
||
| import com.google.gson.Gson; | ||
| import com.google.gson.reflect.TypeToken; | ||
| import io.fabric8.kubernetes.api.model.ConfigMap; | ||
| import io.fabric8.kubernetes.api.model.ConfigMapBuilder; | ||
| import io.fabric8.kubernetes.api.model.ConfigMapVolumeSourceBuilder; | ||
| import io.fabric8.kubernetes.api.model.Container; | ||
| import io.fabric8.kubernetes.api.model.PodSpec; | ||
| import io.fabric8.kubernetes.api.model.VolumeBuilder; | ||
| import io.fabric8.kubernetes.api.model.VolumeMount; | ||
| import io.fabric8.kubernetes.api.model.VolumeMountBuilder; | ||
| import java.lang.reflect.Type; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import javax.inject.Inject; | ||
| import javax.inject.Singleton; | ||
| import org.eclipse.che.api.core.ServerException; | ||
| import org.eclipse.che.api.core.model.workspace.runtime.RuntimeIdentity; | ||
| import org.eclipse.che.api.user.server.PreferenceManager; | ||
| import org.eclipse.che.api.workspace.server.spi.InfrastructureException; | ||
| import org.eclipse.che.commons.env.EnvironmentContext; | ||
| import org.eclipse.che.workspace.infrastructure.kubernetes.environment.KubernetesEnvironment; | ||
|
|
||
| @Singleton | ||
| public class GitUserProfileProvisioner implements ConfigurationProvisioner<KubernetesEnvironment> { | ||
|
|
||
| private final String GIT_CONFIG_MAP_NAME_SUFFIX = "-gitconfig"; | ||
|
|
||
| private static final String GIT_BASE_CONFIG_PATH = "/etc/"; | ||
| private static final String GIT_CONFIG = "gitconfig"; | ||
| private static final String GIT_CONFIG_PATH = GIT_BASE_CONFIG_PATH + GIT_CONFIG; | ||
| private static final String PREFERENCES_KEY_FILTER = "theia-user-preferences"; | ||
| private static final String GIT_USER_NAME_PROPERTY = "git.user.name"; | ||
| private static final String GIT_USER_EMAIL_PROPERTY = "git.user.email"; | ||
| private static final String CONFIG_MAP_VOLUME_NAME = "gitconfigvolume"; | ||
|
|
||
| private PreferenceManager preferenceManager; | ||
|
|
||
| @Inject | ||
| public GitUserProfileProvisioner(PreferenceManager preferenceManager) { | ||
| this.preferenceManager = preferenceManager; | ||
| } | ||
|
|
||
| @Override | ||
| public void provision(KubernetesEnvironment k8sEnv, RuntimeIdentity identity) | ||
| throws InfrastructureException { | ||
| getPreferenceValue(PREFERENCES_KEY_FILTER) | ||
| .ifPresent( | ||
| preferenceJsonValue -> { | ||
| Map<String, String> theiaPreferences = getMapFromJsonObject(preferenceJsonValue); | ||
|
|
||
| getGlobalGitConfigFileContent( | ||
| theiaPreferences.get(GIT_USER_NAME_PROPERTY), | ||
| theiaPreferences.get(GIT_USER_EMAIL_PROPERTY)) | ||
| .ifPresent( | ||
| gitConfigFileContent -> { | ||
| String gitConfigMapName = | ||
| identity.getWorkspaceId() + GIT_CONFIG_MAP_NAME_SUFFIX; | ||
|
|
||
| doProvisionGlobalGitConfig(gitConfigMapName, gitConfigFileContent, k8sEnv); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| private Map<String, String> getMapFromJsonObject(String json) { | ||
| Type stringMapType = new TypeToken<Map<String, String>>() {}.getType(); | ||
|
|
||
| return new Gson().fromJson(json, stringMapType); | ||
| } | ||
|
|
||
| private Optional<String> getPreferenceValue(String keyFilter) throws InfrastructureException { | ||
| try { | ||
| String userId = EnvironmentContext.getCurrent().getSubject().getUserId(); | ||
| Map<String, String> preferencesMap = preferenceManager.find(userId, keyFilter); | ||
|
|
||
| return ofNullable(preferencesMap.get(keyFilter)); | ||
| } catch (ServerException e) { | ||
| throw new InfrastructureException(e); | ||
| } | ||
| } | ||
|
|
||
| private Optional<String> getGlobalGitConfigFileContent(String userName, String userEmail) { | ||
| if (isNullOrEmpty(userName) && isNullOrEmpty(userEmail)) { | ||
| return empty(); | ||
| } | ||
|
|
||
| StringBuilder config = new StringBuilder(); | ||
| config.append("[user]").append('\n'); | ||
|
|
||
| if (userName != null) { | ||
| config.append('\t').append("name = ").append(userName).append('\n'); | ||
| } | ||
|
|
||
| if (userEmail != null) { | ||
| config.append('\t').append("email = ").append(userEmail).append('\n'); | ||
| } | ||
|
|
||
| return of(config.toString()); | ||
| } | ||
|
|
||
| private void doProvisionGlobalGitConfig( | ||
| String gitConfigMapName, String gitConfig, KubernetesEnvironment k8sEnv) { | ||
| Map<String, String> gitConfigData = singletonMap(GIT_CONFIG, gitConfig); | ||
| ConfigMap configMap = | ||
| new ConfigMapBuilder() | ||
| .withNewMetadata() | ||
| .withName(gitConfigMapName) | ||
| .endMetadata() | ||
| .withData(gitConfigData) | ||
| .build(); | ||
|
|
||
| k8sEnv.getConfigMaps().put(configMap.getMetadata().getName(), configMap); | ||
| k8sEnv.getPodsData().values().forEach(p -> mountConfigFile(p.getSpec(), gitConfigMapName)); | ||
| } | ||
|
|
||
| private void mountConfigFile(PodSpec podSpec, String gitConfigMapName) { | ||
| podSpec | ||
| .getVolumes() | ||
| .add( | ||
| new VolumeBuilder() | ||
| .withName(CONFIG_MAP_VOLUME_NAME) | ||
| .withConfigMap( | ||
| new ConfigMapVolumeSourceBuilder().withName(gitConfigMapName).build()) | ||
| .build()); | ||
|
|
||
| List<Container> containers = podSpec.getContainers(); | ||
| containers.forEach( | ||
| container -> { | ||
| VolumeMount volumeMount = | ||
| new VolumeMountBuilder() | ||
| .withName(CONFIG_MAP_VOLUME_NAME) | ||
| .withMountPath(GIT_CONFIG_PATH) | ||
| .withSubPath(GIT_CONFIG) | ||
| .withReadOnly(false) | ||
| .withNewReadOnly(false) | ||
| .build(); | ||
| container.getVolumeMounts().add(volumeMount); | ||
| }); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
131 changes: 131 additions & 0 deletions
131
...ipse/che/workspace/infrastructure/kubernetes/provision/GitUserProfileProvisionerTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| /* | ||
| * Copyright (c) 2012-2018 Red Hat, Inc. | ||
| * This program and the accompanying materials are made | ||
| * available under the terms of the Eclipse Public License 2.0 | ||
| * which is available at https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Red Hat, Inc. - initial API and implementation | ||
| */ | ||
| package org.eclipse.che.workspace.infrastructure.kubernetes.provision; | ||
|
|
||
| import static java.util.Collections.emptyMap; | ||
| import static java.util.Collections.singletonList; | ||
| import static java.util.Collections.singletonMap; | ||
| import static org.mockito.ArgumentMatchers.eq; | ||
| import static org.mockito.Mockito.verifyZeroInteractions; | ||
| import static org.mockito.Mockito.when; | ||
| import static org.testng.Assert.assertEquals; | ||
| import static org.testng.Assert.assertFalse; | ||
| import static org.testng.Assert.assertTrue; | ||
|
|
||
| import io.fabric8.kubernetes.api.model.*; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import org.eclipse.che.api.core.model.workspace.runtime.RuntimeIdentity; | ||
| import org.eclipse.che.api.user.server.PreferenceManager; | ||
| import org.eclipse.che.commons.env.EnvironmentContext; | ||
| import org.eclipse.che.commons.subject.Subject; | ||
| import org.eclipse.che.commons.subject.SubjectImpl; | ||
| import org.eclipse.che.workspace.infrastructure.kubernetes.environment.KubernetesEnvironment; | ||
| import org.mockito.Mock; | ||
| import org.mockito.testng.MockitoTestNGListener; | ||
| import org.testng.annotations.BeforeMethod; | ||
| import org.testng.annotations.Listeners; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| @Listeners(MockitoTestNGListener.class) | ||
| public class GitUserProfileProvisionerTest { | ||
|
|
||
| private KubernetesEnvironment k8sEnv; | ||
|
|
||
| @Mock private RuntimeIdentity runtimeIdentity; | ||
|
|
||
| @Mock private Pod pod; | ||
|
|
||
| @Mock private PodSpec podSpec; | ||
|
|
||
| @Mock private Container container; | ||
|
|
||
| @Mock private PreferenceManager preferenceManager; | ||
|
|
||
| private GitUserProfileProvisioner gitUserProfileProvisioner; | ||
|
|
||
| @BeforeMethod | ||
| public void setup() { | ||
| k8sEnv = KubernetesEnvironment.builder().build(); | ||
| ObjectMeta podMeta = new ObjectMetaBuilder().withName("wksp").build(); | ||
| when(pod.getMetadata()).thenReturn(podMeta); | ||
| when(pod.getSpec()).thenReturn(podSpec); | ||
| k8sEnv.addPod(pod); | ||
| gitUserProfileProvisioner = new GitUserProfileProvisioner(preferenceManager); | ||
|
|
||
| Subject subject = new SubjectImpl(null, "id", null, false); | ||
| EnvironmentContext environmentContext = new EnvironmentContext(); | ||
| environmentContext.setSubject(subject); | ||
| EnvironmentContext.setCurrent(environmentContext); | ||
| } | ||
|
|
||
| @Test | ||
| public void testShouldDoNothingWhenGitUserNameAndEmailIsNotConfigured() throws Exception { | ||
| when(preferenceManager.find(eq("id"), eq("theia-user-preferences"))).thenReturn(emptyMap()); | ||
| gitUserProfileProvisioner.provision(k8sEnv, runtimeIdentity); | ||
|
|
||
| verifyZeroInteractions(runtimeIdentity); | ||
| } | ||
|
|
||
| @Test | ||
| public void testShouldDoNothingWhenGitPreferencesAreEmpty() throws Exception { | ||
| Map<String, String> preferences = singletonMap("theia-user-preferences", "{}"); | ||
| when(preferenceManager.find(eq("id"), eq("theia-user-preferences"))).thenReturn(preferences); | ||
|
|
||
| gitUserProfileProvisioner.provision(k8sEnv, runtimeIdentity); | ||
|
|
||
| verifyZeroInteractions(runtimeIdentity); | ||
| } | ||
|
|
||
| @Test | ||
| public void testShouldCheckIfPodHasMountAndK8HasConfigMapForGitConfig() throws Exception { | ||
| String json = "{\"git.user.name\":\"user\",\"git.user.email\":\"email\"}"; | ||
| Map<String, String> preferences = singletonMap("theia-user-preferences", json); | ||
| when(preferenceManager.find(eq("id"), eq("theia-user-preferences"))).thenReturn(preferences); | ||
| when(runtimeIdentity.getWorkspaceId()).thenReturn("wksp"); | ||
|
|
||
| ObjectMeta podMeta = new ObjectMetaBuilder().withName("wksp").build(); | ||
| when(pod.getMetadata()).thenReturn(podMeta); | ||
| when(pod.getSpec()).thenReturn(podSpec); | ||
| when(podSpec.getContainers()).thenReturn(singletonList(container)); | ||
|
|
||
| List<VolumeMount> volumeMounts = new ArrayList<>(); | ||
|
|
||
| when(container.getVolumeMounts()).thenReturn(volumeMounts); | ||
| k8sEnv.addPod(pod); | ||
|
|
||
| gitUserProfileProvisioner.provision(k8sEnv, runtimeIdentity); | ||
|
|
||
| assertEquals(volumeMounts.size(), 1); | ||
|
|
||
| VolumeMount mount = volumeMounts.get(0); | ||
|
|
||
| assertEquals(mount.getMountPath(), "/etc/gitconfig"); | ||
| assertEquals(mount.getName(), "gitconfigvolume"); | ||
| assertFalse(mount.getReadOnly()); | ||
| assertEquals(mount.getSubPath(), "gitconfig"); | ||
|
|
||
| assertEquals(k8sEnv.getConfigMaps().size(), 1); | ||
| assertTrue(k8sEnv.getConfigMaps().containsKey("wksp-gitconfig")); | ||
|
|
||
| ConfigMap configMap = k8sEnv.getConfigMaps().get("wksp-gitconfig"); | ||
|
|
||
| assertEquals(configMap.getData().size(), 1); | ||
| assertTrue(configMap.getData().containsKey("gitconfig")); | ||
|
|
||
| String gitconfig = configMap.getData().get("gitconfig"); | ||
| String expectedGitconfig = "[user]\n\tname = user\n\temail = email\n"; | ||
|
|
||
| assertEquals(gitconfig, expectedGitconfig); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a fan of static imports of methods such as these, since names like
ofare not descriptive at all. Up to you though, I know we do it all over the codebase currently.