nodejs-quickstart-structure 1.13.0 → 1.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/README.md +4 -3
  3. package/bin/index.js +84 -80
  4. package/lib/generator.js +28 -4
  5. package/lib/modules/app-setup.js +111 -19
  6. package/lib/modules/caching-setup.js +13 -0
  7. package/lib/modules/config-files.js +50 -62
  8. package/lib/modules/database-setup.js +35 -30
  9. package/lib/modules/kafka-setup.js +78 -10
  10. package/package.json +8 -4
  11. package/templates/clean-architecture/js/src/errors/BadRequestError.js +1 -1
  12. package/templates/clean-architecture/js/src/errors/BadRequestError.spec.js.ejs +21 -0
  13. package/templates/clean-architecture/js/src/errors/NotFoundError.js +1 -1
  14. package/templates/clean-architecture/js/src/errors/NotFoundError.spec.js.ejs +21 -0
  15. package/templates/clean-architecture/js/src/infrastructure/log/logger.spec.js.ejs +63 -0
  16. package/templates/clean-architecture/js/src/infrastructure/repositories/UserRepository.js.ejs +2 -3
  17. package/templates/clean-architecture/js/src/infrastructure/repositories/UserRepository.spec.js.ejs +81 -0
  18. package/templates/clean-architecture/js/src/interfaces/controllers/userController.js.ejs +8 -4
  19. package/templates/clean-architecture/js/src/interfaces/controllers/userController.spec.js.ejs +102 -0
  20. package/templates/clean-architecture/js/src/interfaces/graphql/context.spec.js.ejs +31 -0
  21. package/templates/clean-architecture/js/src/interfaces/graphql/resolvers/user.resolvers.spec.js.ejs +49 -0
  22. package/templates/clean-architecture/js/src/interfaces/routes/api.spec.js.ejs +38 -0
  23. package/templates/clean-architecture/js/src/usecases/CreateUser.spec.js.ejs +51 -0
  24. package/templates/clean-architecture/js/src/usecases/GetAllUsers.spec.js.ejs +61 -0
  25. package/templates/clean-architecture/ts/src/errors/BadRequestError.spec.ts.ejs +21 -0
  26. package/templates/clean-architecture/ts/src/errors/BadRequestError.ts +1 -1
  27. package/templates/clean-architecture/ts/src/errors/NotFoundError.spec.ts.ejs +21 -0
  28. package/templates/clean-architecture/ts/src/errors/NotFoundError.ts +1 -1
  29. package/templates/clean-architecture/ts/src/infrastructure/log/logger.spec.ts.ejs +64 -0
  30. package/templates/clean-architecture/ts/src/infrastructure/repositories/UserRepository.spec.ts.ejs +85 -0
  31. package/templates/clean-architecture/ts/src/infrastructure/repositories/UserRepository.ts.ejs +2 -3
  32. package/templates/clean-architecture/ts/src/interfaces/controllers/userController.spec.ts.ejs +166 -0
  33. package/templates/clean-architecture/ts/src/interfaces/graphql/context.spec.ts.ejs +32 -0
  34. package/templates/clean-architecture/ts/src/interfaces/graphql/resolvers/user.resolvers.spec.ts.ejs +51 -0
  35. package/templates/clean-architecture/ts/src/interfaces/routes/userRoutes.spec.ts.ejs +40 -0
  36. package/templates/clean-architecture/ts/src/usecases/createUser.spec.ts.ejs +51 -0
  37. package/templates/clean-architecture/ts/src/usecases/getAllUsers.spec.ts.ejs +63 -0
  38. package/templates/clean-architecture/ts/src/utils/errorMiddleware.ts.ejs +1 -2
  39. package/templates/common/.cursorrules.ejs +60 -0
  40. package/templates/common/.dockerignore +2 -0
  41. package/templates/common/.gitlab-ci.yml.ejs +5 -5
  42. package/templates/common/Jenkinsfile.ejs +1 -1
  43. package/templates/common/README.md.ejs +11 -1
  44. package/templates/common/_github/workflows/ci.yml +7 -4
  45. package/templates/common/caching/js/memoryCache.spec.js.ejs +101 -0
  46. package/templates/common/caching/js/redisClient.spec.js.ejs +149 -0
  47. package/templates/common/caching/ts/memoryCache.spec.ts.ejs +102 -0
  48. package/templates/common/caching/ts/redisClient.spec.ts.ejs +157 -0
  49. package/templates/common/database/js/database.spec.js.ejs +56 -0
  50. package/templates/common/database/js/models/User.js.ejs +22 -0
  51. package/templates/common/database/js/models/User.spec.js.ejs +84 -0
  52. package/templates/common/database/js/mongoose.spec.js.ejs +43 -0
  53. package/templates/common/database/ts/database.spec.ts.ejs +56 -0
  54. package/templates/common/database/ts/models/User.spec.ts.ejs +84 -0
  55. package/templates/common/database/ts/models/User.ts.ejs +26 -0
  56. package/templates/common/database/ts/mongoose.spec.ts.ejs +42 -0
  57. package/templates/common/eslint.config.mjs.ejs +11 -2
  58. package/templates/common/health/js/healthRoute.spec.js.ejs +70 -0
  59. package/templates/common/health/ts/healthRoute.spec.ts.ejs +76 -0
  60. package/templates/common/jest.config.js.ejs +19 -5
  61. package/templates/common/kafka/js/config/kafka.spec.js.ejs +21 -0
  62. package/templates/common/kafka/js/services/kafkaService.js.ejs +9 -5
  63. package/templates/common/kafka/js/services/kafkaService.spec.js.ejs +60 -0
  64. package/templates/common/kafka/ts/config/kafka.spec.ts.ejs +21 -0
  65. package/templates/common/kafka/ts/services/kafkaService.spec.ts.ejs +61 -0
  66. package/templates/common/kafka/ts/services/kafkaService.ts.ejs +1 -1
  67. package/templates/common/package.json.ejs +0 -3
  68. package/templates/common/prompts/add-feature.md.ejs +26 -0
  69. package/templates/common/prompts/project-context.md.ejs +43 -0
  70. package/templates/common/prompts/troubleshoot.md.ejs +28 -0
  71. package/templates/common/shutdown/js/gracefulShutdown.spec.js.ejs +160 -0
  72. package/templates/common/shutdown/ts/gracefulShutdown.spec.ts.ejs +158 -0
  73. package/templates/common/src/utils/errorMiddleware.spec.js.ejs +79 -0
  74. package/templates/common/src/utils/errorMiddleware.spec.ts.ejs +94 -0
  75. package/templates/common/tsconfig.json +1 -1
  76. package/templates/mvc/js/src/controllers/userController.js.ejs +4 -31
  77. package/templates/mvc/js/src/controllers/userController.spec.js.ejs +170 -0
  78. package/templates/mvc/js/src/errors/BadRequestError.js +1 -1
  79. package/templates/mvc/js/src/errors/BadRequestError.spec.js.ejs +21 -0
  80. package/templates/mvc/js/src/errors/NotFoundError.js +1 -1
  81. package/templates/mvc/js/src/errors/NotFoundError.spec.js.ejs +21 -0
  82. package/templates/mvc/js/src/graphql/context.spec.js.ejs +29 -0
  83. package/templates/mvc/js/src/graphql/resolvers/user.resolvers.spec.js.ejs +47 -0
  84. package/templates/mvc/js/src/index.js.ejs +1 -1
  85. package/templates/mvc/js/src/routes/api.spec.js.ejs +36 -0
  86. package/templates/mvc/js/src/utils/logger.spec.js.ejs +63 -0
  87. package/templates/mvc/ts/src/controllers/userController.spec.ts.ejs +185 -0
  88. package/templates/mvc/ts/src/controllers/userController.ts.ejs +4 -31
  89. package/templates/mvc/ts/src/errors/BadRequestError.spec.ts.ejs +21 -0
  90. package/templates/mvc/ts/src/errors/BadRequestError.ts +1 -1
  91. package/templates/mvc/ts/src/errors/NotFoundError.spec.ts.ejs +21 -0
  92. package/templates/mvc/ts/src/errors/NotFoundError.ts +1 -1
  93. package/templates/mvc/ts/src/graphql/context.spec.ts.ejs +30 -0
  94. package/templates/mvc/ts/src/graphql/resolvers/user.resolvers.spec.ts.ejs +51 -0
  95. package/templates/mvc/ts/src/routes/api.spec.ts.ejs +40 -0
  96. package/templates/mvc/ts/src/utils/errorMiddleware.ts.ejs +1 -2
  97. package/templates/mvc/ts/src/utils/logger.spec.ts.ejs +64 -0
  98. package/docs/demo.gif +0 -0
  99. package/docs/generateCase.md +0 -265
  100. package/docs/generatorFlow.md +0 -233
  101. package/docs/releaseNoteRule.md +0 -42
  102. package/docs/ruleDevelop.md +0 -30
  103. package/templates/common/tests/health.test.ts.ejs +0 -24
