-
Notifications
You must be signed in to change notification settings - Fork 35
/
driver.go
103 lines (90 loc) · 3.44 KB
/
driver.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
package driver
import (
"fmt"
"io"
"github.com/cnabio/cnab-go/bundle"
)
// ImageType constants provide some of the image types supported
// TODO: I think we can remove all but Docker, since the rest are supported externally
const (
ImageTypeDocker = "docker"
ImageTypeOCI = "oci"
ImageTypeQCOW = "qcow"
)
// Operation describes the data passed into the driver to run an operation
type Operation struct {
// Installation is the name of this installation
Installation string `json:"installation_name"`
// The revision ID for this installation
Revision string `json:"revision"`
// Action is the action to be performed
Action string `json:"action"`
// Parameters are the parameters to be injected into the container
Parameters map[string]interface{} `json:"parameters"`
// Image is the invocation image
Image bundle.InvocationImage `json:"image"`
// Environment contains environment variables that should be injected into the invocation image
Environment map[string]string `json:"environment"`
// Files contains files that should be injected into the invocation image.
Files map[string]string `json:"files"`
// Outputs map of output paths (e.g. /cnab/app/outputs/NAME) to the name of the output.
// Indicates which outputs the driver should return the contents of in the OperationResult.
Outputs map[string]string `json:"outputs"`
// Output stream for log messages from the driver
Out io.Writer `json:"-"`
// Output stream for error messages from the driver
Err io.Writer `json:"-"`
// Bundle represents the bundle information for use by the operation
Bundle *bundle.Bundle
}
// ResolvedCred is a credential that has been resolved and is ready for injection into the runtime.
type ResolvedCred struct {
Type string `json:"type"`
Name string `json:"name"`
Value string `json:"value"`
}
// OperationResult is the output of the Driver running an Operation.
type OperationResult struct {
// Outputs maps from the name of the output to its content.
Outputs map[string]string
// Error is any errors from executing the operation.
Error error
}
// SetDefaultOutputValues for an output when it does not exist and it has a
// non-empty default value.
func (r *OperationResult) SetDefaultOutputValues(op Operation) error {
if r.Outputs == nil {
r.Outputs = make(map[string]string)
}
for name, output := range op.Bundle.Outputs {
_, hasOutput := r.Outputs[name]
if hasOutput || !output.AppliesTo(op.Action) {
continue
}
if outputDefinition, exists := op.Bundle.Definitions[output.Definition]; exists {
outputDefault := outputDefinition.Default
if outputDefault != nil {
contents := fmt.Sprintf("%v", outputDefault)
r.Outputs[name] = contents
} else {
return fmt.Errorf("required output %s is missing and has no default", name)
}
}
}
return nil
}
// Driver is capable of running a invocation image
type Driver interface {
// Run executes the operation inside of the invocation image
Run(*Operation) (OperationResult, error)
// Handles receives an ImageType* and answers whether this driver supports that type
Handles(string) bool
}
// Configurable drivers can explain their configuration, and have it explicitly set
type Configurable interface {
// Config returns a map of configuration names and values that can be set via environment variable
Config() map[string]string
// SetConfig allows setting configuration, where name corresponds to the key in Config, and value is
// the value to be set.
SetConfig(map[string]string) error
}