add email integration tests (#2)

* refactor to send welcome email to the user

* implement send email with mailgun

* implement send email with mailgun

* add huskey

* update ci

* update ci

* update ci

.github/workflows/node.js.yml

@@ -37,3 +37,6 @@ jobs:
       - run: npm run format:check
       - run: npm run migrate
       - run: npm run test:all
+        env:
+          MAILGUN_API_KEY: ${{ secrets.MAILGUN_API_KEY }}
+          TESTMAIL_API_KEY: ${{ secrets.TESTMAIL_API_KEY }}

.husky/pre-commit

@@ -0,0 +1,3 @@
+npm run lint:check
+npm run format:check
+npm run test:unit -- --run

package.json

@@ -7,20 +7,22 @@
   "devDependencies": {
     "@vitest/coverage-v8": "^0.34.5",
     "eslint": "^8.49.0",
-    "mongodb": "^6.1.0",
+    "husky": "^8.0.3",
     "prettier": "^3.0.3",
     "vitest": "^0.34.5"
   },
   "scripts": {
-    "test": "vitest",
-    "test:integration": "vitest --config vite.config.integration.js",
-    "test:all": "vitest --config vite.config.all.js",
+    "test": "npm run test:unit",
+    "test:all": "vitest",
+    "test:integration": "vitest --run --config vite.config.integration.js",
+    "test:unit": "vitest --run --config vite.config.unit.js",
     "test:coverage": "vitest --coverage",
     "lint:fix": "eslint . --fix",
     "lint:check": "eslint .",
     "format:fix": "prettier --write .",
     "format:check": "prettier --check .",
-    "migrate": "node migrations/migrate-up.js"
+    "migrate": "node migrations/migrate-up.js",
+    "prepare": "husky install"
   },
   "repository": {
     "type": "git",
@@ -33,6 +35,7 @@
   },
   "homepage": "https://github.com/AgileCraftsmanshipCanarias/kata-setup-javascript#readme",
   "dependencies": {
+    "mongodb": "^6.1.0",
     "pg": "^8.11.3"
   }
 }

src/application/RegisterUser.js

@@ -16,7 +16,7 @@ export class RegisterUser {
 
     const user = User.create(this.idGenerator.generate(), name, email, password, age)
 
-    await this.emailSender.send(email, "Welcome to our platform!")
+    await this.emailSender.sendWelcomeEmail(user)
 
     await this.userRepository.save(user)
   }

src/application/RegisterUser.test.js

@@ -20,7 +20,7 @@ describe("RegisterUser", () => {
     vi.spyOn(userRepository, "save")
     idGenerator = new IdGeneratorMock()
     emailSender = new EmailSenderMock()
-    vi.spyOn(emailSender, "send")
+    vi.spyOn(emailSender, "sendWelcomeEmail")
     registerUser = new RegisterUser(userRepository, idGenerator, emailSender)
   })
 
@@ -51,10 +51,14 @@ describe("RegisterUser", () => {
   })
 
   it("sends a welcome email to the user", async () => {
+    const name = "John Doe"
     const email = "[email protected]"
+    const age = 18
+    const password = "password"
 
     await registerUser.execute(notImportantName, email, notImportantPassword, notImportantAge)
 
-    expect(emailSender.send).toHaveBeenCalledWith(email, "Welcome to our platform!")
+    const user = User.create(IdGeneratorMock.MOCK_ID, name, email, password, age)
+    expect(emailSender.sendWelcomeEmail).toHaveBeenCalledWith(user)
   })
 })

src/domain/services/EmailSender.js

@@ -1,6 +1,6 @@
 export class EmailSender {
   // eslint-disable-next-line no-unused-vars
-  send(email, message) {
+  sendWelcomeEmail(user) {
     throw new Error("This is an abstract class. You should implement the send method")
   }
 }

src/domain/utils/sleep.js

@@ -0,0 +1 @@
+export const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms))

src/infrastructure/Config/config.js

@@ -0,0 +1,12 @@
+export const config = {
+  mailgun: {
+    apiKey: process.env.MAILGUN_API_KEY ?? "",
+    domain: process.env.MAILGUN_DOMAIN ?? "sandbox261f754ab73b43388177e85a621a13fb.mailgun.org",
+    fromAddressStart: "mailgun", // this means mailgun@domain.com
+    fromAddressName: "Dan",
+  },
+  testmail: {
+    apiKey: process.env.TESTMAIL_API_KEY ?? "",
+    namespace: process.env.TESTMAIL_NAMESPACE ?? "9eqfr",
+  },
+}