salesforce / avocat Goto Github PK

We're currently dealing only with the get method for the sake of simplicity, but all other HttpMethods should be considered when:

• parsing (parse the requestBody)
• sending a request
• handling a variant

Contract naming depends basically on the title field in the imported swagger contract. Thus, every contract should have a unique title, otherwise, there should be a validation error displayed to the user.

Another option is to ask the user to enter a contract name as an argument of the import command. $ avocat import <contract_path> --name <contract_name>

The validatorService.validateContract*() methods should be merged into one method in the test command class test-command.ts. The service validator-service.ts has the responsibility to call the proper repository method depending on the input params (URL, name, and version).

In addition, it is the contract repository job to load the contract's content, not the service, loadContracts in validator-service.ts should be embedded in the repository findBy* methods.

When validating an API, the values of the parameters sent in the request come from the example/examples objects. These objects are not required in the OpenAPI schema.

Proposal: Generate values for parameters using Faker.js when no examples found.

After running tests, the /.tmp repo should be deleted as no more data are store in it. This is due to the dependency we used (rimraf) at that time.

New versions of NodeJS introduce a new way to remove folders recursively (see: rmdir). Though, this new feature is still experimental for now.

The special characters in the swagger contract title ('/', '', ' ', ...) should be handled and replaced by characters that are valid to be in a file path.

For now, only required query parameters are sent in the request. Path parameters should be handled as well and added to the request

Currently, the core layer depends on the infrastructure layer because of the way the dependencies are injected:

$ find src/main/core -name '*.ts' |  xargs grep import | grep -e 'infrastructure/\|app/'
src/main/core/validator/impl/validator-service-impl.ts:import {FileStoreContractRepository} from '../../../infrastructure/repository/file-store-contract-repository';
src/main/core/validator/impl/validator-service-impl.ts:import {AxiosHttpClient} from '../../../infrastructure/http/axios/axios-http-client';
src/main/core/validator/impl/validator-service-impl.ts:import {AjvContractValidator} from '../../../infrastructure/validator/ajv/ajv-contract-validator';
src/main/core/status/status-service.ts:import {FileStoreContractRepository} from '../../infrastructure/repository/file-store-contract-repository';
src/main/core/import/import-service.ts:import {FileStoreContractRepository} from '../../infrastructure/repository/file-store-contract-repository';

We may wanna find a better way to inject the core dependencies. We may also enforce the dependency check with a script that could throw an error if find src/main/core -name '*.ts' | xargs grep import | grep -e 'infrastructure/\|app/' returns results.

A warning is thrown when executing avocat command lines: (node:45763) ExperimentalWarning: The fs.promises API is experimental

Proposal: limit Node and npm version to more recent ones

Currently, only JSON response schema is dealt with, but other formats such as XML or text/plain or HTML,... should be taken into account as well.

We're using at the moment the NodeJS built-in Event Emitter to decouple the technology we're using for logging from the production code. So that it could be modified easily.

An enhancement would be to use DDD DomainEvents to make logging events even more generic.

There should be a way to import all contacts in a directory instead of importing them one by one.

Proposal: $ avocat import contracts/*