feat: tests (unit, e2e) #7

typeWolffo · 2024-07-15T15:06:05Z

No description provided.

examples/common_nestjs_remix/apps/api/src/auth/__tests__/auth.controller.e2e-spec.ts

k1eu · 2024-07-16T09:54:24Z

examples/common_nestjs_remix/apps/api/src/auth/__tests__/auth.controller.e2e-spec.ts

+      let accessToken = "";
+      let refreshToken = "";
+
+      if (isArray(cookies)) {
+        cookies.forEach((cookie) => {
+          if (cookie.startsWith("access_token=")) {
+            accessToken = cookie;
+          } else if (cookie.startsWith("refresh_token=")) {
+            refreshToken = cookie;
+          }
+        });
+      }


https://www.npmjs.com/package/cookie
maybe something like this? seems usefull

examples/common_nestjs_remix/apps/api/src/auth/__tests__/auth.service.spec.ts

examples/common_nestjs_remix/apps/api/src/users/__tests__/user.controller.e2e-spec.ts

k1eu · 2024-07-16T10:06:12Z

examples/common_nestjs_remix/apps/api/src/users/__tests__/user.controller.e2e-spec.ts

+      const response = await request(app.getHttpServer())
+        .get("/users")
+        .set("Cookie", cookies)
+        .expect(200);
+
+      expect(response.body.data).toBeDefined();
+      expect(Array.isArray(response.body.data)).toBe(true);


I think we'd rather test if the array contains correct data rather than toBeTrue

k1eu · 2024-07-16T10:06:25Z

examples/common_nestjs_remix/apps/api/src/users/__tests__/user.controller.e2e-spec.ts

+      expect(response.body.data).toBeDefined();
+      expect(response.body.data.id).toBe(testUser.id);


same, let's expect the correct object

k1eu · 2024-07-16T10:11:26Z

examples/common_nestjs_remix/apps/api/test/test-database.ts

+  container = await new GenericContainer("postgres:14")
+    .withExposedPorts(5432)


maybe postgres:16 to match the dev env postgres

and also won't the 5432 port collide with the dev postgres port? or is it internal port?

as @k1eu we could use any available port(I think test containers do that by default) and then pass the url to config service.

https://node.testcontainers.org/features/containers/#exposing-container-ports

as docs said: Testcontainers will automatically bind an available, random port on the host to each exposed container port. This is to avoid port conflicts when running tests quickly or in parallel.
so I think it's ok

mikoscz · 2024-07-16T10:53:24Z

examples/common_nestjs_remix/apps/api/test/factory/user.factory.ts

+
+      const now = new Date().toISOString();
+
+      return {


It should return only the user, credentials should be another factory, and we can add trait to the user factory eg. withCredentials() or sth like that.

mikoscz · 2024-07-16T10:53:59Z

examples/common_nestjs_remix/apps/api/test/factory/user.factory.ts

+  return Factory.define<{ users: Users; credentials: Credentials }>(
+    ({ params }) => {
+      const userId = faker.string.uuid();
+      const email = params.users?.email || faker.internet.email();


if you are not doing anything with params you don't need to do that all data put in params would override the factory generated data

mikoscz · 2024-07-16T10:54:10Z

examples/common_nestjs_remix/apps/api/test/factory/user.factory.ts

+
+export function createUsersFactory() {
+  return Factory.define<{ users: Users; credentials: Credentials }>(
+    ({ params }) => {


add onCreate which will save the user in the database

mikoscz · 2024-07-16T10:56:29Z

examples/common_nestjs_remix/apps/api/test/create-unit-test.ts

+    imports: [AppModule],
+    providers: [...customProviders],
+  })
+    .overrideProvider("DB")


We don't need to override db since we are injecting the url form the config service, we could just set the testcontainer url to the config and the rest should be fine.

mikoscz · 2024-07-16T10:57:14Z

examples/common_nestjs_remix/apps/api/test/create-unit-test.ts

+  getService: <T>(service: Type<T>) => T;
+}
+
+export async function createUnitTest(


Nitpick but the setup is more for integration/e2e since unit tests don't need app

mikoscz · 2024-07-16T10:58:30Z

examples/common_nestjs_remix/apps/api/test/create-unit-test.ts

+  })
+    .overrideProvider("DB")
+    .useValue(db)
+    .overrideProvider(JwtService)


We can leave the normal implementation of the jwt service, create a helper that allow us to sing in as a given user, this way we can create e2e tests with multiple users in the workflow.

mikoscz · 2024-07-16T10:59:05Z

examples/common_nestjs_remix/apps/api/test/create-e2e-test.ts

+    imports: [AppModule],
+    providers: [...customProviders],
+  })
+    .overrideProvider("DB")


