Merge pull request #1 from isdi-coders-2023/feature/config

Feature/config

.github/workflows/build.yml

@@ -0,0 +1,24 @@
+name: Build
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Install module
+        run: npm i
+      - name: Testing coverage
+        run: npm run test:prod
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

jest.config.js

@@ -1,150 +1,17 @@
-/**
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
 const config = {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-  // Stop running tests after `n` failures
-  // bail: 0,
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "C:\\Users\\alejandro\\AppData\\Local\\Temp\\jest",
-  // Automatically clear mock calls, instances, contexts and results before every test
-  // clearMocks: false,
-  // Indicates whether the coverage information should be collected while executing the test
   collectCoverage: true,
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
   collectCoverageFrom: ['src/**/*.{ts,tsx}'],
-  // The directory where Jest should output its coverage files
   coverageDirectory: 'coverage',
-  // An array of regexp pattern strings used to skip coverage collection
   coveragePathIgnorePatterns: [
     'index.ts',
     'entities',
     'interface',
     'tools',
-    'type',
     '_mock',
-    //   "\\\\node_modules\\\\"
   ],
-  // Indicates which provider should be used to instrument code for coverage
   coverageProvider: 'v8',
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-  // The default configuration for fake timers
-  // fakeTimers: {
-  //   "enableGlobally": false
-  // },
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "mjs",
-  //   "cjs",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "json",
-  //   "node"
-  // ],
-  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
-  // Activates notifications for test results
-  // notify: false,
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-  // A preset that is used as a base for Jest's configuration
   preset: 'ts-jest',
   testPathIgnorePatterns: ['dist'],
-  // Run tests from one or more projects
-  // projects: undefined,
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-  // Automatically reset mock state before every test
-  // resetMocks: false,
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-  // A path to a custom resolver
   resolver: 'jest-ts-webcompat-resolver',
-  // Automatically restore mock state and implementation before every test
-  // restoreMocks: false,
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
-  // The number of seconds after which a test is considered as slow and reported as such in the results.
-  // slowTestThreshold: 5,
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-  // The test environment that will be used for testing
-  // testEnvironment: "jest-environment-node",
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-  // Adds a location field to test results
-  // testLocationInResults: false,
-  // The glob patterns Jest uses to detect test files
-  // testMatch: [
-  //   "**/__tests__/**/*.[jt]s?(x)",
-  //   "**/?(*.)+(spec|test).[tj]s?(x)"
-  // ],
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "\\\\node_modules\\\\"
-  // ],
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-  // This option allows use of a custom test runner
-  // testRunner: "jest-circus/runner",
-  // A map from regular expressions to paths to transformers
-  // transform: undefined,
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "\\\\node_modules\\\\",
-  //   "\\.pnp\\.[^\\\\]+$"
-  // ],
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-  // Indicates whether each individual test should be reported during the run
-  // verbose: undefined,
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-  // Whether to use watchman for file crawling
-  // watchman: true,
 };
 export default config;

package.json

@@ -5,13 +5,14 @@
   "main": "index.js",
   "type": "module",
   "scripts": {
-    "start": "cross-env NODE_ENV=prod node dist/index.js",
+    "start:prod": "cross-env NODE_ENV=prod node dist/index.js",
     "start:dev": "cross-env DEBUG=W7E* NODE_ENV=dev PORT=3400 node --watch --env-file=.env dist/index.js",
     "start:mon": "cross-env DEBUG=W7E* NODE_ENV=dev PORT=3400 nodemon dist/index.js",
     "build": "tsc",
     "dev": "tsc -w",
     "test": "jest",
     "test:dev": "cross-env NODE_ENV=test jest --watchAll --coverage",
+    "test:prod": "jest --passWithNoTests --coverage",
     "lint": "eslint . --ext .ts"
   },
   "keywords": [],

readme.md

@@ -0,0 +1,13 @@
+En breve descripción, el proyecto es una aplicación de libros en la que los usuarios inscritos como administradores gestionan un listado “fijo” (esto es, a modo de inventario solo actualizable por el administrador). Los usuarios que accedan como usuarios logueados pueden añadir textos breves con imágenes y el resto de usuarios puedan ver el contenido en calidad de invitados.
+
+A continuación un listado completo de componentes empezando con el backend.
+
+Entidades. Mi modelo de datos consta de usuarios, libros y publicaciones. Los usuarios de tipo administrador podrán cada uno gestionar una cantidad indefinida de libros. Del mismo modo, los usuarios de tipo usuario podrán gestionar sus propias publicaciones de cantidad indefinida. Los usuarios de tipo invitado podrán visualizar el contenido.
+Esquemas. Los esquemas de Joi sirven para la validación. Determinan el tipo de datos que se espera recibir en el input y si este es requerido u opcional.
+Repositorios. Manejan las operaciones de base de datos mediante el uso de Prisma. Definen un objeto “select” que especifica los campos a consumir de la base de datos. Será necesario definir primero un repositorio genérico y después uno específico por cada entidad para poner en práctica la inversión de dependencias. Definen los métodos del CRUD.
+Controladores. Al igual que con los repos, convendrá definir primero un controlador genérico y posteriormente los específicos a cada recurso para manejar la operaciones del CRUD. Aquí se implementará la validación descrita en el esquema.
+Servicio de autentificación. Necesitaremos definir otro servicio para las tareas de autenticación que definirá el contenido válido del “payload”, hasheará contraseñas, comparará contraseñas y retornará tokens de autenticación.
+Interceptor de autorización. Crearemos un middleware para manejar las labores de autorización y autenticación como verificar que la cabecera de autorización comienza con el convencional ‘Bearer’ y contiene el token, comprobar si el usuario es administrador.
+Interceptor de errores. También vamos a definir una clase que extienda el interfaz de errores de typescript a fin de personalizar nuestra propia tirada de errores.
+Interceptor de archivos. Necesitaremos un middleware para interceptar la subida de archivos y manjearla de manera acorde mediante Multer y Cloudinary.
+Routers. Necesitaremos enrutadores para libros y artículos así como el de usuarios con los métodos para registro y logueado.

sonar-project.properties

@@ -0,0 +1,13 @@
+sonar.projectKey=isdi-coders-2023_Marcos-Parajua-Final-Project-202402-Mad-Back
+sonar.organization=isdi-coders-2023
+
+# This is the name and version displayed in the SonarCloud UI.
+#sonar.projectName=Marcos-Parajua-Final-Project-202402-Mad-Back
+#sonar.projectVersion=1.0
+
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+#sonar.sources=.
+
+# Encoding of the source code. Default is default system encoding
+#sonar.sourceEncoding=UTF-8

src/app.ts

@@ -0,0 +1 @@
+

src/index.ts

@@ -0,0 +1 @@
+