github/drone
5
0
Fork 0
mirror of https://github.com/harness/drone.git synced 2025-05-10 05:01:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: [CDE-461]: expose the step methods (#2969)

Browse Source 
* feat: [CDE-461]: expose the step methods
* feat: [CDE-461]: expose the step methods
* feat: [CDE-461]: expose the step methods
This commit is contained in:
Ansuman Satapathy 2024-11-11 12:06:42 +00:00 committed by Harness
parent aa7bb45eb9
commit c635effd2f
2 changed files with 38 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
app/gitspace/orchestrator/container/embedded_docker_steps.go → app/gitspace/orchestrator/container/devcontainer_steps.go
View File

@ -21,8 +21,10 @@ import (
"github.com/harness/gitness/app/gitspace/orchestrator/common" "github.com/harness/gitness/app/gitspace/orchestrator/common"
"github.com/harness/gitness/app/gitspace/orchestrator/devcontainer" "github.com/harness/gitness/app/gitspace/orchestrator/devcontainer"
"github.com/harness/gitness/app/gitspace/orchestrator/git"
"github.com/harness/gitness/app/gitspace/orchestrator/ide" "github.com/harness/gitness/app/gitspace/orchestrator/ide"
orchestratorTypes "github.com/harness/gitness/app/gitspace/orchestrator/types" orchestratorTypes "github.com/harness/gitness/app/gitspace/orchestrator/types"
"github.com/harness/gitness/app/gitspace/orchestrator/user"
"github.com/harness/gitness/app/gitspace/scm" "github.com/harness/gitness/app/gitspace/scm"
"github.com/harness/gitness/types" "github.com/harness/gitness/types"
"github.com/harness/gitness/types/enum" "github.com/harness/gitness/types/enum"
@ -43,43 +45,49 @@ func (e *EmbeddedDockerOrchestrator) setupGitspaceAndIDE(
codeRepoDir := filepath.Join(homeDir, resolvedRepoDetails.RepoName) codeRepoDir := filepath.Join(homeDir, resolvedRepoDetails.RepoName)
// Register setup steps // Register setup steps
e.RegisterStep("Validate Supported OS", e.validateSupportedOS, true) e.RegisterStep("Validate Supported OS", ValidateSupportedOS, true)
e.RegisterStep("Manage User", e.manageUser, true) e.RegisterStep("Manage User",
func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error {
return ManageUser(ctx, exec, e.userService, gitspaceLogger)
}, true)
e.RegisterStep("Install Tools", e.RegisterStep("Install Tools",
func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error { func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error {
return e.installTools(ctx, exec, gitspaceLogger, gitspaceConfig.IDE) return InstallTools(ctx, exec, gitspaceLogger, gitspaceConfig.IDE)
}, true) }, true)
e.RegisterStep("Setup IDE", e.RegisterStep("Setup IDE",
func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error { func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error {
return e.setupIDE(ctx, exec, ideService, gitspaceLogger) return SetupIDE(ctx, exec, ideService, gitspaceLogger)
}, true) }, true)
e.RegisterStep("Run IDE", e.RegisterStep("Run IDE",
func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error { func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error {
return e.runIDE(ctx, exec, ideService, gitspaceLogger) return RunIDE(ctx, exec, ideService, gitspaceLogger)
}, true)
e.RegisterStep("Install Git",
func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error {
return InstallGit(ctx, exec, e.gitService, gitspaceLogger)
}, true) }, true)
e.RegisterStep("Install Git", e.installGit, true)
e.RegisterStep("Setup Git Credentials", e.RegisterStep("Setup Git Credentials",
func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error { func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error {
if resolvedRepoDetails.ResolvedCredentials.Credentials != nil { if resolvedRepoDetails.ResolvedCredentials.Credentials != nil {
return e.setupGitCredentials(ctx, exec, resolvedRepoDetails, gitspaceLogger) return SetupGitCredentials(ctx, exec, resolvedRepoDetails, e.gitService, gitspaceLogger)
} }
return nil return nil
}, true) }, true)
e.RegisterStep("Clone Code", e.RegisterStep("Clone Code",
func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error { func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error {
return e.cloneCode(ctx, exec, defaultBaseImage, resolvedRepoDetails, gitspaceLogger) return CloneCode(ctx, exec, defaultBaseImage, resolvedRepoDetails, e.gitService, gitspaceLogger)
}, true) }, true)
// Register the Execute Command steps (PostCreate and PostStart) // Register the Execute Command steps (PostCreate and PostStart)
e.RegisterStep("Execute PostCreate Command", e.RegisterStep("Execute PostCreate Command",
func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error { func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error {
command := ExtractCommand(PostCreateAction, devcontainerConfig) command := ExtractCommand(PostCreateAction, devcontainerConfig)
return e.executeCommand(ctx, exec, codeRepoDir, gitspaceLogger, command, PostCreateAction) return ExecuteCommand(ctx, exec, codeRepoDir, gitspaceLogger, command, PostCreateAction)
}, false) }, false)
e.RegisterStep("Execute PostStart Command", e.RegisterStep("Execute PostStart Command",
func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error { func(ctx context.Context, exec *devcontainer.Exec, gitspaceLogger orchestratorTypes.GitspaceLogger) error {
command := ExtractCommand(PostStartAction, devcontainerConfig) command := ExtractCommand(PostStartAction, devcontainerConfig)
return e.executeCommand(ctx, exec, codeRepoDir, gitspaceLogger, command, PostStartAction) return ExecuteCommand(ctx, exec, codeRepoDir, gitspaceLogger, command, PostStartAction)
}, false) }, false)
// Execute the registered steps // Execute the registered steps
@ -89,7 +97,7 @@ func (e *EmbeddedDockerOrchestrator) setupGitspaceAndIDE(
return nil return nil
} }
func (e *EmbeddedDockerOrchestrator) installTools( func InstallTools(
ctx context.Context, ctx context.Context,
exec *devcontainer.Exec, exec *devcontainer.Exec,
gitspaceLogger orchestratorTypes.GitspaceLogger, gitspaceLogger orchestratorTypes.GitspaceLogger,
@ -99,13 +107,11 @@ func (e *EmbeddedDockerOrchestrator) installTools(
if err != nil { if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while installing tools inside container", err) return logStreamWrapError(gitspaceLogger, "Error while installing tools inside container", err)
} }
gitspaceLogger.Info("Tools installation output...\n" + string(output)) gitspaceLogger.Info("Tools installation output...\n" + string(output))
return nil return nil
} }
func (e *EmbeddedDockerOrchestrator) validateSupportedOS( func ValidateSupportedOS(
ctx context.Context, ctx context.Context,
exec *devcontainer.Exec, exec *devcontainer.Exec,
gitspaceLogger orchestratorTypes.GitspaceLogger, gitspaceLogger orchestratorTypes.GitspaceLogger,
@ -114,13 +120,11 @@ func (e *EmbeddedDockerOrchestrator) validateSupportedOS(
if err != nil { if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while detecting OS inside container", err) return logStreamWrapError(gitspaceLogger, "Error while detecting OS inside container", err)
} }
gitspaceLogger.Info("Validate supported OSes...\n" + string(output)) gitspaceLogger.Info("Validate supported OSes...\n" + string(output))
return nil return nil
} }
func (e *EmbeddedDockerOrchestrator) executeCommand( func ExecuteCommand(
ctx context.Context, ctx context.Context,
exec *devcontainer.Exec, exec *devcontainer.Exec,
codeRepoDir string, codeRepoDir string,
@ -137,35 +141,34 @@ func (e *EmbeddedDockerOrchestrator) executeCommand(
return logStreamWrapError( return logStreamWrapError(
gitspaceLogger, fmt.Sprintf("Error while executing %s command", actionType), err) gitspaceLogger, fmt.Sprintf("Error while executing %s command", actionType), err)
} }
gitspaceLogger.Info("Post create command execution output...\n" + string(output)) gitspaceLogger.Info("Post create command execution output...\n" + string(output))
gitspaceLogger.Info(fmt.Sprintf("Successfully executed %s command", actionType)) gitspaceLogger.Info(fmt.Sprintf("Successfully executed %s command", actionType))
return nil return nil
} }
func (e *EmbeddedDockerOrchestrator) cloneCode( func CloneCode(
ctx context.Context, ctx context.Context,
exec *devcontainer.Exec, exec *devcontainer.Exec,
defaultBaseImage string, defaultBaseImage string,
resolvedRepoDetails scm.ResolvedDetails, resolvedRepoDetails scm.ResolvedDetails,
gitService git.Service,
gitspaceLogger orchestratorTypes.GitspaceLogger, gitspaceLogger orchestratorTypes.GitspaceLogger,
) error { ) error {
output, err := e.gitService.CloneCode(ctx, exec, resolvedRepoDetails, defaultBaseImage) output, err := gitService.CloneCode(ctx, exec, resolvedRepoDetails, defaultBaseImage)
if err != nil { if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while cloning code inside container", err) return logStreamWrapError(gitspaceLogger, "Error while cloning code inside container", err)
} }
gitspaceLogger.Info("Clone output...\n" + string(output)) gitspaceLogger.Info("Clone output...\n" + string(output))
return nil return nil
} }
func (e *EmbeddedDockerOrchestrator) installGit( func InstallGit(
ctx context.Context, ctx context.Context,
exec *devcontainer.Exec, exec *devcontainer.Exec,
gitService git.Service,
gitspaceLogger orchestratorTypes.GitspaceLogger, gitspaceLogger orchestratorTypes.GitspaceLogger,
) error { ) error {
output, err := e.gitService.Install(ctx, exec) output, err := gitService.Install(ctx, exec)
if err != nil { if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while installing git inside container", err) return logStreamWrapError(gitspaceLogger, "Error while installing git inside container", err)
} }
@ -174,13 +177,14 @@ func (e *EmbeddedDockerOrchestrator) installGit(
return nil return nil
} }
func (e *EmbeddedDockerOrchestrator) setupGitCredentials( func SetupGitCredentials(
ctx context.Context, ctx context.Context,
exec *devcontainer.Exec, exec *devcontainer.Exec,
resolvedRepoDetails scm.ResolvedDetails, resolvedRepoDetails scm.ResolvedDetails,
gitService git.Service,
gitspaceLogger orchestratorTypes.GitspaceLogger, gitspaceLogger orchestratorTypes.GitspaceLogger,
) error { ) error {
output, err := e.gitService.SetupCredentials(ctx, exec, resolvedRepoDetails) output, err := gitService.SetupCredentials(ctx, exec, resolvedRepoDetails)
if err != nil { if err != nil {
return logStreamWrapError( return logStreamWrapError(
gitspaceLogger, "Error while setting up git credentials inside container", err) gitspaceLogger, "Error while setting up git credentials inside container", err)
@ -190,12 +194,13 @@ func (e *EmbeddedDockerOrchestrator) setupGitCredentials(
return nil return nil
} }
func (e *EmbeddedDockerOrchestrator) manageUser( func ManageUser(
ctx context.Context, ctx context.Context,
exec *devcontainer.Exec, exec *devcontainer.Exec,
userService user.Service,
gitspaceLogger orchestratorTypes.GitspaceLogger, gitspaceLogger orchestratorTypes.GitspaceLogger,
) error { ) error {
output, err := e.userService.Manage(ctx, exec) output, err := userService.Manage(ctx, exec)
if err != nil { if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while creating user inside container", err) return logStreamWrapError(gitspaceLogger, "Error while creating user inside container", err)
} }
@ -203,7 +208,7 @@ func (e *EmbeddedDockerOrchestrator) manageUser(
return nil return nil
} }
func (e *EmbeddedDockerOrchestrator) setupIDE( func SetupIDE(
ctx context.Context, ctx context.Context,
exec *devcontainer.Exec, exec *devcontainer.Exec,
ideService ide.IDE, ideService ide.IDE,
@ -217,12 +222,11 @@ func (e *EmbeddedDockerOrchestrator) setupIDE(
} }
gitspaceLogger.Info("IDE setup output...\n" + string(output)) gitspaceLogger.Info("IDE setup output...\n" + string(output))
gitspaceLogger.Info("Successfully set up IDE inside container") gitspaceLogger.Info("Successfully set up IDE inside container")
return nil return nil
} }
func (e *EmbeddedDockerOrchestrator) runIDE( func RunIDE(
ctx context.Context, ctx context.Context,
exec *devcontainer.Exec, exec *devcontainer.Exec,
ideService ide.IDE, ideService ide.IDE,
@ -235,7 +239,6 @@ func (e *EmbeddedDockerOrchestrator) runIDE(
} }
gitspaceLogger.Info("IDE run output...\n" + string(output)) gitspaceLogger.Info("IDE run output...\n" + string(output))
gitspaceLogger.Info("Successfully run the IDE inside container") gitspaceLogger.Info("Successfully run the IDE inside container")
return nil return nil
} }

6
app/gitspace/orchestrator/container/embedded_docker_provider.go
View File

@ -204,20 +204,20 @@ func (e *EmbeddedDockerOrchestrator) startStoppedGitspace(
// Set up git credentials if needed // Set up git credentials if needed
if resolvedRepoDetails.Credentials != nil { if resolvedRepoDetails.Credentials != nil {
if err := e.setupGitCredentials(ctx, exec, resolvedRepoDetails, logStreamInstance); err != nil { if err := SetupGitCredentials(ctx, exec, resolvedRepoDetails, e.gitService, logStreamInstance); err != nil {
return err return err
} }
} }
// Run IDE setup // Run IDE setup
if err := e.runIDE(ctx, exec, ideService, logStreamInstance); err != nil { if err := RunIDE(ctx, exec, ideService, logStreamInstance); err != nil {
return err return err
} }
// Execute post-start command // Execute post-start command
devcontainerConfig := resolvedRepoDetails.DevcontainerConfig devcontainerConfig := resolvedRepoDetails.DevcontainerConfig
command := ExtractCommand(PostStartAction, devcontainerConfig) command := ExtractCommand(PostStartAction, devcontainerConfig)
startErr = e.executeCommand(ctx, exec, codeRepoDir, logStreamInstance, command, PostStartAction) startErr = ExecuteCommand(ctx, exec, codeRepoDir, logStreamInstance, command, PostStartAction)
if startErr != nil { if startErr != nil {
log.Warn().Msgf("Error is post-start command, continuing : %s", startErr.Error()) log.Warn().Msgf("Error is post-start command, continuing : %s", startErr.Error())
} }