@@ -0,0 +1,81 @@
1
+ const UserRepository = require('@/infrastructure/repositories/UserRepository');
2
+ const UserModel = require('@/infrastructure/database/models/User');
3
+
4
+ jest.mock('@/infrastructure/database/models/User');
5
+
6
+ describe('UserRepository', () => {
7
+ let userRepository;
8
+
9
+ beforeEach(() => {
10
+ userRepository = new UserRepository();
11
+ jest.clearAllMocks();
12
+ });
13
+
14
+ describe('save', () => {
15
+ it('should save and return a newly created user (Happy Path)', async () => {
16
+ const userData = { name: 'New User', email: 'new@example.com' };
17
+ <%_ if (database === 'MongoDB') { -%>
18
+ const savedData = { _id: 'mock-id', ...userData };
19
+ UserModel.create.mockResolvedValue(savedData);
20
+ <%_ } else if (database === 'None') { -%>
21
+ UserModel.create.mockResolvedValue(userData);
22
+ <%_ } else { -%>
23
+ const savedData = { <%= database === "MongoDB" ? "_id" : "id" %>: '<%= database === "MongoDB" ? "mock-id" : "1" %>', ...userData };
24
+ UserModel.create.mockResolvedValue(savedData);
25
+ <%_ } -%>
26
+
27
+ const result = await userRepository.save(userData);
28
+
29
+ <%_ if (database === 'None') { -%>
30
+ expect(result.name).toEqual(userData.name);
31
+ <%_ } else { -%>
32
+ expect(UserModel.create).toHaveBeenCalledWith(userData);
33
+ expect(result).toEqual({ id: '<%= database === "MongoDB" ? "mock-id" : "1" %>', ...userData });
34
+ <%_ } -%>
35
+ });
36
+
37
+ it('should throw an error when DB fails explicitly (Edge Case)', async () => {
38
+ <%_ if (database === 'None') { -%>
39
+ // mock data logic doesn't throw naturally
40
+ <%_ } else { -%>
41
+ const error = new Error('DB Error');
42
+ UserModel.create.mockRejectedValue(error);
43
+
44
+ await expect(userRepository.save({})).rejects.toThrow('DB Error');
45
+ <%_ } -%>
46
+ });
47
+ });
48
+
49
+ describe('getUsers', () => {
50
+ it('should return a list of mapped UserEntities (Happy Path)', async () => {
51
+ <%_ if (database === 'MongoDB') { -%>
52
+ const mockUsers = [
53
+ { _id: '1', name: 'User 1', email: 'u1@test.com' },
54
+ { _id: '2', name: 'User 2', email: 'u2@test.com' }
55
+ ];
56
+ UserModel.find.mockResolvedValue(mockUsers);
57
+ <%_ } else if (database === 'None') { -%>
58
+ const mockUsers = [{ id: '1', name: 'User 1', email: 'u1@test.com' }];
59
+ UserModel.find.mockResolvedValue(mockUsers);
60
+ <%_ } else { -%>
61
+ const mockUsers = [
62
+ { <%= database === "MongoDB" ? "_id" : "id" %>: '1', name: 'User 1', email: 'u1@test.com' },
63
+ { <%= database === "MongoDB" ? "_id" : "id" %>: '2', name: 'User 2', email: 'u2@test.com' }
64
+ ];
65
+ UserModel.<%= database === "MongoDB" ? "find" : "findAll" %>.mockResolvedValue(mockUsers);
66
+ <%_ } -%>
67
+
68
+ const result = await userRepository.getUsers();
69
+
70
+ <%_ if (database !== 'None') { -%>
71
+ expect(UserModel.<%= database === 'MongoDB' ? 'find' : 'findAll' %>).toHaveBeenCalled();
72
+ <%_ } -%>
73
+ expect(result).toEqual([
74
+ { id: '1', name: 'User 1', email: 'u1@test.com' }
75
+ <%_ if (database !== 'None') { -%>
76
+ , { id: '2', name: 'User 2', email: 'u2@test.com' }
77
+ <%_ } -%>
78
+ ]);
79
+ });
80
+ });
81
+ });
@@ -33,10 +33,14 @@ class UserController {
33
33
  }
