Merge pull request #1 from nixos89/01-implement-flyway

Implementation of Flyway Automatic Migration and REST API

Author: nixos89

README.md

@@ -0,0 +1,36 @@
+# Kotlin-Java Demo ToDo app
+
+Simple ToDo app containing REST API written in Java and Kotlin using:
+* Spring Data JPA
+* Flyway Migration Tool
+* PostgresDB 12 (scripts)
+* JUnit5
+
+
+## Steps for setting and running app:
+1. Create `todo_db` database in Postgres DB ver 12 using `postgres` both as **username** and **password**
+2. Enter directory of `first-java-kotlin-gradle-project` module
+3. Make sure  property `spring.flyway.enabled` is set to `true` located in `src/main/resources/application.properties`
+4. Execute `./gradlew bootRun` command
+5. Before 2nd and every other app run (i.e. before executing Step4) set `spring.flyway.enabled` property to `false` located in `src/main/resources/application.properties` 
+
+## Target one of following endpoints:
+
+1. **GET** all Todo(s) [http://localhost:8080/api/todos](http://localhost:8080/api/todos) <br/>
+2. **GET** Single Todo (with id=1) [http://localhost:8080/api/todos/1](http://localhost:8080/api/todos/1) <br/>
+3. **POST** Todo [http://localhost:8080/api/todos](http://localhost:8080/api/todos) <br/>
+...using following body
+```json
+   {
+      "title": "Kotlin app review",
+      "description": "Survive the Kotlin app review"
+   }
+   ```
+4. **PATCH** Todo [http://localhost:8080/api/todos/3](http://localhost:8080/api/todos/3) <br/>
+...using following body
+```json
+    {
+        "title": "Push created Kotlin project!!!"
+    }
+ ```
+5. **DELETE** Todo [http://localhost:8080/api/todos/2](http://localhost:8080/api/todos/2) <br/>

build.gradle.kts

@@ -32,7 +32,9 @@ dependencies {
     implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
     implementation("org.jetbrains.kotlin:kotlin-reflect")
     implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
+    implementation("org.junit.jupiter:junit-jupiter:5.7.0")
     developmentOnly("org.springframework.boot:spring-boot-devtools")
+    implementation("org.springframework.boot:spring-boot-starter-data-jdbc")
     implementation("org.springframework.boot:spring-boot-starter-data-jpa")
     testImplementation("org.springframework.boot:spring-boot-starter-test") {
         exclude(module = "junit")
@@ -43,9 +45,10 @@ dependencies {
     testImplementation("com.ninja-squad:springmockk:3.0.1")
     implementation("org.springframework.boot:spring-boot-starter-mustache")
     implementation("org.springframework.boot:spring-boot-starter-actuator")
-    runtimeOnly("com.h2database:h2")
+    runtimeOnly("org.postgresql:postgresql")
+    implementation( "org.flywaydb:flyway-core:7.9.1")
     kapt("org.springframework.boot:spring-boot-configuration-processor")
-//    runtimeOnly("org.postgresql:postgresql")
+    implementation("org.springframework.boot:spring-boot-configuration-processor")
 }
 
 tasks.withType<KotlinCompile> {

src/main/java/org/example/java_kotlin/FirstJavaKotlinGradleApp.java

@@ -1,35 +1,15 @@
 package org.example.java_kotlin;
 
-import org.example.java_kotlin.config.BlogProperties;
-import org.springframework.boot.CommandLineRunner;
+import org.example.java_kotlin.config.TodoConfiguration;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.annotation.Bean;
-
-import java.util.Arrays;
 
 @SpringBootApplication
-@EnableConfigurationProperties(BlogProperties.class)
+@EnableConfigurationProperties(TodoConfiguration.class)
 public class FirstJavaKotlinGradleApp {
 
     public static void main(String[] args) {
         SpringApplication.run(FirstJavaKotlinGradleApp.class, args);
     }
-
-    @Bean
-    public CommandLineRunner commandLineRunner(ApplicationContext ctx) {
-        return args -> {
-
-            System.out.println("Let's inspect the beans provided by Spring Boot:");
-
-            String[] beanNames = ctx.getBeanDefinitionNames();
-            Arrays.sort(beanNames);
-            for (String beanName : beanNames) {
-                System.out.println(beanName);
-            }
-
-        };
-    }
 }

src/main/java/org/example/java_kotlin/HelloController.java

@@ -0,0 +1,37 @@
+package org.example.java_kotlin.config;
+
+import com.zaxxer.hikari.HikariConfig;
+import com.zaxxer.hikari.HikariDataSource;
+import org.flywaydb.core.Flyway;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import javax.sql.DataSource;
+
+@Configuration
+@ConfigurationProperties("spring.flyway")
+public class TodoConfiguration {
+
+    @Bean
+    public DataSource datasource(
+            @Value("${spring.datasource.url}") String url,
+            @Value("${spring.datasource.username}") String username,
+            @Value("${spring.datasource.password}") String password,
+            @Value("${spring.datasource.driverClassName}") String driver) {
+        HikariConfig config = new HikariConfig();
+
+        Flyway flyway = Flyway.configure().dataSource(url, username, password).load();
+        flyway.migrate();
+
+        config.setJdbcUrl(url);
+        config.setUsername(username);
+        config.setPassword(password);
+        config.setDriverClassName(driver);
+
+        return new HikariDataSource(config);
+    }
+
+
+}

src/main/java/org/example/java_kotlin/config/BlogConfiguration.kt

@@ -9,6 +9,7 @@ import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
 import org.springframework.web.server.ResponseStatusException
 
+/* These classes are just part of SpringBoot Kotlin tutorial */
 @RestController
 @RequestMapping("/api/article")
 class ArticleController(private val articleRepository: ArticleRepository) {

src/main/java/org/example/java_kotlin/config/BlogProperties.kt

@@ -1,25 +1,65 @@
 package org.example.java_kotlin.controller
 
 import org.example.java_kotlin.model.Todo
+import org.example.java_kotlin.repositories.TodoRepository
+import org.example.java_kotlin.service.TodoService
+import org.springframework.http.HttpStatus
+import org.springframework.http.ResponseEntity
+import org.springframework.util.ObjectUtils
+import org.springframework.validation.annotation.Validated
 import org.springframework.web.bind.annotation.*
 
 @RestController
-@RequestMapping("/todos")
-class TodoController {
+@RequestMapping("/api/todos")
+class TodoController(private val todoRepository: TodoRepository, private val todoService: TodoService) {
 
     @GetMapping("/{todoId}")
-    fun getTodo(@PathVariable todoId: Long) {
-        // TODO: implement `getTodo`
+    fun getTodo(@PathVariable todoId: Long): ResponseEntity<Todo> {
+        val todo = todoService.getTodoById(todoId)
+        if (todo.isPresent) return ResponseEntity(todo.get(), HttpStatus.OK)
+        return ResponseEntity(HttpStatus.NOT_FOUND)
     }
 
     @GetMapping
-    fun getAllTodos() {
-        // TODO: implement `getAllTodos`
+    fun getAllTodos(): ResponseEntity<List<Todo>> {
+        val todos = todoService.getAllTodos().toList()
+        if (todos.isNotEmpty()) return ResponseEntity(todos, HttpStatus.OK)
+        return ResponseEntity(HttpStatus.NOT_FOUND)
     }
 
     @PostMapping
-    fun saveTodo(@RequestBody todo: Todo) {
-        // TODO: implement `saveTodo`
+    fun createTodo(@Validated @RequestBody todo: Todo): ResponseEntity<Void> {
+        if (todoService.createTodo(todo)) {
+            return ResponseEntity(HttpStatus.CREATED)
+        }
+        return ResponseEntity(HttpStatus.INTERNAL_SERVER_ERROR)
+    }
+
+    @PutMapping("/{todoId}")
+    fun updateTodo(@Validated @RequestBody todo: Todo, @PathVariable("todoId") todoId: Long): ResponseEntity<Void> {
+        val todoUpdated = todoService.updateTodo(todo, todoId)
+        if (ObjectUtils.isEmpty(todoUpdated)) {
+            return ResponseEntity(HttpStatus.INTERNAL_SERVER_ERROR)
+        }
+        return ResponseEntity(HttpStatus.NO_CONTENT)
+
+    }
+
+    @PatchMapping("/{todoId}")
+    fun partialUpdateTodo(@RequestBody todo: Todo, @PathVariable todoId: Long): ResponseEntity<Void> {
+        val patchedTodo = todoService.patchTodo(todo, todoId)
+        if (ObjectUtils.isEmpty(patchedTodo)) {
+            return ResponseEntity(HttpStatus.INTERNAL_SERVER_ERROR)
+        }
+        return ResponseEntity(HttpStatus.NO_CONTENT)
+    }
+
+    @DeleteMapping("/{todoId}")
+    fun deleteTodo(@PathVariable todoId: Long): ResponseEntity<Void> {
+        if (todoService.deleteTodo(todoId)) {
+            return ResponseEntity(HttpStatus.NO_CONTENT)
+        }
+        return ResponseEntity(HttpStatus.NOT_FOUND)
     }
 
 }