Add check for missing boards.txt

Author: per1234

Diff for: check/checkconfigurations/checkconfigurations.go

@@ -1151,6 +1151,21 @@ var configurations = []Type{
 		ErrorModes:      []checkmode.Type{checkmode.Strict},
 		CheckFunction:   checkfunctions.MissingReadme,
 	},
+	{
+		ProjectType:     projecttype.Platform,
+		Category:        "configuration files",
+		Subcategory:     "boards.txt",
+		ID:              "",
+		Brief:           "missing",
+		Description:     "",
+		MessageTemplate: "Required boards.txt is missing. Expected at: {{.}}",
+		DisableModes:    nil,
+		EnableModes:     []checkmode.Type{checkmode.Default},
+		InfoModes:       nil,
+		WarningModes:    nil,
+		ErrorModes:      []checkmode.Type{checkmode.Default},
+		CheckFunction:   checkfunctions.BoardsTxtMissing,
+	},
 	{
 		ProjectType:     projecttype.PackageIndex,
 		Category:        "data",

Diff for: check/checkfunctions/platform.go

@@ -0,0 +1,39 @@
+// 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 checkfunctions
+
+import (
+	"github.com/arduino/arduino-check/check/checkdata"
+	"github.com/arduino/arduino-check/check/checkresult"
+)
+
+// The check functions for platforms.
+
+// BoardsTxtMissing checks whether the platform contains a boards.txt
+func BoardsTxtMissing() (result checkresult.Type, output string) {
+	boardsTxtPath := checkdata.ProjectPath().Join("boards.txt")
+	exist, err := boardsTxtPath.ExistCheck()
+	if err != nil {
+		panic(err)
+	}
+
+	if exist {
+		return checkresult.Pass, ""
+	}
+
+	return checkresult.Fail, boardsTxtPath.String()
+}
+

Diff for: check/checkfunctions/platform_test.go

@@ -0,0 +1,73 @@
+// 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 checkfunctions
+
+import (
+	"regexp"
+	"testing"
+
+	"github.com/arduino/arduino-check/check/checkdata"
+	"github.com/arduino/arduino-check/check/checkresult"
+	"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")
+}
+
+type platformCheckFunctionTestTable struct {
+	testName            string
+	platformFolderName  string
+	expectedCheckResult checkresult.Type
+	expectedOutputQuery string
+}
+
+func checkPlatformCheckFunction(checkFunction Type, testTables []platformCheckFunctionTestTable, t *testing.T) {
+	for _, testTable := range testTables {
+		expectedOutputRegexp := regexp.MustCompile(testTable.expectedOutputQuery)
+
+		testProject := project.Type{
+			Path:             platformTestDataPath.Join(testTable.platformFolderName),
+			ProjectType:      projecttype.Platform,
+			SuperprojectType: projecttype.Platform,
+		}
+
+		checkdata.Initialize(testProject, nil)
+
+		result, output := checkFunction()
+		assert.Equal(t, testTable.expectedCheckResult, result, testTable.testName)
+		assert.True(t, expectedOutputRegexp.MatchString(output), testTable.testName)
+	}
+}
+
+func TestBoardsTxtMissing(t *testing.T) {
+	testTables := []platformCheckFunctionTestTable{
+		{"Present", "valid-boards.txt", checkresult.Pass, ""},
+		{"Missing", "missing-boards.txt", checkresult.Fail, ""},
+	}
+
+	checkPlatformCheckFunction(BoardsTxtMissing, testTables, t)
+}
+

Diff for: check/checkfunctions/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