insights-operator-utils

module

v1.6.5 Latest Latest Go to latest Published: Oct 30, 2020 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/RedHatInsights/insights-operator-utils

Links

Open Source Insights

README ¶

insights-operator Utils

Description

Utils that are shared between different insights-operator repositories.

How to use this library

Configuration

No further configuration is needed at this moment.

Contribution

Please look into document CONTRIBUTING.md that contains all information about how to contribute to this project.

Please look also at Definition of Done document with further informations.

Testing

Unit tests can be started by the following command:

./test.sh

It is also possible to specify CLI options for Go test. For example, if you need to disable test results caching, use the following command:

./test -count=1

CI

Travis CI is configured for this repository. Several tests and checks are started for all pull requests:

Unit tests that use the standard tool go test
go fmt tool to check code formatting. That tool is run with -s flag to perform following transformations
go vet to report likely mistakes in source code, for example suspicious constructs, such as Printf calls whose arguments do not align with the format string.
golint as a linter for all Go sources stored in this repository
gocyclo to report all functions and methods with too high cyclomatic complexity. The cyclomatic complexity of a function is calculated according to the following rules: 1 is the base complexity of a function +1 for each 'if', 'for', 'case', '&&' or '||' Go Report Card warns on functions with cyclomatic complexity > 9
goconst to find repeated strings that could be replaced by a constant
gosec to inspect source code for security problems by scanning the Go AST
ineffassign to detect and print all ineffectual assignments in Go code
errcheck for checking for all unchecked errors in go programs
shellcheck to perform static analysis for all shell scripts used in this repository
abcgo to measure ABC metrics for Go source code and check if the metrics does not exceed specified threshold

Please note that all checks mentioned above have to pass for the change to be merged into the main branch (look into Settings to check which branch has been set as main one).

History of checks performed by CI is available at RedHatInsights / insights-operator-utils.

Directories ¶

Path	Synopsis
collections
env
http
logger Package logger contains the configuration structures needed to configure the access to CloudWatch server to sending the log messages there.	Package logger contains the configuration structures needed to configure the access to CloudWatch server to sending the log messages there.
metrics Package metrics contains all metrics that needs to be exposed to Prometheus and indirectly to Grafana.	Package metrics contains all metrics that needs to be exposed to Prometheus and indirectly to Grafana.
responses
tests
helpers
mock_io Package mock_io is a generated GoMock package.	Package mock_io is a generated GoMock package.
mock_testing Package mock_testing is a generated GoMock package.	Package mock_testing is a generated GoMock package.
types Package types contains declaration of various data types (usually structures) used elsewhere in the aggregator code.	Package types contains declaration of various data types (usually structures) used elsewhere in the aggregator code.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL