configuration.go

// 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 configuration handles the configuration of the Arduino Lint tool.
package configuration

import (
	"fmt"
	"io/ioutil"
	"os"
	"strconv"
	"strings"

	"github.com/arduino/arduino-lint/internal/configuration/rulemode"
	"github.com/arduino/arduino-lint/internal/project/projecttype"
	"github.com/arduino/arduino-lint/internal/result/outputformat"
	"github.com/arduino/go-paths-helper"
	"github.com/sirupsen/logrus"
	"github.com/spf13/pflag"
)

// Initialize sets up the tool configuration according to defaults and user-specified options.
func Initialize(flags *pflag.FlagSet, projectPaths []string) error {
	var err error

	complianceString, _ := flags.GetString("compliance")
	if complianceString != "" {
		customRuleModes[rulemode.Strict], customRuleModes[rulemode.Specification], customRuleModes[rulemode.Permissive], err = rulemode.ComplianceModeFromString(complianceString)
		if err != nil {
			return fmt.Errorf("--compliance flag value %s not valid", complianceString)
		}
	}

	outputFormatString, _ := flags.GetString("format")
	outputFormat, err = outputformat.FromString(outputFormatString)
	if err != nil {
		return fmt.Errorf("--format flag value %s not valid", outputFormatString)
	}

	libraryManagerModeString, _ := flags.GetString("library-manager")
	if libraryManagerModeString != "" {
		customRuleModes[rulemode.LibraryManagerSubmission], customRuleModes[rulemode.LibraryManagerIndexed], err = rulemode.LibraryManagerModeFromString(libraryManagerModeString)
		if err != nil {
			return fmt.Errorf("--library-manager flag value %s not valid", libraryManagerModeString)
		}
	}

	if logFormatString, ok := os.LookupEnv("ARDUINO_LINT_LOG_FORMAT"); ok {
		logFormat, err := logFormatFromString(logFormatString)
		if err != nil {
			return fmt.Errorf("--log-format flag value %s not valid", logFormatString)
		}
		logrus.SetFormatter(logFormat)
		EnableLogging(true)
	}

	if logLevelString, ok := os.LookupEnv("ARDUINO_LINT_LOG_LEVEL"); ok {
		logLevel, err := logrus.ParseLevel(logLevelString)
		if err != nil {
			return fmt.Errorf("--log-level flag value %s not valid", logLevelString)
		}
		logrus.SetLevel(logLevel)
		EnableLogging(true)
	}

	superprojectTypeFilterString, _ := flags.GetString("project-type")
	superprojectTypeFilter, err = projecttype.FromString(superprojectTypeFilterString)
	if err != nil {
		return fmt.Errorf("--project-type flag value %s not valid", superprojectTypeFilterString)
	}

	recursive, _ = flags.GetBool("recursive")

	reportFilePathString, _ := flags.GetString("report-file")
	reportFilePath = paths.New(reportFilePathString)

	verbose, _ = flags.GetBool("verbose")

	versionMode, _ = flags.GetBool("version")

	targetPaths = nil
	if len(projectPaths) == 0 {
		// Default to using current working directory.
		workingDirectoryPath, err := os.Getwd()
		if err != nil {
			panic(err)
		}
		targetPaths.Add(paths.New(workingDirectoryPath))
	} else {
		for _, projectPath := range projectPaths {
			targetPath := paths.New(projectPath)
			targetPathExists, err := targetPath.ExistCheck()
			if err != nil {
				return fmt.Errorf("Unable to process PROJECT_PATH argument value %v: %v", targetPath, err)
			}
			if !targetPathExists {
				return fmt.Errorf("PROJECT_PATH argument %v does not exist", targetPath)
			}
			targetPaths.AddIfMissing(targetPath)
		}
	}

	if officialModeString, ok := os.LookupEnv("ARDUINO_LINT_OFFICIAL"); ok {
		customRuleModes[rulemode.Official], err = strconv.ParseBool(officialModeString)
		if err != nil {
			return fmt.Errorf("ARDUINO_LINT_OFFICIAL environment variable value %s not valid", officialModeString)
		}
	}

	logrus.WithFields(logrus.Fields{
		"compliance":                      rulemode.Compliance(customRuleModes),
		"output format":                   OutputFormat(),
		"Library Manager submission mode": customRuleModes[rulemode.LibraryManagerSubmission],
		"Library Manager update mode":     customRuleModes[rulemode.LibraryManagerIndexed],
		"log level":                       logrus.GetLevel().String(),
		"superproject type filter":        SuperprojectTypeFilter(),
		"recursive":                       Recursive(),
		"report file":                     ReportFilePath(),
		"verbose":                         Verbose(),
		"projects path":                   TargetPaths(),
	}).Debug("Configuration initialized")

	return nil
}

// logFormatFromString parses the --log-format flag value and returns the corresponding log formatter.
func logFormatFromString(logFormatString string) (logrus.Formatter, error) {
	switch strings.ToLower(logFormatString) {
	case "text":
		return &logrus.TextFormatter{}, nil
	case "json":
		return &logrus.JSONFormatter{}, nil
	default:
		return nil, fmt.Errorf("No matching log format for string %s", logFormatString)
	}
}

var customRuleModes = make(map[rulemode.Type]bool)

// RuleModes returns the rule modes configuration for the given project type.
func RuleModes(superprojectType projecttype.Type) map[rulemode.Type]bool {
	return rulemode.Modes(defaultRuleModes, customRuleModes, superprojectType)
}

var superprojectTypeFilter projecttype.Type

// SuperprojectTypeFilter returns the superproject type filter configuration.
func SuperprojectTypeFilter() projecttype.Type {
	return superprojectTypeFilter
}

var recursive bool

// Recursive returns the recursive project search configuration value.
func Recursive() bool {
	return recursive
}

var outputFormat outputformat.Type

// OutputFormat returns the tool output format configuration value.
func OutputFormat() outputformat.Type {
	return outputFormat
}

var reportFilePath *paths.Path

// ReportFilePath returns the path to save the report file at.
func ReportFilePath() *paths.Path {
	return reportFilePath
}

var verbose bool

// Verbose returns the verbosity setting.
func Verbose() bool {
	return verbose
}

var versionMode bool

// VersionMode returns the --version setting.
func VersionMode() bool {
	return versionMode
}

var version string

// Version returns the build version.
func Version() string {
	return version
}

var commit string

// Commit returns the HEAD commit of the Arduino Lint repository when the application was built.
func Commit() string {
	return commit
}

var buildTimestamp string

// BuildTimestamp returns the timestamp of the build.
func BuildTimestamp() string {
	return buildTimestamp
}

var targetPaths paths.PathList

// TargetPaths returns the projects search paths.
func TargetPaths() paths.PathList {
	return targetPaths
}

// EnableLogging enables or disables logging debug output.
func EnableLogging(enable bool) {
	if enable {
		logrus.SetOutput(defaultLogOutput) // Enable log output.
	} else {
		logrus.SetOutput(ioutil.Discard)
	}
}