Skip to content
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.

Sign up for GitHub

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

test (jkube-kit/enricher) : Add more tests for GitEnricher #2558

Merged
merged 2 commits into from
Jan 16, 2024
+198 −1
Merged

test (jkube-kit/enricher) : Add more tests for GitEnricher #2558

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69d4524
test (jkube-kit/enricher) : Add more tests for GitEnricher
rohanKanojia Jan 15, 2024
b0fd53d
test: GitEnricherTest doesn't require mocks
manusa Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 198 additions & 1 deletion ...it/enricher/generic/src/test/java/org/eclipse/jkube/enricher/generic/GitEnricherTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,78 @@
*/
package org.eclipse.jkube.enricher.generic;

import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.api.model.KubernetesListBuilder;
import io.fabric8.kubernetes.api.model.ReplicationControllerBuilder;
import io.fabric8.kubernetes.api.model.ServiceBuilder;
import io.fabric8.kubernetes.api.model.apps.DaemonSetBuilder;
import io.fabric8.kubernetes.api.model.apps.DeploymentBuilder;
import io.fabric8.kubernetes.api.model.apps.ReplicaSetBuilder;
import io.fabric8.kubernetes.api.model.apps.StatefulSetBuilder;
import io.fabric8.kubernetes.api.model.batch.v1.JobBuilder;
import io.fabric8.openshift.api.model.DeploymentConfigBuilder;
import org.assertj.core.api.InstanceOfAssertFactories;
import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.transport.URIish;
import org.eclipse.jkube.kit.common.JavaProject;
import org.eclipse.jkube.kit.common.KitLogger;
import org.eclipse.jkube.kit.common.util.FileUtil;
import org.eclipse.jkube.kit.config.resource.JKubeAnnotations;
import org.eclipse.jkube.kit.config.resource.OpenShiftAnnotations;
import org.eclipse.jkube.kit.config.resource.PlatformMode;
import org.eclipse.jkube.kit.enricher.api.JKubeEnricherContext;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInstance;
import org.junit.jupiter.api.io.TempDir;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import java.io.File;
import java.nio.file.Files;
import java.util.Map;
import java.util.Properties;
import java.util.stream.Stream;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.params.provider.Arguments.arguments;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;

