Merge pull request #3 from VeritasOS/main

Use yaml.v3; Set SHELL to bash

Author: abhijithda

Makefile

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
+# Copyright (c) 2023 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
 
 # A Self-Documenting Makefile: http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
 .DEFAULT_GOAL := help
@@ -7,6 +7,7 @@ help:	## Display this help message.
 	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
 
 TOP=$(CURDIR)
+include $(TOP)/Makefile.conf
 
 # Go build related variables
 GOSRC=$(TOP)

Makefile.conf

@@ -0,0 +1,3 @@
+# Copyright (c) 2023 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
+
+SHELL = /bin/bash

cmd/pm/integ_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2021 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
+// Copyright (c) 2023 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
 
 package main
 
@@ -16,7 +16,7 @@ import (
 
 	"github.com/VeritasOS/plugin-manager/config"
 
-	yaml "gopkg.in/yaml.v2"
+	yaml "gopkg.in/yaml.v3"
 )
 
 // Config is Plugin Manager's configuration information.

config/config.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2021 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
+// Copyright (c) 2023 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
 
 package config
 
@@ -8,7 +8,7 @@ import (
 	"os"
 	"path/filepath"
 
-	"gopkg.in/yaml.v2"
+	"gopkg.in/yaml.v3"
 
 	logutil "github.com/VeritasOS/plugin-manager/utils/log"
 )
@@ -59,15 +59,17 @@ func GetPluginsLibrary() string {
 }
 
 // GetPluginsDir gets location of plugins directory.
-//  NOTE: This is deprecated, Use GetPluginsLibrary() instead.
+//
+//	NOTE: This is deprecated, Use GetPluginsLibrary() instead.
 func GetPluginsDir() string {
 	return filepath.FromSlash(filepath.Clean(myConfig.PluginManager.PluginDir) +
 		string(os.PathSeparator))
 }
 
 // GetPMLogDir provides location for storing Plugin Manager logs.
