mirror of https://github.com/harness/drone.git
49 lines
1.5 KiB
Go
49 lines
1.5 KiB
Go
// 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 ide
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/harness/gitness/app/gitspace/orchestrator/devcontainer"
|
|
gitspaceTypes "github.com/harness/gitness/app/gitspace/types"
|
|
"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.
|
|
Setup(
|
|
ctx context.Context,
|
|
exec *devcontainer.Exec,
|
|
gitspaceLogger gitspaceTypes.GitspaceLogger,
|
|
) error
|
|
|
|
// Run runs the IDE and supporting services.
|
|
Run(
|
|
ctx context.Context,
|
|
exec *devcontainer.Exec,
|
|
args map[string]interface{},
|
|
gitspaceLogger gitspaceTypes.GitspaceLogger,
|
|
) error
|
|
|
|
// Port provides the port which will be used by this IDE.
|
|
Port() *types.GitspacePort
|
|
|
|
// Type provides the IDE type to which the service belongs.
|
|
Type() enum.IDEType
|
|
}
|