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

Add pluggable monitor support for platform projects #300

Merged
merged 2 commits into from
Nov 23, 2021
Merged

Add pluggable monitor support for platform projects #300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bc680a
Add pluggable monitor support to platform.txt schema
per1234 Nov 12, 2021
2d263ad
Add rules for the platform.txt pluggable_monitor.* properties
per1234 Nov 12, 2021
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
195 changes: 194 additions & 1 deletion etc/schemas/arduino-platform-txt-definitions-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,7 +877,7 @@
"type": "string"
},
{
"pattern": "^.+:.+$"
"$ref": "#/definitions/patternObjects/resourceReference"
}
]
}
Expand Down Expand Up @@ -910,6 +910,194 @@
}
}
},
"pluggableMonitorPattern": {
"base": {
"object": {
"allOf": [
{
"type": "object"
}
]
}
},
"permissive": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorPattern/base/object"
},
{
"additionalProperties": {
"$ref": "#/definitions/propertiesObjects/pluggableMonitorPatternProtocol/permissive/object"
}
}
]
}
},
"specification": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorPattern/base/object"
},
{
"additionalProperties": {
"$ref": "#/definitions/propertiesObjects/pluggableMonitorPatternProtocol/specification/object"
}
}
]
}
},
"strict": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorPattern/base/object"
},
{
"additionalProperties": {
"$ref": "#/definitions/propertiesObjects/pluggableMonitorPatternProtocol/strict/object"
}
}
]
}
}
},
"pluggableMonitorPatternProtocol": {
"base": {
"object": {
"allOf": [
{
"type": "string"
},
{
"minLength": 1
}
]
}
},
"permissive": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorPatternProtocol/base/object"
}
]
}
},
"specification": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorPatternProtocol/base/object"
}
]
}
},
"strict": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorPatternProtocol/base/object"
}
]
}
}
},
"pluggableMonitorRequired": {
"base": {
"object": {
"allOf": [
{
"type": "object"
}
]
}
},
"permissive": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorRequired/base/object"
},
{
"additionalProperties": {
"$ref": "#/definitions/propertiesObjects/pluggableMonitorRequiredProtocol/permissive/object"
}
}
]
}
},
"specification": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorRequired/base/object"
},
{
"additionalProperties": {
"$ref": "#/definitions/propertiesObjects/pluggableMonitorRequiredProtocol/specification/object"
}
}
]
}
},
"strict": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorRequired/base/object"
},
{
"additionalProperties": {
"$ref": "#/definitions/propertiesObjects/pluggableMonitorRequiredProtocol/strict/object"
}
}
]
}
}
},
"pluggableMonitorRequiredProtocol": {
"base": {
"object": {
"allOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/patternObjects/resourceReference"
}
]
}
},
"permissive": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorRequiredProtocol/base/object"
}
]
}
},
"specification": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorRequiredProtocol/base/object"
}
]
}
},
"strict": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/pluggableMonitorRequiredProtocol/base/object"
}
]
}
}
},
"tools": {
"base": {
"object": {
Expand Down Expand Up @@ -1571,6 +1759,11 @@
}
}
},
"patternObjects": {
"resourceReference": {
"pattern": "^.+:.+$"
}
},
"requiredObjects": {
"root": {
"base": {
Expand Down
6 changes: 6 additions & 0 deletions etc/schemas/arduino-platform-txt-permissive-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@
"pluggable_discovery": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/pluggableDiscovery/permissive/object"
},
"pluggable_monitor.pattern": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/pluggableMonitorPattern/permissive/object"
},
"pluggable_monitor.required": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/pluggableMonitorRequired/permissive/object"
},
"tools": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/tools/permissive/object"
}
Expand Down
6 changes: 6 additions & 0 deletions etc/schemas/arduino-platform-txt-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@
"pluggable_discovery": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/pluggableDiscovery/specification/object"
},
"pluggable_monitor.pattern": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/pluggableMonitorPattern/specification/object"
},
"pluggable_monitor.required": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/pluggableMonitorRequired/specification/object"
},
"tools": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/tools/specification/object"
}
Expand Down
6 changes: 6 additions & 0 deletions etc/schemas/arduino-platform-txt-strict-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@
"pluggable_discovery": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/pluggableDiscovery/strict/object"
},
"pluggable_monitor.pattern": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/pluggableMonitorPattern/strict/object"
},
"pluggable_monitor.required": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/pluggableMonitorRequired/strict/object"
},
"tools": {
"$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/tools/strict/object"
}
Expand Down
8 changes: 6 additions & 2 deletions internal/project/platform/platformtxt/platformtxt.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ func Validate(platformTxt *properties.Map) map[compliancelevel.Type]schema.Valid
validation package.
Even though platform.txt has a multi-level nested data structure, the format has the odd characteristic of allowing
a key to be both an object and a string simultaneously, which is not compatible with Golang maps or JSON. So the
data structure used is a selective map, using a flat map except for the tools and pluggable_discovery keys, which
can contain any number of arbitrary subproperties which must be linted.
data structure used is a selective map, using a flat map except for the tools, pluggable_discovery, and
pluggable_monitor keys, which can contain any number of arbitrary subproperties which must be linted.
*/
platformTxtInterface := make(map[string]interface{})
keys := platformTxt.Keys()
Expand All @@ -72,6 +72,10 @@ func Validate(platformTxt *properties.Map) map[compliancelevel.Type]schema.Valid
// It is a pluggable_discovery.DISCOVERY_ID property.
platformTxtInterface["pluggable_discovery"] = general.PropertiesToMap(platformTxt.SubTree("pluggable_discovery"), 2)
}
} else if strings.HasPrefix(key, "pluggable_monitor.pattern.") {
platformTxtInterface["pluggable_monitor.pattern"] = general.PropertiesToMap(platformTxt.SubTree("pluggable_monitor.pattern"), 1)
} else if strings.HasPrefix(key, "pluggable_monitor.required.") {
platformTxtInterface["pluggable_monitor.required"] = general.PropertiesToMap(platformTxt.SubTree("pluggable_monitor.required"), 1)
} else if strings.HasPrefix(key, "tools.") {
platformTxtInterface["tools"] = general.PropertiesToMap(platformTxt.SubTree("tools"), 4)
} else {
Expand Down
62 changes: 32 additions & 30 deletions internal/project/platform/platformtxt/platformtxt_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,36 +39,38 @@ func init() {
testDataPath = workingDirectory.Join("testdata")

validPlatformTxtMap = map[string]string{
"name": "Arduino AVR Boards",
"version": "1.8.3",
"compiler.warning_flags.none": "asdf",
"compiler.warning_flags.default": "asdf",
"compiler.warning_flags.more": "asdf",
"compiler.warning_flags.all": "asdf",
"compiler.c.extra_flags": "",
"compiler.c.elf.extra_flags": "",
"compiler.S.extra_flags": "",
"compiler.cpp.extra_flags": "",
"compiler.ar.extra_flags": "",
"compiler.objcopy.eep.extra_flags": "",
"compiler.elf2hex.extra_flags": "",
"recipe.c.o.pattern": "asdf {compiler.c.extra_flags}",
"recipe.cpp.o.pattern": "asdf {compiler.cpp.extra_flags}",
"recipe.S.o.pattern": "asdf {compiler.S.extra_flags}",
"recipe.ar.pattern": "asdf {compiler.ar.extra_flags}",
"recipe.c.combine.pattern": "asdf {compiler.c.elf.extra_flags}",
"recipe.objcopy.eep.pattern": "asdf",
"recipe.objcopy.hex.pattern": "asdf",
"recipe.output.tmp_file": "asdf",
"recipe.output.save_file": "asdf",
"recipe.size.pattern": "asdf",
"recipe.size.regex": "asdf",
"recipe.size.regex.data": "asdf",
"pluggable_discovery.required.0": "builtin:serial-discovery",
"pluggable_discovery.required.1": "builtin:mdns-discovery",
"tools.avrdude.upload.params.verbose": "-v",
"tools.avrdude.upload.params.quiet": "-q -q",
"tools.avrdude.upload.pattern": "asdf",
"name": "Arduino AVR Boards",
"version": "1.8.3",
"compiler.warning_flags.none": "asdf",
"compiler.warning_flags.default": "asdf",
"compiler.warning_flags.more": "asdf",
"compiler.warning_flags.all": "asdf",
"compiler.c.extra_flags": "",
"compiler.c.elf.extra_flags": "",
"compiler.S.extra_flags": "",
"compiler.cpp.extra_flags": "",
"compiler.ar.extra_flags": "",
"compiler.objcopy.eep.extra_flags": "",
"compiler.elf2hex.extra_flags": "",
"recipe.c.o.pattern": "asdf {compiler.c.extra_flags}",
"recipe.cpp.o.pattern": "asdf {compiler.cpp.extra_flags}",
"recipe.S.o.pattern": "asdf {compiler.S.extra_flags}",
"recipe.ar.pattern": "asdf {compiler.ar.extra_flags}",
"recipe.c.combine.pattern": "asdf {compiler.c.elf.extra_flags}",
"recipe.objcopy.eep.pattern": "asdf",
"recipe.objcopy.hex.pattern": "asdf",
"recipe.output.tmp_file": "asdf",
"recipe.output.save_file": "asdf",
"recipe.size.pattern": "asdf",
"recipe.size.regex": "asdf",
"recipe.size.regex.data": "asdf",
"pluggable_discovery.required.0": "builtin:serial-discovery",
"pluggable_discovery.required.1": "builtin:mdns-discovery",
"pluggable_monitor.required.carrier-pigeon": "coop:coo",
"pluggable_monitor.required.network": "foo:network-monitor",
"tools.avrdude.upload.params.verbose": "-v",
"tools.avrdude.upload.params.quiet": "-q -q",
"tools.avrdude.upload.pattern": "asdf",
}
}

Expand Down
11 changes: 11 additions & 0 deletions internal/project/platform/platformtxt/platformtxtschema_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@ func TestMinLength(t *testing.T) {
{"recipe.preproc.macros", "recipe\\.preproc\\.macros", 1, compliancelevel.Permissive},
{"recipe.preproc.macros", "recipe\\.preproc\\.macros", 1, compliancelevel.Specification},
{"recipe.preproc.macros", "recipe\\.preproc\\.macros", 1, compliancelevel.Strict},

{"pluggable_monitor.pattern.foo", "pluggable_monitor\\.pattern/foo", 1, compliancelevel.Permissive},
{"pluggable_monitor.pattern.foo", "pluggable_monitor\\.pattern/foo", 1, compliancelevel.Specification},
{"pluggable_monitor.pattern.foo", "pluggable_monitor\\.pattern/foo", 1, compliancelevel.Strict},
}

// Test schema validation results with value length < minimum.
Expand Down Expand Up @@ -453,6 +457,13 @@ func TestPattern(t *testing.T) {
{"pluggable_discovery.required.1", "pluggable_discovery/required", "foo", compliancelevel.Permissive, assert.True},
{"pluggable_discovery.required.1", "pluggable_discovery/required", "foo", compliancelevel.Specification, assert.True},
{"pluggable_discovery.required.1", "pluggable_discovery/required", "foo", compliancelevel.Strict, assert.True},

{"pluggable_monitor.required.foo", "pluggable_monitor\\.required/foo", "bar:baz", compliancelevel.Permissive, assert.False},
{"pluggable_monitor.required.foo", "pluggable_monitor\\.required/foo", "bar:baz", compliancelevel.Specification, assert.False},
{"pluggable_monitor.required.foo", "pluggable_monitor\\.required/foo", "bar:baz", compliancelevel.Strict, assert.False},
{"pluggable_monitor.required.foo", "pluggable_monitor\\.required/foo", "bar", compliancelevel.Permissive, assert.True},
{"pluggable_monitor.required.foo", "pluggable_monitor\\.required/foo", "bar", compliancelevel.Specification, assert.True},
{"pluggable_monitor.required.foo", "pluggable_monitor\\.required/foo", "bar", compliancelevel.Strict, assert.True},
}

for _, testTable := range testTables {
Expand Down
2 changes: 2 additions & 0 deletions internal/project/platform/platformtxt/testdata/valid/platform.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ recipe.size.regex=asdf
recipe.size.regex.data=asdf
pluggable_discovery.required.0=builtin:serial-discovery
pluggable_discovery.required.1=builtin:mdns-discovery
pluggable_monitor.required.carrier-pigeon=coop:coo
pluggable_monitor.required.network=foo:network-monitor
tools.avrdude.upload.params.verbose=-v
tools.avrdude.upload.params.quiet=-q -q
tools.avrdude.upload.pattern=asdf
Loading