Add JSON schema for platform.txt

This schema defines the required data structure of the platform.txt configuration file of Arduino boards platforms.

Author: per1234

etc/schemas/arduino-platform-txt-definitions-schema.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/schemas/arduino-platform-txt-permissive-schema.json",
+  "title": "Arduino platform.txt JSON permissive schema",
+  "description": "platform.txt contains the platform definitions of Arduino platforms. See: https://arduino.github.io/arduino-cli/latest/platform-specification/#platformtxt",
+  "$comment": "For information on the platform.txt format, see https://godoc.org/github.com/arduino/go-properties-orderedmap",
+  "type": "object",
+  "properties": {
+    "name": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/name/permissive/object"
+    },
+    "version": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/version/permissive/object"
+    },
+    "compiler.c.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerCExtraFlags/permissive/object"
+    },
+    "compiler.cpp.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerCppExtraFlags/permissive/object"
+    },
+    "compiler.S.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerSExtraFlags/permissive/object"
+    },
+    "compiler.ar.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerArExtraFlags/permissive/object"
+    },
+    "compiler.c.elf.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerCElfExtraFlags/permissive/object"
+    },
+    "recipe.preproc.macros": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipePreprocMacros/permissive/object"
+    },
+    "recipe.c.o.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeCOPattern/permissive/object"
+    },
+    "recipe.cpp.o.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeCppOPattern/permissive/object"
+    },
+    "recipe.S.o.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeSOPattern/permissive/object"
+    },
+    "recipe.ar.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeArPattern/permissive/object"
+    },
+    "recipe.c.combine.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeCCombinePattern/permissive/object"
+    },
+    "recipe.output.tmp_file": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeOutputTmpFile/permissive/object"
+    },
+    "recipe.output.save_file": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeOutputSaveFile/permissive/object"
+    },
+    "recipe.size.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeSizePattern/permissive/object"
+    },
+    "tools": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/tools/permissive/object"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/dependenciesObjects/root/permissive/object"
+    },
+    {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/requiredObjects/root/permissive/object"
+    }
+  ]
+}

etc/schemas/arduino-platform-txt-permissive-schema.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/schemas/arduino-platform-txt-schema.json",
+  "title": "Arduino platform.txt JSON schema",
+  "description": "platform.txt contains the platform definitions of Arduino platforms. See: https://arduino.github.io/arduino-cli/latest/platform-specification/#platformtxt",
+  "$comment": "For information on the platform.txt format, see https://godoc.org/github.com/arduino/go-properties-orderedmap",
+  "type": "object",
+  "properties": {
+    "name": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/name/specification/object"
+    },
+    "version": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/version/specification/object"
+    },
+    "compiler.c.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerCExtraFlags/specification/object"
+    },
+    "compiler.cpp.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerCppExtraFlags/specification/object"
+    },
+    "compiler.S.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerSExtraFlags/specification/object"
+    },
+    "compiler.ar.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerArExtraFlags/specification/object"
+    },
+    "compiler.c.elf.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerCElfExtraFlags/specification/object"
+    },
+    "recipe.preproc.macros": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipePreprocMacros/specification/object"
+    },
+    "recipe.c.o.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeCOPattern/specification/object"
+    },
+    "recipe.cpp.o.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeCppOPattern/specification/object"
+    },
+    "recipe.S.o.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeSOPattern/specification/object"
+    },
+    "recipe.ar.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeArPattern/specification/object"
+    },
+    "recipe.c.combine.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeCCombinePattern/specification/object"
+    },
+    "recipe.output.tmp_file": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeOutputTmpFile/specification/object"
+    },
+    "recipe.output.save_file": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeOutputSaveFile/specification/object"
+    },
+    "recipe.size.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeSizePattern/specification/object"
+    },
+    "tools": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/tools/specification/object"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/dependenciesObjects/root/specification/object"
+    },
+    {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/requiredObjects/root/specification/object"
+    }
+  ]
+}

