chore: refactor keploy v2 codebase

.github/ISSUE_TEMPLATE/--documentation-update.yaml

@@ -6,7 +6,7 @@ labels: [Documentation]
 body:
   - type: markdown
     attributes:
-      value: Thank you for taking the time to file a Documentation update.
+      value: Thank you for taking the time to file a Documentation tools.
   - type: textarea
     attributes:
       label: What do you want to add to the docs? (please state reasons if any)

.github/workflows/docs.yml

@@ -25,7 +25,7 @@ jobs:
         uses: stefanbuck/github-issue-parser@v3
         id: issue-parser
         with:
-          template-path: .github/ISSUE_TEMPLATE/--documentation-update.yaml
+          template-path: .github/ISSUE_TEMPLATE/--documentation-tools.yaml
 
       - name: Set labels based on repository field
         uses: redhat-plumbers-in-action/advanced-issue-labeler@v2

.github/workflows/test_workflow_scripts/golang-docker.sh

@@ -8,7 +8,7 @@ docker network create keploy-network
 docker run --name mongoDb --rm --net keploy-network -p 27017:27017 -d mongo
 
 # Generate the keploy-config file.
-docker run  --name keploy-v2 -p 16789:16789 --privileged --pid=host -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm keployv2 generate-config
+docker run  --name keploy-v2 -p 16789:16789 --privileged --pid=host -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm keployv2 config --generate
 
 # Update the global noise to ts.
 config_file="./keploy-config.yaml"

.github/workflows/test_workflow_scripts/golang-linux.sh

@@ -15,7 +15,7 @@ if [ -f "./keploy-config.yaml" ]; then
 fi
 
 # Generate the keploy-config file.
-./../../keployv2 generate-config
+./../../keployv2 config --generate
 
 # Update the global noise to ts.
 config_file="./keploy-config.yaml"

.github/workflows/test_workflow_scripts/node-linux.sh

@@ -8,7 +8,7 @@ docker run --name mongoDb --rm -p 27017:27017 -d mongo
 # Install the required node dependencies.
 npm install
 
-# Edit the connection.js file to connect to local mongodb.
+# Edit the conn.js file to connect to local mongodb.
 file_path="src/db/connection.js"
 sed -i "s/mongoDb:27017/localhost:27017/" "$file_path"
 
@@ -70,7 +70,7 @@ sudo -E env PATH=$PATH ./../../keployv2 test -c "npm test" --delay 5 --coverage
 sudo -E env PATH=$PATH ./../../keployv2 test -c 'npm start' --delay 10 --testsets test-set-0
 
 # Generate the keploy-config file.
-./../../keployv2 generate-config
+./../../keployv2 config --generate
 
 # Update the global noise to ts.
 config_file="./keploy-config.yaml"

.github/workflows/test_workflow_scripts/python-docker.sh

@@ -9,7 +9,7 @@ docker network create backend
 rm -rf keploy/
 
 # Generate the keploy-config file.
-docker run --name keploy-v2 -p 16789:16789 --privileged --pid=host  -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm keployv2 generate-config
+docker run --name keploy-v2 -p 16789:16789 --privileged --pid=host  -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm keployv2 config --generate
 
 # Update the global noise to ignore the Allow header.
 config_file="./keploy-config.yaml"

.github/workflows/test_workflow_scripts/python-linux.sh

@@ -20,7 +20,7 @@ python3 manage.py makemigrations
 python3 manage.py migrate
 
 # Generate the keploy-config file.
-./../../../keployv2 generate-config
+./../../../keployv2 config --generate
 
 #Clean any keploy folders.
 sudo rm -rf keploy/

Dockerfile

@@ -21,10 +21,10 @@ RUN go build -ldflags="-X main.dsn=$SENTRY_DSN_DOCKER -X main.version=$VERSION"
 # === Runtime Stage ===
 FROM debian:bookworm-slim
 
-ENV IS_DOCKER_CMD=true
+ENV KEPLOY_INDOCKER=true
 
 # Update the package lists and install required packages
-RUN apt-get update && \
+RUN apt-get tools && \
     apt-get install -y ca-certificates curl sudo && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*

README.md

