USEFULL
/
drone
mirror of https://github.com/harness/drone.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat: [CDE-573]: refactor to reduce utils (#3204) 

* feat: [CDE-573]: refactor to reduce number of utils.
* feat: [CDE-573]: refactor to reduce number of abstractions and modules.
* feat: [CDE-573]: refactor to reduce number of abstractions and modules.
* feat: [CDE-573]: refactor to reduce number of abstractions and modules.
BT-10437
Ansuman Satapathy 2024-12-26 10:50:27 +00:00 committed by Harness
parent cafa55b2e5
commit c54e09908b
4 changed files with 136 additions and 278 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

205
app/gitspace/orchestrator/container/devcontainer_step_utils.go
View File

@ -1,205 +0,0 @@
// Copyright 2023 Harness, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package container
import (
"context"
"fmt"
"sync"
"github.com/harness/gitness/app/gitspace/orchestrator/devcontainer"
"github.com/harness/gitness/app/gitspace/orchestrator/ide"
"github.com/harness/gitness/app/gitspace/orchestrator/utils"
"github.com/harness/gitness/app/gitspace/scm"
gitspaceTypes "github.com/harness/gitness/app/gitspace/types"
"github.com/harness/gitness/types/enum"
)
func InstallTools(
ctx context.Context,
exec *devcontainer.Exec,
gitspaceLogger gitspaceTypes.GitspaceLogger,
ideType enum.IDEType,
) error {
err := utils.InstallTools(ctx, exec, ideType, gitspaceLogger)
if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while installing tools inside container", err)
}
return nil
}
func ValidateSupportedOS(
ctx context.Context,
exec *devcontainer.Exec,
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
err := utils.ValidateSupportedOS(ctx, exec, gitspaceLogger)
if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while detecting OS inside container", err)
}
return nil
}
// ExecuteLifecycleCommands executes commands in parallel, logs with numbers, and prefixes all logs.
func ExecuteLifecycleCommands(
ctx context.Context,
exec devcontainer.Exec,
codeRepoDir string,
gitspaceLogger gitspaceTypes.GitspaceLogger,
commands []string,
actionType PostAction,
) error {
if len(commands) == 0 {
gitspaceLogger.Info(fmt.Sprintf("No %s commands provided, skipping execution", actionType))
return nil
}
gitspaceLogger.Info(fmt.Sprintf("Executing %s commands: %v", actionType, commands))
// Create a WaitGroup to wait for all goroutines to finish.
var wg sync.WaitGroup
// Iterate over commands and execute them in parallel using goroutines.
for index, command := range commands {
// Increment the WaitGroup counter.
wg.Add(1)
// Execute each command in a new goroutine.
go func(index int, command string) {
// Decrement the WaitGroup counter when the goroutine finishes.
defer wg.Done()
// Number the command in the logs and prefix all logs.
commandNumber := index + 1 // Starting from 1 for numbering
logPrefix := fmt.Sprintf("Command #%d - ", commandNumber)
// Log command execution details.
gitspaceLogger.Info(fmt.Sprintf("%sExecuting %s command: %s", logPrefix, actionType, command))
exec.DefaultWorkingDir = codeRepoDir
err := exec.ExecuteCommandInHomeDirAndLog(ctx, command, false, gitspaceLogger, true)
if err != nil {
// Log the error if there is any issue with executing the command.
_ = logStreamWrapError(gitspaceLogger, fmt.Sprintf("%sError while executing %s command: %s",
logPrefix, actionType, command), err)
return
}
// Log completion of the command execution.
gitspaceLogger.Info(fmt.Sprintf(
"%sCompleted execution %s command: %s", logPrefix, actionType, command))
}(index, command)
}
// Wait for all goroutines to finish.
wg.Wait()
return nil
}
func CloneCode(
ctx context.Context,
exec *devcontainer.Exec,
defaultBaseImage string,
resolvedRepoDetails scm.ResolvedDetails,
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
err := utils.CloneCode(ctx, exec, resolvedRepoDetails, defaultBaseImage, gitspaceLogger)
if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while cloning code inside container", err)
}
return nil
}
func InstallGit(
ctx context.Context,
exec *devcontainer.Exec,
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
err := utils.InstallGit(ctx, exec, gitspaceLogger)
if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while installing git inside container", err)
}
return nil
}
func SetupGitCredentials(
ctx context.Context,
exec *devcontainer.Exec,
resolvedRepoDetails scm.ResolvedDetails,
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
err := utils.SetupGitCredentials(ctx, exec, resolvedRepoDetails, gitspaceLogger)
if err != nil {
return logStreamWrapError(
gitspaceLogger, "Error while setting up git credentials inside container", err)
}
return nil
}
func ManageUser(
ctx context.Context,
exec *devcontainer.Exec,
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
err := utils.ManageUser(ctx, exec, gitspaceLogger)
if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while creating user inside container", err)
}
return nil
}
func SetupIDE(
ctx context.Context,
exec *devcontainer.Exec,
ideService ide.IDE,
args map[gitspaceTypes.IDEArg]interface{},
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
gitspaceLogger.Info("Setting up IDE inside container: " + string(ideService.Type()))
err := ideService.Setup(ctx, exec, args, gitspaceLogger)
if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while setting up IDE inside container", err)
}
return nil
}
func RunIDEWithArgs(
ctx context.Context,
exec *devcontainer.Exec,
ideService ide.IDE,
args map[gitspaceTypes.IDEArg]interface{},
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
gitspaceLogger.Info("Running the IDE inside container: " + string(ideService.Type()))
err := ideService.Run(ctx, exec, args, gitspaceLogger)
if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while running IDE inside container", err)
}
return nil
}
func SetEnv(
ctx context.Context,
exec *devcontainer.Exec,
gitspaceLogger gitspaceTypes.GitspaceLogger,
environment []string,
) error {
if len(environment) > 0 {
err := utils.SetEnv(ctx, exec, gitspaceLogger, environment)
if err != nil {
return logStreamWrapError(gitspaceLogger, "Error while installing tools inside container", err)
}
}
return nil
}

