Add monitors enable command

Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>

Author: eamansour

docs/generated/errors-list.md

@@ -214,7 +214,14 @@ The `galasactl` tool can generate the following errors:
 - GAL1215E: An attempt to update a user '{}' failed. Unexpected http status code {} received from the server. Error details from the server are not in a valid json format. Cause: '{}'
 - GAL1216E: An attempt to update a user '{}' failed. Unexpected http status code {} received from the server. Error details from the server are: '{}'
 - GAL1217E: An attempt to update a user '{}' failed. Unexpected http status code {} received from the server. Error details from the server are not in the json format.
-- GAL1225E: Failed to open file '{}' cause: {}. Check that this file exists, and that you have read permissions.
+- GAL1218E: Failed to update a monitor named '{}'. Sending the put request to the Galasa service failed. Cause is {}
+- GAL1219E: Failed to update a monitor named '{}'. Unexpected http status code {} received from the server.
+- GAL1220E: Failed to update a monitor named '{}'. Unexpected http status code {} received from the server. Error details from the server could not be read. Cause: {}
+- GAL1221E: Failed to update a monitor named '{}'. Unexpected http status code {} received from the server. Error details from the server are not in a valid json format. Cause: '{}'
+- GAL1222E: Failed to update a monitor named '{}'. Unexpected http status code {} received from the server. Error details from the server are: '{}'
+- GAL1223E: Failed to update a monitor named '{}'. Unexpected http status code {} received from the server. Error details from the server are not in the json format.
+- GAL1224E: Galasa Monitor named {} is not known on the Galasa service.
+- GAL1225E: Invalid monitor name provided. The name provided with the --name flag cannot be empty and must only contain characters in the following ranges: 'a'-'z', 'A'-'Z', '0'-'9', '-' (dash), '_' (underscore).
 - GAL1226E: Internal failure. Contents of gzip could be read, but not decoded. New gzip reader failed: file: {} error: {}
 - GAL1227E: Internal failure. Contents of gzip could not be decoded. {} error: {}
 - GAL1228E: Internal failure. Contents of gzip could not be encoded and compressed. {} error: {}

docs/generated/galasactl.md

@@ -18,6 +18,7 @@ A tool for controlling Galasa resources using the command-line.
 
 * [galasactl auth](galasactl_auth.md)	 - Manages authentication with a Galasa ecosystem
 * [galasactl local](galasactl_local.md)	 - Manipulate local system
+* [galasactl monitors](galasactl_monitors.md)	 - Manage monitors in the Galasa service
 * [galasactl project](galasactl_project.md)	 - Manipulate local project source code
 * [galasactl properties](galasactl_properties.md)	 - Manages properties in an ecosystem
 * [galasactl resources](galasactl_resources.md)	 - Manages resources in an ecosystem

docs/generated/galasactl_monitors.md

@@ -0,0 +1,29 @@
+## galasactl monitors
+
+Manage monitors in the Galasa service
+
+### Synopsis
+
+The parent command for operations to manipulate monitors in the Galasa service
+
+### Options
+
+```
+  -b, --bootstrap string                      Bootstrap URL. Should start with 'http://' or 'file://'. If it starts with neither, it is assumed to be a fully-qualified path. If missing, it defaults to use the 'bootstrap.properties' file in your GALASA_HOME. Example: http://example.com/bootstrap, file:///user/myuserid/.galasa/bootstrap.properties , file://C:/Users/myuserid/.galasa/bootstrap.properties
+  -h, --help                                  Displays the options for the 'monitors' command.
+      --rate-limit-retries int                The maximum number of retries that should be made when requests to the Galasa Service fail due to rate limits being exceeded. Must be a whole number. Defaults to 3 retries (default 3)
+      --rate-limit-retry-backoff-secs float   The amount of time in seconds to wait before retrying a command if it failed due to rate limits being exceeded. Defaults to 1 second. (default 1)
+```
+
+### Options inherited from parent commands
+
+```
+      --galasahome string   Path to a folder where Galasa will read and write files and configuration settings. The default is '${HOME}/.galasa'. This overrides the GALASA_HOME environment variable which may be set instead.
+  -l, --log string          File to which log information will be sent. Any folder referred to must exist. An existing file will be overwritten. Specify "-" to log to stderr. Defaults to not logging.
+```
+
+### SEE ALSO
+
+* [galasactl](galasactl.md)	 - CLI for Galasa
+* [galasactl monitors enable](galasactl_monitors_enable.md)	 - Enable a monitor in the Galasa service
+

