insights-operator-utils

command module

v1.25.12 Latest Latest Go to latest Published: Oct 7, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

README ¶

insights-operator Utils

GitHub go.mod Go version

Description
Sub-modules in this library
How to use this library
Configuration
Contribution
Makefile targets
Testing
CI
- Travis CI
- GolangCI
Package manifest
Open Source Insights status

Description

Utility packages (written in Go) that are shared between different Insights Operator, Insights Results Aggregator, and CCX Notification Service repositories.

Sub-modules in this library

`github.com/RedHatInsights/insights-operator-utils/collections`

Helper functions to work with collections.

`github.com/RedHatInsights/insights-operator-utils/env`

Functions to work with environment variables.

`github.com/RedHatInsights/insights-operator-utils/evaluator`

Expression evaluator with ability to provide named values into expressions.

`github.com/RedHatInsights/insights-operator-utils/generators`

Value generators - rule FQDNs etc.

`github.com/RedHatInsights/insights-operator-utils/formatters`

Various text formatters utility functions.

`github.com/RedHatInsights/insights-operator-utils/http`

HTTP-related utility functions.

`github.com/RedHatInsights/insights-operator-utils/logger`

Configuration structures needed to configure the access to CloudWatch server to sending the log messages there.

`github.com/RedHatInsights/insights-operator-utils/metrics`

Package metrics contains all metrics that needs to be exposed to Prometheus and indirectly to Grafana.

`github.com/RedHatInsights/insights-operator-utils/metrics/push`

Package metrics/push contains some helping functions to push metrics to a Prometheus Pushgateway.

`github.com/RedHatInsights/insights-operator-utils/migrations`

An implementation of a simple database migration mechanism that allows semi-automatic transitions between various database versions as well as building the latest version of the database from scratch.

`github.com/RedHatInsights/insights-operator-utils/parsers`

Various text parser utility functions.

`github.com/RedHatInsights/insights-operator-utils/responses`

Handlers for HTTP response.

`github.com/RedHatInsights/insights-operator-utils/s3`

Helper functions to work with S3.

`github.com/RedHatInsights/insights-operator-utils/tls`

Helper function to create TLS configurations.

`github.com/RedHatInsights/insights-operator-utils/tests`

Contains sub-modules to make unit tests easier to write.

`github.com/RedHatInsights/insights-operator-utils/types`

Declaration of various data types (usually structures) used elsewhere in the aggregator code.

How to use this library

Use selected sub-module from this library in your import statement. For example:

import (
	"encoding/json"
	"strings"

	"github.com/RedHatInsights/insights-operator-utils/types"
	"github.com/RedHatInsights/insights-results-aggregator-data/testdata"
)

or:

import (
	"context"
	"database/sql"
	"encoding/json"

	"github.com/RedHatInsights/insights-operator-utils/logger"
	"github.com/rs/zerolog/log"
	"golang.org/x/sync/errgroup"
)

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.

Makefile targets

Available targets are:

fmt                  Run go fmt -w for all sources
lint                 Run golint
vet                  Run go vet. Report likely mistakes in source code
cyclo                Run gocyclo
ineffassign          Run ineffassign checker
shellcheck           Run shellcheck
errcheck             Run errcheck
goconst              Run goconst checker
gosec                Run gosec checker
abcgo                Run ABC metrics checker
style                Run all the formatting related commands (fmt, vet, lint, cyclo) + check shell scripts
test                 Run the unit tests
benchmark            Run benchmarks
cover                Display test coverage on generated HTML pages
coverage             Display test coverage onto terminal
before_commit        Checks done before commit
license              Add license in every file in repository
help                 Show this help screen

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

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.

GolangCI

Also GolangCI is configured for this repository and is run for all pull requests.

Package manifest

Package manifest is available at docs/manifest.txt.

Open Source Insights status

Open Source Insights status is available at https://deps.dev/go/github.com%2Fredhatinsights%2Finsights-operator-utils/

Documentation ¶

Overview ¶

Utility packages (written in Go) that are shared between different Insights Operator, Insights Results Aggregator, and CCX Notification Service repositories.

Source Files ¶

View all Source files

Directories ¶

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

Path	Synopsis
clowder
collections Package collections contains helper functions to work with collections.	Package collections contains helper functions to work with collections.
env Package env contains functions to work with environment variables.	Package env contains functions to work with environment variables.
evaluator Package evaluator contains expression evaluator with the ability to provide named values into expressions.	Package evaluator contains expression evaluator with the ability to provide named values into expressions.
formatters Package formatters contains various text formatters utility functions.	Package formatters contains various text formatters utility functions.
generators Package generators contains functions that provide value generators for given input.	Package generators contains functions that provide value generators for given input.
http Package httputils contains HTTP-related utility functions.	Package httputils contains HTTP-related utility functions.
kafka Package kafka contains data types, interfaces, and methods related to Kafka that can be used to configure brokers, as well as consume/produce messages.	Package kafka contains data types, interfaces, and methods related to Kafka that can be used to configure brokers, as well as consume/produce messages.
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.
push
migrations Package migrations contains an implementation of a simple database migration mechanism that allows semi-automatic transitions between various database versions as well as building the latest version of the database from scratch.	Package migrations contains an implementation of a simple database migration mechanism that allows semi-automatic transitions between various database versions as well as building the latest version of the database from scratch.
parsers Package parsers contains various text parser utility functions.	Package parsers contains various text parser utility functions.
postgres
redis Package redis contains shared functionality related to Redis	Package redis contains shared functionality related to Redis
responses Package responses contains handlers for HTTP response.	Package responses contains handlers for HTTP response.
s3 Package s3util contains helper functions to provide high level interface to S3 storage.	Package s3util contains helper functions to provide high level interface to S3 storage.
mocks
tests Package tests contains function and data types used in tests.	Package tests contains function and data types used in tests.
helpers Package helpers contains function and data types used in tests.	Package helpers contains function and data types used in tests.
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.
saramahelpers Package saramahelpers contains helper function to be used in code based on Sarama library with Kafka interface	Package saramahelpers contains helper function to be used in code based on Sarama library with Kafka interface
tls Package tlsutil contains helper function to create TLS configurations	Package tlsutil contains helper function to create TLS configurations
types Package types contains declaration of data types used by other packages from RedHatInsights/insights-operator-utils	Package types contains declaration of data types used by other packages from RedHatInsights/insights-operator-utils