@@ -176,4 +176,4 @@ Whether you're a newbie coder or a wizard 🧙‍♀️, your perspective is gol
 
 ⚙️ [Installation Guide](https://keploy.io/docs/application-development/)
 
-📖 [Contribution Guide](https://docs.keploy.io/docs/devtools/server-contrib-guide/)
+📖 [Contribution Guide](https://docs.keploy.io/docs/devtools/server-contrib-guide/)

cli/cli.go

@@ -0,0 +1,22 @@
+// Package cli provides functionality for the command-line interface of the application.
+package cli
+
+import (
+	"context"
+
+	"github.com/spf13/cobra"
+	"go.keploy.io/server/v2/config"
+	"go.uber.org/zap"
+)
+
+type HookFunc func(context.Context, *zap.Logger, *config.Config, ServiceFactory, CmdConfigurator) *cobra.Command
+
+// Registered holds the registered command hooks
+var Registered map[string]HookFunc
+
+func Register(name string, f HookFunc) {
+	if Registered == nil {
+		Registered = make(map[string]HookFunc)
+	}
+	Registered[name] = f
+}

cli/config.go

@@ -0,0 +1,74 @@
+package cli
+
+import (
+	"context"
+	"errors"
+	"path/filepath"
+
+	"go.keploy.io/server/v2/config"
+
+	toolsSvc "go.keploy.io/server/v2/pkg/service/tools"
+	"go.keploy.io/server/v2/utils"
+
+	"github.com/spf13/cobra"
+	"go.uber.org/zap"
+)
+
+func init() {
+	Register("config", Config)
+}
+
+func Config(ctx context.Context, logger *zap.Logger, cfg *config.Config, servicefactory ServiceFactory, cmdConfigurator CmdConfigurator) *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:     "config",
+		Short:   "manage keploy configuration file",
+		Example: "keploy config --generate --path /path/to/localdir",
+		PreRunE: func(cmd *cobra.Command, _ []string) error {
+			return cmdConfigurator.ValidateFlags(ctx, cmd, cfg)
+		},
+		RunE: func(cmd *cobra.Command, _ []string) error {
+
+			isGenerate, err := cmd.Flags().GetBool("generate")
+			if err != nil {
+				utils.LogError(logger, err, "failed to get generate flag")
+				return err
+			}
+
+			if isGenerate {
+				filePath := filepath.Join(cfg.Path, "keploy.yml")
+				if utils.CheckFileExists(filePath) {
+					override, err := utils.AskForConfirmation("Config file already exists. Do you want to override it?")
+					if err != nil {
+						utils.LogError(logger, err, "failed to ask for confirmation")
+						return err
+					}
+					if !override {
+						return nil
+					}
+				}
+				svc, err := servicefactory.GetService(ctx, cmd.Name(), *cfg)
+				if err != nil {
+					utils.LogError(logger, err, "failed to get service")
+					return err
+				}
+				var tools toolsSvc.Service
+				var ok bool
+				if tools, ok = svc.(toolsSvc.Service); !ok {
+					utils.LogError(logger, nil, "service doesn't satisfy tools service interface")
+					return err
+				}
+				if err := tools.CreateConfig(ctx, filePath, ""); err != nil {
+					utils.LogError(logger, err, "failed to create config")
+					return err
+				}
+				return nil
+			}
+			return errors.New("only generate flag is supported in the config command")
+		},
+	}
+	if err := cmdConfigurator.AddFlags(cmd, cfg); err != nil {
+		utils.LogError(logger, err, "failed to add flags")
+		return nil
+	}
+	return cmd
+}

cli/examples.go

@@ -0,0 +1,44 @@
+package cli
+
+import (
+	"context"
+	"fmt"
+
+	"go.keploy.io/server/v2/cli/provider"
+	"go.keploy.io/server/v2/config"
+	"go.keploy.io/server/v2/utils"
+	"go.uber.org/zap"
+
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	Register("example", Example)
+}
+
+func Example(_ context.Context, logger *zap.Logger, _ *config.Config, _ ServiceFactory, _ CmdConfigurator) *cobra.Command {
+	var customSetup bool
+	var cmd = &cobra.Command{
+		Use:   "example",
+		Short: "Example to record and test via keploy",
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			customSetup, err := cmd.Flags().GetBool("customSetup")
+			if err != nil {
+				utils.LogError(logger, nil, "failed to read the customSetup flag")
+				return err
+			}
+			if customSetup {
+				fmt.Println(provider.Examples)
+				return nil
+			}
+			fmt.Println(provider.ExampleOneClickInstall)
+			fmt.Println(provider.WithoutexampleOneClickInstall)
+			return nil
+		},
+	}
+	cmd.SetHelpTemplate(provider.CustomHelpTemplate)
+
+	cmd.Flags().Bool("customSetup", customSetup, "Check if the user is using one click install")
+
+	return cmd
+}

cli/mock.go

@@ -0,0 +1,79 @@
+package cli
+
+import (
+	"context"
+	"errors"
+
+	"github.com/spf13/cobra"
+	"go.keploy.io/server/v2/config"
+	recordSvc "go.keploy.io/server/v2/pkg/service/record"
+	replaySvc "go.keploy.io/server/v2/pkg/service/replay"
+	"go.keploy.io/server/v2/utils"
+	"go.uber.org/zap"
+)
+
+func init() {
+	Register("mock", Mock)
+}
+
+func Mock(ctx context.Context, logger *zap.Logger, cfg *config.Config, serviceFactory ServiceFactory, cmdConfigurator CmdConfigurator) *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:     "mock",
+		Short:   "Record and replay ougoung network traffic for the user application",
+		Example: `keploy mock -c "/path/to/user/app" --delay 10`,
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			record, err := cmd.Flags().GetBool("record")
+			if err != nil {
+				utils.LogError(logger, nil, "failed to read the record flag")
+				return err
+			}
+			replay, err := cmd.Flags().GetBool("replay")
+			if err != nil {
+				utils.LogError(logger, nil, "failed to read the replay flag")
+				return err
+			}
+			if !record && !replay {
+				return errors.New("missing required --record or --replay flag")
+			}
+			if record && replay {
+				return errors.New("both --record and --replay flags are set")
+			}
+			if record {
+				svc, err := serviceFactory.GetService(ctx, "record", *cfg)
+				if err != nil {
+					utils.LogError(logger, err, "failed to get service")
+					return err
+				}
+				var recordService recordSvc.Service
+				var ok bool
+				if recordService, ok = svc.(recordSvc.Service); ok {
+					return recordService.StartMock(ctx)
+				}
+				utils.LogError(logger, nil, "service doesn't satisfy record service interface")
+				return err
+
+			}
+			if replay {
+				svc, err := serviceFactory.GetService(ctx, "replay", *cfg)
+				if err != nil {
+					utils.LogError(logger, err, "failed to get service")
+					return err
+				}
+				var replayService replaySvc.Service
+				var ok bool
+				if replayService, ok = svc.(replaySvc.Service); ok {
+					return replayService.ProvideMocks(ctx)
+				}
+				utils.LogError(logger, nil, "service doesn't satisfy replay service interface")
+				return err
+			}
+			return nil
+
+		},
+	}
+	if err := cmdConfigurator.AddFlags(cmd, cfg); err != nil {
+		utils.LogError(logger, err, "failed to add flags")
+		return nil
+	}
+	return cmd
+}