{"id":22861545,"url":"https://github.com/jonnathan23/rest_api_node_ts_server","last_synced_at":"2026-05-06T13:10:09.198Z","repository":{"id":267071638,"uuid":"900186065","full_name":"Jonnathan23/Rest_api_node_ts_server","owner":"Jonnathan23","description":"Backend con pern para administrador de productos","archived":false,"fork":false,"pushed_at":"2025-01-28T17:23:08.000Z","size":14839,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-06T13:17:51.028Z","etag":null,"topics":["documentation","jest","nodejs","pern","supertest","swagger","testing","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/Jonnathan23/frontend-administrador-productos","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jonnathan23.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-08T05:00:40.000Z","updated_at":"2025-01-28T17:23:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"f8c14a1d-26be-42ff-b6fa-2539736ef70d","html_url":"https://github.com/Jonnathan23/Rest_api_node_ts_server","commit_stats":null,"previous_names":["jonnathan23/rest_api_node_ts_server"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jonnathan23%2FRest_api_node_ts_server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jonnathan23%2FRest_api_node_ts_server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jonnathan23%2FRest_api_node_ts_server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jonnathan23%2FRest_api_node_ts_server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jonnathan23","download_url":"https://codeload.github.com/Jonnathan23/Rest_api_node_ts_server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246443492,"owners_count":20778247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","jest","nodejs","pern","supertest","swagger","testing","typescript"],"created_at":"2024-12-13T10:09:32.005Z","updated_at":"2026-05-06T13:10:09.161Z","avatar_url":"https://github.com/Jonnathan23.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Backend\n\n## Testing con JEST\nJest puede leer archivos de 3 formas:\n\n* Archivos con la extensión .test.js\n* Archivos con la extensión .spect.js\n* Archivos dentro de la carpeta __tests__\n\n### Instalación de dependencias\n\n```bash\nnpm i -D supertest @types/supertest jest @types/jest ts-jest\n```\n\n### Crear archivo jest.config\n\n```bash\nnpx ts-jest config:init\n```\n\n### Configuraciones\n\nConfiguración en el package.json para ejecutar tests\n\n```json\n\"test\": \"jest --detectOpenHandles\"\n```\n\nPara evitar llenar nuestra base de datos con los objetos que creamos en nuestros tests podemos limpiarla de esta forma\n\n```ts\nconst clearDB = async () =\u003e {\n    try {\n        await db.sync({ force: true })\n        console.log('Datos eliminados correctamente')\n        exit()\n    } catch (error) {\n        console.log(error)\n        exit(1)\n    }\n}\n// detectar el comando de nuestra terminal para ejecutar la función\nif (process.argv[2] === '--clear') {\n    clearDB()\n}\n```\n\nPara ejecutar ese código de forma automática lo que podemos hacer es colocar el comando reservado ``\"pretest\"``, el cual se ejecuta automaticamente antes del comando ``\"test\"`` ,es decir, no es necesario llamarlo desde nuestra terminal\n```json\n\"pretest\": \"ts-node ./src/data --clear\"\n```\n### Code Coverage\nEs una metrica utilizada para medir la cantidad de codigo cubierto por las pruebas.\n\n#### Metricas de coverage\n* \u003c 60% -\u003e No es suficiente\n* 60% - 80% -\u003e se puede mejorar\n* \u003e= 80% -\u003e Es suficiente y una buena medida\n\nPara ejecutar coverage, demos configurar nuestro package.json, colocar esto en nuestros scripts\n```json\n\"test:coverage\": \"npm run pretest \u0026\u0026 jest --detectOpenHandles --coverage\"\n```\n\n### Forzar errores\nPara simular errores en nuestro código podemos utilizar ``mock``, le pasamos como parametro la ruta de nuestra variable, en este caso ``db``. Posterior a ello con ``spyOn()`` en su parametro le pasamos nuestra variable y el metetodo que quemaros observar su comportamiento, por ejemplo ``authenticate()`` en formato ``string``\n\n```ts\n\njest.mock('../config/db')\n\ndescribe('connect DB', () =\u003e {\n    it('should hanlde databe connection error', async () =\u003e {\n        jest.spyOn(db, 'authenticate').mockRejectedValueOnce(new Error('Error al conectar a la BD'))\n        const consoleSpy = jest.spyOn(console, 'log')\n\n        await connectDB()\n\n        expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining('Error al conectar a la BD'))\n    })\n})\n```\n\n\n## Documentacion\n\ninstalar dependencias\n```bash\nnpm i swagger-jsdoc swagger-ui-express\n```\n\n```bash\nnpm i -D @types/swagger-jsdoc @types/swagger-ui-express\n```\n\n## Morgan\n```bash\nnpm i morgan\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonnathan23%2Frest_api_node_ts_server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonnathan23%2Frest_api_node_ts_server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonnathan23%2Frest_api_node_ts_server/lists"}