-
Notifications
You must be signed in to change notification settings - Fork 47
/
types.go
181 lines (158 loc) · 4.8 KB
/
types.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
package catalogmetadata
import (
"encoding/json"
"fmt"
"sync"
bsemver "github.com/blang/semver/v4"
"github.com/operator-framework/operator-registry/alpha/declcfg"
"github.com/operator-framework/operator-registry/alpha/property"
)
type Schemas interface {
Package | Bundle | Channel | Deprecation
}
type Package struct {
declcfg.Package
}
type Channel struct {
declcfg.Channel
}
type Deprecation struct {
declcfg.Deprecation
}
type PackageRequired struct {
property.PackageRequired
SemverRange bsemver.Range `json:"-"`
}
type Bundle struct {
declcfg.Bundle
CatalogName string
InChannels []*Channel
Deprecations []declcfg.DeprecationEntry
mu sync.RWMutex
// these properties are lazy loaded as they are requested
propertiesMap map[string][]*property.Property
bundlePackage *property.Package
semVersion *bsemver.Version
requiredPackages []PackageRequired
}
func (b *Bundle) Version() (*bsemver.Version, error) {
if err := b.loadPackage(); err != nil {
return nil, err
}
return b.semVersion, nil
}
func (b *Bundle) RequiredPackages() ([]PackageRequired, error) {
if err := b.loadRequiredPackages(); err != nil {
return nil, err
}
return b.requiredPackages, nil
}
func (b *Bundle) loadPackage() error {
b.mu.Lock()
defer b.mu.Unlock()
if b.bundlePackage == nil {
bundlePackage, err := loadOneFromProps[property.Package](b, property.TypePackage, true)
if err != nil {
return err
}
b.bundlePackage = &bundlePackage
}
if b.semVersion == nil {
semVer, err := bsemver.Parse(b.bundlePackage.Version)
if err != nil {
return fmt.Errorf("could not parse semver %q for bundle '%s': %s", b.bundlePackage.Version, b.Name, err)
}
b.semVersion = &semVer
}
return nil
}
func (b *Bundle) loadRequiredPackages() error {
b.mu.Lock()
defer b.mu.Unlock()
if b.requiredPackages == nil {
requiredPackages, err := loadFromProps[PackageRequired](b, property.TypePackageRequired, false)
if err != nil {
return fmt.Errorf("error determining bundle required packages for bundle %q: %s", b.Name, err)
}
for i := range requiredPackages {
semverRange, err := bsemver.ParseRange(requiredPackages[i].VersionRange)
if err != nil {
return fmt.Errorf(
"error parsing bundle required package semver range for bundle %q (required package %q): %s",
b.Name,
requiredPackages[i].PackageName,
err,
)
}
requiredPackages[i].SemverRange = semverRange
}
b.requiredPackages = requiredPackages
}
return nil
}
func (b *Bundle) propertiesByType(propType string) []*property.Property {
if b.propertiesMap == nil {
b.propertiesMap = make(map[string][]*property.Property)
for i := range b.Properties {
prop := b.Properties[i]
b.propertiesMap[prop.Type] = append(b.propertiesMap[prop.Type], &prop)
}
}
return b.propertiesMap[propType]
}
// HasDeprecation returns true if the bundle
// has any deprecations associated with it.
// This may return true even in cases where the bundle
// may be associated with an olm.channel deprecation
// but the bundle is not considered "deprecated" because
// the bundle is selected via a non-deprecated channel.
func (b *Bundle) HasDeprecation() bool {
return len(b.Deprecations) > 0
}
// IsDeprecated returns true if the bundle
// has been explicitly deprecated. This can occur
// if the bundle itself has been deprecated.
// this function does not take into consideration
// olm.channel or olm.package deprecations associated
// with the bundle as a bundle can be present in multiple
// channels with some channels being deprecated and some not
// Package deprecation does not carry the same meaning as an individual
// bundle deprecation, so package deprecation is not considered.
func (b *Bundle) IsDeprecated() bool {
for _, dep := range b.Deprecations {
if dep.Reference.Schema == declcfg.SchemaBundle && dep.Reference.Name == b.Name {
return true
}
}
return false
}
func loadOneFromProps[T any](bundle *Bundle, propType string, required bool) (T, error) {
r, err := loadFromProps[T](bundle, propType, required)
if err != nil {
return *new(T), err
}
if len(r) > 1 {
return *new(T), fmt.Errorf("expected 1 instance of property with type %q, got %d", propType, len(r))
}
if !required && len(r) == 0 {
return *new(T), nil
}
return r[0], nil
}
func loadFromProps[T any](bundle *Bundle, propType string, required bool) ([]T, error) {
props := bundle.propertiesByType(propType)
if len(props) != 0 {
result := []T{}
for i := range props {
parsedProp := *new(T)
if err := json.Unmarshal(props[i].Value, &parsedProp); err != nil {
return nil, fmt.Errorf("property %q with value %q could not be parsed: %s", propType, props[i].Value, err)
}
result = append(result, parsedProp)
}
return result, nil
} else if required {
return nil, fmt.Errorf("bundle property with type %q not found", propType)
}
return nil, nil
}