etc/schemas/arduino-platform-txt-schema.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/schemas/arduino-platform-txt-strict-schema.json",
+  "title": "Arduino platform.txt JSON strict schema",
+  "description": "platform.txt contains the platform definitions of Arduino platforms. See: https://arduino.github.io/arduino-cli/latest/platform-specification/#platformtxt",
+  "$comment": "For information on the platform.txt format, see https://godoc.org/github.com/arduino/go-properties-orderedmap",
+  "type": "object",
+  "properties": {
+    "name": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/name/strict/object"
+    },
+    "version": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/version/strict/object"
+    },
+    "compiler.c.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerCExtraFlags/strict/object"
+    },
+    "compiler.cpp.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerCppExtraFlags/strict/object"
+    },
+    "compiler.S.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerSExtraFlags/strict/object"
+    },
+    "compiler.ar.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerArExtraFlags/strict/object"
+    },
+    "compiler.c.elf.extra_flags": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/compilerCElfExtraFlags/strict/object"
+    },
+    "recipe.preproc.macros": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipePreprocMacros/strict/object"
+    },
+    "recipe.c.o.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeCOPattern/strict/object"
+    },
+    "recipe.cpp.o.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeCppOPattern/strict/object"
+    },
+    "recipe.S.o.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeSOPattern/strict/object"
+    },
+    "recipe.ar.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeArPattern/strict/object"
+    },
+    "recipe.c.combine.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeCCombinePattern/strict/object"
+    },
+    "recipe.output.tmp_file": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeOutputTmpFile/strict/object"
+    },
+    "recipe.output.save_file": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeOutputSaveFile/strict/object"
+    },
+    "recipe.size.pattern": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/recipeSizePattern/strict/object"
+    },
+    "tools": {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/propertiesObjects/tools/strict/object"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/dependenciesObjects/root/strict/object"
+    },
+    {
+      "$ref": "arduino-platform-txt-definitions-schema.json#/definitions/requiredObjects/root/strict/object"
+    }
+  ]
+}

etc/schemas/arduino-platform-txt-strict-schema.json

@@ -0,0 +1,83 @@
+// This file is part of arduino-lint.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-lint.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+/*
+Package platformtxt provides functions specific to linting the platform.txt configuration files of Arduino platform platforms.
+See: https://arduino.github.io/arduino-cli/latest/platform-specification/#platformtxt
+*/
+package platformtxt
+
+import (
+	"strings"
+
+	"github.com/arduino/arduino-lint/internal/project/general"
+	"github.com/arduino/arduino-lint/internal/rule/schema"
+	"github.com/arduino/arduino-lint/internal/rule/schema/compliancelevel"
+	"github.com/arduino/arduino-lint/internal/rule/schema/schemadata"
+	"github.com/arduino/go-paths-helper"
+	"github.com/arduino/go-properties-orderedmap"
+)
+
+// Properties parses the platform.txt from the given path and returns the data.
+func Properties(platformPath *paths.Path) (*properties.Map, error) {
+	return properties.LoadFromPath(platformPath.Join("platform.txt"))
+}
+
+var schemaObject = make(map[compliancelevel.Type]schema.Schema)
+
+// Validate validates platform.txt data against the JSON schema and returns a map of the result for each compliance level.
+func Validate(platformTxt *properties.Map) map[compliancelevel.Type]schema.ValidationResult {
+	referencedSchemaFilenames := []string{
+		"general-definitions-schema.json",
+		"arduino-platform-txt-definitions-schema.json",
+	}
+
+	var validationResults = make(map[compliancelevel.Type]schema.ValidationResult)
+
+	if schemaObject[compliancelevel.Permissive].Compiled == nil { // Only compile the schemas once.
+		schemaObject[compliancelevel.Permissive] = schema.Compile("arduino-platform-txt-permissive-schema.json", referencedSchemaFilenames, schemadata.Asset)
+		schemaObject[compliancelevel.Specification] = schema.Compile("arduino-platform-txt-schema.json", referencedSchemaFilenames, schemadata.Asset)
+		schemaObject[compliancelevel.Strict] = schema.Compile("arduino-platform-txt-strict-schema.json", referencedSchemaFilenames, schemadata.Asset)
+	}
+
+	/*
+		Convert the platform.txt data from the native properties.Map type to the interface type required by the schema
+		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 key, which can contain any number of
+		arbitrary tool name subproperties which must be linted.
+	*/
+	platformTxtInterface := make(map[string]interface{})
+	keys := platformTxt.Keys()
+	for _, key := range keys {
+		if strings.HasPrefix(key, "tools.") {
+			platformTxtInterface["tools"] = general.PropertiesToMap(platformTxt.SubTree("tools"), 3)
+		} else {
+			platformTxtInterface[key] = platformTxt.Get(key)
+		}
+	}
+
+	validationResults[compliancelevel.Permissive] = schema.Validate(platformTxtInterface, schemaObject[compliancelevel.Permissive])
+	validationResults[compliancelevel.Specification] = schema.Validate(platformTxtInterface, schemaObject[compliancelevel.Specification])
+	validationResults[compliancelevel.Strict] = schema.Validate(platformTxtInterface, schemaObject[compliancelevel.Strict])
+
+	return validationResults
+}
+
+// ToolNames returns the list of tool names from the given platform.txt properties.
+func ToolNames(platformTxt *properties.Map) []string {
+	return platformTxt.SubTree("tools").FirstLevelKeys()
+}

