feat: Add Git import integration test suite

app/server/appsmith-server/src/main/java/com/appsmith/server/domains/ce/ArtifactCE.java

@@ -13,6 +13,8 @@ default String getBaseId() {
 
     String getName();
 
+    void setName(String artifactName);
+
     String getWorkspaceId();
 
     Boolean getExportWithConfiguration();

app/server/appsmith-server/src/main/java/com/appsmith/server/git/common/CommonGitServiceCEImpl.java

@@ -2187,13 +2187,17 @@ public Mono<? extends Artifact> deleteBranch(String baseArtifactId, String branc
                             .onErrorResume(throwable -> {
                                 log.error("Delete branch failed {}", throwable.getMessage());
                                 if (throwable instanceof CannotDeleteCurrentBranchException) {
-                                    return Mono.error(new AppsmithException(
-                                            AppsmithError.GIT_ACTION_FAILED,
-                                            "delete branch",
-                                            "Cannot delete current checked out branch"));
+                                    return releaseFileLock(baseArtifactId)
+                                            .then(Mono.error(new AppsmithException(
+                                                    AppsmithError.GIT_ACTION_FAILED,
+                                                    "delete branch",
+                                                    "Cannot delete current checked out branch")));
                                 }
-                                return Mono.error(new AppsmithException(
-                                        AppsmithError.GIT_ACTION_FAILED, "delete branch", throwable.getMessage()));
+                                return releaseFileLock(baseArtifactId)
+                                        .then(Mono.error(new AppsmithException(
+                                                AppsmithError.GIT_ACTION_FAILED,
+                                                "delete branch",
+                                                throwable.getMessage())));
                             })
                             .flatMap(isBranchDeleted ->
                                     releaseFileLock(baseArtifactId).map(status -> isBranchDeleted))

app/server/appsmith-server/src/test/it/com/appsmith/server/git/templates/contexts/GitContext.java

@@ -0,0 +1,69 @@
+package com.appsmith.server.git.templates.contexts;
+
+import com.appsmith.server.constants.ArtifactType;
+import com.appsmith.server.dtos.ArtifactExchangeJson;
+import com.appsmith.server.git.ArtifactBuilderExtension;
+import org.junit.jupiter.api.extension.Extension;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.ParameterContext;
+import org.junit.jupiter.api.extension.ParameterResolutionException;
+import org.junit.jupiter.api.extension.ParameterResolver;
+import org.junit.jupiter.api.extension.TestTemplateInvocationContext;
+
+import java.util.List;
+
+public class GitContext implements TestTemplateInvocationContext, ParameterResolver {
+
+    private final String fileName;
+
+    private final Class<? extends ArtifactExchangeJson> artifactExchangeJsonType;
+    private final ArtifactType artifactType;
+
+    public GitContext(
+        ExtensionContext extensionContext, String fileName, Class<? extends ArtifactExchangeJson> artifactExchangeJsonType, ArtifactType artifactType) {
+        this.artifactType = artifactType;
+        ExtensionContext.Store contextStore = extensionContext.getStore(ExtensionContext.Namespace.create(ArtifactBuilderExtension.class));
+        contextStore.put(ArtifactExchangeJson.class, artifactExchangeJsonType);
+        contextStore.put("filePath", fileName);
+        this.fileName = fileName;
+        this.artifactExchangeJsonType = artifactExchangeJsonType;
+    }
+
+    @Override
+    public String getDisplayName(int invocationIndex) {
+        return fileName;
+    }
+
+    @Override
+    public List<Extension> getAdditionalExtensions() {
+        return List.of(this);
+    }
+
+    public String getFileName() {
+        return fileName;
+    }
+
+    public Class<? extends ArtifactExchangeJson> getArtifactExchangeJsonType() {
+        return artifactExchangeJsonType;
+    }
+
+    @Override
+    public boolean supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
+        throws ParameterResolutionException {
+        return true;
+    }
+
+    @Override
+    public Object resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
+        throws ParameterResolutionException {
+        if (parameterContext.getParameter().getType().equals(ExtensionContext.class)) {
+            return extensionContext;
+        }
+
+        return this;
+    }
+
+    public ArtifactType getArtifactType() {
+        return artifactType;
+    }
+}

app/server/appsmith-server/src/test/it/com/appsmith/server/git/templates/contexts/GitImportContext.java

@@ -0,0 +1,13 @@
+package com.appsmith.server.git.templates.contexts;
+
+import com.appsmith.server.constants.ArtifactType;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+public class GitImportContext extends GitContext {
+    public GitImportContext(ExtensionContext extensionContext,
+                          String jsonFilePath,
+                          Class<?> jsonClass,
+                          ArtifactType artifactType) {
+        super(extensionContext, jsonFilePath, jsonClass, artifactType);
+    }
+}

app/server/appsmith-server/src/test/it/com/appsmith/server/git/templates/providers/GitBranchesTestTemplateProvider.java

@@ -0,0 +1,7 @@
+package com.appsmith.server.git.templates.providers;
+
+import com.appsmith.server.git.templates.providers.ce.GitBranchesTestTemplateProviderCE;
+import org.springframework.stereotype.Component;
+
+@Component
+public class GitBranchesTestTemplateProvider extends GitBranchesTestTemplateProviderCE {}

app/server/appsmith-server/src/test/it/com/appsmith/server/git/templates/providers/GitImportTestTemplateProvider.java

@@ -0,0 +1,7 @@
+package com.appsmith.server.git.templates.providers;
+
+import com.appsmith.server.git.templates.providers.ce.GitImportTestTemplateProviderCE;
+import org.springframework.stereotype.Component;
+
+@Component
+public class GitImportTestTemplateProvider extends GitImportTestTemplateProviderCE {}

app/server/appsmith-server/src/test/it/com/appsmith/server/git/templates/providers/ce/GitBranchesTestTemplateProviderCE.java

@@ -0,0 +1,31 @@
+package com.appsmith.server.git.templates.providers.ce;
+
+import com.appsmith.server.constants.ArtifactType;
+import com.appsmith.server.dtos.ApplicationJson;
+import com.appsmith.server.git.templates.contexts.GitContext;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.TestTemplateInvocationContext;
+import org.junit.jupiter.api.extension.TestTemplateInvocationContextProvider;
+
+import java.util.stream.Stream;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class GitBranchesTestTemplateProviderCE implements TestTemplateInvocationContextProvider {
+
+    @Override
+    public boolean supportsTestTemplate(ExtensionContext extensionContext) {
+        return true;
+    }
+
+    @Override
+    public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContexts(
+            ExtensionContext extensionContext) {
+        GitContext context = new GitContext(
+            extensionContext,
+            "com/appsmith/server/git/application.json",
+            ApplicationJson.class,
+            ArtifactType.APPLICATION);
+        return Stream.of(context);
+    }
+}

app/server/appsmith-server/src/test/it/com/appsmith/server/git/templates/providers/ce/GitImportTestTemplateProviderCE.java

@@ -0,0 +1,46 @@
+package com.appsmith.server.git.templates.providers.ce;
+
+import com.appsmith.server.constants.ArtifactType;
+import com.appsmith.server.dtos.ApplicationJson;
+import com.appsmith.server.git.templates.contexts.GitImportContext;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.TestTemplateInvocationContext;
+import org.junit.jupiter.api.extension.TestTemplateInvocationContextProvider;
+
+import java.util.stream.Stream;
+
+public class GitImportTestTemplateProviderCE implements TestTemplateInvocationContextProvider {
+
+    @Override
+    public boolean supportsTestTemplate(ExtensionContext extensionContext) {
+        return true;
+    }
+
+    @Override
+    public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContexts(
+            ExtensionContext extensionContext) {
+
+        // Context for basic import test (empty repository)
+        GitImportContext basicContext = new GitImportContext(
+                extensionContext,
+                "test_assets/ImportExportServiceTest/valid-application.json",
+                ApplicationJson.class,
+                ArtifactType.APPLICATION);
+
+        // Context for repository with unconfigured datasources
+        GitImportContext datasourcesContext = new GitImportContext(
+                extensionContext,
+                "test_assets/ImportExportServiceTest/valid-application-with-un-configured-datasource.json",
+                ApplicationJson.class,
+                ArtifactType.APPLICATION);
+
+        // Context for repository with branches (using same as GitBranchesTestTemplateProviderCE)
+        GitImportContext branchesContext = new GitImportContext(
+                extensionContext,
+                "com/appsmith/server/git/application.json",
+                ApplicationJson.class,
+                ArtifactType.APPLICATION);
+
+        return Stream.of(basicContext, datasourcesContext, branchesContext);
+    }
+}

app/server/appsmith-server/src/test/utils/com/appsmith/server/git/ArtifactBuilderContext.java

@@ -0,0 +1,22 @@
+package com.appsmith.server.git;
+
+import com.appsmith.server.constants.ArtifactType;
+import com.appsmith.server.dtos.ArtifactExchangeJson;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+public interface ArtifactBuilderContext extends ExtensionContext {
+
+    ArtifactType getArtifactType();
+
+    Class<? extends ArtifactExchangeJson> getArtifactJsonType();
+
+    String getArtifactJsonPath();
+
+    String getWorkspaceId();
+
+    void setWorkspaceId(String workspaceId);
+
+    String getArtifactId();
+
+    void setArtifactId(String artifactId);
+}

app/server/appsmith-server/src/test/utils/com/appsmith/server/git/ArtifactBuilderExtension.java

@@ -0,0 +1,117 @@
+package com.appsmith.server.git;
+
+import com.appsmith.server.applications.base.ApplicationService;
+import com.appsmith.server.constants.FieldName;
+import com.appsmith.server.domains.Artifact;
+import com.appsmith.server.domains.User;
+import com.appsmith.server.domains.Workspace;
+import com.appsmith.server.dtos.ArtifactExchangeJson;
+import com.appsmith.server.imports.internal.ImportService;
+import com.appsmith.server.migrations.JsonSchemaMigration;
+import com.appsmith.server.services.ApplicationPageService;
+import com.appsmith.server.services.UserService;
+import com.appsmith.server.services.WorkspaceService;
+import com.appsmith.server.solutions.ApplicationPermission;
+import com.fasterxml.jackson.databind.MapperFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.extension.AfterEachCallback;
+import org.junit.jupiter.api.extension.BeforeEachCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.stereotype.Component;
+import reactor.core.publisher.Mono;
+
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.util.UUID;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * This extension basically just creates a new workspace and initializes the artifact provided in context
+ * This artifact is provided in the form of a JSON file that is specified in the context itself
+ */
+@Component
+public class ArtifactBuilderExtension implements AfterEachCallback, BeforeEachCallback {
+
+    @Autowired
+    UserService userService;
+
+    @Autowired
+    WorkspaceService workspaceService;
+
+    @Autowired
+    ImportService importService;
+
+    @Autowired
+    ObjectMapper objectMapper;
+
+    @Autowired
+    JsonSchemaMigration jsonSchemaMigration;
+
+    @Autowired
+    ApplicationService applicationService;
+
+    @Autowired
+    ApplicationPermission applicationPermission;
+
+    @Autowired
+    ApplicationPageService applicationPageService;
+
+    @Override
+    public void beforeEach(ExtensionContext extensionContext) throws Exception {
+        ExtensionContext.Store parentContextStore = extensionContext.getParent().get().getStore(ExtensionContext.Namespace.create(ArtifactBuilderExtension.class));
+        Class<? extends ArtifactExchangeJson> aClass = parentContextStore.get(ArtifactExchangeJson.class, Class.class);
+        String filePath = parentContextStore.get("filePath", String.class);
+        ExtensionContext.Store contextStore = extensionContext.getStore(ExtensionContext.Namespace.create(ArtifactBuilderExtension.class));
+
+        ArtifactExchangeJson artifactExchangeJson = createArtifactJson(filePath, aClass).block();
+        assertThat(artifactExchangeJson).isNotNull();
+
+        artifactExchangeJson.getArtifact().setName(aClass.getSimpleName() + "_" + UUID.randomUUID());
+
+        User apiUser = userService.findByEmail("api_user").block();
+        Workspace toCreate = new Workspace();
+        toCreate.setName("Workspace_" + UUID.randomUUID());
+        Workspace workspace =
+            workspaceService.create(toCreate, apiUser, Boolean.FALSE).block();
+        assertThat(workspace).isNotNull();
+
+        Artifact artifact = importService.importNewArtifactInWorkspaceFromJson(workspace.getId(), artifactExchangeJson).block();
+        assertThat(artifact).isNotNull();
+
+        contextStore.put(FieldName.WORKSPACE_ID, (workspace.getId()));
+        contextStore.put(FieldName.ARTIFACT_ID, (artifact.getId()));
+    }
+
+
+    @Override
+    public void afterEach(ExtensionContext extensionContext) {
+
+        ExtensionContext.Store contextStore = extensionContext.getStore(ExtensionContext.Namespace.create(ArtifactBuilderExtension.class));
+        String workspaceId = contextStore.get(FieldName.WORKSPACE_ID, String.class);
+
+        // Because right now we only have checks for apps
+        // Move this to artifact based model when we fix that
+        applicationService
+            .findByWorkspaceId(workspaceId, applicationPermission.getDeletePermission())
+            .flatMap(remainingApplication -> applicationPageService.deleteApplication(remainingApplication.getId()))
+            .collectList()
+            .block();
+        workspaceService.archiveById(workspaceId).block();
+
+    }
+
+    private Mono<? extends ArtifactExchangeJson> createArtifactJson(String filePath, Class<? extends ArtifactExchangeJson> exchangeJsonType) throws IOException {
+
+        ClassPathResource classPathResource = new ClassPathResource(filePath);
+
+        String artifactJson = classPathResource.getContentAsString(Charset.defaultCharset());
+
+        ArtifactExchangeJson artifactExchangeJson =
+            objectMapper.copy().disable(MapperFeature.USE_ANNOTATIONS).readValue(artifactJson, exchangeJsonType);
+
+        return jsonSchemaMigration.migrateArtifactExchangeJsonToLatestSchema(artifactExchangeJson, null, null);
+    }
+}