|
| 1 | +package entity |
| 2 | + |
| 3 | +import ( |
| 4 | + "encoding/json" |
| 5 | + "fmt" |
| 6 | + "sync" |
| 7 | + |
| 8 | + "github.com/blang/semver/v4" |
| 9 | + "github.com/operator-framework/deppy/pkg/deppy/input" |
| 10 | + "github.com/operator-framework/operator-registry/alpha/property" |
| 11 | +) |
| 12 | + |
| 13 | +const PropertyBundlePath = "olm.bundle.path" |
| 14 | + |
| 15 | +type ChannelProperties struct { |
| 16 | + property.Channel |
| 17 | + Replaces string `json:"replaces,omitempty"` |
| 18 | + Skips []string `json:"skips,omitempty"` |
| 19 | + SkipRange string `json:"skipRange,omitempty"` |
| 20 | +} |
| 21 | + |
| 22 | +type PackageRequired struct { |
| 23 | + property.PackageRequired |
| 24 | + SemverRange *semver.Range `json:"-"` |
| 25 | +} |
| 26 | + |
| 27 | +type GVK property.GVK |
| 28 | + |
| 29 | +func (g GVK) String() string { |
| 30 | + return fmt.Sprintf(`group:"%s" version:"%s" kind:"%s"`, g.Group, g.Version, g.Kind) |
| 31 | +} |
| 32 | + |
| 33 | +type GVKRequired property.GVKRequired |
| 34 | + |
| 35 | +func (g GVKRequired) String() string { |
| 36 | + return fmt.Sprintf(`group:"%s" version:"%s" kind:"%s"`, g.Group, g.Version, g.Kind) |
| 37 | +} |
| 38 | + |
| 39 | +type BundleEntity struct { |
| 40 | + *input.Entity |
| 41 | + |
| 42 | + // these properties are lazy loaded as they are requested |
| 43 | + bundlePackage *property.Package |
| 44 | + providedGVKs []GVK |
| 45 | + requiredGVKs []GVKRequired |
| 46 | + requiredPackages []PackageRequired |
| 47 | + channelProperties *ChannelProperties |
| 48 | + semVersion *semver.Version |
| 49 | + bundlePath string |
| 50 | + mu sync.RWMutex |
| 51 | +} |
| 52 | + |
| 53 | +func NewBundleEntity(entity *input.Entity) *BundleEntity { |
| 54 | + return &BundleEntity{ |
| 55 | + Entity: entity, |
| 56 | + mu: sync.RWMutex{}, |
| 57 | + } |
| 58 | +} |
| 59 | + |
| 60 | +func (b *BundleEntity) PackageName() (string, error) { |
| 61 | + if err := b.loadPackage(); err != nil { |
| 62 | + return "", err |
| 63 | + } |
| 64 | + return b.bundlePackage.PackageName, nil |
| 65 | +} |
| 66 | + |
| 67 | +func (b *BundleEntity) Version() (*semver.Version, error) { |
| 68 | + if err := b.loadPackage(); err != nil { |
| 69 | + return nil, err |
| 70 | + } |
| 71 | + return b.semVersion, nil |
| 72 | +} |
| 73 | + |
| 74 | +func (b *BundleEntity) ProvidedGVKs() ([]GVK, error) { |
| 75 | + if err := b.loadProvidedGVKs(); err != nil { |
| 76 | + return nil, err |
| 77 | + } |
| 78 | + return b.providedGVKs, nil |
| 79 | +} |
| 80 | + |
| 81 | +func (b *BundleEntity) RequiredGVKs() ([]GVKRequired, error) { |
| 82 | + if err := b.loadRequiredGVKs(); err != nil { |
| 83 | + return nil, err |
| 84 | + } |
| 85 | + return b.requiredGVKs, nil |
| 86 | +} |
| 87 | + |
| 88 | +func (b *BundleEntity) RequiredPackages() ([]PackageRequired, error) { |
| 89 | + if err := b.loadRequiredPackages(); err != nil { |
| 90 | + return nil, err |
| 91 | + } |
| 92 | + return b.requiredPackages, nil |
| 93 | +} |
| 94 | + |
| 95 | +func (b *BundleEntity) ChannelName() (string, error) { |
| 96 | + if err := b.loadChannelProperties(); err != nil { |
| 97 | + return "", err |
| 98 | + } |
| 99 | + return b.channelProperties.ChannelName, nil |
| 100 | +} |
| 101 | + |
| 102 | +func (b *BundleEntity) ChannelProperties() (*ChannelProperties, error) { |
| 103 | + if err := b.loadChannelProperties(); err != nil { |
| 104 | + return nil, err |
| 105 | + } |
| 106 | + return b.channelProperties, nil |
| 107 | +} |
| 108 | + |
| 109 | +func (b *BundleEntity) BundlePath() (string, error) { |
| 110 | + if err := b.loadBundlePath(); err != nil { |
| 111 | + return "", err |
| 112 | + } |
| 113 | + return b.bundlePath, nil |
| 114 | +} |
| 115 | + |
| 116 | +func (b *BundleEntity) loadPackage() error { |
| 117 | + b.mu.Lock() |
| 118 | + defer b.mu.Unlock() |
| 119 | + if b.bundlePackage == nil { |
| 120 | + bundlePackage, err := loadFromEntity[property.Package](b.Entity, property.TypePackage) |
| 121 | + if err != nil { |
| 122 | + return fmt.Errorf("error determining package for entity '%s': %w", b.ID, err) |
| 123 | + } |
| 124 | + b.bundlePackage = &bundlePackage |
| 125 | + if b.semVersion == nil { |
| 126 | + semVer, err := semver.Parse(b.bundlePackage.Version) |
| 127 | + if err != nil { |
| 128 | + return fmt.Errorf("could not parse semver (%s) for entity '%s': %w", b.bundlePackage.Version, b.ID, err) |
| 129 | + } |
| 130 | + b.semVersion = &semVer |
| 131 | + } |
| 132 | + } |
| 133 | + return nil |
| 134 | +} |
| 135 | + |
| 136 | +func (b *BundleEntity) loadProvidedGVKs() error { |
| 137 | + b.mu.Lock() |
| 138 | + defer b.mu.Unlock() |
| 139 | + if b.providedGVKs == nil { |
| 140 | + providedGVKs, err := loadFromEntity[[]GVK](b.Entity, property.TypeGVK) |
| 141 | + if err != nil { |
| 142 | + return fmt.Errorf("error determining bundle provided gvks for entity '%s': %w", b.ID, err) |
| 143 | + } |
| 144 | + b.providedGVKs = providedGVKs |
| 145 | + } |
| 146 | + return nil |
| 147 | +} |
| 148 | + |
| 149 | +func (b *BundleEntity) loadRequiredGVKs() error { |
| 150 | + b.mu.Lock() |
| 151 | + defer b.mu.Unlock() |
| 152 | + if b.requiredGVKs == nil { |
| 153 | + requiredGVKs, err := loadFromEntity[[]GVKRequired](b.Entity, property.TypeGVKRequired) |
| 154 | + if err != nil { |
| 155 | + return fmt.Errorf("error determining bundle required gvks for entity '%s': %w", b.ID, err) |
| 156 | + } |
| 157 | + b.requiredGVKs = requiredGVKs |
| 158 | + } |
| 159 | + return nil |
| 160 | +} |
| 161 | + |
| 162 | +func (b *BundleEntity) loadRequiredPackages() error { |
| 163 | + b.mu.Lock() |
| 164 | + defer b.mu.Unlock() |
| 165 | + if b.requiredPackages == nil { |
| 166 | + requiredPackages, err := loadFromEntity[[]PackageRequired](b.Entity, property.TypePackageRequired) |
| 167 | + if err != nil { |
| 168 | + return fmt.Errorf("error determining bundle required packages for entity '%s': %w", b.ID, err) |
| 169 | + } |
| 170 | + for _, requiredPackage := range requiredPackages { |
| 171 | + semverRange, err := semver.ParseRange(requiredPackage.VersionRange) |
| 172 | + if err != nil { |
| 173 | + return fmt.Errorf("error determining bundle required package semver range for entity '%s': '%w'", b.ID, err) |
| 174 | + } |
| 175 | + requiredPackage.SemverRange = &semverRange |
| 176 | + } |
| 177 | + b.requiredPackages = requiredPackages |
| 178 | + } |
| 179 | + return nil |
| 180 | +} |
| 181 | + |
| 182 | +func (b *BundleEntity) loadChannelProperties() error { |
| 183 | + b.mu.Lock() |
| 184 | + defer b.mu.Unlock() |
| 185 | + if b.channelProperties == nil { |
| 186 | + channel, err := loadFromEntity[ChannelProperties](b.Entity, property.TypeChannel) |
| 187 | + if err != nil { |
| 188 | + return fmt.Errorf("error determining bundle channel properties for entity '%s': %w", b.ID, err) |
| 189 | + } |
| 190 | + b.channelProperties = &channel |
| 191 | + } |
| 192 | + return nil |
| 193 | +} |
| 194 | + |
| 195 | +func (b *BundleEntity) loadBundlePath() error { |
| 196 | + b.mu.Lock() |
| 197 | + defer b.mu.Unlock() |
| 198 | + if b.bundlePath == "" { |
| 199 | + bundlePath, err := loadFromEntity[string](b.Entity, PropertyBundlePath) |
| 200 | + if err != nil { |
| 201 | + return fmt.Errorf("error determining bundle path for entity '%s': %w", b.ID, err) |
| 202 | + } |
| 203 | + b.bundlePath = bundlePath |
| 204 | + } |
| 205 | + return nil |
| 206 | +} |
| 207 | + |
| 208 | +func loadFromEntity[T interface{}](entity *input.Entity, propertyName string) (T, error) { |
| 209 | + deserializedProperty := *new(T) |
| 210 | + propertyValue, ok := entity.Properties[propertyName] |
| 211 | + if !ok { |
| 212 | + return deserializedProperty, fmt.Errorf("property '%s' not found", propertyName) |
| 213 | + } |
| 214 | + |
| 215 | + if err := json.Unmarshal([]byte(propertyValue), &deserializedProperty); err != nil { |
| 216 | + return deserializedProperty, fmt.Errorf("property '%s' ('%s') could not be parsed: %w", propertyName, propertyValue, err) |
| 217 | + } |
| 218 | + return deserializedProperty, nil |
| 219 | +} |
0 commit comments