Skip to content

Add schema-based rules for pluggable monitor dependencies data of package index #293

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 3 commits into from
Nov 17, 2021
Merged

Add schema-based rules for pluggable monitor dependencies data of package index #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4fcbd06
Add pluggable monitor support to package index schema
per1234 Nov 11, 2021
090eb85
Refactor package index project data component parsing code
per1234 Nov 11, 2021
ec2851f
Add schema-based rules for monitor dependencies data of package index
per1234 Nov 11, 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
86 changes: 86 additions & 0 deletions etc/schemas/arduino-package-index-definitions-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,9 @@
},
"discoveryDependencies": {
"$ref": "#/definitions/propertiesObjects/discoveryDependencies/permissive/object"
},
"monitorDependencies": {
"$ref": "#/definitions/propertiesObjects/monitorDependencies/permissive/object"
}
},
"additionalProperties": false
Expand Down Expand Up @@ -510,6 +513,9 @@
},
"discoveryDependencies": {
"$ref": "#/definitions/propertiesObjects/discoveryDependencies/specification/object"
},
"monitorDependencies": {
"$ref": "#/definitions/propertiesObjects/monitorDependencies/specification/object"
}
},
"additionalProperties": false
Expand Down Expand Up @@ -565,6 +571,9 @@
},
"discoveryDependencies": {
"$ref": "#/definitions/propertiesObjects/discoveryDependencies/strict/object"
},
"monitorDependencies": {
"$ref": "#/definitions/propertiesObjects/monitorDependencies/strict/object"
}
},
"additionalProperties": false
Expand Down Expand Up @@ -1084,6 +1093,83 @@
}
}
},
"monitorDependencies": {
"base": {
"object": {
"type": "array",
"items": {
"type": "object",
"required": ["packager", "name"]
}
}
},
"permissive": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/monitorDependencies/base/object"
},
{
"items": {
"properties": {
"packager": {
"$ref": "#/definitions/propertiesObjects/packager/permissive/object"
},
"name": {
"$ref": "#/definitions/propertiesObjects/toolName/permissive/object"
}
},
"additionalProperties": false
}
}
]
}
},
"specification": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/monitorDependencies/base/object"
},
{
"items": {
"properties": {
"packager": {
"$ref": "#/definitions/propertiesObjects/packager/specification/object"
},
"name": {
"$ref": "#/definitions/propertiesObjects/toolName/specification/object"
}
},
"additionalProperties": false
}
}
]
}
},
"strict": {
"object": {
"allOf": [
{
"$ref": "#/definitions/propertiesObjects/monitorDependencies/base/object"
},
{
"items": {
"properties": {
"packager": {
"$ref": "#/definitions/propertiesObjects/packager/strict/object"
},
"name": {
"$ref": "#/definitions/propertiesObjects/toolName/strict/object"
}
},
"additionalProperties": false
}
}
]
}
}
},
"packager": {
"base": {
"object": {
Expand Down
33 changes: 33 additions & 0 deletions internal/project/packageindex/packageindexschemas_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ var validIndexRaw = []byte(`
"packager": "arduino",
"name": "ble-discovery"
}
],
"monitorDependencies": [
{
"packager": "arduino",
"name": "network-monitor"
}
]
}
],
Expand Down Expand Up @@ -152,6 +158,14 @@ func TestMinLength(t *testing.T) {
{"/packages/0/platforms/0/discoveryDependencies/0/name", 1, compliancelevel.Specification},
{"/packages/0/platforms/0/discoveryDependencies/0/name", 1, compliancelevel.Strict},

{"/packages/0/platforms/0/monitorDependencies/0/packager", 1, compliancelevel.Permissive},
{"/packages/0/platforms/0/monitorDependencies/0/packager", 1, compliancelevel.Specification},
{"/packages/0/platforms/0/monitorDependencies/0/packager", 1, compliancelevel.Strict},

{"/packages/0/platforms/0/monitorDependencies/0/name", 1, compliancelevel.Permissive},
{"/packages/0/platforms/0/monitorDependencies/0/name", 1, compliancelevel.Specification},
{"/packages/0/platforms/0/monitorDependencies/0/name", 1, compliancelevel.Strict},

{"/packages/0/tools/0/systems/0/archiveFileName", 1, compliancelevel.Permissive},
{"/packages/0/tools/0/systems/0/archiveFileName", 1, compliancelevel.Specification},
{"/packages/0/tools/0/systems/0/archiveFileName", 1, compliancelevel.Strict},
Expand Down Expand Up @@ -303,6 +317,18 @@ func TestRequired(t *testing.T) {
{"/packages/0/platforms/0/discoveryDependencies/0/name", compliancelevel.Specification, assert.True},
{"/packages/0/platforms/0/discoveryDependencies/0/name", compliancelevel.Strict, assert.True},

{"/packages/0/platforms/0/monitorDependencies", compliancelevel.Permissive, assert.False},
{"/packages/0/platforms/0/monitorDependencies", compliancelevel.Specification, assert.False},
{"/packages/0/platforms/0/monitorDependencies", compliancelevel.Strict, assert.False},

{"/packages/0/platforms/0/monitorDependencies/0/packager", compliancelevel.Permissive, assert.True},
{"/packages/0/platforms/0/monitorDependencies/0/packager", compliancelevel.Specification, assert.True},
{"/packages/0/platforms/0/monitorDependencies/0/packager", compliancelevel.Strict, assert.True},

{"/packages/0/platforms/0/monitorDependencies/0/name", compliancelevel.Permissive, assert.True},
{"/packages/0/platforms/0/monitorDependencies/0/name", compliancelevel.Specification, assert.True},
{"/packages/0/platforms/0/monitorDependencies/0/name", compliancelevel.Strict, assert.True},

{"/packages/0/tools/0/name", compliancelevel.Permissive, assert.True},
{"/packages/0/tools/0/name", compliancelevel.Specification, assert.True},
{"/packages/0/tools/0/name", compliancelevel.Strict, assert.True},
Expand Down Expand Up @@ -586,6 +612,9 @@ func TestType(t *testing.T) {
{"/packages/0/platforms/0/discoveryDependencies", 42, assert.True},
{"/packages/0/platforms/0/discoveryDependencies/0/packager", 42, assert.True},
{"/packages/0/platforms/0/discoveryDependencies/0/name", 42, assert.True},
{"/packages/0/platforms/0/monitorDependencies", 42, assert.True},
{"/packages/0/platforms/0/monitorDependencies/0/packager", 42, assert.True},
{"/packages/0/platforms/0/monitorDependencies/0/name", 42, assert.True},
{"/packages/0/tools", 42, assert.True},
{"/packages/0/tools/0/name", 42, assert.True},
{"/packages/0/tools/0/version", 42, assert.True},
Expand Down Expand Up @@ -717,6 +746,10 @@ func TestAdditionalProperties(t *testing.T) {
{"/packages/0/platforms/0/discoveryDependencies/0", compliancelevel.Specification, assert.True},
{"/packages/0/platforms/0/discoveryDependencies/0", compliancelevel.Strict, assert.True},

{"/packages/0/platforms/0/monitorDependencies/0", compliancelevel.Permissive, assert.True},
{"/packages/0/platforms/0/monitorDependencies/0", compliancelevel.Specification, assert.True},
{"/packages/0/platforms/0/monitorDependencies/0", compliancelevel.Strict, assert.True},

{"/packages/0/tools/0", compliancelevel.Permissive, assert.True},
{"/packages/0/tools/0", compliancelevel.Specification, assert.True},
{"/packages/0/tools/0", compliancelevel.Strict, assert.True},
Expand Down
20 changes: 10 additions & 10 deletions internal/project/projectdata/packageindex.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ func InitializeForPackageIndex() {
packageIndexBoards = nil
packageIndexToolsDependencies = nil
packageIndexDiscoveryDependencies = nil
packageIndexMonitorDependencies = nil
packageIndexTools = nil
packageIndexSystems = nil
packageIndexSchemaValidationResult = nil
Expand All @@ -54,22 +55,14 @@ func InitializeForPackageIndex() {

for _, packageData := range PackageIndexPackages() {
packageIndexPlatforms = append(packageIndexPlatforms, getPackageIndexData(packageData.Object, packageData.JSONPointer, "platforms", packageData.ID, ":{{index . 0}}@{{index . 1}}", []string{"architecture", "version"})...)
packageIndexTools = append(packageIndexTools, getPackageIndexData(packageData.Object, packageData.JSONPointer, "tools", packageData.ID, ":{{index . 0}}@{{index . 1}}", []string{"name", "version"})...)
}

for _, platformData := range PackageIndexPlatforms() {
packageIndexBoards = append(packageIndexBoards, getPackageIndexData(platformData.Object, platformData.JSONPointer, "boards", platformData.ID, " >> {{index . 0}}", []string{"name"})...)
}

for _, platformData := range PackageIndexPlatforms() {
packageIndexToolsDependencies = append(packageIndexToolsDependencies, getPackageIndexData(platformData.Object, platformData.JSONPointer, "toolsDependencies", platformData.ID, " >> {{index . 0}}:{{index . 1}}@{{index . 2}}", []string{"packager", "name", "version"})...)
}

for _, platformData := range PackageIndexPlatforms() {
packageIndexDiscoveryDependencies = append(packageIndexDiscoveryDependencies, getPackageIndexData(platformData.Object, platformData.JSONPointer, "discoveryDependencies", platformData.ID, " >> {{index . 0}}:{{index . 1}}", []string{"packager", "name"})...)
}

for _, packageData := range PackageIndexPackages() {
packageIndexTools = append(packageIndexTools, getPackageIndexData(packageData.Object, packageData.JSONPointer, "tools", packageData.ID, ":{{index . 0}}@{{index . 1}}", []string{"name", "version"})...)
packageIndexMonitorDependencies = append(packageIndexMonitorDependencies, getPackageIndexData(platformData.Object, platformData.JSONPointer, "monitorDependencies", platformData.ID, " >> {{index . 0}}:{{index . 1}}", []string{"packager", "name"})...)
}

for _, toolData := range PackageIndexTools() {
Expand Down Expand Up @@ -136,6 +129,13 @@ func PackageIndexDiscoveryDependencies() []PackageIndexData {
return packageIndexDiscoveryDependencies
}

var packageIndexMonitorDependencies []PackageIndexData

// PackageIndexMonitorDependencies returns the slice of pluggable monitor tool dependency data for the package index.
func PackageIndexMonitorDependencies() []PackageIndexData {
return packageIndexMonitorDependencies
}

var packageIndexTools []PackageIndexData

// PackageIndexTools returns the slice of tool data for the package index.
Expand Down
Loading