Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaces priority #1166

Merged
merged 4 commits into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions pkg/build/package.go
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,9 @@ replaces = {{ $dep }}
{{- if .Dependencies.ProviderPriority }}
provider_priority = {{ .Dependencies.ProviderPriority }}
{{- end }}
{{- if .Dependencies.ReplacesPriority }}
replaces_priority = {{ .Dependencies.ReplacesPriority }}
{{- end }}
{{- if .Scriptlets.Trigger.Paths }}
triggers = {{ range $item := .Scriptlets.Trigger.Paths }}{{ $item }} {{ end }}
{{- end }}
Expand Down
60 changes: 55 additions & 5 deletions pkg/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,30 @@ func (cfg *Configuration) applySubstitutionsForProvides() error {
return nil
}

func (cfg *Configuration) applySubstitutionsForPriorities() error {
nw := buildConfigMap(cfg)
var err error
cfg.Package.Dependencies.ProviderPriority, err = util.MutateStringFromMap(nw, cfg.Package.Dependencies.ProviderPriority)
if err != nil {
return fmt.Errorf("failed to apply replacement to provides %q: %w", cfg.Package.Dependencies.ProviderPriority, err)
}
cfg.Package.Dependencies.ReplacesPriority, err = util.MutateStringFromMap(nw, cfg.Package.Dependencies.ReplacesPriority)
if err != nil {
return fmt.Errorf("failed to apply replacement to provides %q: %w", cfg.Package.Dependencies.ReplacesPriority, err)
}
for _, sp := range cfg.Subpackages {
sp.Dependencies.ProviderPriority, err = util.MutateStringFromMap(nw, sp.Dependencies.ProviderPriority)
if err != nil {
return fmt.Errorf("failed to apply replacement to provides %q: %w", sp.Dependencies.ProviderPriority, err)
}
sp.Dependencies.ReplacesPriority, err = util.MutateStringFromMap(nw, sp.Dependencies.ReplacesPriority)
if err != nil {
return fmt.Errorf("failed to apply replacement to provides %q: %w", sp.Dependencies.ReplacesPriority, err)
}
}
return nil
}

func (cfg *Configuration) applySubstitutionsForRuntime() error {
nw := buildConfigMap(cfg)
for i, runtime := range cfg.Package.Dependencies.Runtime {
Expand Down Expand Up @@ -514,9 +538,12 @@ type Dependencies struct {
Provides []string `json:"provides,omitempty" yaml:"provides,omitempty"`
// Optional: List of replace objectives
Replaces []string `json:"replaces,omitempty" yaml:"replaces,omitempty"`
// Optional: An integer compared against other equal package provides used to
// determine priority
ProviderPriority int `json:"provider-priority,omitempty" yaml:"provider-priority,omitempty"`
// Optional: An integer string compared against other equal package provides used to
// determine priority of provides
ProviderPriority string `json:"provider-priority,omitempty" yaml:"provider-priority,omitempty"`
// Optional: An integer string compared against other equal package provides used to
// determine priority of file replacements
ReplacesPriority string `json:"replaces-priority,omitempty" yaml:"replaces-priority,omitempty"`

// List of self-provided dependencies found outside of lib directories
// ("lib", "usr/lib", "lib64", or "usr/lib64").
Expand Down Expand Up @@ -762,7 +789,8 @@ func ParseConfiguration(ctx context.Context, configurationFilePath string, opts
Runtime: replaceAll(replacer, sp.Dependencies.Runtime),
Provides: replaceAll(replacer, sp.Dependencies.Provides),
Replaces: replaceAll(replacer, sp.Dependencies.Replaces),
ProviderPriority: sp.Dependencies.ProviderPriority,
ProviderPriority: replacer.Replace(sp.Dependencies.ProviderPriority),
ReplacesPriority: replacer.Replace(sp.Dependencies.ReplacesPriority),
},
Options: sp.Options,
Scriptlets: Scriptlets{
Expand Down Expand Up @@ -935,6 +963,9 @@ func ParseConfiguration(ctx context.Context, configurationFilePath string, opts
if err := cfg.applySubstitutionsForPackages(); err != nil {
return nil, err
}
if err := cfg.applySubstitutionsForPriorities(); err != nil {
return nil, err
}

// Propagate all child pipelines
cfg.propagatePipelines()
Expand Down Expand Up @@ -986,6 +1017,9 @@ func (cfg Configuration) validate() error {

// TODO: try to validate value of .package.version

if err := validateDependenciesPriorities(cfg.Package.Dependencies); err != nil {
return ErrInvalidConfiguration{Problem: errors.New("prioritiy must convert to integer")}
}
if err := validatePipelines(cfg.Pipeline); err != nil {
return ErrInvalidConfiguration{Problem: err}
}
Expand All @@ -994,7 +1028,9 @@ func (cfg Configuration) validate() error {
if !packageNameRegex.MatchString(sp.Name) {
return ErrInvalidConfiguration{Problem: fmt.Errorf("subpackage name %q (subpackages index: %d) must match regex %q", sp.Name, i, packageNameRegex)}
}

if err := validateDependenciesPriorities(sp.Dependencies); err != nil {
return ErrInvalidConfiguration{Problem: errors.New("prioritiy must convert to integer")}
}
if err := validatePipelines(sp.Pipeline); err != nil {
return ErrInvalidConfiguration{Problem: err}
}
Expand All @@ -1020,6 +1056,20 @@ func validatePipelines(ps []Pipeline) error {
return nil
}

func validateDependenciesPriorities(deps Dependencies) error {
priorities := []string{deps.ProviderPriority, deps.ProviderPriority}
for _, priority := range priorities {
if priority == "" {
continue
}
_, err := strconv.Atoi(priority)
if err != nil {
return err
}
}
return nil
}

// PackageURLs returns a list of package URLs ("purls") for the given
// configuration. The first PURL is always the origin package, and any subsequent
// items are the PURLs for the Configuration's subpackages. For more information
Expand Down
8 changes: 6 additions & 2 deletions pkg/config/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,12 @@
"description": "Optional: List of replace objectives"
},
"provider-priority": {
"type": "integer",
"description": "Optional: An integer compared against other equal package provides used to\ndetermine priority"
"type": "string",
"description": "Optional: An integer string compared against other equal package provides used to\ndetermine priority of provides"
},
"replaces-priority": {
"type": "string",
"description": "Optional: An integer string compared against other equal package provides used to\ndetermine priority of file replacements"
}
},
"additionalProperties": false,
Expand Down