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.

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

Jump to bottom

helper/schema: Adjusted validation error messages #755

Merged
merged 1 commit into from
Apr 30, 2021
Merged

helper/schema: Adjusted validation error messages #755

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
34 changes: 17 additions & 17 deletions helper/schema/schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1439,7 +1439,7 @@ func (m schemaMap) validate(
if err != nil {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "Loading Default",
Summary: "Failed to determine default value",
Detail: err.Error(),
AttributePath: path,
})
Expand All @@ -1453,7 +1453,7 @@ func (m schemaMap) validate(
if err != nil {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "ExactlyOne",
Summary: "Invalid combination of arguments",
Detail: err.Error(),
AttributePath: path,
})
Expand All @@ -1463,7 +1463,7 @@ func (m schemaMap) validate(
if err != nil {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "AtLeastOne",
Summary: "Missing required argument",
Detail: err.Error(),
AttributePath: path,
})
Expand All @@ -1485,8 +1485,8 @@ func (m schemaMap) validate(
// This is a computed-only field
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "Computed attributes cannot be set",
Detail: fmt.Sprintf("Computed attributes cannot be set, but a value was set for %q.", k),
Summary: "Value for unconfigurable attribute",
Detail: fmt.Sprintf("Can't configure a value for %q: its value will be decided automatically based on the result of applying this configuration.", k),
AttributePath: path,
})
}
Expand All @@ -1495,7 +1495,7 @@ func (m schemaMap) validate(
if err != nil {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "RequiredWith",
Summary: "Missing required argument",
Detail: err.Error(),
AttributePath: path,
})
Expand All @@ -1510,7 +1510,7 @@ func (m schemaMap) validate(
if schema.Deprecated != "" {
return append(diags, diag.Diagnostic{
Severity: diag.Warning,
Summary: "Attribute is deprecated",
Summary: "Argument is deprecated",
Detail: schema.Deprecated,
AttributePath: path,
})
Expand All @@ -1522,7 +1522,7 @@ func (m schemaMap) validate(
if err != nil {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "ConflictsWith",
Summary: "Conflicting configuration arguments",
Detail: err.Error(),
AttributePath: path,
})
Expand Down Expand Up @@ -1699,7 +1699,7 @@ func (m schemaMap) validateList(
if rawV.Kind() != reflect.Slice {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "Attribute should be a list",
Summary: "Attribute must be a list",
AttributePath: path,
})
}
Expand All @@ -1717,17 +1717,17 @@ func (m schemaMap) validateList(
if schema.MaxItems > 0 && rawV.Len() > schema.MaxItems {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "List longer than MaxItems",
Detail: fmt.Sprintf("Attribute supports %d item maximum, config has %d declared", schema.MaxItems, rawV.Len()),
Summary: "Too many list items",
Detail: fmt.Sprintf("Attribute supports %d item maximum, but config has %d declared.", schema.MaxItems, rawV.Len()),
AttributePath: path,
})
}

