Mongo sync guide

guides/micronaut-mongodb-synchronous/java/src/main/java/example/micronaut/Fruit.java

@@ -0,0 +1,51 @@
+package example.micronaut;
+
+import io.micronaut.core.annotation.Creator;
+import io.micronaut.core.annotation.Introspected;
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.core.annotation.Nullable;
+import javax.validation.constraints.NotBlank;
+
+@Introspected // <1>
+public class Fruit {
+
+    @NonNull
+    @NotBlank // <2>
+    private String name;
+
+    @Nullable
+    private String description;
+
+    public Fruit() {
+
+    }
+
+    public Fruit(@NonNull String name) {
+        this(name, null);        
+    }
+
+    @Creator
+    public Fruit(@NonNull String name, @Nullable String description) {
+        this.name = name;
+        this.description = description;
+    }
+
+    public void setName(@NonNull String name) {
+        this.name = name;
+    }
+
+    public void setDescription(@Nullable String description) {
+        this.description = description;
+    }
+
+    @NonNull
+    public String getName() {
+        return name;
+    }
+
+    @Nullable
+    public String getDescription() {
+        return description;
+    }
+
+}

guides/micronaut-mongodb-synchronous/java/src/main/java/example/micronaut/FruitController.java

@@ -0,0 +1,40 @@
+package example.micronaut;
+
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.http.HttpStatus;
+import io.micronaut.http.annotation.Controller;
+import io.micronaut.http.annotation.Get;
+import io.micronaut.http.annotation.Post;
+import io.micronaut.http.annotation.Status;
+import io.micronaut.scheduling.TaskExecutors;
+import io.micronaut.scheduling.annotation.ExecuteOn;
+
+import javax.validation.Valid;
+import javax.validation.constraints.NotNull;
+import java.util.Iterator;
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
+
+@Controller("/fruits") // <1>
+@ExecuteOn(TaskExecutors.IO)  // <2>
+public class FruitController {
+
+    private final FruitRepository fruitService;
+
+    public FruitController(FruitRepository fruitService) {  // <3>
+        this.fruitService = fruitService;
+    }
+
+    @Get  // <4>
+    public List<Fruit> list() {
+        return StreamSupport.stream(fruitService.list().spliterator(), false)
+                .collect(Collectors.toList());
+    }
+
+    @Post // <5>
+    @Status(HttpStatus.CREATED) // <6>
+    public void save(@NonNull @NotNull @Valid Fruit fruit) { // <7>
+        fruitService.save(fruit);
+    }
+}

guides/micronaut-mongodb-synchronous/java/src/main/java/example/micronaut/FruitRepository.java

@@ -0,0 +1,13 @@
+package example.micronaut;
+
+import io.micronaut.core.annotation.NonNull;
+import javax.validation.Valid;
+import javax.validation.constraints.NotNull;
+import java.util.Iterator;
+
+public interface FruitRepository {
+    @NonNull
+    Iterable<Fruit> list();
+
+    void save(@NonNull @NotNull @Valid Fruit fruit); // <1>
+}

guides/micronaut-mongodb-synchronous/java/src/main/java/example/micronaut/MongoDbConfiguration.java

@@ -0,0 +1,11 @@
+package example.micronaut;
+
+import io.micronaut.context.annotation.ConfigurationProperties;
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.core.naming.Named;
+
+@ConfigurationProperties("db") // <1>
+public interface MongoDbConfiguration extends Named {
+    @NonNull
+    String getCollection();
+}

guides/micronaut-mongodb-synchronous/java/src/main/java/example/micronaut/MongoDbFruitRepository.java

@@ -0,0 +1,46 @@
+package example.micronaut;
+
+import com.mongodb.client.MongoClient;
+import com.mongodb.client.MongoCollection;
+import com.mongodb.client.MongoCursor;
+import io.micronaut.core.annotation.NonNull;
+import jakarta.inject.Singleton;
+import org.bson.Document;
+import javax.validation.Valid;
+import javax.validation.constraints.NotNull;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
+
+@Singleton // <1>
+public class MongoDbFruitRepository implements FruitRepository {
+
+    private final MongoDbConfiguration mongoConf;
+    private final MongoClient mongoClient;
+
+    public MongoDbFruitRepository(MongoDbConfiguration mongoConf,  // <2>
+                                  MongoClient mongoClient) {  // <3>
+        this.mongoConf = mongoConf;
+        this.mongoClient = mongoClient;
+    }
+
+    @Override
+    public void save(@NonNull @NotNull @Valid Fruit fruit){
+        getCollection().insertOne(fruit);
+    }
+
+    @Override
+    @NonNull
+    public Iterable<Fruit> list() {
+        return getCollection().find();
+    }
+
+    @NonNull
+    private MongoCollection<Fruit> getCollection(){
+        return mongoClient.getDatabase(mongoConf.getName())
+                .getCollection(mongoConf.getCollection(), Fruit.class);
+    }
+}

guides/micronaut-mongodb-synchronous/java/src/test/java/example/micronaut/FruitClient.java

@@ -0,0 +1,22 @@
+package example.micronaut;
+
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.http.HttpStatus;
+import io.micronaut.http.annotation.Get;
+import io.micronaut.http.annotation.Post;
+import io.micronaut.http.client.annotation.Client;
+import javax.validation.Valid;
+import javax.validation.constraints.NotNull;
+import java.util.List;
+
+@Client("/fruits")
+public interface FruitClient {
+
+    @Post
+    @NonNull
+    HttpStatus save(@NonNull @NotNull @Valid Fruit fruit);
+
+    @NonNull
+    @Get
+    List<Fruit> findAll();
+}