34
34
  }
35
35
  <% } else { -%>
36
- getUsers(req, res, next) {
37
- this.getAllUsersUseCase.execute()
38
- .then(users => res.json(users))
39
- .catch(next);
36
+ async getUsers(req, res, next) {
37
+ try {
38
+ const users = await this.getAllUsersUseCase.execute();
39
+ res.json(users);
40
+ } catch (error) {
41
+ logger.error('Error getting users:', error);
42
+ next(error);
43
+ }
40
44
  }
41
45
 
42
46
  async createUser(req, res, next) {
@@ -0,0 +1,102 @@
1
+ const UserController = require('@/interfaces/controllers/userController');
2
+ const CreateUser = require('@/usecases/CreateUser');
3
+ const GetAllUsers = require('@/usecases/GetAllUsers');
4
+
5
+ jest.mock('@/usecases/CreateUser');
6
+ jest.mock('@/usecases/GetAllUsers');
7
+
8
+ describe('UserController (Clean Architecture)', () => {
9
+ let userController;
10
+ let mockCreateUserUseCase;
11
+ let mockGetAllUsersUseCase;
12
+ <%_ if (communication !== 'GraphQL') { -%>
13
+ let mockRequest;
14
+ let mockResponse;
15
+ let mockNext;
16
+ <%_ } -%>
17
+
18
+ beforeEach(() => {
19
+ jest.clearAllMocks();
20
+
21
+ userController = new UserController();
22
+
23
+ // Retrieve the mocked instances created inside UserController constructor
24
+ mockCreateUserUseCase = CreateUser.mock.instances[0];
25
+ mockGetAllUsersUseCase = GetAllUsers.mock.instances[0];
26
+
27
+ <%_ if (communication !== 'GraphQL') { -%>
28
+ mockRequest = {
29
+ body: {}
30
+ };
31
+ mockResponse = {
32
+ status: jest.fn().mockReturnThis(),
33
+ json: jest.fn()
34
+ };
35
+ mockNext = jest.fn();
36
+ <%_ } -%>
37
+ });
38
+
39
+ describe('getUsers', () => {
40
+ it('should return successfully (Happy Path)', async () => {
41
+ const usersMock = [{ id: '1', name: 'Test', email: 'test@example.com' }];
42
+ mockGetAllUsersUseCase.execute.mockResolvedValue(usersMock);
43
+
44
+ <%_ if (communication === 'GraphQL') { -%>
45
+ const result = await userController.getUsers();
46
+ expect(result).toEqual(usersMock);
47
+ <%_ } else { -%>
48
+ await userController.getUsers(mockRequest, mockResponse, mockNext);
49
+ expect(mockResponse.json).toHaveBeenCalledWith(usersMock);
50
+ <%_ } -%>
51
+ expect(mockGetAllUsersUseCase.execute).toHaveBeenCalled();
52
+ });
53
+
54
+ it('should handle errors correctly (Error Handling)', async () => {
55
+ const error = new Error('UseCase Error');
56
+ mockGetAllUsersUseCase.execute.mockRejectedValue(error);
57
+
58
+ <%_ if (communication === 'GraphQL') { -%>
59
+ await expect(userController.getUsers()).rejects.toThrow(error);
60
+ <%_ } else { -%>
61
+ await userController.getUsers(mockRequest, mockResponse, mockNext);
62
+ expect(mockNext).toHaveBeenCalledWith(error);
63
+ <%_ } -%>
64
+ });
65
+ });
66
+
67
+ describe('createUser', () => {
68
+ it('should successfully create a new user (Happy Path)', async () => {
69
+ const payload = { name: 'Alice', email: 'alice@example.com' };
70
+ <%_ if (communication === 'GraphQL') { -%>
71
+ const dataArg = payload;
72
+ <%_ } else { -%>
73
+ mockRequest.body = payload;
74
+ <%_ } -%>
75
+ const expectedUser = { id: '1', ...payload };
76
+
77
+ mockCreateUserUseCase.execute.mockResolvedValue(expectedUser);
78
+
79
+ <%_ if (communication === 'GraphQL') { -%>
80
+ const result = await userController.createUser(dataArg);
81
+ expect(result).toEqual(expectedUser);
82
+ <%_ } else { -%>
83
+ await userController.createUser(mockRequest, mockResponse, mockNext);
84
+ expect(mockResponse.status).toHaveBeenCalledWith(201);
85
+ expect(mockResponse.json).toHaveBeenCalledWith(expectedUser);
86
+ <%_ } -%>
87
+ expect(mockCreateUserUseCase.execute).toHaveBeenCalledWith(payload.name, payload.email);
88
+ });
89
+
90
+ it('should handle errors when creation fails (Error Handling)', async () => {
91
+ const error = new Error('Creation Error');
92
+ mockCreateUserUseCase.execute.mockRejectedValue(error);
93
+
94
+ <%_ if (communication === 'GraphQL') { -%>
95
+ await expect(userController.createUser({ name: 'Bob', email: 'bob@example.com' })).rejects.toThrow(error);
96
+ <%_ } else { -%>
97
+ await userController.createUser(mockRequest, mockResponse, mockNext);
98
+ expect(mockNext).toHaveBeenCalledWith(error);
99
+ <%_ } -%>
100
+ });
101
+ });
102
+ });
@@ -0,0 +1,31 @@
1
+ const { gqlContext } = require('@/interfaces/graphql/context');
2
+ const { resolvers } = require('@/interfaces/graphql/resolvers');
3
+ const { typeDefs } = require('@/interfaces/graphql/typeDefs');
4
+
5
+ jest.mock('@/infrastructure/repositories/UserRepository');
6
+
7
+ describe('GraphQL Context', () => {
8
+ it('should exercise GraphQL index entry points', () => {
9
+ expect(resolvers).toBeDefined();
10
+ expect(typeDefs).toBeDefined();
11
+ });
12
+ it('should return context with token when authorization header is present', async () => {
13
+ const mockRequest = {
14
+ headers: {
15
+ authorization: 'Bearer token123',
16
+ },
17
+ };
18
+
19
+ const context = await gqlContext({ req: mockRequest });
20
+ expect(context.token).toBe('Bearer token123');
21
+ });
22
+
23
+ it('should return context with empty token when authorization header is missing', async () => {
24
+ const mockRequest = {
25
+ headers: {},
26
+ };
27
+
28
+ const context = await gqlContext({ req: mockRequest });
29
+ expect(context.token).toBe('');
30
+ });
31
+ });
@@ -0,0 +1,49 @@
1
+ const { userResolvers } = require('@/interfaces/graphql/resolvers/user.resolvers');
2
+
3
+ const mockGetUsers = jest.fn().mockResolvedValue([{ id: '1', name: 'John Doe', email: 'john@example.com' }]);
4
+ const mockCreateUser = jest.fn().mockResolvedValue({ id: '1', name: 'Jane', email: 'jane@example.com' });
5
+
6
+ jest.mock('@/interfaces/controllers/userController', () => {
7
+ return jest.fn().mockImplementation(() => ({
8
+ getUsers: (...args) => mockGetUsers(...args),
9
+ createUser: (...args) => mockCreateUser(...args)
10
+ }));
11
+ });
12
+
13
+ describe('User Resolvers', () => {
14
+ afterEach(() => {
15
+ jest.clearAllMocks();
16
+ });
17
+
18
+ describe('Query.getAllUsers', () => {
19
+ it('should return all users', async () => {
20
+ const result = await userResolvers.Query.getAllUsers();
21
+ expect(result).toEqual([{ id: '1', name: 'John Doe', email: 'john@example.com' }]);
22
+ expect(mockGetUsers).toHaveBeenCalledTimes(1);
23
+ });
24
+ });
25
+
26
+ describe('Mutation.createUser', () => {
27
+ it('should create and return a new user', async () => {
28
+ const result = await userResolvers.Mutation.createUser(null, { name: 'Jane', email: 'jane@example.com' });
29
+ expect(result).toEqual({ id: '1', name: 'Jane', email: 'jane@example.com' });
30
+ expect(mockCreateUser).toHaveBeenCalledWith({ name: 'Jane', email: 'jane@example.com' });
31
+ expect(mockCreateUser).toHaveBeenCalledTimes(1);
32
+ });
33
+ });
34
+ <%_ if (database === 'MongoDB') { -%>
35
+ describe('User.id', () => {
36
+ it('should return parent.id if available', () => {
37
+ const parent = { id: '123' };
38
+ const result = userResolvers.User.id(parent);
39
+ expect(result).toBe('123');
40
+ });
41
+
42
+ it('should fallback to parent._id if id is not available', () => {
43
+ const parent = { _id: '456' };
44
+ const result = userResolvers.User.id(parent);
45
+ expect(result).toBe('456');
46
+ });
47
+ });
48
+ <%_ } -%>
49
+ });
@@ -0,0 +1,38 @@
1
+ const request = require('supertest');
2
+ const express = require('express');
3
+ const router = require('@/interfaces/routes/api');
4
+
5
+ const mockGetUsers = jest.fn().mockImplementation((req, res) => res.status(200).json([{ id: '1', name: 'John Doe' }]));
6
+ const mockCreateUser = jest.fn().mockImplementation((req, res) => res.status(201).json({ id: '1', name: 'Test' }));
7
+
8
+ jest.mock('@/interfaces/controllers/userController', () => {
9
+ return jest.fn().mockImplementation(() => ({
10
+ getUsers: (...args) => mockGetUsers(...args),
11
+ createUser: (...args) => mockCreateUser(...args)
12
+ }));
13
+ });
14
+
15
+ describe('ApiRoutes', () => {
16
+ let app;
17
+
18
+ beforeEach(() => {
19
+ app = express();
20
+ app.use(express.json());
21
+ app.use('/api', router);
22
+ });
23
+
24
+ it('POST /api/users should call controller.createUser', async () => {
25
+ await request(app)
26
+ .post('/api/users')
27
+ .send({ name: 'Test', email: 'test@example.com' });
28
+
29
+ expect(mockCreateUser).toHaveBeenCalledTimes(1);
30
+ });
31
+
32
+ it('GET /api/users should call controller.getUsers', async () => {
33
+ await request(app)
34
+ .get('/api/users');
35
+
36
+ expect(mockGetUsers).toHaveBeenCalledTimes(1);
37
+ });
38
+ });
@@ -0,0 +1,51 @@
1
+ const CreateUser = require('@/usecases/CreateUser');
2
+ const UserRepository = require('@/infrastructure/repositories/UserRepository');
3
+ <%_ if (caching !== 'None') { -%>
4
+ const cacheService = require('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>');
5
+ <%_ } -%>
6
+
7
+ jest.mock('@/infrastructure/repositories/UserRepository');
8
+ <%_ if (caching !== 'None') { -%>
9
+ jest.mock('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>', () => ({
10
+ get: jest.fn(),
11
+ set: jest.fn(),
12
+ del: jest.fn()
13
+ }));
14
+ <%_ } -%>
15
+
16
+ describe('CreateUser UseCase', () => {
17
+ let createUser;
18
+ let mockUserRepository;
19
+
20
+ beforeEach(() => {
21
+ mockUserRepository = new UserRepository();
22
+ createUser = new CreateUser(mockUserRepository);
23
+ jest.clearAllMocks();
24
+ });
25
+
26
+ it('should create and save a new user', async () => {
27
+ const name = 'Test User';
28
+ const email = 'test@example.com';
29
+ const expectedResult = { id: 1, name, email };
30
+
31
+ mockUserRepository.save.mockResolvedValue(expectedResult);
32
+
33
+ const result = await createUser.execute(name, email);
34
+
35
+ expect(mockUserRepository.save).toHaveBeenCalledTimes(1);
36
+ const savedUser = mockUserRepository.save.mock.calls[0][0];
37
+ expect(savedUser.name).toBe(name);
38
+ expect(savedUser.email).toBe(email);
39
+ expect(result).toEqual(expectedResult);
40
+ <%_ if (caching !== 'None') { -%>
41
+ expect(cacheService.del).toHaveBeenCalledWith('users:all');
42
+ <%_ } -%>
43
+ });
44
+
45
+ it('should throw an error if repository fails', async () => {
46
+ const error = new Error('Database error');
47
+ mockUserRepository.save.mockRejectedValue(error);
48
+
49
+ await expect(createUser.execute('Test', 'test@test.com')).rejects.toThrow(error);
50
+ });
51
+ });
@@ -0,0 +1,61 @@
1
+ const GetAllUsers = require('@/usecases/GetAllUsers');
2
+ const UserRepository = require('@/infrastructure/repositories/UserRepository');
3
+ <%_ if (caching !== 'None') { -%>
4
+ const cacheService = require('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>');
5
+ <%_ } -%>
6
+
7
+ jest.mock('@/infrastructure/repositories/UserRepository');
8
+ <%_ if (caching !== 'None') { -%>
9
+ jest.mock('<% if (caching === "Redis") { %>@/infrastructure/caching/redisClient<% } else { %>@/infrastructure/caching/memoryCache<% } %>', () => ({
10
+ get: jest.fn(),
11
+ set: jest.fn(),
12
+ del: jest.fn()
13
+ }));
14
+ <%_ } -%>
15
+
16
+ describe('GetAllUsers UseCase', () => {
17
+ let getAllUsers;
18
+ let mockUserRepository;
19
+
20
+ beforeEach(() => {
21
+ mockUserRepository = new UserRepository();
22
+ getAllUsers = new GetAllUsers(mockUserRepository);
23
+ jest.clearAllMocks();
24
+ });
25
+
26
+ it('should retrieve all users', async () => {
27
+ const expectedUsers = [{ id: 1, name: 'Alice', email: 'alice@example.com' }];
28
+ mockUserRepository.getUsers.mockResolvedValue(expectedUsers);
29
+ <%_ if (caching !== 'None') { -%>
30
+ cacheService.get.mockResolvedValue(null); // Cache miss
31
+ <%_ } -%>
32
+ const result = await getAllUsers.execute();
33
+
34
+ expect(mockUserRepository.getUsers).toHaveBeenCalledTimes(1);
35
+ expect(result).toEqual(expectedUsers);
36
+ <%_ if (caching !== 'None') { -%>
37
+ expect(cacheService.set).toHaveBeenCalled();
38
+ <%_ } -%>
39
+ });
40
+
41
+ <%_ if (caching !== 'None') { -%>
42
+ it('should return from cache if available', async () => {
43
+ const cachedUsers = [{ id: 1, name: 'Cached', email: 'cached@example.com' }];
44
+ cacheService.get.mockResolvedValue(cachedUsers);
45
+
46
+ const result = await getAllUsers.execute();
47
+
48
+ expect(mockUserRepository.getUsers).not.toHaveBeenCalled();
49
+ expect(result).toEqual(cachedUsers);
50
+ });
51
+ <%_ } -%>
52
+
53
+ it('should throw an error if repository fails', async () => {
54
+ const error = new Error('Database error');
55
+ mockUserRepository.getUsers.mockRejectedValue(error);
56
+ <%_ if (caching !== 'None') { -%>
57
+ cacheService.get.mockResolvedValue(null); // Cache miss
58
+ <%_ } -%>
59
+ await expect(getAllUsers.execute()).rejects.toThrow(error);
60
+ });
61
+ });
@@ -0,0 +1,21 @@
1
+ import { BadRequestError } from '@/errors/BadRequestError';
2
+ import { ApiError } from '@/errors/ApiError';
3
+ import { HTTP_STATUS } from '@/utils/httpCodes';
4
+
5
+ describe('BadRequestError', () => {
6
+ it('should extend ApiError', () => {
7
+ const error = new BadRequestError();
8
+ expect(error).toBeInstanceOf(ApiError);
9
+ });
10
+
11
+ it('should have default message "Bad request"', () => {
12
+ const error = new BadRequestError();
13
+ expect(error.message).toBe('Bad request');
14
+ expect(error.statusCode).toBe(HTTP_STATUS.BAD_REQUEST);
15
+ });
16
+
17
+ it('should accept a custom message', () => {
18
+ const error = new BadRequestError('Custom bad request');
19
+ expect(error.message).toBe('Custom bad request');
20
+ });
21
+ });
@@ -1,4 +1,4 @@
1
- import { ApiError } from './ApiError';
1
+ import { ApiError } from '@/errors/ApiError';
2
2
  import { HTTP_STATUS } from '@/utils/httpCodes';
3
3
 
4
4
  export class BadRequestError extends ApiError {
@@ -0,0 +1,21 @@
1
+ import { NotFoundError } from '@/errors/NotFoundError';
2
+ import { ApiError } from '@/errors/ApiError';
3
+ import { HTTP_STATUS } from '@/utils/httpCodes';
4
+
5
+ describe('NotFoundError', () => {
6
+ it('should extend ApiError', () => {
7
+ const error = new NotFoundError();
8
+ expect(error).toBeInstanceOf(ApiError);
9
+ });
10
+
11
+ it('should have default message "Resource not found"', () => {
12
+ const error = new NotFoundError();
13
+ expect(error.message).toBe('Resource not found');
14
+ expect(error.statusCode).toBe(HTTP_STATUS.NOT_FOUND);
15
+ });
16
+
17
+ it('should accept a custom message', () => {
18
+ const error = new NotFoundError('User not found');
19
+ expect(error.message).toBe('User not found');
20
+ });
21
+ });
@@ -1,4 +1,4 @@
1
- import { ApiError } from './ApiError';
1
+ import { ApiError } from '@/errors/ApiError';
2
2
  import { HTTP_STATUS } from '@/utils/httpCodes';
3
3
 
4
4
  export class NotFoundError extends ApiError {
@@ -0,0 +1,64 @@
1
+ jest.mock('winston-daily-rotate-file');
2
+ jest.mock('winston', () => {
3
+ const mockLogger = {
4
+ add: jest.fn(),
5
+ info: jest.fn(),
6
+ error: jest.fn(),
7
+ warn: jest.fn()
8
+ };
9
+ const format = {
10
+ combine: jest.fn(),
11
+ timestamp: jest.fn(),
12
+ json: jest.fn(),
13
+ simple: jest.fn()
14
+ };
15
+ const transports = {
16
+ Console: jest.fn(),
17
+ DailyRotateFile: jest.fn()
18
+ };
19
+ return {
20
+ format,
21
+ transports,
22
+ createLogger: jest.fn().mockReturnValue(mockLogger)
23
+ };
24
+ });
25
+
26
+ <% if (architecture === 'MVC') { -%>
27
+ import logger from '@/utils/logger';
28
+ <% } else { -%>
29
+ import logger from '@/infrastructure/log/logger';
30
+ <% } -%>
31
+
32
+ describe('Logger', () => {
33
+ it('should export a logger instance', () => {
34
+ expect(logger).toBeDefined();
35
+ });
36
+
37
+ it('should have info method', () => {
38
+ expect(typeof logger.info).toBe('function');
39
+ });
40
+
41
+ it('should have error method', () => {
42
+ expect(typeof logger.error).toBe('function');
43
+ });
44
+
45
+ it('should call info', () => {
46
+ logger.info('test message');
47
+ expect(logger.info).toHaveBeenCalledWith('test message');
48
+ });
49
+
50
+ it('should call error', () => {
51
+ logger.error('test error');
52
+ expect(logger.error).toHaveBeenCalledWith('test error');
53
+ });
54
+
55
+ it('should use JSON format in production environment', () => {
56
+ const winston = require('winston');
57
+ jest.resetModules();
58
+ process.env.NODE_ENV = 'production';
59
+ // eslint-disable-next-line @typescript-eslint/no-require-imports
60
+ require('<% if (architecture === "MVC") { %>@/utils/logger<% } else { %>@/infrastructure/log/logger<% } %>');
61
+ expect(winston.format.json).toHaveBeenCalled();
62
+ process.env.NODE_ENV = 'test';
63
+ });
64
+ });
@@ -0,0 +1,85 @@
1
+ import { UserRepository } from '@/infrastructure/repositories/UserRepository';
2
+ import UserModel from '@/infrastructure/database/models/User';
3
+
4
+ // Mock DB Model Database Layer
5
+ jest.mock('@/infrastructure/database/models/User');
6
+
7
+ describe('UserRepository', () => {
8
+ let userRepository: UserRepository;
9
+
10
+ beforeEach(() => {
11
+ userRepository = new UserRepository();
12
+ jest.clearAllMocks();
13
+ });
14
+
15
+ describe('save', () => {
16
+ it('should save and return a newly created user (Happy Path)', async () => {
17
+ // Arrange
18
+ const payload = { id: '', name: 'TestUser', email: 'test@example.com' };
19
+ <%_ if (database === 'MongoDB') { -%>
20
+ const mockDbRecord = { _id: { toString: () => '1' }, name: 'TestUser', email: 'test@example.com' };
21
+ (UserModel.create as jest.Mock).mockResolvedValue(mockDbRecord);
22
+ <%_ } else if (database === 'None') { -%>
23
+ (UserModel.create as jest.Mock).mockResolvedValue(payload);
24
+ <%_ } else { -%>
25
+ const mockDbRecord = { id: '1', name: 'TestUser', email: 'test@example.com' };
26
+ (UserModel.create as jest.Mock).mockResolvedValue(mockDbRecord);
27
+ <%_ } -%>
28
+
29
+ // Act
30
+ const result = await userRepository.save(payload);
31
+
32
+ // Assert
33
+ <%_ if (database === 'None') { -%>
34
+ expect(result.name).toEqual(payload.name)
35
+ <%_ } else { -%>
36
+ expect(result).toEqual({ id: '1', name: 'TestUser', email: 'test@example.com' });
37
+ expect(UserModel.create).toHaveBeenCalledWith({ name: payload.name, email: payload.email });
38
+ <%_ } -%>
39
+ });
40
+
41
+ it('should throw an error when DB fails explicitly (Edge Case)', async () => {
42
+ <%_ if (database === 'None') { -%>
43
+ // Mocks do not naturally fail
44
+ <%_ } else { -%>
45
+ // Arrange
46
+ const payload = { id: '', name: 'FailUser', email: 'fail@example.com' };
47
+ const error = new Error('DB Connection Refused');
48
+ (UserModel.create as jest.Mock).mockRejectedValue(error);
49
+
50
+ // Act & Assert
51
+ await expect(userRepository.save(payload)).rejects.toThrow(error);
52
+ <%_ } -%>
53
+ });
54
+ });
55
+
56
+ describe('getUsers', () => {
57
+ it('should return a list of mapped UserEntities (Happy Path)', async () => {
58
+ // Arrange
59
+ <%_ if (database === 'MongoDB') { -%>
60
+ const mockDbRecords = [{ _id: { toString: () => '1' }, name: 'User1', email: 'user1@example.com' }];
61
+ (UserModel.find as jest.Mock).mockResolvedValue(mockDbRecords);
62
+ <%_ } else if (database === 'None') { -%>
63
+ const mockData = [{ id: '1', name: 'User1', email: 'user1@example.com' }];
64
+ (UserModel.find as jest.Mock).mockResolvedValue(mockData);
65
+ <%_ } else { -%>
66
+ const mockDbRecords = [{ id: '1', name: 'User1', email: 'user1@example.com' }];
67
+ (UserModel.findAll as jest.Mock).mockResolvedValue(mockDbRecords);
68
+ <%_ } -%>
69
+
70
+ // Act
71
+ const result = await userRepository.getUsers();
72
+
73
+ // Assert
74
+ expect(result).toHaveLength(1);
75
+ expect(result[0]).toEqual({ id: '1', name: 'User1', email: 'user1@example.com' });
76
+ <%_ if (database !== 'None') { -%>
77
+ <%_ if (database === 'MongoDB') { -%>
78
+ expect(UserModel.find).toHaveBeenCalled();
79
+ <%_ } else { -%>
80
+ expect(UserModel.findAll).toHaveBeenCalled();
81
+ <%_ } -%>
82
+ <%_ } -%>
83
+ });
84
+ });
85
+ });
@@ -7,8 +7,7 @@ export class UserRepository {
7
7
  const newUser = await UserModel.create({ name: user.name, email: user.email });
8
8
  return { id: newUser._id.toString(), name: newUser.name, email: newUser.email };
9
9
  <%_ } else if (database === 'None') { -%>
10
- const newUser = { id: String(UserModel.mockData.length + 1), name: user.name, email: user.email };
11
- UserModel.mockData.push(newUser);
10
+ const newUser = await UserModel.create(user);
12
11
  return newUser;
13
12
  <%_ } else { -%>
14
13
  const newUser = await UserModel.create({ name: user.name, email: user.email });
@@ -25,7 +24,7 @@ export class UserRepository {
25
24
  email: user.email
26
25
  }));
27
26
  <%_ } else if (database === 'None') { -%>
28
- return UserModel.mockData;
27
+ return await UserModel.find();
29
28
  <%_ } else { -%>
30
29
  const users = await UserModel.findAll();
31
30
  return users.map(user => ({