if schema.MinItems > 0 && rawV.Len() < schema.MinItems {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "List shorter than MinItems",
Detail: fmt.Sprintf("Attribute supports %d item minimum, config has %d declared", schema.MinItems, rawV.Len()),
Summary: "Not enough list items",
Detail: fmt.Sprintf("Attribute requires %d item minimum, but config has only %d declared.", schema.MinItems, rawV.Len()),
AttributePath: path,
})
}
Expand Down Expand Up @@ -1794,7 +1794,7 @@ func (m schemaMap) validateMap(
if reifiedOk && raw == reified && !c.IsComputed(k) {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "Attribute should be a map",
Summary: "Attribute must be a map",
AttributePath: path,
})
}
Expand All @@ -1805,7 +1805,7 @@ func (m schemaMap) validateMap(
default:
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "Attribute should be a map",
Summary: "Attribute must be a map",
AttributePath: path,
})
}
Expand All @@ -1832,7 +1832,7 @@ func (m schemaMap) validateMap(
if v.Kind() != reflect.Map {
return append(diags, diag.Diagnostic{
Severity: diag.Error,
Summary: "Attribute should be a map",
Summary: "Attribute must be a map",
AttributePath: path,
})
}
Expand Down Expand Up @@ -2111,7 +2111,7 @@ func (m schemaMap) validateType(
if schema.Deprecated != "" {
diags = append(diags, diag.Diagnostic{
Severity: diag.Warning,
Summary: "Deprecated Attribute",
Summary: "Argument is deprecated",
Detail: schema.Deprecated,
AttributePath: path,
})
Expand Down
30 changes: 15 additions & 15 deletions helper/schema/schema_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5506,7 +5506,7 @@ func TestSchemaMap_Validate(t *testing.T) {

Err: true,
Errors: []error{
fmt.Errorf("Error: Attribute should be a list"),
fmt.Errorf("Error: Attribute must be a list"),
},
},

Expand All @@ -5527,7 +5527,7 @@ func TestSchemaMap_Validate(t *testing.T) {

Err: true,
Errors: []error{
fmt.Errorf("Error: Attribute should be a list"),
fmt.Errorf("Error: Attribute must be a list"),
},
},

Expand Down Expand Up @@ -5563,7 +5563,7 @@ func TestSchemaMap_Validate(t *testing.T) {
},

Warnings: []string{
"Warning: Attribute is deprecated: please use 'new_news' instead",
"Warning: Argument is deprecated: please use 'new_news' instead",
},
},

Expand Down Expand Up @@ -5953,7 +5953,7 @@ func TestSchemaMap_Validate(t *testing.T) {
Err: false,

Warnings: []string{
"Warning: Deprecated Attribute: please use 'new_news' instead",
"Warning: Argument is deprecated: please use 'new_news' instead",
},
},

Expand Down Expand Up @@ -5991,7 +5991,7 @@ func TestSchemaMap_Validate(t *testing.T) {

Err: true,
Errors: []error{
fmt.Errorf(`Error: ConflictsWith: "blacklist": conflicts with whitelist`),
fmt.Errorf(`Error: Conflicting configuration arguments: "blacklist": conflicts with whitelist`),
},
},

Expand Down Expand Up @@ -6087,8 +6087,8 @@ func TestSchemaMap_Validate(t *testing.T) {

Err: true,
Errors: []error{
fmt.Errorf(`Error: ConflictsWith: "blacklist": conflicts with greenlist`),
fmt.Errorf(`Error: ConflictsWith: "greenlist": conflicts with blacklist`),
fmt.Errorf(`Error: Conflicting configuration arguments: "blacklist": conflicts with greenlist`),
fmt.Errorf(`Error: Conflicting configuration arguments: "greenlist": conflicts with blacklist`),
},
},

Expand Down Expand Up @@ -6132,7 +6132,7 @@ func TestSchemaMap_Validate(t *testing.T) {

Err: true,
Errors: []error{
fmt.Errorf(`Error: ConflictsWith: "optional_att": conflicts with required_att`),
fmt.Errorf(`Error: Conflicting configuration arguments: "optional_att": conflicts with required_att`),
},
},

Expand All @@ -6159,8 +6159,8 @@ func TestSchemaMap_Validate(t *testing.T) {

Err: true,
Errors: []error{
fmt.Errorf(`Error: ConflictsWith: "bar_att": conflicts with foo_att`),
fmt.Errorf(`Error: ConflictsWith: "foo_att": conflicts with bar_att`),
fmt.Errorf(`Error: Conflicting configuration arguments: "bar_att": conflicts with foo_att`),
fmt.Errorf(`Error: Conflicting configuration arguments: "foo_att": conflicts with bar_att`),
},
},

Expand Down Expand Up @@ -6528,7 +6528,7 @@ func TestSchemaMap_Validate(t *testing.T) {

ws := diagutils.WarningDiags(diags).Warnings()
if !reflect.DeepEqual(ws, tc.Warnings) {
t.Fatalf("%q: warnings:\n\nexpected: %#v\ngot:%#v", tn, tc.Warnings, ws)
t.Fatalf("%q: warnings:\n\ngot: %#v\nwant: %#v", tn, ws, tc.Warnings)
}

es := diagutils.ErrorDiags(diags).Errors()
Expand All @@ -6537,7 +6537,7 @@ func TestSchemaMap_Validate(t *testing.T) {
sort.Sort(errorSort(tc.Errors))

if !errorEquals(es, tc.Errors) {
t.Fatalf("%q: errors:\n\nexpected: %q\ngot: %q", tn, tc.Errors, es)
t.Fatalf("%q: errors:\n\ngot: %q\nwant: %q", tn, es, tc.Errors)
}
}
})
Expand Down Expand Up @@ -6583,7 +6583,7 @@ func TestSchemaSet_ValidateMaxItems(t *testing.T) {
Diff: nil,
Err: true,
Errors: []error{
fmt.Errorf("Error: List longer than MaxItems: Attribute supports 1 item maximum, config has 2 declared"),
fmt.Errorf("Error: Too many list items: Attribute supports 1 item maximum, but config has 2 declared."),
},
},
"#1": {
Expand Down Expand Up @@ -6705,7 +6705,7 @@ func TestSchemaSet_ValidateMinItems(t *testing.T) {
Diff: nil,
Err: true,
Errors: []error{
fmt.Errorf("Error: List shorter than MinItems: Attribute supports 2 item minimum, config has 1 declared"),
fmt.Errorf("Error: Not enough list items: Attribute requires 2 item minimum, but config has only 1 declared."),
},
},
}
Expand All @@ -6729,7 +6729,7 @@ func TestSchemaSet_ValidateMinItems(t *testing.T) {
es := diagutils.ErrorDiags(diags).Errors()
if tc.Errors != nil {
if !errorEquals(es, tc.Errors) {
t.Fatalf("%q: expected: %q\ngot: %q", tn, tc.Errors, es)
t.Fatalf("%q: wrong errors\ngot: %q\nwant: %q", tn, es, tc.Errors)
}
}
}
Expand Down