utils

Documentation

Overview

Package utils contains utilities common to all units of the Operator

The package includes:

- Common utilities

- Common test utilities, like constructors for test doubles etc

Index

• Constants
• Variables
• func AddCommandToChannel(ctx context.Context, cmd *apis.Command, channel *chan SessionObj)
• func ExtractContainersToImageIDsFromPod(pod *core1.Pod) map[string]string
• func ExtractImageID(imageID string) string
• func InitKubescapeHttpClient() httputils.IHttpClient
• func InitReporterHttpClient() httputils.IHttpClient
• func InitVulnScanHttpClient() httputils.IHttpClient
• func LoadEnvironmentVariables(ctx context.Context) (err error)
• func MapToString(m map[string]interface{}) []string
• func NewJobTracking(reporter reporterlib.IReporter) *apis.JobTracking
• func NewK8sInterfaceFake(k8sClient k8s.Interface) *k8sinterface.KubernetesApi
• type ClientMock
  • func (c *ClientMock) Do(req *http.Request) (*http.Response, error)
• type CredStruct
• type SessionObj
  • func NewSessionObj(ctx context.Context, command *apis.Command, message, parentID, jobID string, ...) *SessionObj
  • func (sessionObj *SessionObj) WatchErrors(ctx context.Context)

Constants

const (
	ReleaseBuildTagEnvironmentVariable = "RELEASE"
	NamespaceEnvironmentVariable       = "NAMESPACE"
	ConfigEnvironmentVariable          = "CONFIG"
	PortEnvironmentVariable            = "PORT"
	CleanUpDelayEnvironmentVariable    = "CLEANUP_DELAY"
)

const ContainerToImageIdsArg = "containerToImageIDs"

const KubescapeRequestPathV1 = "v1/scan"

const KubescapeRequestStatusV1 = "v1/status"

const KubescapeScanV1 = "scanV1"

Variables

var (
	Namespace              string        = "default" // default namespace
	RestAPIPort            string        = "4002"    // default port
	CleanUpRoutineInterval time.Duration = 10 * time.Minute
)

var ClusterConfig = &utilsmetadata.ClusterConfig{}

var ReporterHttpClient httputils.IHttpClient

Functions

func AddCommandToChannel

func AddCommandToChannel(ctx context.Context, cmd *apis.Command, channel *chan SessionObj)

func ExtractContainersToImageIDsFromPod

func ExtractContainersToImageIDsFromPod(pod *core1.Pod) map[string]string

func ExtractImageID

func ExtractImageID(imageID string) string

func InitKubescapeHttpClient

func InitKubescapeHttpClient() httputils.IHttpClient

func InitReporterHttpClient

func InitReporterHttpClient() httputils.IHttpClient

func InitVulnScanHttpClient

func InitVulnScanHttpClient() httputils.IHttpClient

func LoadEnvironmentVariables

func LoadEnvironmentVariables(ctx context.Context) (err error)

func MapToString

func MapToString(m map[string]interface{}) []string

func NewJobTracking

func NewJobTracking(reporter reporterlib.IReporter) *apis.JobTracking

func NewK8sInterfaceFake

func NewK8sInterfaceFake(k8sClient k8s.Interface) *k8sinterface.KubernetesApi

NewK8sInterfaceFake returns a new K8sInterface with a fake Kubernetes Client attached

This function is a Dependency Injection-friendly version for the `KubernetesApi` constructor that allows to inject any Kubernetes Clients. For example, the official fake Kubernetes client, so unit tests would have a suitable test double instead of trying to talk to a real cluster

Types

type ClientMock

type ClientMock struct {
}

func (*ClientMock) Do

func (c *ClientMock) Do(req *http.Request) (*http.Response, error)

type CredStruct

type CredStruct struct {
	User     string `json:"user"`
	Password string `json:"password"`
	Customer string `json:"customer"`
}

CredStruct holds the various credentials needed to do login into CA BE

type SessionObj

type SessionObj struct {
	Command  apis.Command          `json:"command"`
	Reporter reporterlib.IReporter `json:"reporter"`
	ErrChan  chan error            `json:"-"`
}

Commands list of commands received from websocket

func NewSessionObj

func NewSessionObj(ctx context.Context, command *apis.Command, message, parentID, jobID string, actionNumber int) *SessionObj

func (*SessionObj) WatchErrors

func (sessionObj *SessionObj) WatchErrors(ctx context.Context)