87
app/gitspace/orchestrator/container/embedded_docker_container_orchestrator.go
View File

@ -23,6 +23,7 @@ import (
"github.com/harness/gitness/app/gitspace/orchestrator/devcontainer"
"github.com/harness/gitness/app/gitspace/orchestrator/ide"
"github.com/harness/gitness/app/gitspace/orchestrator/runarg"
"github.com/harness/gitness/app/gitspace/orchestrator/utils"
"github.com/harness/gitness/app/gitspace/scm"
gitspaceTypes "github.com/harness/gitness/app/gitspace/types"
"github.com/harness/gitness/infraprovider"
@ -128,7 +129,7 @@ func (e *EmbeddedDockerOrchestrator) CreateAndStartGitspace(
logger.Debug().Msg("gitspace is already running")
case ContainerStateStopped:
if err := e.startStoppedGitspace(
if err = e.startStoppedGitspace(
ctx,
gitspaceConfig,
dockerClient,
@ -139,7 +140,7 @@ func (e *EmbeddedDockerOrchestrator) CreateAndStartGitspace(
return nil, err
}
case ContainerStateRemoved:
if err := e.createAndStartNewGitspace(
if err = e.createAndStartNewGitspace(
ctx,
gitspaceConfig,
dockerClient,
@ -206,13 +207,13 @@ func (e *EmbeddedDockerOrchestrator) startStoppedGitspace(
// Set up git credentials if needed
if resolvedRepoDetails.Credentials != nil {
if err := SetupGitCredentials(ctx, exec, resolvedRepoDetails, logStreamInstance); err != nil {
if err = utils.SetupGitCredentials(ctx, exec, resolvedRepoDetails, logStreamInstance); err != nil {
return err
}
}
// Run IDE setup
if err := RunIDEWithArgs(ctx, exec, ideService, nil, logStreamInstance); err != nil {
if err = ideService.Run(ctx, exec, nil, logStreamInstance); err != nil {
return err
}
@ -259,7 +260,7 @@ func (e *EmbeddedDockerOrchestrator) StopGitspace(
case ContainerStateRunning:
logger.Debug().Msg("stopping gitspace")
if err := e.stopRunningGitspace(ctx, gitspaceConfig, containerName, dockerClient); err != nil {
if err = e.stopRunningGitspace(ctx, gitspaceConfig, containerName, dockerClient); err != nil {
return err
}
case ContainerStatePaused, ContainerStateCreated, ContainerStateUnknown, ContainerStateDead:
@ -335,7 +336,7 @@ func (e *EmbeddedDockerOrchestrator) StopAndRemoveGitspace(
// Step 5: Stop the container if it's not already stopped
if state != ContainerStateStopped {
logger.Debug().Msg("stopping gitspace")
if err := ManageContainer(
if err = ManageContainer(
ctx, ContainerActionStop, containerName, dockerClient, logStreamInstance); err != nil {
return fmt.Errorf("failed to stop gitspace %s: %w", containerName, err)
}
@ -344,7 +345,7 @@ func (e *EmbeddedDockerOrchestrator) StopAndRemoveGitspace(
// Step 6: Remove the container
logger.Debug().Msg("removing gitspace")
if err := ManageContainer(
if err = ManageContainer(
ctx, ContainerActionRemove, containerName, dockerClient, logStreamInstance); err != nil {
return fmt.Errorf("failed to remove gitspace %s: %w", containerName, err)
}
@ -382,7 +383,7 @@ func (e *EmbeddedDockerOrchestrator) runGitspaceSetupSteps(
containerName := GetGitspaceContainerName(gitspaceConfig)
devcontainerConfig := resolvedRepoDetails.DevcontainerConfig
imageName := GetImage(devcontainerConfig, defaultBaseImage)
imageName := getImage(devcontainerConfig, defaultBaseImage)
runArgsMap, err := ExtractRunArgsWithLogging(ctx, gitspaceConfig.SpaceID, e.runArgProvider,
devcontainerConfig.RunArgs, gitspaceLogger)
@ -391,7 +392,7 @@ func (e *EmbeddedDockerOrchestrator) runGitspaceSetupSteps(
}
// Pull the required image
if err := PullImage(ctx, imageName, dockerClient, runArgsMap, gitspaceLogger, imageAuthMap); err != nil {
if err = PullImage(ctx, imageName, dockerClient, runArgsMap, gitspaceLogger, imageAuthMap); err != nil {
return err
}
@ -418,8 +419,8 @@ func (e *EmbeddedDockerOrchestrator) runGitspaceSetupSteps(
gitspaceLogger.Info(fmt.Sprintf("Setting Environment : %v", environment))
}
containerUser := GetContainerUser(runArgsMap, devcontainerConfig, metadataFromImage, imageUser)
remoteUser := GetRemoteUser(devcontainerConfig, metadataFromImage, containerUser)
containerUser := getContainerUser(runArgsMap, devcontainerConfig, metadataFromImage, imageUser)
remoteUser := getRemoteUser(devcontainerConfig, metadataFromImage, containerUser)
homeDir := GetUserHomeDir(remoteUser)
@ -447,7 +448,7 @@ func (e *EmbeddedDockerOrchestrator) runGitspaceSetupSteps(
}
// Start the container
if err := ManageContainer(ctx, ContainerActionStart, containerName, dockerClient, gitspaceLogger); err != nil {
if err = ManageContainer(ctx, ContainerActionStart, containerName, dockerClient, gitspaceLogger); err != nil {
return err
}
@ -461,7 +462,7 @@ func (e *EmbeddedDockerOrchestrator) runGitspaceSetupSteps(
AccessType: gitspaceConfig.GitspaceInstance.AccessType,
}
if err := e.setupGitspaceAndIDE(
if err = e.setupGitspaceAndIDE(
ctx,
exec,
gitspaceLogger,
@ -471,7 +472,7 @@ func (e *EmbeddedDockerOrchestrator) runGitspaceSetupSteps(
defaultBaseImage,
environment,
); err != nil {
return err
return logStreamWrapError(gitspaceLogger, "Error while setting up gitspace", err)
}
return nil
@ -491,12 +492,12 @@ func (e *EmbeddedDockerOrchestrator) buildSetupSteps(
return []step{
{
Name: "Validate Supported OS",
Execute: ValidateSupportedOS,
Execute: utils.ValidateSupportedOS,
StopOnFailure: true,
},
{
Name: "Manage User",
Execute: ManageUser,
Execute: utils.ManageUser,
StopOnFailure: true,
},
{
@ -506,7 +507,7 @@ func (e *EmbeddedDockerOrchestrator) buildSetupSteps(
exec *devcontainer.Exec,
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
return SetEnv(ctx, exec, gitspaceLogger, environment)
return utils.SetEnv(ctx, exec, gitspaceLogger, environment)
},
StopOnFailure: true,
},
@ -517,13 +518,13 @@ func (e *EmbeddedDockerOrchestrator) buildSetupSteps(
exec *devcontainer.Exec,
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
return InstallTools(ctx, exec, gitspaceLogger, gitspaceConfig.IDE)
return utils.InstallTools(ctx, exec, gitspaceConfig.IDE, gitspaceLogger)
},
StopOnFailure: true,
},
{
Name: "Install Git",
Execute: InstallGit,
Execute: utils.InstallGit,
StopOnFailure: true,
},
{
@ -534,7 +535,7 @@ func (e *EmbeddedDockerOrchestrator) buildSetupSteps(
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
if resolvedRepoDetails.ResolvedCredentials.Credentials != nil {
return SetupGitCredentials(ctx, exec, resolvedRepoDetails, gitspaceLogger)
return utils.SetupGitCredentials(ctx, exec, resolvedRepoDetails, gitspaceLogger)
}
return nil
},
@ -547,7 +548,7 @@ func (e *EmbeddedDockerOrchestrator) buildSetupSteps(
exec *devcontainer.Exec,
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
return CloneCode(ctx, exec, defaultBaseImage, resolvedRepoDetails, gitspaceLogger)
return utils.CloneCode(ctx, exec, resolvedRepoDetails, defaultBaseImage, gitspaceLogger)
},
StopOnFailure: true,
},
@ -561,7 +562,7 @@ func (e *EmbeddedDockerOrchestrator) buildSetupSteps(
// Run IDE setup
args := ExtractIDECustomizations(ideService, resolvedRepoDetails.DevcontainerConfig)
args[gitspaceTypes.IDERepoNameArg] = resolvedRepoDetails.RepoName
return SetupIDE(ctx, exec, ideService, args, gitspaceLogger)
return ideService.Setup(ctx, exec, args, gitspaceLogger)
},
StopOnFailure: true,
},
@ -572,7 +573,7 @@ func (e *EmbeddedDockerOrchestrator) buildSetupSteps(
exec *devcontainer.Exec,
gitspaceLogger gitspaceTypes.GitspaceLogger,
) error {
return RunIDEWithArgs(ctx, exec, ideService, nil, gitspaceLogger)
return ideService.Run(ctx, exec, nil, gitspaceLogger)
},
StopOnFailure: true,
},
@ -720,3 +721,43 @@ func (e *EmbeddedDockerOrchestrator) flushLogStream(logStreamInstance *logutil.L
log.Warn().Err(err).Msgf("failed to flush log stream for gitspace ID %d", gitspaceID)
}
}
func getRemoteUser(
devcontainerConfig types.DevcontainerConfig,
metadataFromImage map[string]any,
containerUser string,
) string {
if devcontainerConfig.RemoteUser != "" {
return devcontainerConfig.RemoteUser
}
if remoteUser, ok := metadataFromImage["remoteUser"].(string); ok {
return remoteUser
}
return containerUser
}
func getContainerUser(
runArgsMap map[types.RunArg]*types.RunArgValue,
devcontainerConfig types.DevcontainerConfig,
metadataFromImage map[string]any,
imageUser string,
) string {
if containerUser := getUser(runArgsMap); containerUser != "" {
return containerUser
}
if devcontainerConfig.ContainerUser != "" {
return devcontainerConfig.ContainerUser
}
if containerUser, ok := metadataFromImage["containerUser"].(string); ok {
return containerUser
}
return imageUser
}
func getImage(devcontainerConfig types.DevcontainerConfig, defaultBaseImage string) string {
imageName := devcontainerConfig.Image
if imageName == "" {
imageName = defaultBaseImage
}
return imageName
}

96
app/gitspace/orchestrator/container/util.go
View File

@ -15,11 +15,16 @@
package container
import (
"context"
"fmt"
"path/filepath"
"sync"
"github.com/harness/gitness/app/gitspace/orchestrator/devcontainer"
gitspaceTypes "github.com/harness/gitness/app/gitspace/types"
"github.com/harness/gitness/types"
types2 "github.com/docker/docker/api/types"
dockerTypes "github.com/docker/docker/api/types"
)
const (
@ -39,33 +44,7 @@ func GetUserHomeDir(userIdentifier string) string {
return filepath.Join(linuxHome, userIdentifier)
}
func GetImage(devcontainerConfig types.DevcontainerConfig, defaultBaseImage string) string {
imageName := devcontainerConfig.Image
if imageName == "" {
imageName = defaultBaseImage
}
return imageName
}
func GetContainerUser(
runArgsMap map[types.RunArg]*types.RunArgValue,
devcontainerConfig types.DevcontainerConfig,
metadataFromImage map[string]any,
imageUser string,
) string {
if containerUser := getUser(runArgsMap); containerUser != "" {
return containerUser
}
if devcontainerConfig.ContainerUser != "" {
return devcontainerConfig.ContainerUser
}
if containerUser, ok := metadataFromImage["containerUser"].(string); ok {
return containerUser
}
return imageUser
}
func ExtractRemoteUserFromLabels(inspectResp types2.ContainerJSON) string {
func ExtractRemoteUserFromLabels(inspectResp dockerTypes.ContainerJSON) string {
remoteUser := deprecatedRemoteUser
if remoteUserValue, ok := inspectResp.Config.Labels[gitspaceRemoteUserLabel]; ok {
@ -74,16 +53,57 @@ func ExtractRemoteUserFromLabels(inspectResp types2.ContainerJSON) string {
return remoteUser
}
func GetRemoteUser(
devcontainerConfig types.DevcontainerConfig,
metadataFromImage map[string]any,
containerUser string,
) string {
if devcontainerConfig.RemoteUser != "" {
return devcontainerConfig.RemoteUser
// ExecuteLifecycleCommands executes commands in parallel, logs with numbers, and prefixes all logs.
func ExecuteLifecycleCommands(
ctx context.Context,
exec devcontainer.Exec,
codeRepoDir string,
gitspaceLogger gitspaceTypes.GitspaceLogger,
commands []string,
actionType PostAction,
) error {
if len(commands) == 0 {
gitspaceLogger.Info(fmt.Sprintf("No %s commands provided, skipping execution", actionType))
return nil
}
if remoteUser, ok := metadataFromImage["remoteUser"].(string); ok {
return remoteUser
gitspaceLogger.Info(fmt.Sprintf("Executing %s commands: %v", actionType, commands))
// Create a WaitGroup to wait for all goroutines to finish.
var wg sync.WaitGroup
// Iterate over commands and execute them in parallel using goroutines.
for index, command := range commands {
// Increment the WaitGroup counter.
wg.Add(1)
// Execute each command in a new goroutine.
go func(index int, command string) {
// Decrement the WaitGroup counter when the goroutine finishes.
defer wg.Done()
// Number the command in the logs and prefix all logs.
commandNumber := index + 1 // Starting from 1 for numbering
logPrefix := fmt.Sprintf("Command #%d - ", commandNumber)
// Log command execution details.
gitspaceLogger.Info(fmt.Sprintf("%sExecuting %s command: %s", logPrefix, actionType, command))
exec.DefaultWorkingDir = codeRepoDir
err := exec.ExecuteCommandInHomeDirAndLog(ctx, command, false, gitspaceLogger, true)
if err != nil {
// Log the error if there is any issue with executing the command.
_ = logStreamWrapError(gitspaceLogger, fmt.Sprintf("%sError while executing %s command: %s",
logPrefix, actionType, command), err)
return
}
// Log completion of the command execution.
gitspaceLogger.Info(fmt.Sprintf(
"%sCompleted execution %s command: %s", logPrefix, actionType, command))
}(index, command)
}
return containerUser
// Wait for all goroutines to finish.
wg.Wait()
return nil
}

26
app/gitspace/orchestrator/utils/environment.go
View File

@ -72,18 +72,20 @@ func SetEnv(
gitspaceLogger types.GitspaceLogger,
environment []string,
) error {
script, err := GenerateScriptFromTemplate(
templateSetEnv, &types.SetEnvPayload{
EnvVariables: environment,
})
if err != nil {
return fmt.Errorf("failed to generate scipt to set env from template %s: %w",
templateSetEnv, err)
}
gitspaceLogger.Info("Setting env...")
err = exec.ExecuteCommandInHomeDirAndLog(ctx, script, true, gitspaceLogger, true)
if err != nil {
return fmt.Errorf("error while setting env vars: %w", err)
if len(environment) > 0 {
script, err := GenerateScriptFromTemplate(
templateSetEnv, &types.SetEnvPayload{
EnvVariables: environment,
})
if err != nil {
return fmt.Errorf("failed to generate scipt to set env from template %s: %w",
templateSetEnv, err)
}
gitspaceLogger.Info("Setting env...")
err = exec.ExecuteCommandInHomeDirAndLog(ctx, script, true, gitspaceLogger, true)
if err != nil {
return fmt.Errorf("error while setting env vars: %w", err)
}
}
return nil
}