-
Notifications
You must be signed in to change notification settings - Fork 15
/
api.go
58 lines (52 loc) · 2.02 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/*
* Copyright 2018-2023, CS Systemes d'Information, http://csgroup.eu
*
* 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 api
import (
"context"
"time"
"github.com/CS-SI/SafeScale/v22/lib/utils/cli/enums/outputs"
"github.com/CS-SI/SafeScale/v22/lib/utils/fail"
)
// Config is a shared interface for both binary-based ssh and library-based ssh
type Config interface {
GetUser() (string, fail.Error)
GetHostname() (string, fail.Error)
GetLocalHost() (string, fail.Error)
GetPort() (uint, fail.Error)
GetLocalPort() (uint, fail.Error)
GetIPAddress() (string, fail.Error)
GetPrivateKey() (string, fail.Error)
GetPrimaryGatewayConfig() (Config, fail.Error)
GetSecondaryGatewayConfig() (Config, fail.Error)
GetGatewayConfig(uint) (Config, fail.Error)
HasGateways() (bool, fail.Error)
}
// Connector describes the interface that exposes methods to interact with remote
type Connector interface {
CreatePersistentTunneling() fail.Error
Config() (Config, fail.Error)
CopyWithTimeout(context.Context, string, string, bool, time.Duration) (int, string, string, fail.Error)
Enter(context.Context, string, string) fail.Error
NewCommand(context.Context, string) (Command, fail.Error)
NewSudoCommand(context.Context, string) (Command, fail.Error)
WaitServerReady(context.Context, string, time.Duration) (string, fail.Error)
}
// Command defines an SSH command
type Command interface {
String() string
Close() fail.Error
RunWithTimeout(ctx context.Context, outs outputs.Enum, timeout time.Duration) (int, string, string, fail.Error)
}