Merge branch 'main' into em-2067-monitors-enable-disable

Signed-off-by: Eamonn Mansour <[email protected]>

Author: eamansour

README.md

@@ -477,6 +477,28 @@ galasactl monitors set --name myCustomMonitor --is-enabled false
 
 For a complete list of supported parameters see [here](./docs/generated/galasactl_monitors_set.md).
 
+## monitors get
+
+This command can be used to get the details of monitors, like resource cleanup monitors, that are available in the Galasa service.
+
+By default, the output of `monitors get` will be in a "summary" format. To change the output format, you can supply the `--format` flag followed by the format that you wish the output to be displayed in. For a list of supported formats, view the command's help information by running `galasactl monitors get --help`.
+
+### Examples
+
+To get a list of all monitors that are currently available in the Galasa service, run the following command:
+
+```
+galasactl monitors get 
+```
+
+If you would like to get a specific monitor, you can supply the name of the monitor with the `--name` flag. For example, the following command can be used to get a monitor named "myCustomMonitor":
+
+```
+galasactl monitors get --name myCustomMonitor
+```
+
+For a complete list of supported parameters see [here](./docs/generated/galasactl_monitors_get.md).
+
 ## properties get
 This command retrieves details of properties in a namespace.
 

docs/generated/errors-list.md

@@ -214,19 +214,21 @@ 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.
-- 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.
+- GAL1218E: Failed to get monitors. Sending the get request to the Galasa service failed. Cause is {}
+- GAL1219E: Failed to get monitors. Unexpected http status code {} received from the server.
+- GAL1220E: Failed to get monitors. Unexpected http status code {} received from the server. Error details from the server could not be read. Cause: {}
+- GAL1221E: Failed to get monitors. Unexpected http status code {} received from the server. Error details from the server are not in a valid json format. Cause: '{}'
+- GAL1222E: Failed to get monitors. Unexpected http status code {} received from the server. Error details from the server are: '{}'
+- GAL1223E: Failed to get monitors. 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: Invalid '--is-enabled' value provided. Supported values are 'true' and 'false'. Check your command parameters and try again.
-- GAL1227E: Internal failure. Contents of gzip could not be decoded. {} error: {}
-- GAL1228E: Internal failure. Contents of gzip could not be encoded and compressed. {} error: {}
-- GAL1229E: Internal failure. Contents of gzip could not be flushed while encoding and compressing. {} error: {}
-- GAL1230E: Internal failure. Gzip file could not be closed while encoding and compressing. {} error: {}
+- GAL1227E: Failed to update a monitor named '{}'. Sending the put request to the Galasa service failed. Cause is {}
+- GAL1228E: Failed to update a monitor named '{}'. Unexpected http status code {} received from the server.
+- GAL1229E: Failed to update a monitor named '{}'. Unexpected http status code {} received from the server. Error details from the server could not be read. Cause: {}
+- GAL1230E: 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: '{}'
+- GAL1231E: Failed to update a monitor named '{}'. Unexpected http status code {} received from the server. Error details from the server are: '{}'
+- GAL1232E: 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.
 - GAL2000W: Warning: Maven configuration file settings.xml should contain a reference to a Galasa repository so that the galasa OBR can be resolved. The official release repository is '{}', and 'pre-release' repository is '{}'
 - GAL2501I: Downloaded {} artifacts to folder '{}'
 

docs/generated/galasactl_monitors.md

@@ -25,5 +25,6 @@ The parent command for operations to manipulate monitors in the Galasa service
 ### SEE ALSO
 
 * [galasactl](galasactl.md)	 - CLI for Galasa
+* [galasactl monitors get](galasactl_monitors_get.md)	 - Get monitors from the Galasa service
 * [galasactl monitors set](galasactl_monitors_set.md)	 - Update a monitor in the Galasa service
 

docs/generated/galasactl_monitors_get.md