docs/generated/galasactl_monitors_enable.md

@@ -0,0 +1,33 @@
+## galasactl monitors enable
+
+Enable a monitor in the Galasa service
+
+### Synopsis
+
+Enables a given monitor in the Galasa service
+
+```
+galasactl monitors enable [flags]
+```
+
+### Options
+
+```
+  -h, --help          Displays the options for the 'monitors enable' command.
+      --name string   A mandatory flag that identifies the monitor to be manipulated by name.
+```
+
+### Options inherited from parent commands
+
+```
+  -b, --bootstrap string                      Bootstrap URL. Should start with 'http://' or 'file://'. If it starts with neither, it is assumed to be a fully-qualified path. If missing, it defaults to use the 'bootstrap.properties' file in your GALASA_HOME. Example: http://example.com/bootstrap, file:///user/myuserid/.galasa/bootstrap.properties , file://C:/Users/myuserid/.galasa/bootstrap.properties
+      --galasahome string                     Path to a folder where Galasa will read and write files and configuration settings. The default is '${HOME}/.galasa'. This overrides the GALASA_HOME environment variable which may be set instead.
+  -l, --log string                            File to which log information will be sent. Any folder referred to must exist. An existing file will be overwritten. Specify "-" to log to stderr. Defaults to not logging.
+      --rate-limit-retries int                The maximum number of retries that should be made when requests to the Galasa Service fail due to rate limits being exceeded. Must be a whole number. Defaults to 3 retries (default 3)
+      --rate-limit-retry-backoff-secs float   The amount of time in seconds to wait before retrying a command if it failed due to rate limits being exceeded. Defaults to 1 second. (default 1)
+```
+
+### SEE ALSO
+
+* [galasactl monitors](galasactl_monitors.md)	 - Manage monitors in the Galasa service
+

pkg/cmd/commandCollection.go