class GitEnricherTest {

private static final String GIT_REMOTE_URL = "https://github.com:jkubeio/eclipse-jkube-demo-project.git";
private static final String GIT_BRANCH = "master";
private static final String GIT_COMMIT_ID = "058bed285de43aac80b5bf9433b9a3a9c3915e19";
private JKubeEnricherContext context;
private GitEnricher gitEnricher;
private Properties properties;
private KubernetesListBuilder klb;

@TempDir
private File baseDirectory;

@BeforeEach
void setUp() throws Exception {
klb = new KubernetesListBuilder().withItems(new ServiceBuilder().build());
properties = new Properties();
context = JKubeEnricherContext.builder()
.project(JavaProject.builder()
.groupId("org.example")
.artifactId("test-project")
.version("0.0.1")
.baseDirectory(baseDirectory)
.properties(properties)
.build())
.log(spy(new KitLogger.SilentLogger()))
.build();
gitEnricher = new GitEnricher(context);
Files.createTempFile(baseDirectory.toPath(), "random", "txt");
}

@Test
void getAnnotations_addedInKubernetesPlatformMode() {
Expand All @@ -51,7 +109,7 @@ void getAnnotations_addedInOpenShiftPlatformMode() {
// Then
assertJkubeAnnotations(annotations);
assertThat(annotations).containsEntry(OpenShiftAnnotations.VCS_REF.value(), GIT_BRANCH)
.containsEntry(OpenShiftAnnotations.VCS_URI.value(), GIT_REMOTE_URL);
.containsEntry(OpenShiftAnnotations.VCS_URI.value(), GIT_REMOTE_URL);
}

@Test
Expand All @@ -78,6 +136,145 @@ void getAnnotations_addedWithNullCommitValues() {
assertJkubeAnnotationsRemoteUrlAndBranch(annotations);
}

@Test
@DisplayName("no .git repository found, then no git annotations added")
void create_whenNoGitRepositoryFound_thenNoAnnotationsAdded() {
// When
gitEnricher.create(PlatformMode.kubernetes, klb);

// Then
HasMetadata result = klb.buildFirstItem();
assertThat(result)
.extracting("metadata.annotations")
.asInstanceOf(InstanceOfAssertFactories.MAP)
.doesNotContainKey("jkube.eclipse.org/git-branch")
.doesNotContainKey("jkube.eclipse.org/git-commit")
.doesNotContainKey("jkube.eclipse.org/git-url");
}

@Nested
@DisplayName("given an invalid .git repository exists")
class InvalidGitRepositoryExists {

@Test
@DisplayName("With empty .git directory, then no annotations added")
void withEmptyGitDirectory_thenNoGitAnnotationsAdded() throws Exception {
// Given
FileUtil.createDirectory(new File(baseDirectory, ".git"));
// When
gitEnricher.create(PlatformMode.kubernetes, klb);
// Then
HasMetadata result = klb.buildFirstItem();
assertThat(result)
.extracting("metadata.annotations")
.asInstanceOf(InstanceOfAssertFactories.MAP)
.doesNotContainKey("jkube.eclipse.org/git-branch")
.doesNotContainKey("jkube.eclipse.org/git-commit")
.doesNotContainKey("jkube.eclipse.org/git-url");
verify(context.getLog()).warn("jkube-git: Could not detect any git remote");
}
}
@Nested
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
@DisplayName("given a valid .git repository exists")
class ValidGitRepositoryExists {

private Git git;
private RevCommit commit;

@BeforeEach
void setUp() throws Exception {
git = Git.init().setDirectory(baseDirectory).setInitialBranch("test-branch").call();
git.add().addFilepattern(".").call();
git.remoteAdd().setName("origin").setUri(new URIish("https://example.com/origin.git")).call();
commit = git.commit().setMessage("Initial commit").call();
}


Stream<Arguments> controllerResources() {
return Stream.of(
arguments(new ServiceBuilder().build()),
arguments(new DeploymentBuilder().build()),
arguments(new DeploymentConfigBuilder().build()),
arguments(new ReplicaSetBuilder().build()),
arguments(new ReplicationControllerBuilder().build()),
arguments(new DaemonSetBuilder().build()),
arguments(new StatefulSetBuilder().build()),
arguments(new JobBuilder().build())
);
}

@ParameterizedTest(name = "Git annotations should be added to {0}")
@MethodSource("controllerResources")
void create_whenResourceProvided_thenAddGitAnnotations(HasMetadata h) throws Exception {
// When
gitEnricher.create(PlatformMode.kubernetes, klb);
// Then
HasMetadata result = klb.buildFirstItem();
assertThat(result)
.extracting("metadata.annotations")
.asInstanceOf(InstanceOfAssertFactories.MAP)
.containsEntry("jkube.eclipse.org/git-branch", "test-branch")
.containsEntry("jkube.eclipse.org/git-commit", commit.getName())
.containsEntry("jkube.eclipse.org/git-url", "https://example.com/origin.git");
}

@Test
@DisplayName("jkube.remoteName=upstream, then fetch git-url from specified remote")
void whenGitRemotePropertySpecified_thenUseProvidedGitRemoteInAnnotations() throws Exception {
// Given
git.remoteAdd().setName("upstream").setUri(new URIish("https://example.com/upstream.git")).call();
properties.put("jkube.remoteName", "upstream");

// When
gitEnricher.create(PlatformMode.kubernetes, klb);

// Then
HasMetadata result = klb.buildFirstItem();
assertThat(result)
.extracting("metadata.annotations")
.asInstanceOf(InstanceOfAssertFactories.MAP)
.containsEntry("jkube.eclipse.org/git-branch", "test-branch")
.containsEntry("jkube.eclipse.org/git-commit", commit.getName())
.containsEntry("jkube.eclipse.org/git-url", "https://example.com/upstream.git");
}

@Test
@DisplayName("git remote not found, then do not add git-url annotation")
void whenRemoteNotFound_thenGitUrlAnnotationNotAdded() throws Exception {
// Given
git.remoteRemove().setRemoteName("origin").call();

// When
gitEnricher.create(PlatformMode.kubernetes, klb);

// Then
HasMetadata result = klb.buildFirstItem();
assertThat(result)
.extracting("metadata.annotations")
.asInstanceOf(InstanceOfAssertFactories.MAP)
.containsEntry("jkube.eclipse.org/git-branch", "test-branch")
.containsEntry("jkube.eclipse.org/git-commit", commit.getName())
.doesNotContainKey("jkube.eclipse.org/git-url");
verify(context.getLog()).warn("jkube-git: Could not detect any git remote");
}

@Test
@DisplayName("OpenShift vcs-uri, vcs-ref annotations added in OpenShift Platform")
void whenPlatformModeOpenShift_thenAddOpenShiftVcsAnnotations() {
// When
gitEnricher.create(PlatformMode.openshift, klb);

// Then
HasMetadata result = klb.buildFirstItem();
assertThat(result)
.extracting("metadata.annotations")
.asInstanceOf(InstanceOfAssertFactories.MAP)
.containsEntry("app.openshift.io/vcs-ref", "test-branch")
.containsEntry("app.openshift.io/vcs-uri", "https://example.com/origin.git");
}
}

private void assertJkubeAnnotations(Map<String, String> annotations) {
assertJkubeAnnotationsRemoteUrlAndBranch(annotations);
assertThat(annotations).containsEntry(JKubeAnnotations.GIT_COMMIT.value(true), GIT_COMMIT_ID);
Expand Down
Loading