utils

Documentation

Overview

Package utils provides utility functions for the Keploy application.

Index

• Variables
• func AskForConfirmation(s string) (bool, error)
• func BindFlagsToViper(logger *zap.Logger, cmd *cobra.Command, viperKeyPrefix string) error
• func CheckFileExists(path string) bool
• func DeleteLogs(logger *zap.Logger)
• func EnsureRmBeforeName(cmd string) string
• func GenerateDockerEnvs(config DockerConfigStruct) string
• func GenerateGithubActions(logger *zap.Logger, appCmd string)
• func GetAbsPath(path string) (string, error)
• func GetPIDFromPort(_ context.Context, logger *zap.Logger, port int) (uint32, error)
• func HandleRecovery(logger *zap.Logger, r interface{}, errMsg string)
• func InterruptProcessTree(logger *zap.Logger, ppid int, sig syscall.Signal) error
• func IsDockerKind(kind CmdType) bool
• func Keys(m map[string][]string) []string
• func LogError(logger *zap.Logger, err error, msg string, fields ...zap.Field)
• func NewCtx() context.Context
• func Recover(logger *zap.Logger)
• func ReplaceHostToIP(currentURL string, ipAddress string) (string, error)
• func RestoreUmask(oldMask int)
• func RunInDocker(ctx context.Context, logger *zap.Logger) error
• func SendSignal(logger *zap.Logger, pid int, sig syscall.Signal) error
• func SentryInit(logger *zap.Logger, dsn string)
• func SetCancel(c context.CancelFunc)
• func SetCoveragePath(logger *zap.Logger, goCovPath string) (string, error)
• func SetUmask() int
• func StartInDocker(ctx context.Context, logger *zap.Logger, conf *config.Config) error
• func Stop(logger *zap.Logger, reason string) error
• type AutoInc
  • func (a *AutoInc) Next() (id int)
• type CmdError
  • func ExecuteCommand(ctx context.Context, logger *zap.Logger, userCmd string, ...) CmdError
• type CmdType
  • func FindDockerCmd(cmd string) CmdType
• type DockerConfigStruct
• type ErrType
• type GitHubRelease
  • func GetLatestGitHubRelease(ctx context.Context, logger *zap.Logger) (GitHubRelease, error)

Variables

var ConfigGuide = `
# Visit [https://keploy.io/docs/running-keploy/configuration-file/] to learn about using keploy through configration file.
`

var DockerConfig = DockerConfigStruct{
	DockerImage: "ghcr.io/keploy/keploy",
}

var Emoji = "\U0001F430" + " Keploy:"

var ErrGitHubAPIUnresponsive = errors.New("GitHub API is unresponsive")

var Version string

var WarningSign = "\U000026A0"

Functions

func AskForConfirmation

func AskForConfirmation(s string) (bool, error)

AskForConfirmation asks the user for confirmation. A user must type in "yes" or "no" and then press enter. It has fuzzy matching, so "y", "Y", "yes", "YES", and "Yes" all count as confirmations. If the input is not recognized, it will ask again. The function does not return until it gets a valid response from the user.

func BindFlagsToViper

func BindFlagsToViper(logger *zap.Logger, cmd *cobra.Command, viperKeyPrefix string) error

func CheckFileExists

func CheckFileExists(path string) bool

func DeleteLogs

func DeleteLogs(logger *zap.Logger)

func EnsureRmBeforeName

func EnsureRmBeforeName(cmd string) string

func GenerateDockerEnvs

func GenerateDockerEnvs(config DockerConfigStruct) string

func GenerateGithubActions

func GenerateGithubActions(logger *zap.Logger, appCmd string)

GenerateGithubActions generates a GitHub Actions workflow file for Keploy

func GetAbsPath

func GetAbsPath(path string) (string, error)

func GetPIDFromPort

func GetPIDFromPort(_ context.Context, logger *zap.Logger, port int) (uint32, error)

func HandleRecovery

func HandleRecovery(logger *zap.Logger, r interface{}, errMsg string)

HandleRecovery handles the common logic for recovering from a panic.

func InterruptProcessTree

func InterruptProcessTree(logger *zap.Logger, ppid int, sig syscall.Signal) error

InterruptProcessTree interrupts an entire process tree using the given signal

func IsDockerKind

func IsDockerKind(kind CmdType) bool

func Keys

func Keys(m map[string][]string) []string

Keys returns an array containing the keys of the given map.

func LogError

func LogError(logger *zap.Logger, err error, msg string, fields ...zap.Field)

LogError logs the error with the provided fields if the error is not context.Canceled.

func NewCtx

func NewCtx() context.Context

func Recover

func Recover(logger *zap.Logger)

Recover recovers from a panic and logs the stack trace to Sentry. It also stops the global context.

func ReplaceHostToIP

func ReplaceHostToIP(currentURL string, ipAddress string) (string, error)

func RestoreUmask

func RestoreUmask(oldMask int)

func RunInDocker

func RunInDocker(ctx context.Context, logger *zap.Logger) error

func SendSignal

func SendSignal(logger *zap.Logger, pid int, sig syscall.Signal) error

func SentryInit

func SentryInit(logger *zap.Logger, dsn string)

func SetCancel

func SetCancel(c context.CancelFunc)

func SetCoveragePath

func SetCoveragePath(logger *zap.Logger, goCovPath string) (string, error)

SetCoveragePath takes a goCovPath and sets the coverage path accordingly. It returns an error if the path is a file or if the path does not exist.

func SetUmask

func SetUmask() int

func StartInDocker

func StartInDocker(ctx context.Context, logger *zap.Logger, conf *config.Config) error

StartInDocker will check if the docker command is provided as an input then start the Keploy as a docker container and run the command should also return a boolean if the execution is moved to docker

func Stop

func Stop(logger *zap.Logger, reason string) error

Stop requires a reason to stop the server. this is to ensure that the server is not stopped accidentally. and to trace back the stopper

Types

type AutoInc

type AutoInc struct {
	sync.Mutex // ensures autoInc is goroutine-safe
	// contains filtered or unexported fields
}

func (*AutoInc) Next

func (a *AutoInc) Next() (id int)

type CmdError

type CmdError struct {
	Type ErrType
	Err  error
}

func ExecuteCommand

func ExecuteCommand(ctx context.Context, logger *zap.Logger, userCmd string, cancel func(cmd *exec.Cmd) func() error, waitDelay time.Duration) CmdError

type CmdType

type CmdType string

const (
	DockerRun     CmdType = "docker-run"
	DockerStart   CmdType = "docker-start"
	DockerCompose CmdType = "docker-compose"
	Native        CmdType = "native"
	Empty         CmdType = ""
)

CmdType constants

func FindDockerCmd

func FindDockerCmd(cmd string) CmdType

FindDockerCmd checks if the cli is related to docker or not, it also returns if it is a docker compose file

type DockerConfigStruct

type DockerConfigStruct struct {
	DockerImage string
	Envs        map[string]string
}

type ErrType

type ErrType string

const (
	Init    ErrType = "init"
	Runtime ErrType = "runtime"
)

ErrType constants to get the type of error, during init or runtime

type GitHubRelease

type GitHubRelease struct {
	TagName string `json:"tag_name"`
	Body    string `json:"body"`
}

func GetLatestGitHubRelease

func GetLatestGitHubRelease(ctx context.Context, logger *zap.Logger) (GitHubRelease, error)

GetLatestGitHubRelease fetches the latest version and release body from GitHub releases with a timeout.