Hello Qualiters!

Aprenda no passo a passo a garantir a qualidade dos seus testes de serviço e/ou integrados através do Node + Jest + Supertest para APIs GraphQL.

Antes de começar a automação e configuração de fato precisamos começar com as configurações do computador e a instalação das dependências.

Fase 1: Configure seu computador

Vamos começar instalando o Node, na versão mais atual que pode ser encontrado para download no link https://nodejs.org/pt. Ele irá fazer com que seu computador entenda a instalação de dependências e a linguagem JS.

Fase 2: Crie seu projeto local

• Agora vamos criar uma pasta onde será o seu projeto.
• Abra ela no VS Code ou o Editor de sua preferência
• De o comando abaixo para inicializar o projeto

npm init

Fase 3: Instale dependências

Agora vamos instalar todas as dependências que seu projeto precisa para funcionar. Você pode utilizar o npm, porém como eu gosto de utilizar o yarn irei deixar o comando para instalar.

npm install --global yarn

Já o Babel é uma ferramenta de compilação de código que permite a conversão de código moderno para versões compatíveis.

yarn add @babel/preset-env

Já o eslint irá deixar o código dentro de um padrão de código desejável, evitando assim problemas com copilação de código como a falta de ; por exemplo.

yarn add eslint

O Jest é a biblioteca JS criado para realizar os testes unitários do código.

yarn add jest

Agora para realizar request com a formatação correta para o GraphQL precisamos instalar a dependência do GraphQL.

yarn add graphql

Para realizarmos as validações dos nossos testes iremos utilizar o chai.js então iremos instalar está dependência para isso.

yarn add chai

Agora como estamos utilizando API Graphql precisamos instalar uma dependência bem especifica para isso, que é chai-grapqhl.

yarn add chai-graphql

E para realizarmos os nossos request de API, precisamos da lib supertest.

yarn add supertest

Caso queiram consultar o meu arquivo package.json ficou assim.

{
  "name": "geographQLJestAPI",
  "version": "0.0.1",
  "dependencies": {
    "@babel/preset-env": "^7.19.4",
    "chai": "^4.3.6",
    "chai-graphql": "^4.0.0",
    "graphql": "^16.6.0",
    "jest": "^29.2.2",
    "supertest": "^6.3.1"
  },
  "scripts": {
    "test": "jest"
  }
}

Fase 4: Crie arquivos de configuração

Na raiz do projeto você precisara criar alguns arquivos de configuração de código.

O primeiro deles é o babel.config.js, nele irá configurar como deve ocorrer o copile do código para ele ficar apto para a “leitura” em qualquer dispositivo. É tipo eu escrever em inglês e ele “converter” para português e assim você conseguir ler.

module.exports = {
  presets: [["@babel/preset-env", { targets: { node: "current" } }]],
};

Também na raiz do projeto iremos criar o arquivo jest.config.mjs ele irá fazer todas as configurações Jest que precisamos para criar os nossos testes. Você pode copiar e colar este código sem medo.

/*
 * For a detailed explanation regarding each configuration property, visit:
 * https://jestjs.io/docs/configuration
 */

export default {
  // 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\\priscila.caimi\\AppData\\Local\\Temp\\jest",

  // Automatically clear mock calls, instances, contexts and results before every test
  clearMocks: true,

  // 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: undefined,

  // The directory where Jest should output its coverage files
  coverageDirectory: "coverage",

  // An array of regexp pattern strings used to skip coverage collection
  // coveragePathIgnorePatterns: [
  //   "\\\\node_modules\\\\"
  // ],

  // Indicates which provider should be used to instrument code for coverage
  // coverageProvider: "babel",

  // 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: undefined,

  // 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: undefined,

  // 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,
};

E por último mais não menos importante o nosso “formatador” de código o aquivo .eslintrc.js deve ser criado e o conteúdo abaixo adicionado nele.

module.exports = {
  env: {
    browser: true,
    es2021: true,
  },
  extends: ["prettier"],
  overrides: [],
  parserOptions: {
    ecmaVersion: "latest",
    sourceType: "module",
  },
  rules: {},
};

Primeira parte finalizada com sucesso. No próximo tutorial iremos fazer o nosso primeiro request.

E se você quer ver como o repositório final se encontra só acessar o meu portfolio no Github https://github.com/pricaimiTech/geographqlJestAPI

E não esqueça de me seguir nas minhas redes sociais https://linktr.ee/priscilacaimi