Setup Spring example

Author: HHMagnus

.idea/gradle.xml

@@ -17,13 +17,11 @@ Features:
 
 Roadmap:
 - Hibernate support library to allow for cloning Hibernate models.
-- Spring support for @Transactional support.
 - Cleanup to allow for resetting the cloned entity.
 - Utility to verify the configuration before running the clone.
 - Support for manifests for specifying which tables were cloned in the export. Could also be used to verify the table structure on import.
 - Masking sensitive data. Could be done by creating a custom view for the export. Or by using a CSV library like Apache Commons CSV to read and transform the CSV data.
 
-
 ------------------------
 
 # Usage

.idea/runConfigurations/Example_1.xml

@@ -7,6 +7,7 @@ allprojects {
 
     group = 'dev.mhh.cloner'
     version = '1.0-SNAPSHOT'
+    description = 'PostgreSQL Cloner for moving entities between databases'
 
     java {
         toolchain {

.idea/runConfigurations/Example_2.xml

@@ -3,7 +3,7 @@ plugins {
 }
 
 dependencies {
-    implementation 'org.postgresql:postgresql:42.7.9'
+    api 'org.postgresql:postgresql:42.7.9'
 
     testImplementation 'org.testcontainers:postgresql:1.21.4'
     testImplementation 'org.testcontainers:junit-jupiter:1.21.4'

README.md

@@ -0,0 +1,28 @@
+plugins {
+    id 'java'
+    id 'org.springframework.boot' version '4.0.2'
+    id 'io.spring.dependency-management' version '1.1.7'
+}
+
+dependencies {
+    implementation project(':spring')
+
+    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
+    implementation 'org.springframework.boot:spring-boot-starter-webmvc'
+
+    runtimeOnly 'org.postgresql:postgresql'
+
+    compileOnly 'org.projectlombok:lombok:1.18.42'
+    annotationProcessor 'org.projectlombok:lombok:1.18.42'
+
+    testCompileOnly 'org.projectlombok:lombok:1.18.42'
+    testAnnotationProcessor 'org.projectlombok:lombok:1.18.42'
+
+    testImplementation 'org.testcontainers:postgresql:1.21.4'
+    testImplementation 'org.testcontainers:junit-jupiter:1.21.4'
+
+    testImplementation 'org.springframework.boot:spring-boot-starter-data-jpa-test'
+    testImplementation 'org.springframework.boot:spring-boot-starter-thymeleaf-test'
+    testImplementation 'org.springframework.boot:spring-boot-starter-webmvc-test'
+}

build.gradle

@@ -0,0 +1,16 @@
+package dev.mhh.cloner.example;
+
+import dev.mhh.cloner.spring.SpringConfig;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Import;
+
+@SpringBootApplication
+@Import(SpringConfig.class)
+public class ExampleApplication {
+
+	public static void main(final String[] args) {
+		SpringApplication.run(ExampleApplication.class, args);
+	}
+
+}

core/build.gradle

@@ -0,0 +1,81 @@
+package dev.mhh.cloner.example.controller;
+
+import dev.mhh.cloner.api.CloneConfiguration;
+import dev.mhh.cloner.example.repository.MovableDataRepository;
+import dev.mhh.cloner.example.service.RandomMovableDataGenerator;
+import dev.mhh.cloner.example.service.MovableDataReader;
+import dev.mhh.cloner.spring.SpringCloner;
+import jakarta.servlet.http.HttpServletResponse;
+import jakarta.transaction.Transactional;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.experimental.FieldDefaults;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.io.IOException;
+import java.sql.SQLException;
+import java.util.List;
+import java.util.UUID;
+
+@Controller
+@Transactional
+@AllArgsConstructor
+@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
+public class MovableDataController {
+    SpringCloner cloner;
+    MovableDataReader movableDataReader;
+    RandomMovableDataGenerator randomMovableDataGenerator;
+    MovableDataRepository movableDataRepository;
+
+    @GetMapping
+    public String index(final Model model) {
+        model.addAttribute("elements", movableDataReader.getAll());
+        return "index";
+    }
+
+    @PostMapping("/import")
+    public String importElements(@RequestParam("file") final MultipartFile file) throws IOException, SQLException {
+        cloner.importClone(file.getInputStream());
+        return "redirect:/";
+    }
+
+    @PostMapping("/export")
+    public void exportElements(
+            @RequestParam(name = "selectedIds", required = false)
+            final List<UUID> selectedIds,
+            final HttpServletResponse response
+    ) throws IOException, SQLException {
+        if (selectedIds == null || selectedIds.isEmpty()) {
+            response.sendError(HttpServletResponse.SC_BAD_REQUEST, "No elements selected");
+            return;
+        }
+
+        response.setContentType("text/plain");
+        response.setHeader("Content-Disposition", "attachment; filename=entities.zip");
+
+        final var cloneConfiguration = CloneConfiguration.builder()
+                .table("movable", "id", selectedIds, subTables ->
+                        subTables.joinByJoinTableForeignKey("movable_element", "movable_id"))
+                .build();
+
+        cloner.exportClone(response.getOutputStream(), cloneConfiguration);
+    }
+
+    @PostMapping("/insert-random")
+    public String insertRandom() {
+        final var random = randomMovableDataGenerator.generateRandom();
+        movableDataRepository.save(random);
+        return "redirect:/";
+    }
+
+    @PostMapping("/clear")
+    public String clearAll() {
+        movableDataRepository.deleteAll();
+        return "redirect:/";
+    }
+}

example/build.gradle

@@ -0,0 +1,9 @@
+package dev.mhh.cloner.example.jpa;
+
+import jakarta.persistence.Embeddable;
+
+@Embeddable
+public record MovableDataElementJpa(
+    long sample,
+    boolean tested
+) { }