Skip to content

fix: omit unset variables without defaults from Fleet API requests #2980

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: omit unset variables without defaults from Fleet API requests #2980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions internal/packages/archetype/data_stream_inputs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ func unpackVars(output *[]packages.Variable, input []InputVariable) {
newVar.MaxDuration = inputVar.MaxDuration
newVar.Description = inputVar.Description
if inputVar.Default != nil {
newVar.Default = &packages.VarValue{}
newVar.Default.Unpack(inputVar.Default)
}
*output = append(*output, newVar)
Expand Down
26 changes: 13 additions & 13 deletions internal/packages/packages.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,19 +102,19 @@ func VarValueYamlString(vv VarValue, field string, numSpaces ...int) string {

// Variable is an instance of configuration variable (named, typed).
type Variable struct {
Name string `config:"name" json:"name" yaml:"name"`
Type string `config:"type" json:"type" yaml:"type"`
Title string `config:"title" json:"title" yaml:"title"`
Description string `config:"description" json:"description" yaml:"description"`
Multi bool `config:"multi" json:"multi" yaml:"multi"`
Required bool `config:"required" json:"required" yaml:"required"`
Secret bool `config:"secret" json:"secret" yaml:"secret"`
ShowUser bool `config:"show_user" json:"show_user" yaml:"show_user"`
HideInDeploymentModes []string `config:"hide_in_deployment_modes" json:"hide_in_deployment_modes" yaml:"hide_in_deployment_modes"`
UrlAllowedSchemes []string `config:"url_allowed_schemes" json:"url_allowed_schemes" yaml:"url_allowed_schemes"`
MinDuration string `config:"min_duration" json:"min_duration" yaml:"min_duration"`
MaxDuration string `config:"max_duration" json:"max_duration" yaml:"max_duration"`
Default VarValue `config:"default" json:"default" yaml:"default"`
Name string `config:"name" json:"name" yaml:"name"`
Type string `config:"type" json:"type" yaml:"type"`
Title string `config:"title" json:"title" yaml:"title"`
Description string `config:"description" json:"description" yaml:"description"`
Multi bool `config:"multi" json:"multi" yaml:"multi"`
Required bool `config:"required" json:"required" yaml:"required"`
Secret bool `config:"secret" json:"secret" yaml:"secret"`
ShowUser bool `config:"show_user" json:"show_user" yaml:"show_user"`
HideInDeploymentModes []string `config:"hide_in_deployment_modes" json:"hide_in_deployment_modes" yaml:"hide_in_deployment_modes"`
UrlAllowedSchemes []string `config:"url_allowed_schemes" json:"url_allowed_schemes" yaml:"url_allowed_schemes"`
MinDuration string `config:"min_duration" json:"min_duration" yaml:"min_duration"`
MaxDuration string `config:"max_duration" json:"max_duration" yaml:"max_duration"`
Default *VarValue `config:"default" json:"default" yaml:"default"`
}

// Input is a single input configuration.
Expand Down
11 changes: 9 additions & 2 deletions internal/resources/fleetpolicy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,17 +312,24 @@ func createInputPackagePolicy(policy FleetAgentPolicy, manifest packages.Package
func setKibanaVariables(definitions []packages.Variable, values common.MapStr) kibana.Vars {
vars := kibana.Vars{}
for _, definition := range definitions {
// Elastic Package uses the deprecated 'inputs' array in its /api/fleet/package_policies request.
// When using this API parameter, default values are not automatically incorporated into
// the policy, whereas with the 'inputs' object, defaults are incorporated by the API service.
// This means that our client must include the default values in its request to ensure correct behavior.
val := definition.Default

value, err := values.GetValue(definition.Name)
if err == nil {
val = packages.VarValue{}
val = &packages.VarValue{}
val.Unpack(value)
} else if errors.Is(err, common.ErrKeyNotFound) && definition.Default == nil {
// Do not include nulls for unset variables.
continue
}

vars[definition.Name] = kibana.Var{
Type: definition.Type,
Value: val,
Value: *val,
}
}
return vars
Expand Down
11 changes: 9 additions & 2 deletions internal/testrunner/runners/system/tester.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2042,17 +2042,24 @@ func createInputPackageDatastream(
func setKibanaVariables(definitions []packages.Variable, values common.MapStr) kibana.Vars {
vars := kibana.Vars{}
for _, definition := range definitions {
// Elastic Package uses the deprecated 'inputs' array in its /api/fleet/package_policies request.
// When using this API parameter, default values are not automatically incorporated into
// the policy, whereas with the 'inputs' object, defaults are incorporated by the API service.
// This means that our client must include the default values in its request to ensure correct behavior.
val := definition.Default

value, err := values.GetValue(definition.Name)
if err == nil {
val = packages.VarValue{}
val = &packages.VarValue{}
val.Unpack(value)
} else if errors.Is(err, common.ErrKeyNotFound) && definition.Default == nil {
// Do not include nulls for unset variables.
continue
}

vars[definition.Name] = kibana.Var{
Type: definition.Type,
Value: val,
Value: *val,
}
}
return vars
Expand Down