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

feat: [CDE-156]: Changes to install SSH server only when the IDE is VS Code. (#2222) 

* feat: [CDE-156]: Changes to install SSH server only when the IDE is VS Code.
unified-ui
Dhruv Dhruv 2024-07-15 09:21:31 +00:00 committed by Harness
parent 6c3627621e
commit b4f35ddbbe
4 changed files with 45 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
app/gitspace/orchestrator/container/embedded_docker.go
View File

@ -41,7 +41,6 @@ var _ Orchestrator = (*EmbeddedDockerOrchestrator)(nil)
const (
loggingKey = "gitspace.container"
sshPort = "22/tcp"
catchAllIP = "0.0.0.0"
catchAllPort = "0"
containerStateRunning = "running"
@ -85,7 +84,7 @@ func NewEmbeddedDockerOrchestrator(
// StartGitspace checks if the Gitspace is already running by checking its entry in a map. If is it running,
// it returns, else, it creates a new Gitspace container by using the provided image. If the provided image is
// nil, it uses a default image read from Gitness config. Post creation it runs the postCreate command and clones
// the code inside the container. It uses the IDE service to setup the relevant IDE and also installs SSH server
// the code inside the container. It uses the IDE service to setup the relevant IDE and install the SSH server
// inside the container.
func (e *EmbeddedDockerOrchestrator) StartGitspace(
ctx context.Context,
@ -229,12 +228,7 @@ func (e *EmbeddedDockerOrchestrator) startGitspace(
return err
}
err = e.setupSSHServer(ctx, gitspaceConfig.GitspaceInstance, devcontainer, logStreamInstance)
if err != nil {
return err
}
err = e.setupIDE(ctx, devcontainer, ideService, logStreamInstance)
err = e.setupIDE(ctx, gitspaceConfig.GitspaceInstance, devcontainer, ideService, logStreamInstance)
if err != nil {
return err
}
@ -244,6 +238,7 @@ func (e *EmbeddedDockerOrchestrator) startGitspace(
func (e *EmbeddedDockerOrchestrator) setupIDE(
ctx context.Context,
gitspaceInstance *types.GitspaceInstance,
devcontainer *Devcontainer,
ideService IDE,
logStreamInstance *logutil.LogStreamInstance,
@ -253,7 +248,7 @@ func (e *EmbeddedDockerOrchestrator) setupIDE(
return fmt.Errorf("logging error: %w", loggingErr)
}
output, err := ideService.Setup(ctx, devcontainer)
output, err := ideService.Setup(ctx, devcontainer, gitspaceInstance)
if err != nil {
loggingErr = logStreamInstance.Write("Error while setting up IDE inside container: " + err.Error())
@ -292,9 +287,6 @@ func (e *EmbeddedDockerOrchestrator) getContainerInfo(
usedPorts := map[enum.IDEType]string{}
for port, bindings := range inspectResp.NetworkSettings.Ports {
if port == sshPort {
usedPorts[enum.IDETypeVSCode] = bindings[0].HostPort
}
if port == nat.Port(ideService.PortAndProtocol()) {
usedPorts[ideService.Type()] = bindings[0].HostPort
}
@ -318,54 +310,6 @@ func (e *EmbeddedDockerOrchestrator) getIDEService(gitspaceConfig *types.Gitspac
return ideService, nil
}
func (e *EmbeddedDockerOrchestrator) setupSSHServer(
ctx context.Context,
gitspaceInstance *types.GitspaceInstance,
devcontainer *Devcontainer,
logStreamInstance *logutil.LogStreamInstance,
) error {
sshServerScript, err := GenerateScriptFromTemplate(
templateSetupSSHServer, &SetupSSHServerPayload{
Username: "harness",
Password: *gitspaceInstance.AccessKey,
WorkingDirectory: devcontainer.WorkingDir,
})
if err != nil {
return fmt.Errorf(
"failed to generate scipt to setup ssh server from template %s: %w", templateSetupSSHServer, err)
}
loggingErr := logStreamInstance.Write("Installing ssh-server inside container")
if loggingErr != nil {
return fmt.Errorf("logging error: %w", loggingErr)
}
output, err := devcontainer.ExecuteCommand(ctx, sshServerScript, false)
if err != nil {
loggingErr = logStreamInstance.Write("Error while installing ssh-server inside container: " + err.Error())
err = fmt.Errorf("failed to setup SSH server: %w", err)
if loggingErr != nil {
err = fmt.Errorf("original error: %w; logging error: %w", err, loggingErr)
}
return err
}
loggingErr = logStreamInstance.Write("SSH server installation output...\n" + string(output))
if loggingErr != nil {
return fmt.Errorf("logging error: %w", loggingErr)
}
loggingErr = logStreamInstance.Write("Successfully installed ssh-server inside container")
if loggingErr != nil {
return fmt.Errorf("logging error: %w", loggingErr)
}
return nil
}
func (e *EmbeddedDockerOrchestrator) cloneCode(
ctx context.Context,
gitspaceConfig *types.GitspaceConfig,
@ -478,10 +422,6 @@ func (e *EmbeddedDockerOrchestrator) createContainer(
) error {
portUsedByIDE := ideService.PortAndProtocol()
exposedPorts := nat.PortSet{
sshPort: struct{}{},
}
hostPortBindings := []nat.PortBinding{
{
HostIP: catchAllIP,
@ -489,9 +429,8 @@ func (e *EmbeddedDockerOrchestrator) createContainer(
},
}
portBindings := nat.PortMap{
sshPort: hostPortBindings,
}
exposedPorts := nat.PortSet{}
portBindings := nat.PortMap{}
if portUsedByIDE != "" {
natPort := nat.Port(portUsedByIDE)

3
app/gitspace/orchestrator/container/ide.go
View File

@ -17,13 +17,14 @@ package container
import (
"context"
"github.com/harness/gitness/types"
"github.com/harness/gitness/types/enum"
)
type IDE interface {
// Setup is responsible for doing all the operations for setting up the IDE in the container e.g. installation,
// copying settings and configurations, ensuring SSH server is running etc.
Setup(ctx context.Context, containerParams *Devcontainer) ([]byte, error)
Setup(ctx context.Context, containerParams *Devcontainer, gitspaceInstance *types.GitspaceInstance) ([]byte, error)
// PortAndProtocol provides the port with protocol which will be used by this IDE.
PortAndProtocol() string

41
app/gitspace/orchestrator/container/vscode.go
View File

@ -16,27 +16,56 @@ package container
import (
"context"
"fmt"
"github.com/harness/gitness/types"
"github.com/harness/gitness/types/enum"
)
var _ IDE = (*VSCode)(nil)
const sshPort = "22/tcp"
type VSCode struct{}
func NewVsCodeService() *VSCode {
return &VSCode{}
}
// Setup is a NOOP since VS Code doesn't require any installation.
// TODO Check if the SSH server is accessible on the required port.
func (v *VSCode) Setup(_ context.Context, _ *Devcontainer) ([]byte, error) {
return nil, nil
// Setup installs and runs SSH server inside the container.
func (v *VSCode) Setup(
ctx context.Context,
devcontainer *Devcontainer,
gitspaceInstance *types.GitspaceInstance,
) ([]byte, error) {
var output = ""
sshServerScript, err := GenerateScriptFromTemplate(
templateSetupSSHServer, &SetupSSHServerPayload{
Username: "harness",
Password: *gitspaceInstance.AccessKey,
WorkingDirectory: devcontainer.WorkingDir,
})
if err != nil {
return nil, fmt.Errorf(
"failed to generate scipt to setup ssh server from template %s: %w", templateSetupSSHServer, err)
}
output += "Installing ssh-server inside container\n"
execOutput, err := devcontainer.ExecuteCommand(ctx, sshServerScript, false)
if err != nil {
return nil, fmt.Errorf("failed to setup SSH serverr: %w", err)
}
output += "SSH server installation output...\n" + string(execOutput) + "\nSuccessfully installed ssh-server\n"
return []byte(output), nil
}
// PortAndProtocol return nil since VS Code doesn't require any additional port to be exposed.
// PortAndProtocol returns the port on which the ssh-server is listening.
func (v *VSCode) PortAndProtocol() string {
return ""
return sshPort
}
func (v *VSCode) Type() enum.IDEType {

3
app/gitspace/orchestrator/container/vscodeweb.go
View File

@ -18,6 +18,7 @@ import (
"context"
"fmt"
"github.com/harness/gitness/types"
"github.com/harness/gitness/types/enum"
_ "embed"
@ -43,7 +44,7 @@ func NewVsCodeWebService(config *VSCodeWebConfig) *VSCodeWeb {
}
// Setup runs the installScript which downloads the required version of the code-server binary and runs it.
func (v *VSCodeWeb) Setup(ctx context.Context, devcontainer *Devcontainer) ([]byte, error) {
func (v *VSCodeWeb) Setup(ctx context.Context, devcontainer *Devcontainer, _ *types.GitspaceInstance) ([]byte, error) {
output, err := devcontainer.ExecuteCommand(ctx, installScript, false)
if err != nil {
return nil, fmt.Errorf("failed to install code-server: %w", err)