guides/micronaut-mongodb-synchronous/java/src/test/java/example/micronaut/FruitControllerTest.java

@@ -0,0 +1,51 @@
+package example.micronaut;
+
+import io.micronaut.context.ApplicationContext;
+import io.micronaut.core.type.Argument;
+import io.micronaut.http.HttpRequest;
+import io.micronaut.http.HttpResponse;
+import io.micronaut.http.HttpStatus;
+import io.micronaut.http.client.BlockingHttpClient;
+import io.micronaut.http.client.HttpClient;
+import io.micronaut.runtime.server.EmbeddedServer;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.Collections;
+import java.util.List;
+
+public class FruitControllerTest {
+
+    @Test
+    void fruitsEndpointInteractsWithMongo() {        
+        EmbeddedServer embeddedServer = ApplicationContext.run(EmbeddedServer.class, 
+            Collections.singletonMap("mongodb.uri", MongoDbUtils.getMongoDbUri()));
+        FruitClient fruitClient = embeddedServer.getApplicationContext()
+            .getBean(FruitClient.class);
+
+        List<Fruit> fruits = fruitClient.findAll();
+        assertTrue(fruits.isEmpty());
+
+        HttpStatus status = fruitClient.save(new Fruit("banana"));
+
+        assertEquals(HttpStatus.CREATED, status);
+        fruits = fruitClient.findAll();
+        assertFalse(fruits.isEmpty());
+        assertEquals("banana", fruits.get(0).getName());
+        assertNull(fruits.get(0).getDescription());
+
+        status = fruitClient.save(new Fruit("Apple", "Keeps the doctor away"));
+        assertEquals(HttpStatus.CREATED, status);
+        fruits = fruitClient.findAll();
+        assertTrue(fruits.stream()
+            .filter(f -> f.getDescription() != null && f.getDescription().equals("Keeps the doctor away"))
+            .findFirst()
+            .isPresent());
+        embeddedServer.close();
+        MongoDbUtils.closeMongoDb();
+    }
+}

guides/micronaut-mongodb-synchronous/java/src/test/java/example/micronaut/FruitControllerValidationTest.java

@@ -0,0 +1,52 @@
+package example.micronaut;
+
+import io.micronaut.context.annotation.Property;
+import io.micronaut.context.annotation.Replaces;
+import io.micronaut.context.annotation.Requires;
+import io.micronaut.http.HttpRequest;
+import static io.micronaut.http.HttpStatus.BAD_REQUEST;
+
+import io.micronaut.http.HttpStatus;
+import io.micronaut.http.client.HttpClient;
+import io.micronaut.http.client.annotation.Client;
+import io.micronaut.http.client.exceptions.HttpClientResponseException;
+import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
+import jakarta.inject.Inject;
+import jakarta.inject.Singleton;
+import org.junit.jupiter.api.Test;
+
+import java.util.Collections;
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+@Property(name = "spec.name", value = "FruitControllerValidationTest")
+@MicronautTest
+public class FruitControllerValidationTest {
+    @Inject
+    @Client("/")
+    HttpClient httpClient;
+
+    @Test
+    public void testFruitIsValidated() {
+        HttpClientResponseException e = assertThrows(HttpClientResponseException.class, () ->
+                httpClient.toBlocking().exchange(HttpRequest.POST("/fruits",new Fruit("", "Hola"))));
+        assertEquals(HttpStatus.BAD_REQUEST, e.getStatus());
+    }
+
+    @Requires(property = "spec.name", value = "FruitControllerValidationTest")
+    @Singleton
+    @Replaces(FruitRepository.class)
+    static class MockFruitRepository implements FruitRepository {
+        @Override
+        public List<Fruit> list() {
+            return Collections.emptyList();
+        }
+
+        @Override
+        public void save(Fruit fruit) {
+
+        }
+    }
+}

guides/micronaut-mongodb-synchronous/java/src/test/java/example/micronaut/MongoDbUtils.java

@@ -0,0 +1,31 @@
+package example.micronaut;
+
+import org.testcontainers.containers.MongoDBContainer;
+import org.testcontainers.utility.DockerImageName;
+
+public class MongoDbUtils {
+    static MongoDBContainer mongoDBContainer;
+
+    public static void startMongoDb() {
+        if (mongoDBContainer == null) {
+            mongoDBContainer = new MongoDBContainer(DockerImageName.parse("mongo:4.0.10"))
+                    .withExposedPorts(27017);
+        }
+        if (!mongoDBContainer.isRunning()) {
+            mongoDBContainer.start();
+        }
+    }
+
+    public static String getMongoDbUri() {
+        if (mongoDBContainer == null || !mongoDBContainer.isRunning()) {
+            startMongoDb();
+        }
+        return mongoDBContainer.getReplicaSetUrl();
+    }
+
+    public static void closeMongoDb() {
+        if (mongoDBContainer != null) {
+            mongoDBContainer.close();
+        }
+    }
+}

guides/micronaut-mongodb-synchronous/metadata.json

@@ -0,0 +1,18 @@
+{
+    "asciidoctor": "micronaut-mongodb-synchronous.adoc",
+    "slug": "micronaut-mongodb-synchronous",
+    "title": "Micronaut MongoDB Synchronous",
+    "intro": "Learn how to use a blocking MongoClient with a Micronaut application",
+    "authors": ["Sergio del Amo"],
+    "tags": ["mongodb"],
+    "category": "Data Access",
+    "publicationDate": "2021-09-15",
+    "languages": ["java"],
+    "apps": [
+        {
+            "name": "default",
+            "features": ["mongo-sync"]
+        }
+    ]
+}
+