Add functions to provide check data for sketches

Author: per1234

check/checkdata/checkdata.go

@@ -33,6 +33,7 @@ func Initialize(project project.Type, schemasPath *paths.Path) {
 	projectPath = project.Path
 	switch project.ProjectType {
 	case projecttype.Sketch:
+		InitializeForSketch(project)
 	case projecttype.Library:
 		InitializeForLibrary(project, schemasPath)
 	case projecttype.Platform:

check/checkdata/sketch.go

@@ -0,0 +1,60 @@
+// 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-cli/arduino/sketches"
+)
+
+// InitializeForSketch gathers the check data for the specified sketch project.
+func InitializeForSketch(project project.Type) {
+	loadedSketch, sketchLoadError = sketches.NewSketchFromPath(ProjectPath())
+
+	metadataSketchObject := &sketches.Sketch{
+		Name:     ProjectPath().Base(),
+		FullPath: ProjectPath(),
+	}
+	metadataLoadError = metadataSketchObject.ImportMetadata()
+}
+
+var sketchLoadError error
+
+// SketchLoadError returns the error output from Arduino CLI loading the sketch.
+func SketchLoadError() error {
+	return sketchLoadError
+}
+
+var loadedSketch *sketches.Sketch
+
+// Sketch returns the sketch object generated by Arduino CLI.
+func Sketch() *sketches.Sketch {
+	return loadedSketch
+}
+
+var metadataLoadError error
+
+// MetadataLoadError returns the error produced during load of the sketch metadata.
+func MetadataLoadError() error {
+	return metadataLoadError
+}
+
+var metadataSketchObject *sketches.Sketch
+
+// Metadata returns the metadata object produced by Arduino CLI.
+func Metadata() *sketches.Metadata {
+	return metadataSketchObject.Metadata
+}

project/sketch/sketch.go

@@ -62,3 +62,27 @@ func HasSupportedExtension(filePath *paths.Path) bool {
 	_, hasAdditionalFileValidExtensions := globals.AdditionalFileValidExtensions[filePath.Ext()]
 	return hasAdditionalFileValidExtensions || HasMainFileValidExtension(filePath)
 }
+
+var empty struct{}
+
+// See: https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata
+var metadataFilenames = map[string]struct{}{
+	"sketch.json": empty,
+}
+
+// MetadataPath returns the path of the sketch's metadata file.
+func MetadataPath(sketchPath *paths.Path) *paths.Path {
+	for metadataFileName := range metadataFilenames {
+		metadataPath := sketchPath.Join(metadataFileName)
+		exist, err := metadataPath.ExistCheck()
+		if err != nil {
+			panic(err)
+		}
+
+		if exist {
+			return metadataPath
+		}
+	}
+
+	return nil
+}

project/sketch/sketch_test.go

@@ -45,3 +45,8 @@ func TestHasSupportedExtension(t *testing.T) {
 	assert.True(t, HasSupportedExtension(paths.New("/foo/bar.h")))
 	assert.False(t, HasSupportedExtension(paths.New("/foo/bar.baz")))
 }
+
+func TestMetadataPath(t *testing.T) {
+	assert.True(t, MetadataPath(testDataPath.Join("HasMetadataFile")).EquivalentTo(testDataPath.Join("HasMetadataFile", "sketch.json")))
+	assert.Nil(t, MetadataPath(testDataPath.Join("NoMetadataFile")))
+}

project/sketch/testdata/HasMetadataFile/HasMetadataFile.ino

@@ -0,0 +1,2 @@
+void setup() {}
+void loop() {}

project/sketch/testdata/HasMetadataFile/sketch.json

@@ -0,0 +1,2 @@
+void setup() {}
+void loop() {}