Merge pull request #31 from arduino/per1234/create-report-file-parents

Create parent path of report file

Author: per1234

Diff for: command/command.go

@@ -63,7 +63,10 @@ func ArduinoCheck(rootCommand *cobra.Command, cliArguments []string) {
 
 	if configuration.ReportFilePath() != nil {
 		// Write report file.
-		result.Results.WriteReport()
+		if err := result.Results.WriteReport(); err != nil {
+			feedback.Error(err.Error())
+			os.Exit(1)
+		}
 	}
 
 	if !result.Results.Passed() {

Diff for: configuration/configuration.go

@@ -70,7 +70,6 @@ func Initialize(flags *pflag.FlagSet, projectPaths []string) error {
 
 	recursive, _ = flags.GetBool("recursive")
 
-	// TODO: validate path
 	reportFilePathString, _ := flags.GetString("report-file")
 	reportFilePath = paths.New(reportFilePathString)
 

Diff for: result/result.go

@@ -224,13 +224,25 @@ func (results Type) jsonReportRaw() []byte {
 }
 
 // WriteReport writes a report for all projects to the specified file.
-func (results Type) WriteReport() {
-	// Write report file
-	err := configuration.ReportFilePath().WriteFile(results.jsonReportRaw())
+func (results Type) WriteReport() error {
+	reportFilePath := configuration.ReportFilePath()
+	reportFilePathParentExists, err := reportFilePath.Parent().ExistCheck()
 	if err != nil {
-		feedback.Errorf("Error while writing report: %v", err)
-		os.Exit(1)
+		return fmt.Errorf("Problem processing --report-file flag value %v: %v", reportFilePath, err)
+	}
+	if !reportFilePathParentExists {
+		err = reportFilePath.Parent().MkdirAll()
+		if err != nil {
+			return fmt.Errorf("Error while creating report file path (%v): %v", reportFilePath.Parent(), err)
+		}
 	}
+
+	err = reportFilePath.WriteFile(results.jsonReportRaw())
+	if err != nil {
+		return fmt.Errorf("Error while writing report: %v", err)
+	}
+
+	return nil
 }
 
 // Passed returns whether the checks passed cumulatively.

Diff for: result/result_test.go

@@ -0,0 +1,61 @@
+// 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 result
+
+import (
+	"io/ioutil"
+	"os"
+	"testing"
+
+	"github.com/arduino/arduino-check/configuration"
+	"github.com/arduino/arduino-check/util/test"
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestWriteReport(t *testing.T) {
+	flags := test.ConfigurationFlags()
+
+	projectPaths := []string{"/foo"}
+
+	reportFolderPathString, err := ioutil.TempDir("", "arduino-check-result-TestWriteReport")
+	require.Nil(t, err)
+	defer os.RemoveAll(reportFolderPathString) // clean up
+	reportFolderPath := paths.New(reportFolderPathString)
+
+	reportFilePath := reportFolderPath.Join("report-file.json")
+	_, err = reportFilePath.Create() // Create file using the report folder path.
+	require.Nil(t, err)
+
+	flags.Set("report-file", reportFilePath.Join("report-file.json").String())
+	assert.Nil(t, configuration.Initialize(flags, projectPaths))
+	assert.Error(t, Results.WriteReport(), "Parent folder creation should fail due to a collision with an existing file at that path")
+
+	reportFilePath = reportFolderPath.Join("report-file-subfolder", "report-file-subsubfolder", "report-file.json")
+	flags.Set("report-file", reportFilePath.String())
+	assert.Nil(t, configuration.Initialize(flags, projectPaths))
+	assert.NoError(t, Results.WriteReport(), "Creation of multiple levels of parent folders")
+
+	reportFile, err := reportFilePath.Open()
+	require.Nil(t, err)
+	reportFileInfo, err := reportFile.Stat()
+	require.Nil(t, err)
+	reportFileBytes := make([]byte, reportFileInfo.Size())
+	_, err = reportFile.Read(reportFileBytes)
+	require.Nil(t, err)
+	assert.True(t, assert.ObjectsAreEqualValues(reportFileBytes, Results.jsonReportRaw()), "Report file contents are correct")
+}