BUILD.md

BUILD

Table of contents

1. About

2. Environment

3. Development

3.1. Style Guide

3.2. Tests

3.3. Security

4. Production

About

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

Environment

• Golang: ^1.17.X
• Kubectl: ^1.20.X
• Helm: ^3.7.X
• Kind: ^0.11.1
• GNU Make: ^4.2.X

Development

At the root of the project, run the following command:

make up-local-operator

It will create a kind cluster with all dependencies and secrets, install operator CDR and apply a yaml with the platform definitions.

Style Guide

For source code standardization, the project uses the golangci-lint tool as a Go linter aggregator. You can perform the lint check via the make command:

make lint

The project also has a dependency import pattern, and the commands below organize your code in the pattern defined by the Horusec team, run:

make format

All project files must have the license header. You can check if all files are in agreement, using the command:

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

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

make tests

To check test coverage, run the command below:

make coverage

Security

We use the latest version of the tool itself to maintain the security of our source code. Through the command below, you can perform this verification:

make security

Production

The Horusec-Operator is one of the recommended ways to make Horusec-Platform available in a production environment.

In our documentation you can check all the steps that must be followed.