Refactor backup and restore plugins to accept logger as a parameter and remove verbosity level configuration

Signed-off-by: Tiger Kaovilai <[email protected]>

Author: kaovilai

main.go

@@ -15,10 +15,10 @@ func main() {
 
 func newHCPBackupPlugin(logger logrus.FieldLogger) (interface{}, error) {
 	logger.Info("Initializing HCP Backup Plugin")
-	return core.NewBackupPlugin()
+	return core.NewBackupPlugin(logger)
 }
 
 func newHCPRestorePlugin(logger logrus.FieldLogger) (interface{}, error) {
 	logger.Info("Initializing HCP Restore Plugin")
-	return core.NewRestorePlugin()
+	return core.NewRestorePlugin(logger)
 }

pkg/core/backup.go

@@ -44,13 +44,10 @@ type BackupPlugin struct {
 }
 
 // NewBackupPlugin instantiates BackupPlugin.
-func NewBackupPlugin() (*BackupPlugin, error) {
+func NewBackupPlugin(log logrus.FieldLogger) (*BackupPlugin, error) {
 	var (
 		err error
-		log = logrus.New()
 	)
-	log.SetLevel(logrus.DebugLevel)
-
 	log.Infof("initializing hypershift OADP backup plugin")
 	client, err := common.GetClient()
 	if err != nil {
@@ -74,7 +71,7 @@ func NewBackupPlugin() (*BackupPlugin, error) {
 	}
 
 	bp := &BackupPlugin{
-		log:       log,
+		log:       log.WithField("type", "core-backup"),
 		client:    client,
 		config:    pluginConfig.Data,
 		finished:  false,
@@ -86,18 +83,6 @@ func NewBackupPlugin() (*BackupPlugin, error) {
 		return nil, fmt.Errorf("error validating plugin configuration: %s", err.Error())
 	}
 
-	// Set the log level to pluginVerbosityLevel if set, keep debug level if not set
-	if bp.BackupOptions.PluginVerbosityLevel != "" {
-		parsedLevel, err := logrus.ParseLevel(bp.BackupOptions.PluginVerbosityLevel)
-		if err != nil {
-			return nil, fmt.Errorf("error parsing pluginVerbosityLevel: %s", err.Error())
-		}
-		log.Infof("pluginVerbosityLevel set to %s", parsedLevel)
-		log.SetLevel(parsedLevel)
-	}
-
-	bp.log = log.WithField("type", "core-backup")
-
 	return bp, nil
 }
 

pkg/core/restore.go

@@ -45,12 +45,10 @@ type RestoreOptions struct {
 }
 
 // NewRestorePlugin instantiates RestorePlugin.
-func NewRestorePlugin() (*RestorePlugin, error) {
+func NewRestorePlugin(log logrus.FieldLogger) (*RestorePlugin, error) {
 	var (
 		err error
-		log = logrus.New()
 	)
-	log.SetLevel(logrus.DebugLevel)
 
 	log.Info("initializing hypershift OADP restore plugin")
 	client, err := common.GetClient()
@@ -76,7 +74,7 @@ func NewRestorePlugin() (*RestorePlugin, error) {
 	}
 
 	rp := &RestorePlugin{
-		log:      log,
+		log:      log.WithField("type", "core-restore"),
 		ctx:      ctx,
 		client:   client,
 		fsBackup: false,
@@ -90,18 +88,6 @@ func NewRestorePlugin() (*RestorePlugin, error) {
 		return nil, fmt.Errorf("error validating plugin configuration: %s", err.Error())
 	}
 
-	// Set the log level to pluginVerbosityLevel if set, keep debug level if not set
-	if rp.RestoreOptions.PluginVerbosityLevel != "" {
-		parsedLevel, err := logrus.ParseLevel(rp.RestoreOptions.PluginVerbosityLevel)
-		if err != nil {
-			return nil, fmt.Errorf("error parsing pluginVerbosityLevel: %s", err.Error())
-		}
-		log.Infof("pluginVerbosityLevel set to %s", parsedLevel)
-		log.SetLevel(parsedLevel)
-	}
-
-	rp.log = log.WithField("type", "core-restore")
-
 	return rp, nil
 }
 

pkg/core/types/types.go

@@ -29,8 +29,6 @@ type BackupOptions struct {
 	DataUploadCheckPace time.Duration
 	// ManagedServices is a flag to indicate if the backup is done for ManagedServices like ROSA, ARO, etc.
 	ManagedServices bool
-	// PluginVerbosityLevel is the verbosity level of the plugin.
-	PluginVerbosityLevel string
 }
 
 type RestoreOptions struct {

pkg/core/validation/backup.go

@@ -16,7 +16,7 @@ type BackupValidator interface {
 }
 
 type BackupPluginValidator struct {
-	Log *logrus.Logger
+	Log logrus.FieldLogger
 }
 
 func (p *BackupPluginValidator) ValidatePluginConfig(config map[string]string) (*plugtypes.BackupOptions, error) {
@@ -56,7 +56,6 @@ func (p *BackupPluginValidator) ValidatePluginConfig(config map[string]string) (
 			bo.DataUploadCheckPace = time.Duration(seconds)
 		case "pluginVerbosityLevel":
 			p.Log.Debugf("reading/parsing pluginVerbosityLevel %s", value)
-			bo.PluginVerbosityLevel = value
 		default:
 			p.Log.Warnf("unknown configuration key: %s with value %s", key, value)
 		}