-//  NOTE: The plugin logs would be stored "plugins" directory under the
-//  same path, and use GetPluginsLogDir() to get that path.
+//
+//	NOTE: The plugin logs would be stored "plugins" directory under the
+//	same path, and use GetPluginsLogDir() to get that path.
 func GetPMLogDir() string {
 	return filepath.FromSlash(filepath.Clean(myConfig.PluginManager.LogDir) +
 		string(os.PathSeparator))
@@ -136,9 +138,10 @@ func readConfigFile(confFilePath string) (Config, error) {
 }
 
 // SetLogDir sets the location for storing Plugin Manager logs.
-//  Use GetPMLogDir() to obtain this location from config.
-//  NOTE: The plugin logs would be stored "plugins" directory under the
-//  same path, and use GetPluginsLogDir() to get that path.
+//
+//	Use GetPMLogDir() to obtain this location from config.
+//	NOTE: The plugin logs would be stored "plugins" directory under the
+//	same path, and use GetPluginsLogDir() to get that path.
 func SetLogDir(logDir string) {
 	// TODO: Move log parameters one level up in config as it's common to asum,
 	// and not specific to PM.
@@ -147,9 +150,10 @@ func SetLogDir(logDir string) {
 }
 
 // SetLogFile sets the log file to use.
-//  Use GetLogDir() to obtain this location from config.
-//  NOTE: The plugin logs would be stored "plugins" directory under the
-//  same path, and use Get/SetPluginsLogDir() to get/set that path.
+//
+//	Use GetLogDir() to obtain this location from config.
+//	NOTE: The plugin logs would be stored "plugins" directory under the
+//	same path, and use Get/SetPluginsLogDir() to get/set that path.
 func SetLogFile(logFile string) {
 	// TODO: Move log parameters one level up in config as it's common to asum,
 	// and not specific to PM.
@@ -163,7 +167,8 @@ func SetPluginsLibrary(library string) {
 }
 
 // SetPluginsDir sets location of plugins directory.
-//  NOTE: This is deprecated, Use SetPluginsLibrary() instead.
+//
+//	NOTE: This is deprecated, Use SetPluginsLibrary() instead.
 func SetPluginsDir(library string) {
 	myConfig.PluginManager.PluginDir = filepath.FromSlash(filepath.Clean(library) +
 		string(os.PathSeparator))
@@ -175,9 +180,10 @@ func SetPMLogFile(logfile string) {
 }
 
 // SetPMLogDir sets the location for storing Plugin Manager logs.
-//  Use GetPMLogDir() to obtain this location from config.
-//  NOTE: The plugin logs would be stored "plugins" directory under the
-//  same path, and use GetPluginsLogDir() to get that path.
+//
+//	Use GetPMLogDir() to obtain this location from config.
+//	NOTE: The plugin logs would be stored "plugins" directory under the
+//	same path, and use GetPluginsLogDir() to get that path.
 func SetPMLogDir(logDir string) {
 	myConfig.PluginManager.LogDir = filepath.FromSlash(
 		filepath.Clean(logDir) + string(os.PathSeparator))

go.mod

@@ -1,5 +1,5 @@
 module github.com/VeritasOS/plugin-manager
 
-go 1.12
+go 1.19
 
-require gopkg.in/yaml.v2 v2.4.0
+require gopkg.in/yaml.v3 v3.0.1

go.sum

@@ -1,4 +1,4 @@
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
-gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

graph.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2021 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
+// Copyright (c) 2023 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
 
 // Package pm graph is used for generating the graph image.
 package pm
@@ -108,7 +108,7 @@ func initGraph(pluginType string, pluginsInfo map[string]*PluginAttributes) erro
 }
 
 // generateGraph generates an input `.dot` file based on the fileNoExt name,
-// 	and then generates an `.svg` image output file as fileNoExt.svg.
+// and then generates an `.svg` image output file as fileNoExt.svg.
 func generateGraph() error {
 	dotFile := getDotFilePath()
 	svgFile := getImagePath()

plugin.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2021 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
+// Copyright (c) 2023 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
 
 // Package pm defines Plugin Manager (PM) functions like executing
 // all plugins of a particular plugin type.
@@ -684,10 +684,10 @@ func Run(result *RunStatus, pluginType string) error {
 // ScanCommandOptions scans for the command line options and makes appropriate
 // function call.
 // Input:
-// 	1. map[string]interface{}
-//    where, the options could be following:
-// 		"progname":  Name of the program along with any cmds (ex: asum pm)
-// 		"cmd-index": Index to the cmd (ex: run)
+//  1. map[string]interface{}
+//     where, the options could be following:
+//     "progname":  Name of the program along with any cmds (ex: asum pm)
+//     "cmd-index": Index to the cmd (ex: run)
 func ScanCommandOptions(options map[string]interface{}) error {
 	log.Printf("Entering ScanCommandOptions(%+v)...", options)
 	defer log.Println("Exiting ScanCommandOptions")

utils/log/log.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2021 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
+// Copyright (c) 2023 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
 
 package log
 
@@ -17,7 +17,7 @@ func PrintNLog(format string, a ...interface{}) {
 }
 
 // PrintNLogError prints to console and log file along with returning the
-//  message in error format.
+// message in error format.
 func PrintNLogError(format string, a ...interface{}) error {
 	err := fmt.Errorf(format, a...)
 	log.Printf("ERROR: %v", err.Error())
@@ -26,7 +26,7 @@ func PrintNLogError(format string, a ...interface{}) error {
 }
 
 // PrintNLogWarning prints warning message to console and log file along with
-//  returning the message in error format.
+// returning the message in error format.
 func PrintNLogWarning(format string, a ...interface{}) error {
 	err := fmt.Errorf(format, a...)
 	log.Printf("WARNING: %v", err.Error())
@@ -35,10 +35,10 @@ func PrintNLogWarning(format string, a ...interface{}) error {
 }
 
 // SetLogging sets the logfile for this program.
-// 	To handle log rotation, the specified myLogFile would be suffixed with
-//  the current date before the log file extension.
-// 	Ex: If myLogFile := "/log/asum/pm", then the logfile used for
-// 		logging would be "/log/asum/pm.20181212235500.0000.log".
+// To handle log rotation, the specified myLogFile would be suffixed with
+// the current date before the log file extension.
+// Ex: If myLogFile := "/log/asum/pm", then the logfile used for
+// logging would be "/log/asum/pm.20181212235500.0000.log".
 func SetLogging(myLogFile string) error {
 	ts := time.Now().Format(time.RFC3339Nano)
 	myLogFile = filepath.Clean(myLogFile)

utils/os/os.go

@@ -1,7 +1,7 @@
-// Copyright (c) 2021 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
+// Copyright (c) 2023 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
 
 // Package os contains pointers to os package functions so as to help
-// 	in unit testing (mocking).
+// in unit testing (mocking).
 package os
 
 import (

utils/output/output.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2021 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
+// Copyright (c) 2023 Veritas Technologies LLC. All rights reserved. IP63-2828-7171-04-15-9
 
 package output
 
@@ -10,7 +10,7 @@ import (
 	"log"
 	"path/filepath"
 
-	"gopkg.in/yaml.v2"
+	"gopkg.in/yaml.v3"
 )
 
 // cmdOptions contains commandline parameters/options for generating output in specified format.
@@ -59,8 +59,9 @@ func RegisterCommandOptions(f *flag.FlagSet, defaultParams map[string]string) {
 }
 
 // Write writes the given data in the format {json|yaml} that was set in options.
-// 	into a specified file. If file is not specified, then it will print
-// 	on STDOUT.
+//
+//	into a specified file. If file is not specified, then it will print
+//	on STDOUT.
 func Write(data interface{}) error {
 	log.Println("Entering Write")
 	defer log.Println("Exiting Write")
@@ -75,8 +76,9 @@ func Write(data interface{}) error {
 }
 
 // writeToFile writes the given data in the specified format {json|yaml}
-// 	into a specified file. If file is not specified, then it will print
-// 	on STDOUT.
+//
+//	into a specified file. If file is not specified, then it will print
+//	on STDOUT.
 func writeToFile(data interface{}, format string, filePath string) error {
 	log.Println("Entering writeToFile")
 	defer log.Println("Exiting writeToFile")