@@ -0,0 +1,34 @@
+## galasactl monitors get
+
+Get monitors from the Galasa service
+
+### Synopsis
+
+Get a list of monitors or a specific monitor from the Galasa service
+
+```
+galasactl monitors get [flags]
+```
+
+### Options
+
+```
+      --format string   the output format of the returned monitors. Supported formats are: 'summary', 'yaml'. (default "summary")
+  -h, --help            Displays the options for the 'monitors get' command.
+      --name string     An optional flag that identifies the monitor to be retrieved 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

@@ -40,6 +40,7 @@ const (
 	COMMAND_NAME_LOCAL                    = "local"
 	COMMAND_NAME_LOCAL_INIT               = "local init"
 	COMMAND_NAME_MONITORS                 = "monitors"
+	COMMAND_NAME_MONITORS_GET             = "monitors get"
 	COMMAND_NAME_MONITORS_SET             = "monitors set"
 	COMMAND_NAME_PROPERTIES               = "properties"
 	COMMAND_NAME_PROPERTIES_GET           = "properties get"
@@ -440,16 +441,19 @@ func (commands *commandCollectionImpl) addMonitorsCommands(factory spi.Factory,
 
 	var err error
 	var monitorsCommand spi.GalasaCommand
+	var monitorsGetCommand spi.GalasaCommand
 	var monitorsSetCommand spi.GalasaCommand
 
 	monitorsCommand, err = NewMonitorsCmd(rootCommand, commsFlagSet)
 
 	if err == nil {
+		monitorsGetCommand, err = NewMonitorsGetCommand(factory, monitorsCommand, commsFlagSet)
 		monitorsSetCommand, err = NewMonitorsSetCommand(factory, monitorsCommand, commsFlagSet)
 	}
 
 	if err == nil {
 		commands.commandMap[monitorsCommand.Name()] = monitorsCommand
+		commands.commandMap[monitorsGetCommand.Name()] = monitorsGetCommand
 		commands.commandMap[monitorsSetCommand.Name()] = monitorsSetCommand
 	}
 

pkg/cmd/monitorsGet.go

@@ -0,0 +1,144 @@
+/*
+ * 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 MonitorsGetCmdValues struct {
+	outputFormat string
+}
+
+type MonitorsGetCommand struct {
+	values *MonitorsGetCmdValues
+    cobraCommand *cobra.Command
+}
+
+// ------------------------------------------------------------------------------------------------
+// Constructors methods
+// ------------------------------------------------------------------------------------------------
+func NewMonitorsGetCommand(
+    factory spi.Factory,
+    monitorsGetCommand spi.GalasaCommand,
+    commsFlagSet GalasaFlagSet,
+) (spi.GalasaCommand, error) {
+
+    cmd := new(MonitorsGetCommand)
+
+    err := cmd.init(factory, monitorsGetCommand, commsFlagSet)
+    return cmd, err
+}
+
+// ------------------------------------------------------------------------------------------------
+// Public methods
+// ------------------------------------------------------------------------------------------------
+func (cmd *MonitorsGetCommand) Name() string {
+    return COMMAND_NAME_MONITORS_GET
+}
+
+func (cmd *MonitorsGetCommand) CobraCommand() *cobra.Command {
+    return cmd.cobraCommand
+}
+
+func (cmd *MonitorsGetCommand) Values() interface{} {
+	return cmd.values
+}
+
+// ------------------------------------------------------------------------------------------------
+// Private methods
+// ------------------------------------------------------------------------------------------------
+func (cmd *MonitorsGetCommand) init(factory spi.Factory, monitorsCommand spi.GalasaCommand, commsFlagSet GalasaFlagSet) error {
+    var err error
+
+	cmd.values = &MonitorsGetCmdValues{}
+    cmd.cobraCommand, err = cmd.createCobraCmd(factory, monitorsCommand, commsFlagSet.Values().(*CommsFlagSetValues))
+
+    return err
+}
+
+func (cmd *MonitorsGetCommand) createCobraCmd(
+    factory spi.Factory,
+    monitorsCommand spi.GalasaCommand,
+    commsFlagSetValues *CommsFlagSetValues,
+) (*cobra.Command, error) {
+
+    var err error
+
+    monitorsCommandValues := monitorsCommand.Values().(*MonitorsCmdValues)
+    monitorsGetCobraCmd := &cobra.Command{
+        Use:     "get",
+        Short:   "Get monitors from the Galasa service",
+        Long:    "Get a list of monitors or a specific monitor from the Galasa service",
+        Aliases: []string{COMMAND_NAME_MONITORS_GET},
+        RunE: func(cobraCommand *cobra.Command, args []string) error {
+			return cmd.executeMonitorsGet(factory, monitorsCommand.Values().(*MonitorsCmdValues), commsFlagSetValues)
+        },
+    }
+
+    addMonitorNameFlag(monitorsGetCobraCmd, false, monitorsCommandValues)
+
+	formatters := monitors.GetFormatterNamesAsString()
+	monitorsGetCobraCmd.Flags().StringVar(&cmd.values.outputFormat, "format", "summary", "the output format of the returned monitors. Supported formats are: "+formatters+".")
+
+    monitorsCommand.CobraCommand().AddCommand(monitorsGetCobraCmd)
+
+    return monitorsGetCobraCmd, err
+}
+
+func (cmd *MonitorsGetCommand) executeMonitorsGet(
+    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 - Get 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 {
+	
+				var console = factory.GetStdOutConsole()	
+				byteReader := factory.GetByteReader()
+
+				getMonitorsFunc := func(apiClient *galasaapi.APIClient) error {
+					return monitors.GetMonitors(monitorsCmdValues.name, cmd.values.outputFormat, console, apiClient, byteReader)
+				}
+				err = commsClient.RunAuthenticatedCommandWithRateLimitRetries(getMonitorsFunc)
+			}
+		}
+	}
+
+    return err
+}

pkg/cmd/monitorsGet_test.go

@@ -0,0 +1,63 @@
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package cmd
+
+import (
+    "testing"
+
+    "github.com/galasa-dev/cli/pkg/utils"
+    "github.com/stretchr/testify/assert"
+)
+
+func TestCommandListContainsMonitorsGetCommand(t *testing.T) {
+    /// Given...
+    factory := utils.NewMockFactory()
+    commands, _ := NewCommandCollection(factory)
+
+    // When...
+    monitorsCommand, err := commands.GetCommand(COMMAND_NAME_MONITORS_GET)
+    assert.Nil(t, err)
+
+    // Then...
+    assert.NotNil(t, monitorsCommand)
+    assert.Equal(t, COMMAND_NAME_MONITORS_GET, monitorsCommand.Name())
+    assert.NotNil(t, monitorsCommand.Values())
+	assert.IsType(t, &MonitorsGetCmdValues{}, monitorsCommand.Values())
+}
+
+func TestMonitorsGetHelpFlagSetCorrectly(t *testing.T) {
+    // Given...
+    factory := utils.NewMockFactory()
+	commandCollection, _ := setupTestCommandCollection(COMMAND_NAME_MONITORS_GET, factory, t)
+
+    var args []string = []string{"monitors", "get", "--help"}
+
+    // When...
+    err := commandCollection.Execute(args)
+
+    // Then...
+    checkOutput("Get a list of monitors or a specific monitor from the Galasa service", "", factory, t)
+
+    assert.Nil(t, err)
+}
+
+func TestMonitorsGetNoFlagsReturnsOk(t *testing.T) {
+	// Given...
+	factory := utils.NewMockFactory()
+	commandCollection, _ := setupTestCommandCollection(COMMAND_NAME_MONITORS_GET, factory, t)
+
+	var args []string = []string{"monitors", "get"}
+
+	// When...
+	err := commandCollection.Execute(args)
+
+	// Then...
+	assert.Nil(t, err)
+
+	// Check what the user saw is reasonable.
+	checkOutput("", "", factory, t)
+}
+