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, config config.IConfig, cmd *apis.Command, ...) error
• func ExtractContainersToImageIDsFromPod(pod *core1.Pod) map[string]string
• func ExtractImageID(imageID string) string
• func GetRequestHeaders(accessKey string) map[string]string
• func InitHttpClient(url string) httputils.IHttpClient
• func MapToString(m map[string]interface{}) []string
• func NewJobTracking(reporter systemreports.IReporter) *apis.JobTracking
• func NewK8sInterfaceFake(k8sClient k8s.Interface) *k8sinterface.KubernetesApi
• type ClientMock
  • func (c *ClientMock) Do(req *http.Request) (*http.Response, error)
• type ContainerData
  • func PodToContainerData(k8sAPI *k8sinterface.KubernetesApi, pod *core1.Pod, ...) (*ContainerData, error)
• type CredStruct
• type Job
  • func (j *Job) Context() context.Context
  • func (j *Job) Obj() SessionObj
  • func (j *Job) SetContext(ctx context.Context)
  • func (j *Job) SetObj(sessionObj SessionObj)
• type SessionObj
  • func NewSessionObj(ctx context.Context, config config.IConfig, command *apis.Command, ...) *SessionObj

Constants

const ArgdContainerToImageIds = "containerToImageIDs"

const ArgsContainerData = "containerData"

const ArgsPod = "pod"

const CommandScanFilteredSBOM = "scanFilteredSBOM"

const KubescapeRequestPathV1 = "v1/scan"

const KubescapeRequestStatusV1 = "v1/status"

const KubescapeScanV1 = "scanV1"

Variables

var (
	ReporterHttpClient httputils.IHttpClient
)

Functions

func AddCommandToChannel

func AddCommandToChannel(ctx context.Context, config config.IConfig, cmd *apis.Command, workerPool *ants.PoolWithFunc) error

func ExtractContainersToImageIDsFromPod

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

func ExtractImageID

func ExtractImageID(imageID string) string

func GetRequestHeaders

func GetRequestHeaders(accessKey string) map[string]string

func InitHttpClient

func InitHttpClient(url string) httputils.IHttpClient

func MapToString

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

func NewJobTracking

func NewJobTracking(reporter systemreports.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 ContainerData

type ContainerData struct {
	ImageTag      string // imageTag (from container.Image)
	ImageID       string // imageID (from containerStatus.ImageID)
	ContainerName string // containerName
	ContainerType string // containerType (init or regular)
	Slug          string // represent the unique identifier of the container
	Wlid          string // workloadID
}

func PodToContainerData

func PodToContainerData(k8sAPI *k8sinterface.KubernetesApi, pod *core1.Pod, instanceID instanceidhandler.IInstanceID, clusterName string) (*ContainerData, 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 Job

type Job struct {
	// contains filtered or unexported fields
}

func (*Job) Context

func (j *Job) Context() context.Context

func (*Job) Obj

func (j *Job) Obj() SessionObj

func (*Job) SetContext

func (j *Job) SetContext(ctx context.Context)

func (*Job) SetObj

func (j *Job) SetObj(sessionObj SessionObj)

type SessionObj

type SessionObj struct {
	Command  apis.Command             `json:"command"`
	Reporter beClientV1.IReportSender `json:"reporter"`
}

Commands list of commands received from websocket

func NewSessionObj

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