add more docs and add test for config

Author: J0nasMayr

pom.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
     <parent>
@@ -12,7 +11,7 @@
 
     <groupId>it.aboutbits.springboot</groupId>
     <artifactId>emailservice</artifactId>
-    <version>BUILD-SNAPSHOT</version>
+    <version>1.2.0</version>
     <description>Spring Boot Email Service</description>
 
     <properties>

readme.md

@@ -30,8 +30,6 @@ public AttachmentDataSource attachmentDataSource(JdbcTemplate jdbcTemplate) {
 }
 ```
 
-The `JdbcAttachmentDataSource` creates its table itself on construction, so no further setup is needed.
-
 #### Inline (CID) attachments
 
 To embed an attachment inline, set a `contentId` on the attachment and reference it in the `htmlBody` via the `cid:` scheme.

src/main/java/it/aboutbits/springboot/emailservice/lib/AttachmentDataSource.java

@@ -9,6 +9,13 @@
 public interface AttachmentDataSource {
     InputStream getAttachmentPayload(long fileReference) throws AttachmentException;
 
+    /**
+     * Stores the payload and returns the reference used to read it back later.
+     * The implementation takes ownership of the stream and must close it.
+     *
+     * @param payload the attachment payload, closed by the implementation
+     * @return the reference to pass to {@link #getAttachmentPayload(long)}
+     */
     long storeAttachmentPayload(InputStream payload) throws AttachmentException;
 
     void releaseAttachment(long fileReference) throws AttachmentException;

src/test/java/it/aboutbits/springboot/emailservice/EmailServiceConfigurationTest.java

@@ -0,0 +1,89 @@
+package it.aboutbits.springboot.emailservice;
+
+import it.aboutbits.springboot.emailservice.lib.AttachmentDataSource;
+import it.aboutbits.springboot.emailservice.lib.EmailState;
+import it.aboutbits.springboot.emailservice.lib.application.EmailParameter;
+import it.aboutbits.springboot.emailservice.lib.application.ManageEmail;
+import it.aboutbits.springboot.emailservice.lib.exception.AttachmentException;
+import it.aboutbits.springboot.emailservice.lib.exception.EmailException;
+import it.aboutbits.springboot.emailservice.support.database.WithPostgres;
+import org.jspecify.annotations.NullMarked;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.ApplicationContext;
+
+import java.io.ByteArrayInputStream;
+import java.time.OffsetDateTime;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
+
+@SpringBootTest
+@WithPostgres
+@NullMarked
+class EmailServiceConfigurationTest {
+    @Autowired
+    ApplicationContext applicationContext;
+
+    @Autowired
+    ManageEmail manageEmail;
+
+    @Test
+    void givenNoAttachmentDataSourceBean_context_shouldStart() {
+        assertThat(applicationContext.getBeanNamesForType(AttachmentDataSource.class)).isEmpty();
+        assertThat(manageEmail).isNotNull();
+    }
+
+    @Test
+    void givenNoAttachmentDataSourceBean_scheduleWithoutAttachment_shouldSucceed() throws EmailException {
+        var result = manageEmail.schedule(getValidParameterWithoutAttachment());
+
+        assertThat(result.id()).isPositive();
+        assertThat(result.state()).isEqualTo(EmailState.PENDING);
+    }
+
+    @Test
+    void givenNoAttachmentDataSourceBean_scheduleWithAttachment_shouldFail() {
+        var parameter = getValidParameterWithAttachment();
+
+        assertThatExceptionOfType(EmailException.class).isThrownBy(
+                () -> manageEmail.schedule(parameter)
+        ).withCauseInstanceOf(AttachmentException.class);
+    }
+
+    private static EmailParameter getValidParameterWithoutAttachment() {
+        return EmailParameter.builder()
+                .scheduledAt(OffsetDateTime.now())
+                .email(EmailParameter.Email.builder()
+                               .subject("Example email subject")
+                               .textBody("Email body")
+                               .htmlBody("<h1>Html email body</h1>")
+                               .recipient("person1@example.com")
+                               .fromAddress("somebody@aboutbits.it")
+                               .fromName("somebody")
+                               .build()
+                ).build();
+    }
+
+    private static EmailParameter getValidParameterWithAttachment() {
+        return EmailParameter.builder()
+                .scheduledAt(OffsetDateTime.now())
+                .email(EmailParameter.Email.builder()
+                               .subject("Example email subject")
+                               .textBody("Email body")
+                               .htmlBody("<h1>Html email body</h1>")
+                               .recipient("person1@example.com")
+                               .attachment(
+                                       EmailParameter.Email.Attachment.builder()
+                                               .contentType("image/png")
+                                               .fileName("x.png")
+                                               .payload(new ByteArrayInputStream(new byte[0]))
+                                               .build()
+                               )
+                               .fromAddress("somebody@aboutbits.it")
+                               .fromName("somebody")
+                               .build()
+                ).build();
+    }
+}