Skip to content

Provide schema validation results in package index project data #193

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
Jun 15, 2021
Merged

Provide schema validation results in package index project data #193

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
12 changes: 12 additions & 0 deletions internal/project/projectdata/packageindex.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import (

clipackageindex "github.com/arduino/arduino-cli/arduino/cores/packageindex"
"github.com/arduino/arduino-lint/internal/project/packageindex"
"github.com/arduino/arduino-lint/internal/rule/schema"
"github.com/arduino/arduino-lint/internal/rule/schema/compliancelevel"
)

// PackageIndexData is the type for package index data.
Expand All @@ -41,6 +43,7 @@ func InitializeForPackageIndex() {
packageIndexPlatforms = nil
packageIndexTools = nil
packageIndexSystems = nil
packageIndexSchemaValidationResult = nil
if packageIndexLoadError == nil {
packageIndexPackages = getPackageIndexData(PackageIndex(), "", "packages", "", "name", "")

Expand All @@ -55,6 +58,8 @@ func InitializeForPackageIndex() {
for _, toolData := range PackageIndexTools() {
packageIndexSystems = append(packageIndexSystems, getPackageIndexData(toolData.Object, toolData.JSONPointer, "systems", toolData.ID+" - ", "host", "")...)
}

packageIndexSchemaValidationResult = packageindex.Validate(PackageIndex())
}
}

Expand Down Expand Up @@ -107,6 +112,13 @@ func PackageIndexSystems() []PackageIndexData {
return packageIndexSystems
}

var packageIndexSchemaValidationResult map[compliancelevel.Type]schema.ValidationResult

// PackageIndexSchemaValidationResult returns the result of validating the package index against the JSON schema.
func PackageIndexSchemaValidationResult() map[compliancelevel.Type]schema.ValidationResult {
return packageIndexSchemaValidationResult
}

func getPackageIndexData(interfaceObject map[string]interface{}, pointerPrefix string, dataKey string, iDPrefix string, iDKey string, versionKey string) []PackageIndexData {
var data []PackageIndexData

Expand Down
68 changes: 37 additions & 31 deletions internal/project/projectdata/packageindex_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,20 @@ func init() {

func TestInitializeForPackageIndex(t *testing.T) {
testTables := []struct {
testName string
path *paths.Path
packageIndexAssertion assert.ValueAssertionFunc
packageIndexLoadErrorAssertion assert.ValueAssertionFunc
packageIndexCLILoadErrorAssertion assert.ValueAssertionFunc
packageIndexPackagesAssertion assert.ValueAssertionFunc
packageIndexPackagesDataAssertion []PackageIndexData
packageIndexPlatformsAssertion assert.ValueAssertionFunc
packageIndexPlatformsDataAssertion []PackageIndexData
packageIndexToolsAssertion assert.ValueAssertionFunc
packageIndexToolsDataAssertion []PackageIndexData
packageIndexSystemsAssertion assert.ValueAssertionFunc
packageIndexSystemsDataAssertion []PackageIndexData
testName string
path *paths.Path
packageIndexAssertion assert.ValueAssertionFunc
packageIndexLoadErrorAssertion assert.ValueAssertionFunc
packageIndexCLILoadErrorAssertion assert.ValueAssertionFunc
packageIndexPackagesAssertion assert.ValueAssertionFunc
packageIndexPackagesDataAssertion []PackageIndexData
packageIndexPlatformsAssertion assert.ValueAssertionFunc
packageIndexPlatformsDataAssertion []PackageIndexData
packageIndexToolsAssertion assert.ValueAssertionFunc
packageIndexToolsDataAssertion []PackageIndexData
packageIndexSystemsAssertion assert.ValueAssertionFunc
packageIndexSystemsDataAssertion []PackageIndexData
packageIndexSchemaValidationResultAssertion assert.ValueAssertionFunc
}{
{
testName: "Valid",
Expand Down Expand Up @@ -116,6 +117,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
JSONPointer: "/packages/1/tools/1/systems/1",
},
},
packageIndexSchemaValidationResultAssertion: assert.NotNil,
},
{
testName: "Missing IDs",
Expand Down Expand Up @@ -191,6 +193,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
JSONPointer: "/packages/1/tools/2/systems/0",
},
},
packageIndexSchemaValidationResultAssertion: assert.NotNil,
},
{
testName: "Empty IDs",
Expand Down Expand Up @@ -266,28 +269,31 @@ func TestInitializeForPackageIndex(t *testing.T) {
JSONPointer: "/packages/1/tools/2/systems/0",
},
},
packageIndexSchemaValidationResultAssertion: assert.NotNil,
},
{
testName: "Invalid package index",
path: packageIndexTestDataPath.Join("invalid-package-index", "package_foo_index.json"),
packageIndexAssertion: assert.Nil,
packageIndexLoadErrorAssertion: assert.NotNil,
packageIndexCLILoadErrorAssertion: assert.NotNil,
packageIndexPackagesAssertion: assert.Nil,
packageIndexPlatformsAssertion: assert.Nil,
packageIndexToolsAssertion: assert.Nil,
packageIndexSystemsAssertion: assert.Nil,
testName: "Invalid package index",
path: packageIndexTestDataPath.Join("invalid-package-index", "package_foo_index.json"),
packageIndexAssertion: assert.Nil,
packageIndexLoadErrorAssertion: assert.NotNil,
packageIndexCLILoadErrorAssertion: assert.NotNil,
packageIndexPackagesAssertion: assert.Nil,
packageIndexPlatformsAssertion: assert.Nil,
packageIndexToolsAssertion: assert.Nil,
packageIndexSystemsAssertion: assert.Nil,
packageIndexSchemaValidationResultAssertion: assert.Nil,
},
{
testName: "Invalid JSON",
path: packageIndexTestDataPath.Join("invalid-JSON", "package_foo_index.json"),
packageIndexAssertion: assert.Nil,
packageIndexLoadErrorAssertion: assert.NotNil,
packageIndexCLILoadErrorAssertion: assert.NotNil,
packageIndexPackagesAssertion: assert.Nil,
packageIndexPlatformsAssertion: assert.Nil,
packageIndexToolsAssertion: assert.Nil,
packageIndexSystemsAssertion: assert.Nil,
testName: "Invalid JSON",
path: packageIndexTestDataPath.Join("invalid-JSON", "package_foo_index.json"),
packageIndexAssertion: assert.Nil,
packageIndexLoadErrorAssertion: assert.NotNil,
packageIndexCLILoadErrorAssertion: assert.NotNil,
packageIndexPackagesAssertion: assert.Nil,
packageIndexPlatformsAssertion: assert.Nil,
packageIndexToolsAssertion: assert.Nil,
packageIndexSystemsAssertion: assert.Nil,
packageIndexSchemaValidationResultAssertion: assert.Nil,
},
}

Expand Down