Provide check data for platforms

Author: per1234

Diff for: check/checkdata/checkdata.go

@@ -35,6 +35,7 @@ func Initialize(project project.Type, schemasPath *paths.Path) {
 	case projecttype.Library:
 		InitializeForLibrary(project, schemasPath)
 	case projecttype.Platform:
+		InitializeForPlatform(project)
 	case projecttype.PackageIndex:
 		var err error
 		// Because a package index project is a file, but project.Path may be a folder, an extra discovery step is needed for this project type.

Diff for: check/checkdata/platform.go

@@ -0,0 +1,41 @@
+// This file is part of arduino-check.
+//
+// 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-check.
+// 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 [email protected].
+
+package checkdata
+
+import (
+	"github.com/arduino/arduino-check/project"
+	"github.com/arduino/arduino-check/project/platform/boardstxt"
+	"github.com/arduino/go-properties-orderedmap"
+)
+
+// Initialize gathers the platform check data for the specified project.
+func InitializeForPlatform(project project.Type) {
+	boardsTxt, boardsTxtLoadError = boardstxt.Properties(ProjectPath())
+}
+
+var boardsTxt *properties.Map
+
+// BoardsTxt returns the data from the boards.txt configuration file.
+func BoardsTxt() *properties.Map {
+	return boardsTxt
+}
+
+var boardsTxtLoadError error
+
+// BoardsTxtLoadError returns the error output from loading the boards.txt configuration file.
+func BoardsTxtLoadError() error {
+	return boardsTxtLoadError
+}

Diff for: check/checkdata/platform_test.go

@@ -0,0 +1,63 @@
+// This file is part of arduino-check.
+//
+// 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-check.
+// 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 [email protected].
+
+package checkdata
+
+import (
+	"testing"
+
+	"github.com/arduino/arduino-check/project"
+	"github.com/arduino/arduino-check/project/projecttype"
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/assert"
+)
+
+var platformTestDataPath *paths.Path
+
+func init() {
+	workingDirectory, err := paths.Getwd()
+	if err != nil {
+		panic(err)
+	}
+	platformTestDataPath = workingDirectory.Join("testdata", "platforms")
+}
+
+func TestInitializeForPlatform(t *testing.T) {
+	testTables := []struct {
+		testName                    string
+		platformFolderName          string
+		boardsTxtAssertion          assert.ValueAssertionFunc
+		boardsTxtLoadErrorAssertion assert.ValueAssertionFunc
+	}{
+		{"Valid", "valid-boards.txt", assert.NotNil, assert.Nil},
+		{"Invalid", "invalid-boards.txt", assert.Nil, assert.NotNil},
+		{"Missing", "missing-boards.txt", assert.NotNil, assert.Nil},
+	}
+
+	for _, testTable := range testTables {
+
+		testProject := project.Type{
+			Path:             platformTestDataPath.Join(testTable.platformFolderName),
+			ProjectType:      projecttype.Platform,
+			SuperprojectType: projecttype.Platform,
+		}
+		Initialize(testProject, nil)
+
+		testTable.boardsTxtLoadErrorAssertion(t, BoardsTxtLoadError(), testTable.testName)
+		if BoardsTxtLoadError() == nil {
+			testTable.boardsTxtAssertion(t, BoardsTxt(), testTable.testName)
+		}
+	}
+}

Diff for: check/checkdata/testdata/platforms/invalid-boards.txt/boards.txt

@@ -0,0 +1 @@
+This makes the format invalid

Diff for: check/checkdata/testdata/platforms/missing-boards.txt/.gitkeep

@@ -0,0 +1,8 @@
+uno.name=Arduino Uno
+
+uno.build.core=arduino
+uno.build.variant=standard
+
+uno.upload.tool=avrdude
+uno.upload.maximum_size=32256
+uno.upload.maximum_data_size=2048

Diff for: check/checkdata/testdata/platforms/valid-boards.txt/boards.txt

@@ -0,0 +1,30 @@
+// This file is part of arduino-check.
+//
+// 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-check.
+// 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 [email protected].
+
+/*
+Package boardstxt provides functions specific to checking the boards.txt configuration files of Arduino boards platforms.
+See: https://arduino.github.io/arduino-cli/latest/platform-specification/#boardstxt
+*/
+package boardstxt
+
+import (
+	"github.com/arduino/go-paths-helper"
+	"github.com/arduino/go-properties-orderedmap"
+)
+
+// Properties parses the library.properties from the given path and returns the data.
+func Properties(platformPath *paths.Path) (*properties.Map, error) {
+	return properties.SafeLoadFromPath(platformPath.Join("boards.txt"))
+}