@@ -39,6 +39,8 @@ const (
 	COMMAND_NAME_PROJECT_CREATE           = "project create"
 	COMMAND_NAME_LOCAL                    = "local"
 	COMMAND_NAME_LOCAL_INIT               = "local init"
+	COMMAND_NAME_MONITORS                 = "monitors"
+	COMMAND_NAME_MONITORS_ENABLE          = "monitors enable"
 	COMMAND_NAME_PROPERTIES               = "properties"
 	COMMAND_NAME_PROPERTIES_GET           = "properties get"
 	COMMAND_NAME_PROPERTIES_SET           = "properties set"
@@ -137,6 +139,10 @@ func (commands *commandCollectionImpl) init(factory spi.Factory) error {
 		err = commands.addLocalCommands(factory, rootCommand)
 	}
 
+	if err == nil {
+		err = commands.addMonitorsCommands(factory, rootCommand, commsFlagSet)
+	}
+
 	if err == nil {
 		err = commands.addProjectCommands(factory, rootCommand)
 	}
@@ -430,6 +436,26 @@ func (commands *commandCollectionImpl) addSecretsCommands(factory spi.Factory, r
 	return err
 }
 
+func (commands *commandCollectionImpl) addMonitorsCommands(factory spi.Factory, rootCommand spi.GalasaCommand, commsFlagSet GalasaFlagSet) error {
+
+	var err error
+	var monitorsCommand spi.GalasaCommand
+	var monitorsEnableCommand spi.GalasaCommand
+
+	monitorsCommand, err = NewMonitorsCmd(rootCommand, commsFlagSet)
+
+	if err == nil {
+		monitorsEnableCommand, err = NewMonitorsEnableCommand(factory, monitorsCommand, commsFlagSet)
+	}
+
+	if err == nil {
+		commands.commandMap[monitorsCommand.Name()] = monitorsCommand
+		commands.commandMap[monitorsEnableCommand.Name()] = monitorsEnableCommand
+	}
+
+	return err
+}
+
 func (commands *commandCollectionImpl) addUsersCommands(factory spi.Factory, rootCommand spi.GalasaCommand, commsFlagSet GalasaFlagSet) error {
 
 	var err error

pkg/cmd/monitors.go

@@ -0,0 +1,93 @@
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package cmd
+
+import (
+	"github.com/galasa-dev/cli/pkg/spi"
+	"github.com/spf13/cobra"
+)
+
+type MonitorsCmdValues struct {
+    name string
+}
+
+type MonitorsCommand struct {
+    cobraCommand *cobra.Command
+    values       *MonitorsCmdValues
+}
+
+// ------------------------------------------------------------------------------------------------
+// Constructors
+// ------------------------------------------------------------------------------------------------
+
+func NewMonitorsCmd(rootCommand spi.GalasaCommand, commsFlagSet GalasaFlagSet) (spi.GalasaCommand, error) {
+    cmd := new(MonitorsCommand)
+    err := cmd.init(rootCommand, commsFlagSet)
+    return cmd, err
+}
+
+// ------------------------------------------------------------------------------------------------
+// Public functions
+// ------------------------------------------------------------------------------------------------
+
+func (cmd *MonitorsCommand) Name() string {
+    return COMMAND_NAME_MONITORS
+}
+
+func (cmd *MonitorsCommand) CobraCommand() *cobra.Command {
+    return cmd.cobraCommand
+}
+
+func (cmd *MonitorsCommand) Values() interface{} {
+    return cmd.values
+}
+
+// ------------------------------------------------------------------------------------------------
+// Private functions
+// ------------------------------------------------------------------------------------------------
+
+func (cmd *MonitorsCommand) init(rootCommand spi.GalasaCommand, commsFlagSet GalasaFlagSet) error {
+
+    var err error
+
+    cmd.values = &MonitorsCmdValues{}
+    cmd.cobraCommand, err = cmd.createCobraCommand(rootCommand, commsFlagSet)
+
+    return err
+}
+
+func (cmd *MonitorsCommand) createCobraCommand(rootCommand spi.GalasaCommand, commsFlagSet GalasaFlagSet) (*cobra.Command, error) {
+
+    var err error
+
+    monitorsCobraCmd := &cobra.Command{
+        Use:   "monitors",
+        Short: "Manage monitors in the Galasa service",
+        Long:  "The parent command for operations to manipulate monitors in the Galasa service",
+    }
+
+    monitorsCobraCmd.PersistentFlags().AddFlagSet(commsFlagSet.Flags())
+    rootCommand.CobraCommand().AddCommand(monitorsCobraCmd)
+
+    return monitorsCobraCmd, err
+}
+
+func addMonitorNameFlag(cmd *cobra.Command, isMandatory bool, monitorsCmdValues *MonitorsCmdValues) {
+
+	flagName := "name"
+	var description string
+	if isMandatory {
+		description = "A mandatory flag that identifies the monitor to be manipulated by name."
+	} else {
+		description = "An optional flag that identifies the monitor to be retrieved by name."
+	}
+
+	cmd.Flags().StringVar(&monitorsCmdValues.name, flagName, "", description)
+
+	if isMandatory {
+		cmd.MarkFlagRequired(flagName)
+	}
+}

pkg/cmd/monitorsEnable.go

@@ -0,0 +1,139 @@
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package cmd
+
+import (
+	"log"
+
+	"github.com/galasa-dev/cli/pkg/api"
+	"github.com/galasa-dev/cli/pkg/galasaapi"
+	"github.com/galasa-dev/cli/pkg/monitors"
+	"github.com/galasa-dev/cli/pkg/spi"
+	"github.com/galasa-dev/cli/pkg/utils"
+	"github.com/spf13/cobra"
+)
+
+type MonitorsEnableCmdValues struct {
+}
+
+type MonitorsEnableCommand struct {
+	values *MonitorsEnableCmdValues
+    cobraCommand *cobra.Command
+}
+
+// ------------------------------------------------------------------------------------------------
+// Constructors methods
+// ------------------------------------------------------------------------------------------------
+func NewMonitorsEnableCommand(
+    factory spi.Factory,
+    monitorsEnableCommand spi.GalasaCommand,
+    commsFlagSet GalasaFlagSet,
+) (spi.GalasaCommand, error) {
+
+    cmd := new(MonitorsEnableCommand)
+
+    err := cmd.init(factory, monitorsEnableCommand, commsFlagSet)
+    return cmd, err
+}
+
+// ------------------------------------------------------------------------------------------------
+// Public methods
+// ------------------------------------------------------------------------------------------------
+func (cmd *MonitorsEnableCommand) Name() string {
+    return COMMAND_NAME_MONITORS_ENABLE
+}
+
+func (cmd *MonitorsEnableCommand) CobraCommand() *cobra.Command {
+    return cmd.cobraCommand
+}
+
+func (cmd *MonitorsEnableCommand) Values() interface{} {
+	return cmd.values
+}
+
+// ------------------------------------------------------------------------------------------------
+// Private methods
+// ------------------------------------------------------------------------------------------------
+func (cmd *MonitorsEnableCommand) init(factory spi.Factory, monitorsCommand spi.GalasaCommand, commsFlagSet GalasaFlagSet) error {
+    var err error
+
+	cmd.values = &MonitorsEnableCmdValues{}
+    cmd.cobraCommand, err = cmd.createCobraCmd(factory, monitorsCommand, commsFlagSet.Values().(*CommsFlagSetValues))
+
+    return err
+}
+
+func (cmd *MonitorsEnableCommand) createCobraCmd(
+    factory spi.Factory,
+    monitorsCommand spi.GalasaCommand,
+    commsFlagSetValues *CommsFlagSetValues,
+) (*cobra.Command, error) {
+
+    var err error
+
+    monitorsCommandValues := monitorsCommand.Values().(*MonitorsCmdValues)
+    monitorsEnableCobraCmd := &cobra.Command{
+        Use:     "enable",
+        Short:   "Enable a monitor in the Galasa service",
+        Long:    "Enables a given monitor in the Galasa service",
+        Aliases: []string{COMMAND_NAME_MONITORS_ENABLE},
+        RunE: func(cobraCommand *cobra.Command, args []string) error {
+			return cmd.executeMonitorsEnable(factory, monitorsCommand.Values().(*MonitorsCmdValues), commsFlagSetValues)
+        },
+    }
+
+    addMonitorNameFlag(monitorsEnableCobraCmd, true, monitorsCommandValues)
+
+    monitorsCommand.CobraCommand().AddCommand(monitorsEnableCobraCmd)
+
+    return monitorsEnableCobraCmd, err
+}
+
+func (cmd *MonitorsEnableCommand) executeMonitorsEnable(
+    factory spi.Factory,
+    monitorsCmdValues *MonitorsCmdValues,
+    commsFlagSetValues *CommsFlagSetValues,
+) error {
+
+    var err error
+    // Operations on the file system will all be relative to the current folder.
+    fileSystem := factory.GetFileSystem()
+
+	err = utils.CaptureLog(fileSystem, commsFlagSetValues.logFileName)
+	if err == nil {
+		commsFlagSetValues.isCapturingLogs = true
+
+		log.Println("Galasa CLI - Enable monitors from the Galasa service")
+
+		env := factory.GetEnvironment()
+
+		var galasaHome spi.GalasaHome
+		galasaHome, err = utils.NewGalasaHome(fileSystem, env, commsFlagSetValues.CmdParamGalasaHomePath)
+		if err == nil {
+
+			var commsClient api.APICommsClient
+			commsClient, err = api.NewAPICommsClient(
+				commsFlagSetValues.bootstrap,
+				commsFlagSetValues.maxRetries,
+				commsFlagSetValues.retryBackoffSeconds,
+				factory,
+				galasaHome,
+			)
+
+			if err == nil {
+
+				byteReader := factory.GetByteReader()
+
+				enableMonitorsFunc := func(apiClient *galasaapi.APIClient) error {
+					return monitors.EnableMonitor(monitorsCmdValues.name, apiClient, byteReader)
+				}
+				err = commsClient.RunAuthenticatedCommandWithRateLimitRetries(enableMonitorsFunc)
+			}
+		}
+	}
+
+    return err
+}