utils

Documentation

Index

• func CheckIfPortAvailable(port int) error
• func Contains[T comparable](vs []T, x T) bool
• func CreateContainerName(serviceContainerName string, dockerNetwork string) string
• func CreateDirectory(dir string) error
• func FindFileInDir(dirPath, fileName string) (string, error)
• func GetAbsPath(baseDir, path string) string
• func GetContainerRuntimeCmd(containerRuntime string) string
• func GetDefaultRegistry(githubContainerRegistryName, dockerContainerRegistryName string) (string, error)
• func GetEnv(envName string, defaultValue string) string
• func GetSocket(path, appID, protocol string) string
• func GetVariantVersion(version, imageVariant string) string
• func GetVersionAndImageVariant(imageTag string) (string, string)
• func IsAddressLegal(address string) bool
• func IsDaprListeningOnPort(port int, timeout time.Duration) error
• func IsDaprListeningOnSocket(socket string, timeout time.Duration) error
• func IsDockerInstalled() bool
• func IsPodmanInstalled() bool
• func IsValidContainerRuntime(containerRuntime string) bool
• func MarshalAndWriteTable(writer io.Writer, in interface{}) error
• func PrintDetail(writer io.Writer, outputFormat string, list interface{}) error
• func PrintTable(csvContent string)
• func ReadFile(filePath string) ([]byte, error)
• func RunCmdAndWait(name string, args ...string) (string, error)
• func TruncateString(str string, maxLength int) string
• func ValidateFilePath(filePath string) error
• func ValidateImageVariant(imageVariant string) error
• func WriteTable(writer io.Writer, csvContent string)
• type ContainerRuntime

Functions

func CheckIfPortAvailable

func CheckIfPortAvailable(port int) error

CheckIfPortAvailable returns an error if the port is not available else returns nil.

func Contains

func Contains[T comparable](vs []T, x T) bool

Contains returns true if vs contains x.

func CreateContainerName

func CreateContainerName(serviceContainerName string, dockerNetwork string) string

func CreateDirectory

func CreateDirectory(dir string) error

func FindFileInDir

func FindFileInDir(dirPath, fileName string) (string, error)

FindFileInDir finds and returns the path of the given file name in the given directory.

func GetAbsPath

func GetAbsPath(baseDir, path string) string

GetAbsPath returns the absolute path of the given file path and base directory.

func GetContainerRuntimeCmd

func GetContainerRuntimeCmd(containerRuntime string) string

GetContainerRuntimeCmd returns a valid container runtime to be used by CLI operations. If the input is a valid container runtime, it is returned as is. Otherwise the default container runtime, docker, is returned.

func GetDefaultRegistry

func GetDefaultRegistry(githubContainerRegistryName, dockerContainerRegistryName string) (string, error)

func GetEnv

func GetEnv(envName string, defaultValue string) string

GetEnv get value from environment variable.

func GetSocket

func GetSocket(path, appID, protocol string) string

func GetVariantVersion

func GetVariantVersion(version, imageVariant string) string

func GetVersionAndImageVariant

func GetVersionAndImageVariant(imageTag string) (string, string)

Returns image version and variant. Expected imageTag format: <version>-<variant>, i.e. 1.0.0-mariner or 1.0.0-rc.1-mariner.

func IsAddressLegal

func IsAddressLegal(address string) bool

func IsDaprListeningOnPort

func IsDaprListeningOnPort(port int, timeout time.Duration) error

IsDaprListeningOnPort checks if Dapr is litening to a given port.

func IsDaprListeningOnSocket

func IsDaprListeningOnSocket(socket string, timeout time.Duration) error

func IsDockerInstalled

func IsDockerInstalled() bool

IsDockerInstalled checks whether docker is installed/running.

func IsPodmanInstalled

func IsPodmanInstalled() bool

func IsValidContainerRuntime

func IsValidContainerRuntime(containerRuntime string) bool

IsValidContainerRuntime checks if the input is a valid container runtime. Valid container runtimes are docker and podman.

func MarshalAndWriteTable

func MarshalAndWriteTable(writer io.Writer, in interface{}) error

func PrintDetail

func PrintDetail(writer io.Writer, outputFormat string, list interface{}) error

func PrintTable

func PrintTable(csvContent string)

PrintTable to print in the table format.

func ReadFile

func ReadFile(filePath string) ([]byte, error)

func RunCmdAndWait

func RunCmdAndWait(name string, args ...string) (string, error)

func TruncateString

func TruncateString(str string, maxLength int) string

func ValidateFilePath

func ValidateFilePath(filePath string) error

Returns true if the given file path is valid.

func ValidateImageVariant

func ValidateImageVariant(imageVariant string) error

func WriteTable

func WriteTable(writer io.Writer, csvContent string)

WriteTable writes the csv table to writer.

Types

type ContainerRuntime

type ContainerRuntime string

const (
	DOCKER ContainerRuntime = "docker"
	PODMAN ContainerRuntime = "podman"
)