-
Notifications
You must be signed in to change notification settings - Fork 36
/
factory.go
189 lines (166 loc) · 5.18 KB
/
factory.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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
package command
import (
"io"
"go.uber.org/zap"
"github.com/stateful/runme/v3/internal/dockerexec"
"github.com/stateful/runme/v3/internal/project"
"github.com/stateful/runme/v3/internal/ulid"
runnerv2alpha1 "github.com/stateful/runme/v3/pkg/api/gen/proto/go/runme/runner/v2alpha1"
)
type CommandOptions struct {
// EnableEcho enables the echo when typing in the terminal.
// It's respected only by interactive commands, i.e. composed
// with [virtualCommand].
EnableEcho bool
Session *Session
StdinWriter io.Writer
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
}
type Factory interface {
Build(*ProgramConfig, CommandOptions) Command
}
type FactoryOption func(*commandFactory)
func WithDocker(docker *dockerexec.Docker) FactoryOption {
return func(f *commandFactory) {
f.docker = docker
}
}
func WithLogger(logger *zap.Logger) FactoryOption {
return func(f *commandFactory) {
f.logger = logger
}
}
func WithProject(proj *project.Project) FactoryOption {
return func(f *commandFactory) {
f.project = proj
}
}
func NewFactory(opts ...FactoryOption) Factory {
f := &commandFactory{}
for _, opt := range opts {
opt(f)
}
return f
}
type commandFactory struct {
docker *dockerexec.Docker // used only for [dockerCommand]
logger *zap.Logger
project *project.Project
}
// Build creates a new command based on the provided [ProgramConfig] and [CommandOptions].
//
// There are three types of commands that are :
// - [base] - the base command that is used by all other commands. It provides
// generic, runtime agnostic functionality. It's not fully functional, though.
// - [nativeCommand], [virtualCommand], and [dockerCommand] - are mid-layer commands
// built on top of the [base] command. They are fully functional, but they
// don't really fit any real world use case. They are runtime specific.
// - [inlineCommand], [inlineShellCommand], [terminalCommand], and [fileCommand] - are
// high-level commands that are built on top of the mid-layer commands. They implement
// real world use cases and are fully functional and can be used by callers.
func (f *commandFactory) Build(cfg *ProgramConfig, opts CommandOptions) Command {
mode := cfg.Mode
// For backward compatibility, if the mode is not specified,
// we will try to infer it from the language. If it's shell,
// we default it to inline.
if mode == runnerv2alpha1.CommandMode_COMMAND_MODE_UNSPECIFIED && isShell(cfg) {
mode = runnerv2alpha1.CommandMode_COMMAND_MODE_INLINE
}
// Session should be always available. If non is provided,
// return a new one.
if opts.Session == nil {
opts.Session = NewSession()
}
switch mode {
case runnerv2alpha1.CommandMode_COMMAND_MODE_INLINE:
if isShell(cfg) {
return &inlineShellCommand{
internalCommand: f.buildInternal(cfg, opts),
logger: f.getLogger("InlineShellCommand"),
session: opts.Session,
}
}
return &inlineCommand{
internalCommand: f.buildInternal(cfg, opts),
logger: f.getLogger("InlineCommand"),
}
case runnerv2alpha1.CommandMode_COMMAND_MODE_TERMINAL:
// For terminal commands, we always want them to be interactive.
cfg.Interactive = true
// And echo typed characters.
opts.EnableEcho = true
return &terminalCommand{
internalCommand: f.buildVirtual(f.buildBase(cfg, opts), opts),
logger: f.getLogger("TerminalCommand"),
session: opts.Session,
stdinWriter: opts.StdinWriter,
}
case runnerv2alpha1.CommandMode_COMMAND_MODE_FILE:
fallthrough
default:
return &fileCommand{
internalCommand: f.buildInternal(cfg, opts),
logger: f.getLogger("FileCommand"),
}
}
}
func (f *commandFactory) buildBase(cfg *ProgramConfig, opts CommandOptions) *base {
var runtime runtime
if f.docker != nil {
runtime = &dockerRuntime{Docker: f.docker}
} else {
runtime = &hostRuntime{}
}
return &base{
cfg: cfg,
project: f.project,
runtime: runtime,
session: opts.Session,
stdin: opts.Stdin,
stdinWriter: opts.StdinWriter,
stdout: opts.Stdout,
stderr: opts.Stderr,
}
}
func (f *commandFactory) buildInternal(cfg *ProgramConfig, opts CommandOptions) internalCommand {
base := f.buildBase(cfg, opts)
switch {
case f.docker != nil:
return f.buildDocker(base)
case base.Interactive():
return f.buildVirtual(base, opts)
default:
return f.buildNative(base)
}
}
func (f *commandFactory) buildDocker(base *base) internalCommand {
return &dockerCommand{
base: base,
docker: f.docker,
logger: f.getLogger("DockerCommand"),
}
}
func (f *commandFactory) buildNative(base *base) internalCommand {
return &nativeCommand{
base: base,
logger: f.getLogger("NativeCommand"),
}
}
func (f *commandFactory) buildVirtual(base *base, opts CommandOptions) internalCommand {
var stdin io.ReadCloser
if in := base.Stdin(); !isNil(in) {
stdin = &readCloser{r: in, done: make(chan struct{})}
}
return &virtualCommand{
base: base,
isEchoEnabled: opts.EnableEcho,
logger: f.getLogger("VirtualCommand"),
stdin: stdin,
}
}
func (f *commandFactory) getLogger(name string) *zap.Logger {
id := ulid.GenerateID()
return f.logger.Named(name).With(zap.String("instanceID", id))
}