override config value

mikoscz · 2024-07-16T11:00:45Z

examples/common_nestjs_remix/apps/api/test/helpers/test-helpers.ts

+  return jwtService.sign({ sub: userId });
+}
+
+export async function truncateAllDatabase(


nitpick: truncateAllTables is more precise but I am fine with this one

mikoscz · 2024-07-16T11:01:40Z

examples/common_nestjs_remix/apps/api/test/helpers/test-helpers.ts

+    get: jest.fn((key: string) => {
+      switch (key) {
+        case "DATABASE_URL":
+          return process.env.DATABASE_URL;


Maybe we could just user config overrides for this one, you know some ppl export production db credentials sometimes :D

mikoscz · 2024-07-16T11:04:32Z

examples/common_nestjs_remix/apps/api/src/auth/__tests__/auth.service.spec.ts

+  });
+
+  afterAll(async () => {
+    if (testContext.container) {


Move it to the testContext as teardown or afterAll so we don't need to care in every test

mikoscz · 2024-07-16T11:06:17Z

examples/common_nestjs_remix/apps/api/src/auth/__tests__/auth.service.spec.ts

+
+    it("should throw ConflictException if user already exists", async () => {
+      const email = "existing@example.com";
+      await db.insert(users).values({ email });


I've already commented in the factory file, but when you add onCreate then you could use factory to insert the user.

mikoscz · 2024-07-16T11:07:10Z

examples/common_nestjs_remix/apps/api/src/auth/__tests__/auth.service.spec.ts

+      const password = "password123";
+      const hashedPassword = await bcrypt.hash(password, 10);
+      const { users: userData, credentials: userCredentials } =
+        userFactory.build();
+
+      const [user] = await db.insert(users).values(userData).returning();
+      await db.insert(credentials).values({
+        ...userCredentials,
+        userId: user.id,
+        password: hashedPassword,
+      });


Move that to factory trait

mikoscz · 2024-07-16T11:11:03Z

examples/common_nestjs_remix/apps/api/src/users/__tests__/user.controller.e2e-spec.ts

+    const { users: newUser, credentials } = userFactory.build();
+    testUser = await authService.register(newUser.email, credentials.password);
+    testCredentials = credentials;
+
+    const loginResponse = await request(app.getHttpServer())
+      .post("/auth/login")
+      .send({
+        email: newUser.email,
+        password: credentials.password,
+      });
+
+    cookies = loginResponse.headers["set-cookie"];


Create a helper that would give as valid set of cookies instead so we don't need to call login endpoint in every test

or you could also add method to testagent .signAs(user)

…alFactory

typeWolffo · 2024-07-17T22:41:12Z

examples/common_nestjs_remix/apps/api/test/create-e2e-test.ts

+export async function createE2ETest(customProviders: Provider[] = []) {
+  const { db, connectionString } = await setupTestDatabase();
+
+  process.env.DATABASE_URL = connectionString;


@mikoscz what do you think about overriding database URL like that? :D

k1eu · 2024-07-18T09:28:04Z

examples/common_nestjs_remix/apps/api/src/auth/__tests__/auth.controller.e2e-spec.ts

+        .withCredentials({ password: "password123" })
+        .build();


k1eu · 2024-07-18T09:30:33Z

examples/common_nestjs_remix/apps/api/src/auth/__tests__/auth.service.spec.ts

+        .select()
+        .from(users)
+        .where(eq(users.email, user.email));
+      expect(savedUser).toBeDefined();


I'd move it to the expect part of this test

k1eu · 2024-07-18T09:33:14Z

examples/common_nestjs_remix/apps/api/src/users/__tests__/users.service.spec.ts

+      expect(updatedUser).toBeDefined();
+      expect(updatedUser.email).toBe("new@example.com");
+
+      const [dbUser] = await db
+        .select()
+        .from(users)
+        .where(eq(users.id, testUser.id));
+      expect(dbUser.email).toBe("new@example.com");


same a bit of reorder so the expect are last

* feat: configure jest for TypeScript and test database setup * feat: expand e2e tests for auth.controller and add new migration file * feat: update password change functionality and schema * feat: initialize test context and services * feat: create unit test setup function * feat: initialize test context and services for e2e tests * feat: create e2e test setup function * refactor: improve user and credential factories, add userWithCredentialFactory * feat: update dependencies and add JWT_REFRESH_SECRET * refactor: refactor user factory and add hashPassword function * fix: update password handling in user controller e2e tests * feat: refactor userFactory and authService.register * chore: update assertions in auth and users service tests

typeWolffo added 3 commits July 15, 2024 16:59

feat: configure jest for TypeScript and test database setup

0ef0282

feat: expand e2e tests for auth.controller and add new migration file

955440a

feat: update password change functionality and schema

8f7e31e

typeWolffo force-pushed the jw/tests branch from b749b34 to 8f7e31e Compare July 15, 2024 15:08

typeWolffo added 3 commits July 15, 2024 20:28

feat: initialize test context and services

84fdb40

feat: create unit test setup function

ff17fcb

feat: initialize test context and services for e2e tests

8f74c5e

typeWolffo requested review from mikoscz and k1eu July 15, 2024 20:19

typeWolffo self-assigned this Jul 15, 2024

typeWolffo force-pushed the jw/tests branch 2 times, most recently from befc4c9 to 8e58e1e Compare July 15, 2024 21:11

feat: create e2e test setup function

0772543

typeWolffo force-pushed the jw/tests branch from 8e58e1e to 0772543 Compare July 15, 2024 21:12

k1eu requested changes Jul 16, 2024

View reviewed changes

mikoscz reviewed Jul 16, 2024

View reviewed changes

typeWolffo added 2 commits July 17, 2024 09:54

refactor: improve user and credential factories, add userWithCredenti…

6d8feba

…alFactory

--wip-- [skip ci]

a0b8ea7

typeWolffo added 4 commits July 17, 2024 11:26

--wip-- [skip ci]

a0421e8

feat: update dependencies and add JWT_REFRESH_SECRET

e6cb8d2

refactor: refactor user factory and add hashPassword function

622207f

fix: update password handling in user controller e2e tests

92cf39b

typeWolffo commented Jul 17, 2024

View reviewed changes

typeWolffo force-pushed the jw/tests branch from b1a3356 to d0fdaed Compare July 17, 2024 22:47

feat: refactor userFactory and authService.register

a53b3df

typeWolffo force-pushed the jw/tests branch from d0fdaed to a53b3df Compare July 17, 2024 22:56

typeWolffo requested review from mikoscz and k1eu July 18, 2024 09:25

k1eu approved these changes Jul 18, 2024

View reviewed changes

chore: update assertions in auth and users service tests

254f5f0

typeWolffo merged commit 0cff62a into jw/user-auth Jul 18, 2024

typeWolffo deleted the jw/tests branch July 18, 2024 12:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: tests (unit, e2e) #7

feat: tests (unit, e2e) #7

typeWolffo commented Jul 15, 2024

k1eu Jul 16, 2024

k1eu Jul 16, 2024

k1eu Jul 16, 2024

k1eu Jul 16, 2024

k1eu Jul 16, 2024

mikoscz Jul 16, 2024

typeWolffo Jul 18, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

mikoscz Jul 16, 2024

typeWolffo Jul 17, 2024

k1eu Jul 18, 2024

k1eu Jul 18, 2024

k1eu Jul 18, 2024

		expect(response.body.data).toBeDefined();
		expect(response.body.data.id).toBe(testUser.id);

		container = await new GenericContainer("postgres:14")
		.withExposedPorts(5432)

feat: tests (unit, e2e) #7

feat: tests (unit, e2e) #7

Conversation

typeWolffo commented Jul 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment