Skip to content

Update platform.txt schema to account for the *_remote tools #141

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

Merged
merged 1 commit into from
Jan 8, 2021
Merged

Update platform.txt schema to account for the *_remote tools #141

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
44 changes: 41 additions & 3 deletions etc/schemas/arduino-platform-txt-definitions-schema.json
View file
Original file line number Diff line number Diff line change
@@ -851,7 +851,7 @@
"$ref": "#/definitions/propertiesObjects/toolsToolNameUpload/base/object"
},
{
"$ref": "#/definitions/requiredObjects/toolsToolNameActionName/permissive/object"
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/permissive/object"
}
]
}
@@ -863,7 +863,7 @@
"$ref": "#/definitions/propertiesObjects/toolsToolNameUpload/base/object"
},
{
"$ref": "#/definitions/requiredObjects/toolsToolNameActionName/specification/object"
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/specification/object"
}
]
}
@@ -875,7 +875,7 @@
"$ref": "#/definitions/propertiesObjects/toolsToolNameUpload/base/object"
},
{
"$ref": "#/definitions/requiredObjects/toolsToolNameActionName/strict/object"
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/strict/object"
}
]
}
@@ -1168,6 +1168,44 @@
]
}
}
},
"toolsToolNameUpload": {
"base": {
"object": {
"allOf": [
{
"required": ["pattern"]
}
]
}
},
"permissive": {
"object": {
"allOf": [
{
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/base/object"
}
]
}
},
"specification": {
"object": {
"allOf": [
{
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/base/object"
}
]
}
},
"strict": {
"object": {
"allOf": [
{
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/base/object"
}
]
}
}
}
}
}
27 changes: 13 additions & 14 deletions internal/project/platform/platformtxt/platformtxtschema_test.go
View file
Original file line number Diff line number Diff line change
@@ -58,6 +58,9 @@ var validPlatformTxtRaw = []byte(`
tools.avrdude.upload.params.verbose=-v
tools.avrdude.upload.params.quiet=-q -q
tools.avrdude.upload.pattern=asdf
tools.avrdude.program.params.verbose=-v
tools.avrdude.program.params.quiet=-q -q
tools.avrdude.program.pattern=asdf
tools.bossac.upload.params.verbose=-v
tools.bossac.upload.params.quiet=-q -q
tools.bossac.upload.pattern=asdf
@@ -196,25 +199,21 @@ func TestRequired(t *testing.T) {
{"recipe.output.tmp_file", "recipe\\.output\\.tmp_file", compliancelevel.Specification, assert.True},
{"recipe.output.tmp_file", "recipe\\.output\\.tmp_file", compliancelevel.Strict, assert.True},

{"tools.avrdude.upload.params.verbose", "tools/avrdude/upload/params\\.verbose", compliancelevel.Permissive, assert.True},
{"tools.avrdude.upload.params.verbose", "tools/avrdude/upload/params\\.verbose", compliancelevel.Specification, assert.True},
{"tools.avrdude.upload.params.verbose", "tools/avrdude/upload/params\\.verbose", compliancelevel.Strict, assert.True},

{"tools.avrdude.upload.params.quiet", "tools/avrdude/upload/params\\.quiet", compliancelevel.Permissive, assert.True},
{"tools.avrdude.upload.params.quiet", "tools/avrdude/upload/params\\.quiet", compliancelevel.Specification, assert.True},
{"tools.avrdude.upload.params.quiet", "tools/avrdude/upload/params\\.quiet", compliancelevel.Strict, assert.True},

{"tools.avrdude.upload.pattern", "tools/avrdude/upload/pattern", compliancelevel.Permissive, assert.True},
{"tools.avrdude.upload.pattern", "tools/avrdude/upload/pattern", compliancelevel.Specification, assert.True},
{"tools.avrdude.upload.pattern", "tools/avrdude/upload/pattern", compliancelevel.Strict, assert.True},

{"tools.bossac.upload.params.verbose", "tools/bossac/upload/params\\.verbose", compliancelevel.Permissive, assert.True},
{"tools.bossac.upload.params.verbose", "tools/bossac/upload/params\\.verbose", compliancelevel.Specification, assert.True},
{"tools.bossac.upload.params.verbose", "tools/bossac/upload/params\\.verbose", compliancelevel.Strict, assert.True},
{"tools.avrdude.program.params.verbose", "tools/avrdude/program/params\\.verbose", compliancelevel.Permissive, assert.True},
{"tools.avrdude.program.params.verbose", "tools/avrdude/program/params\\.verbose", compliancelevel.Specification, assert.True},
{"tools.avrdude.program.params.verbose", "tools/avrdude/program/params\\.verbose", compliancelevel.Strict, assert.True},

{"tools.avrdude.program.params.quiet", "tools/avrdude/program/params\\.quiet", compliancelevel.Permissive, assert.True},
{"tools.avrdude.program.params.quiet", "tools/avrdude/program/params\\.quiet", compliancelevel.Specification, assert.True},
{"tools.avrdude.program.params.quiet", "tools/avrdude/program/params\\.quiet", compliancelevel.Strict, assert.True},

{"tools.bossac.upload.params.quiet", "tools/bossac/upload/params\\.quiet", compliancelevel.Permissive, assert.True},
{"tools.bossac.upload.params.quiet", "tools/bossac/upload/params\\.quiet", compliancelevel.Specification, assert.True},
{"tools.bossac.upload.params.quiet", "tools/bossac/upload/params\\.quiet", compliancelevel.Strict, assert.True},
{"tools.avrdude.program.pattern", "tools/avrdude/program/pattern", compliancelevel.Permissive, assert.True},
{"tools.avrdude.program.pattern", "tools/avrdude/program/pattern", compliancelevel.Specification, assert.True},
{"tools.avrdude.program.pattern", "tools/avrdude/program/pattern", compliancelevel.Strict, assert.True},

{"tools.bossac.upload.pattern", "tools/bossac/upload/pattern", compliancelevel.Permissive, assert.True},
{"tools.bossac.upload.pattern", "tools/bossac/upload/pattern", compliancelevel.Specification, assert.True},
32 changes: 0 additions & 32 deletions internal/rule/ruleconfiguration/ruleconfiguration.go
View file
Original file line number Diff line number Diff line change
@@ -2649,38 +2649,6 @@ var configurations = []Type{
ErrorModes: []rulemode.Type{rulemode.Strict},
RuleFunction: rulefunction.PlatformTxtRecipeSizeRegexDataMissing,
},
{
ProjectType: projecttype.Platform,
SuperprojectType: projecttype.All,
Category: "configuration files",
Subcategory: "platform.txt",
ID: "PF078",
Brief: "missing upload.params.verbose",
Description: "",
MessageTemplate: "Missing upload.params.verbose for {{.}} tool(s). See: https://arduino.github.io/arduino-cli/latest/platform-specification/#verbose-parameter",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []rulemode.Type{rulemode.Default},
RuleFunction: rulefunction.PlatformTxtUploadParamsVerboseMissing,
},
{
ProjectType: projecttype.Platform,
SuperprojectType: projecttype.All,
Category: "configuration files",
Subcategory: "platform.txt",
ID: "PF079",
Brief: "missing upload.params.quiet",
Description: "",
MessageTemplate: "Missing upload.params.quiet for {{.}} tool(s). See: https://arduino.github.io/arduino-cli/latest/platform-specification/#verbose-parameter",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
WarningModes: nil,
ErrorModes: []rulemode.Type{rulemode.Default},
RuleFunction: rulefunction.PlatformTxtUploadParamsQuietMissing,
},
{
ProjectType: projecttype.Platform,
SuperprojectType: projecttype.All,
24 changes: 0 additions & 24 deletions internal/rule/rulefunction/platform_test.go
View file
Original file line number Diff line number Diff line change
@@ -934,30 +934,6 @@ func TestPlatformTxtRecipeSizeRegexDataMissing(t *testing.T) {
checkPlatformRuleFunction(PlatformTxtRecipeSizeRegexDataMissing, testTables, t)
}

func TestPlatformTxtUploadParamsVerboseMissing(t *testing.T) {
testTables := []platformRuleFunctionTestTable{
{"Missing", "missing-platform.txt", ruleresult.Skip, ""},
{"Invalid", "invalid-platform.txt", ruleresult.NotRun, ""},
{"No tools", "no-tools-platform.txt", ruleresult.Skip, ""},
{"Property missing", "upload-params-verbose-missing-platform.txt", ruleresult.Fail, "avrdude, bossac"},
{"Valid", "valid-platform.txt", ruleresult.Pass, ""},
}

checkPlatformRuleFunction(PlatformTxtUploadParamsVerboseMissing, testTables, t)
}

func TestPlatformTxtUploadParamsQuietMissing(t *testing.T) {
testTables := []platformRuleFunctionTestTable{
{"Missing", "missing-platform.txt", ruleresult.Skip, ""},
{"Invalid", "invalid-platform.txt", ruleresult.NotRun, ""},
{"No tools", "no-tools-platform.txt", ruleresult.Skip, ""},
{"Property missing", "upload-params-quiet-missing-platform.txt", ruleresult.Fail, "avrdude, bossac"},
{"Valid", "valid-platform.txt", ruleresult.Pass, ""},
}

checkPlatformRuleFunction(PlatformTxtUploadParamsQuietMissing, testTables, t)
}

func TestPlatformTxtUploadPatternMissing(t *testing.T) {
testTables := []platformRuleFunctionTestTable{
{"Missing", "missing-platform.txt", ruleresult.Skip, ""},
44 changes: 41 additions & 3 deletions internal/rule/schema/schemadata/bindata.go
View file
Original file line number Diff line number Diff line change
@@ -3148,7 +3148,7 @@ var _arduinoPlatformTxtDefinitionsSchemaJson = []byte(`{
"$ref": "#/definitions/propertiesObjects/toolsToolNameUpload/base/object"
},
{
"$ref": "#/definitions/requiredObjects/toolsToolNameActionName/permissive/object"
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/permissive/object"
}
]
}
@@ -3160,7 +3160,7 @@ var _arduinoPlatformTxtDefinitionsSchemaJson = []byte(`{
"$ref": "#/definitions/propertiesObjects/toolsToolNameUpload/base/object"
},
{
"$ref": "#/definitions/requiredObjects/toolsToolNameActionName/specification/object"
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/specification/object"
}
]
}
@@ -3172,7 +3172,7 @@ var _arduinoPlatformTxtDefinitionsSchemaJson = []byte(`{
"$ref": "#/definitions/propertiesObjects/toolsToolNameUpload/base/object"
},
{
"$ref": "#/definitions/requiredObjects/toolsToolNameActionName/strict/object"
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/strict/object"
}
]
}
@@ -3465,6 +3465,44 @@ var _arduinoPlatformTxtDefinitionsSchemaJson = []byte(`{
]
}
}
},
"toolsToolNameUpload": {
"base": {
"object": {
"allOf": [
{
"required": ["pattern"]
}
]
}
},
"permissive": {
"object": {
"allOf": [
{
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/base/object"
}
]
}
},
"specification": {
"object": {
"allOf": [
{
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/base/object"
}
]
}
},
"strict": {
"object": {
"allOf": [
{
"$ref": "#/definitions/requiredObjects/toolsToolNameUpload/base/object"
}
]
}
}
}
}
}