internal/project/platform/platformtxt/platformtxt.go

@@ -0,0 +1,102 @@
+// This file is part of arduino-lint.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-lint.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package platformtxt
+
+import (
+	"testing"
+
+	"github.com/arduino/arduino-lint/internal/rule/schema/compliancelevel"
+	"github.com/arduino/go-paths-helper"
+	"github.com/arduino/go-properties-orderedmap"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+var testDataPath *paths.Path
+
+var validPlatformTxtMap map[string]string
+
+func init() {
+	workingDirectory, err := paths.Getwd()
+	if err != nil {
+		panic(err)
+	}
+	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",
+		"tools.avrdude.upload.params.verbose": "-v",
+		"tools.avrdude.upload.params.quiet":   "-q -q",
+		"tools.avrdude.upload.pattern":        "asdf",
+	}
+}
+
+func TestProperties(t *testing.T) {
+	propertiesOutput, err := Properties(testDataPath.Join("valid"))
+	require.Nil(t, err)
+
+	assert.True(t, properties.NewFromHashmap(validPlatformTxtMap).Equals(propertiesOutput))
+}
+
+func TestValidate(t *testing.T) {
+	platformTxt := properties.NewFromHashmap(validPlatformTxtMap)
+	validationResult := Validate(platformTxt)
+
+	assert.Nil(t, validationResult[compliancelevel.Permissive].Result, "Valid (permissive)")
+	assert.Nil(t, validationResult[compliancelevel.Specification].Result, "Valid (specification)")
+	assert.Nil(t, validationResult[compliancelevel.Strict].Result, "Valid (strict)")
+
+	platformTxt.Remove("name") // Remove required property.
+	validationResult = Validate(platformTxt)
+	assert.NotNil(t, validationResult[compliancelevel.Permissive].Result, "Invalid (permissive)")
+	assert.NotNil(t, validationResult[compliancelevel.Specification].Result, "Invalid (specification)")
+	assert.NotNil(t, validationResult[compliancelevel.Strict].Result, "Invalid (strict)")
+}
+
+func TestToolNames(t *testing.T) {
+	platformTxt := properties.NewFromHashmap(validPlatformTxtMap)
+
+	assert.ElementsMatch(t, []string{"avrdude"}, ToolNames(platformTxt))
+
+	platformTxt.Set("tools.bossac.program.params.verbose", "asdf")
+	platformTxt.Set("tools.bossac.program.params.quiet", "asdf")
+	platformTxt.Set("tools.bossac.program.pattern", "asdf")
+	assert.ElementsMatch(t, []string{"avrdude", "bossac"}, ToolNames(platformTxt))
+}