Skip to content

Commit 6f56dc5

Browse files
spuxx-devspuxx-dev
committed
feat: Implemented new @spuxx/nest-testing package
1 parent a185157 commit 6f56dc5

23 files changed

+904
-2
lines changed

‎.release-please/config.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"packages": {
33
"packages/js-utils": {},
44
"packages/browser-utils": {},
5-
"packages/nest-utils": {}
5+
"packages/nest-utils": {},
6+
"packages/nest-testing": {}
67
},
78
"changelog-sections": [
89
{ "type": "feat", "section": "Features" },

‎.release-please/manifest.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"packages/js-utils": "1.2.0",
33
"packages/browser-utils": "1.2.0",
4-
"packages/nest-utils": "2.4.1"
4+
"packages/nest-utils": "2.4.1",
5+
"packages/nest-testing": "0.0.0"
56
}

‎packages/nest-testing/.npmignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/*
2+
!/dist
3+
!package.json
4+
!LICENSE.md
5+
!README.md

‎packages/nest-testing/CHANGELOG.md

+210
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
# Changelog
2+
3+
## [2.4.1](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.4.0...nest-utils-v2.4.1) (2024-11-07)
4+
5+
6+
### Bug Fixes
7+
8+
* **transformers:** Fixed an issue with `transformBooleanString()` where undefined or nullish values would become `false` ([eaee6ee](https://github.com/spuxx1701/jslibs/commit/eaee6ee68f5e226e6eeaccb1d4e1ae05b683b3ce))
9+
10+
## [2.4.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.3.3...nest-utils-v2.4.0) (2024-11-06)
11+
12+
13+
### Features
14+
15+
* **http:** Implemented '@IncludeQueryParam` decorator ([b7ebc57](https://github.com/spuxx1701/jslibs/commit/b7ebc57841b6cb27f5902497ce121fe846d23288))
16+
* **transformers:** Implemented `@TransformArrayString()` decorator and `transformArrayString()` function ([8e77f0c](https://github.com/spuxx1701/jslibs/commit/8e77f0cd00d2f85cd13f0cdc2de35981455fdd22))
17+
* **transformers:** Refactored `@TransformBooleanString` decorator and exposed `transformBooleanString()` function ([a11da65](https://github.com/spuxx1701/jslibs/commit/a11da65b63ea13078f55c2c169d46f26bb62bf40))
18+
19+
20+
### Bug Fixes
21+
22+
* **auth:** Explicitly import and export `AuthGuard` ([46d43b2](https://github.com/spuxx1701/jslibs/commit/46d43b2508d0e805f5572c77ed4f66b85524f789))
23+
24+
## [2.3.3](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.3.2...nest-utils-v2.3.3) (2024-10-30)
25+
26+
27+
### Bug Fixes
28+
29+
* **auth:** Mark `AuthModule` as a global module ([11f92af](https://github.com/spuxx1701/jslibs/commit/11f92af11f95192bf917a7a9449b59d699dda57a))
30+
31+
## [2.3.2](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.3.1...nest-utils-v2.3.2) (2024-10-30)
32+
33+
34+
### Bug Fixes
35+
36+
* **auth:** Fixed an issue with `SessionResource` being wrongly typed that would prevent family_name from being accessible ([b76cb8e](https://github.com/spuxx1701/jslibs/commit/b76cb8e4c0bdb9a1405e2852dc15ae6a562b8102))
37+
38+
## [2.3.1](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.3.0...nest-utils-v2.3.1) (2024-10-29)
39+
40+
41+
### Bug Fixes
42+
43+
* **mapping:** Fixed an issue that would cause `@Mapper()` to break on `Date` properties ([6507169](https://github.com/spuxx1701/jslibs/commit/6507169c0478fd95222c25abf09dc1c5f11d47f0))
44+
45+
## [2.3.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.2.0...nest-utils-v2.3.0) (2024-10-29)
46+
47+
48+
### Features
49+
50+
* **mapping:** `@Map()` is now able to map nested properties fully automatically ([bb18d8c](https://github.com/spuxx1701/jslibs/commit/bb18d8cf9c766dccfec9ad197e2cca61f4fc119e))
51+
52+
## [2.2.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.1.3...nest-utils-v2.2.0) (2024-10-29)
53+
54+
55+
### Features
56+
57+
* **mapping:** `@Map()` decorator now supports mapping nested objects ([650535f](https://github.com/spuxx1701/jslibs/commit/650535fed06215350dd6ab412e2fd84cacd74b42))
58+
59+
## [2.1.3](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.1.2...nest-utils-v2.1.3) (2024-10-27)
60+
61+
62+
### Bug Fixes
63+
64+
* **mapping:** Fixed an issue that would prevent metadata to be retrieved from sequelize models correctly ([f9f30fe](https://github.com/spuxx1701/jslibs/commit/f9f30feecfb4b646095fd02239c856927d6c4f1c))
65+
66+
## [2.1.2](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.1.1...nest-utils-v2.1.2) (2024-10-27)
67+
68+
69+
### Bug Fixes
70+
71+
* **mapping:** Fixed an issue that would prevent metadata to be retrieved from sequelize models correctly ([6d8106e](https://github.com/spuxx1701/jslibs/commit/6d8106ec652836c497e06b86bc687aa022dbd399))
72+
73+
## [2.1.1](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.1.0...nest-utils-v2.1.1) (2024-10-27)
74+
75+
76+
### Bug Fixes
77+
78+
* **mapping:** Turned MappingModule into a global module ([afc545d](https://github.com/spuxx1701/jslibs/commit/afc545d37a5019ed8af643f359c600a8a26c8e44))
79+
80+
## [2.1.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v2.0.0...nest-utils-v2.1.0) (2024-10-27)
81+
82+
83+
### Features
84+
85+
* **mapping:** Mapping now implements the preserveUndefined option ([14ba050](https://github.com/spuxx1701/jslibs/commit/14ba05070fc9e17c0dd350fd5984955dd0dde176))
86+
87+
88+
### Bug Fixes
89+
90+
* **mapping:** Export @Map() decorator ([7f16918](https://github.com/spuxx1701/jslibs/commit/7f169187e81791bf8312f13e9ba328d7bd86058e))
91+
92+
## [2.0.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.5.0...nest-utils-v2.0.0) (2024-10-27)
93+
94+
95+
### ⚠ BREAKING CHANGES
96+
97+
* **mapping:** Replaced automapper integration with a custom implementation of MappingModule
98+
99+
### Features
100+
101+
* **mapping:** Replaced automapper integration with a custom implementation of MappingModule ([49cf08e](https://github.com/spuxx1701/jslibs/commit/49cf08eb0dd08ff83303e8df50def13dc8990db7))
102+
103+
104+
### Bug Fixes
105+
106+
* **mapping:** Export mapper service ([eac1ab2](https://github.com/spuxx1701/jslibs/commit/eac1ab2fb0306bef46503004eddccb8d49c26f8c))
107+
108+
## [1.5.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.4.0...nest-utils-v1.5.0) (2024-10-26)
109+
110+
111+
### Features
112+
113+
* **mapping:** MappingModule now supports sequelize ([720bcb5](https://github.com/spuxx1701/jslibs/commit/720bcb5e7f080a89b1a54c42d92a7632f7c09af1))
114+
115+
## [1.4.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.3.0...nest-utils-v1.4.0) (2024-10-26)
116+
117+
118+
### Features
119+
120+
* **mapping:** Implemented MappingModule ([7bc49e9](https://github.com/spuxx1701/jslibs/commit/7bc49e92090930d828f2b5f347ec57fd4241af30))
121+
122+
## [1.3.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.2.0...nest-utils-v1.3.0) (2024-10-26)
123+
124+
125+
### Features
126+
127+
* **testing:** Implement more supertest methods ([b4bdaaf](https://github.com/spuxx1701/jslibs/commit/b4bdaafb002500b89a143c687c71f75078419389))
128+
129+
## [1.2.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.1.4...nest-utils-v1.2.0) (2024-10-24)
130+
131+
132+
### Features
133+
134+
* **auth:** Implemented getSession and isAuthenticated utility functions ([711d9c3](https://github.com/spuxx1701/jslibs/commit/711d9c3d9ddd1f0083290c70ffecf14eb49d6112))
135+
* **auth:** Session resource now includes preferred_username ([e00a8e3](https://github.com/spuxx1701/jslibs/commit/e00a8e3781e1c458678537761cc51a4a52b7e64c))
136+
* **testing:** TestContainer now offers an afterCreate hook ([26d6d02](https://github.com/spuxx1701/jslibs/commit/26d6d02165873926ad0db051d5fe09fd841c84e9))
137+
138+
## [1.1.4](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.1.3...nest-utils-v1.1.4) (2024-10-08)
139+
140+
141+
### Bug Fixes
142+
143+
* **auth:** Session resource now correctly references groups claim ([0177c39](https://github.com/spuxx1701/jslibs/commit/0177c39bd25d47188968455f6e5c97b9c47b1b94))
144+
145+
## [1.1.3](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.1.2...nest-utils-v1.1.3) (2024-10-08)
146+
147+
148+
### Bug Fixes
149+
150+
* **auth:** Improve AuthGuard's verbose logging ([c7f6985](https://github.com/spuxx1701/jslibs/commit/c7f6985e8af711933d3238442a94d6aa1524e4f8))
151+
* **auth:** Update user role detection to support the common 'groups' claim ([def2ada](https://github.com/spuxx1701/jslibs/commit/def2ada1c1f7151886d796205b4d406428c49f5e))
152+
153+
## [1.1.2](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.1.1...nest-utils-v1.1.2) (2024-10-08)
154+
155+
156+
### Bug Fixes
157+
158+
* **deps:** Declare `rxjs` as a peer dependency ([732922c](https://github.com/spuxx1701/jslibs/commit/732922c2a736be313b396f67b65feaf67dc5a8a2))
159+
160+
## [1.1.1](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.1.0...nest-utils-v1.1.1) (2024-10-08)
161+
162+
163+
### Bug Fixes
164+
165+
* **http:** Add missing `http` exports ([43c07b8](https://github.com/spuxx1701/jslibs/commit/43c07b86775f494bb9441726f22873b94c7bf4bf))
166+
167+
## [1.1.0](https://github.com/spuxx1701/jslibs/compare/nest-utils-v1.0.0...nest-utils-v1.1.0) (2024-10-07)
168+
169+
170+
### Features
171+
172+
* `@nanogiants/nestjs-swagger-api-exception-decorator` is now bundled into `nest-utils` ([de635f0](https://github.com/spuxx1701/jslibs/commit/de635f0fb09aa205a740429fe42f8bd13c8cad1e))
173+
* Added `CustomLogger.getContext()` method ([4b2fb40](https://github.com/spuxx1701/jslibs/commit/4b2fb40ff4523bb34a92471de8098f09b553fc5c))
174+
* **auth:** Replaced `authOptions.allowedRedirectUrls` with `authOptions.allowedRedirectHostnames` to better resemble the behavior of the validation ([5aa928e](https://github.com/spuxx1701/jslibs/commit/5aa928ea392aba9f9052dd2f09cf834f860541af))
175+
* **testing:** TestAppLogger now stores messages for easier assertions and debugging ([3fee10e](https://github.com/spuxx1701/jslibs/commit/3fee10e26f75c7598246b9e6d5aed4be971e0d9a))
176+
177+
178+
### Bug Fixes
179+
180+
* **auth:** Enabled protection for /auth/session route ([d48e033](https://github.com/spuxx1701/jslibs/commit/d48e0334db5d119967c91fed579a9f0fd24a9652))
181+
* **auth:** Fixed a bug that would cause an internal error if an authenticated user would not have any of the application's roles ([2bcfc98](https://github.com/spuxx1701/jslibs/commit/2bcfc98c43932eeab08c9a6f902f78471da7c8be))
182+
* **deps:** Fixed peer dependency versioning ([3f341a5](https://github.com/spuxx1701/jslibs/commit/3f341a51ab0eaa245f68bafb8a1aba12bec4a059))
183+
* **deps:** Turned `@nanogiants/nestjs-swagger-api-exception-decorator` into a peer dependency ([b1904b4](https://github.com/spuxx1701/jslibs/commit/b1904b427611d759736df70716b82111c608fe52))
184+
* **testing:** Fixed vitest being bundled and hoisted ([2a1cac5](https://github.com/spuxx1701/jslibs/commit/2a1cac5d123f4d2079b33fd51ba7cc47ec9243c2))
185+
* **testing:** Removed obsolete session property on TestContainer ([2af4809](https://github.com/spuxx1701/jslibs/commit/2af4809da55495bc95a922e387a7786f6068772e))
186+
187+
## 1.0.0 (2024-08-31)
188+
189+
190+
### Features
191+
192+
* Add EnvModule to help with loading and handling environment variables ([641559f](https://github.com/spuxx1701/jslibs/commit/641559f6576a0273609724498f55eacc3a64a09c))
193+
* CustomLogger can now update its log level during runtime ([7c6e92b](https://github.com/spuxx1701/jslibs/commit/7c6e92bd0f0ac00cd743c4811850ce5dab8565c0))
194+
* Expose TestContainer and Supertest helper classes to help with testing Nest applications ([797c471](https://github.com/spuxx1701/jslibs/commit/797c471941de1c09ff8e369f39f412a01ce16bf8))
195+
* Implement `TransformBooleanString` transformer decorator ([b2a567d](https://github.com/spuxx1701/jslibs/commit/b2a567d37def2e8dd39a9c7c8fcb29f8ca2b9f3b))
196+
* Implement CustomLogger class ([883fa99](https://github.com/spuxx1701/jslibs/commit/883fa99108c711fc2076e5ff0f868c0573f862e6))
197+
* Implement HttpLoggingInterceptor ([e7df43f](https://github.com/spuxx1701/jslibs/commit/e7df43f718700fbc793f36d06e18d54e1a21a4c6))
198+
* Introduce `AuthModule` for handling authorization and authentication through OIDC ([0d3cdd7](https://github.com/spuxx1701/jslibs/commit/0d3cdd77b7b235480a95876f248a227e509db74b))
199+
200+
201+
### Bug Fixes
202+
203+
* EnvModule now properly loads environment variables when being accessed ([2a8f661](https://github.com/spuxx1701/jslibs/commit/2a8f661e9573f7db05869e2ed2a30085b4116919))
204+
205+
206+
### Documentation
207+
208+
* Added comment to test ([297ffd1](https://github.com/spuxx1701/jslibs/commit/297ffd1e725fd6f42bbc32743483aa871847dbcf))
209+
210+
## Changelog

‎packages/nest-testing/LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) [2024] [spuxx]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎packages/nest-testing/README.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# @spuxx/js-utils
2+
3+
![Main pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/main.yml/badge.svg)
4+
![Release pipeline](https://github.com/spuxx1701/jslibs/actions/workflows/release_nest_utils.yml/badge.svg)
5+
![npm version](https://img.shields.io/npm/v/%40spuxx%2Fnest-utils)
6+
![npm bundle size](https://img.shields.io/bundlephobia/min/%40spuxx%2Fnest-utils)
7+
![License](https://img.shields.io/github/license/spuxx1701/jslibs)
8+
9+
<!-- vscode-markdown-toc -->
10+
11+
- [Description](#Description)
12+
- [Links](#Links)
13+
14+
<!-- vscode-markdown-toc-config
15+
numbering=false
16+
autoSave=true
17+
/vscode-markdown-toc-config -->
18+
<!-- /vscode-markdown-toc -->
19+
20+
## <a name='Description'></a>Description
21+
22+
`@spuxx/nest-utils` contains a selection of core utilities that I keep reusing in my NestJS applications.
23+
24+
## <a name='Links'></a>Links
25+
26+
- [Source](https://github.com/spuxx1701/jslibs)

‎packages/nest-testing/package.json

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
{
2+
"name": "@spuxx/nest-testing",
3+
"version": "2.4.1",
4+
"description": "A package containing various utilities for NestJS applications.",
5+
"license": "MIT",
6+
"author": {
7+
"name": "spuxx",
8+
"email": "hi@spuxx.dev",
9+
"url": "https://spuxx.dev"
10+
},
11+
"keywords": [
12+
"spuxx"
13+
],
14+
"repository": {
15+
"type": "git",
16+
"url": "https://github.com/spuxx1701/jslibs"
17+
},
18+
"homepage": "https://github.com/spuxx1701/jslibs/blob/main/packages/nest-testing/README.md",
19+
"bugs": {
20+
"url": "https://github.com/spuxx1701/jslibs/issues"
21+
},
22+
"type": "module",
23+
"main": "dist/main.js",
24+
"module": "dist/main.js",
25+
"types": "dist/main.d.ts",
26+
"exports": {
27+
".": {
28+
"types": "./dist/main.d.ts",
29+
"require": "./dist/main.cjs",
30+
"import": "./dist/main.js",
31+
"default": "./dist/main.js"
32+
}
33+
},
34+
"files": [
35+
"dist",
36+
"README.md",
37+
"LICENSE",
38+
"package.json"
39+
],
40+
"scripts": {
41+
"dev": "vite build --watch",
42+
"build": "vite build",
43+
"types": "tsc --noEmit"
44+
},
45+
"peerDependencies": {
46+
"@spuxx/nest-utils": "^3.0.0",
47+
"@nestjs/common": "^10.4.0",
48+
"@nestjs/core": "^10.4.0",
49+
"@nestjs/testing": "^10.4.0",
50+
"supertest": "^7.0.0"
51+
},
52+
"dependencies": {
53+
"@spuxx/js-utils": "workspace:@spuxx/js-utils@*"
54+
},
55+
"devDependencies": {
56+
"@rollup/plugin-node-resolve": "15.2.3",
57+
"sequelize": "6.37.5",
58+
"sequelize-typescript": "2.1.6",
59+
"sqlite3": "5.1.7"
60+
}
61+
}

‎packages/nest-testing/src/container/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
export * from './test-container';
2+
export * from './types';

‎packages/nest-testing/src/container/private/end-to-end.ts

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import { INestApplication } from '@nestjs/common';
2+
import { TestingModule } from '@nestjs/testing';
3+
4+
/**
5+
* Creates a NestApplication that is suitable for (almost) complete end-to-end testing.
6+
* It will still mock some things (e.g. express-oidc) that will only work in live runtime.
7+
* @param module The testing module.
8+
* @returns The application.
9+
*/
10+
export const createEndToEndNestApplication = async (
11+
module: TestingModule,
12+
): Promise<INestApplication> => {
13+
const app = module.createNestApplication();
14+
await app.init();
15+
return app;
16+
};

0 commit comments

Comments
 (0)