BUILD.md

BUILD

Table of contents

1. About

2. Environment

3. Development

3.1. Style Guide

3.2. Tests

3.3. Security

About

The BUILD.md is a file to check the environment and build specifications of horusec-devkit project.

Environment

• Golang: ^1.17.X
• GNU Make: ^4.2.X

Development

Horusec-DevKit is the repository where there are some abstractions that the Horusec team uses to simplify development and testing.

You can use it as a package by running the following command in your Golang project:

go get github.com/ZupIT/horusec-devkit

Style Guide

For source code standardization, the project uses the golangci-lint tool as a Go linter aggregator. You can check the lint through the make command available in each microservice:

make lint

To perform the indentation and removal of unused code automatically, just run the following command:

make format

The project also has a pattern of dependency imports, and the command below organizes your code in the pattern defined by the Horusec team, this command must be run in each microservice:

make fix-imports

All project files must have the license header. You can check if all files are in agreement by running the following command in project root:

make license

If it is necessary to add the license in any file, run the command below to insert it in all files that do not have it:

make license-fix

Tests

The unit tests were written with the standard package and some mock and assert snippets, we used the testify. You can run the tests using the command below:

make test

To check test coverage, run the command below:

make coverage

Security

We use the latest version of Horusec-CLI to maintain the security of our source code. Through the command below, you can perform this verification in the project:

make security