CLOUDP-197021: Atlas deployments logs (#2350)

Author: blva

docs/atlascli/command/atlas-deployments-logs.txt

@@ -39,14 +39,42 @@ Options
      - string
      - false
      - Name of the deployment.
+   * - --end
+     - int
+     - false
+     - UNIX Epoch-formatted ending date and time for the range of log messages to retrieve. This value defaults to the current timestamp.
+   * - --force
+     - 
+     - false
+     - Overwrites the destination file.
    * - -h, --help
      - 
      - false
      - help for logs
+   * - --hostname
+     - string
+     - false
+     - Name of the host that stores the log files that you want to download.
+   * - --name
+     - string
+     - false
+     - Name of the log file (e.g. mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz).
    * - -o, --output
      - string
      - false
      - Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
+   * - --projectId
+     - string
+     - false
+     - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
+   * - --start
+     - int
+     - false
+     - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp.
+   * - --type
+     - string
+     - false
+     - Type of deployment that you want to create. Valid values are ATLAS or LOCAL.
 
 Inherited Options
 -----------------

internal/cli/atlas/deployments/logs.go

@@ -15,48 +15,163 @@
 package deployments
 
 import (
+	"compress/gzip"
 	"context"
 	"errors"
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
 	"strings"
 
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/atlas/deployments/options"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/require"
+	"github.com/mongodb/mongodb-atlas-cli/internal/config"
 	"github.com/mongodb/mongodb-atlas-cli/internal/flag"
-	"github.com/mongodb/mongodb-atlas-cli/internal/log"
+	"github.com/mongodb/mongodb-atlas-cli/internal/search"
+	"github.com/mongodb/mongodb-atlas-cli/internal/store"
 	"github.com/mongodb/mongodb-atlas-cli/internal/usage"
+	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
+	"go.mongodb.org/atlas-sdk/v20230201008/admin"
 )
 
 type DownloadOpts struct {
 	cli.OutputOpts
 	cli.GlobalOpts
+	cli.DownloaderOpts
 	options.DeploymentOpts
+	downloadStore store.LogsDownloader
+	host          string
+	name          string
+	start         int64
+	end           int64
 }
 
 var ErrAtlasNotSupported = errors.New("atlas deployments are not supported")
 
+const filePermission = 0644
+
+func (opts *DownloadOpts) initStore(ctx context.Context) func() error {
+	return func() error {
+		var err error
+		opts.downloadStore, err = store.New(store.AuthenticatedPreset(config.Default()), store.WithContext(ctx))
+		return err
+	}
+}
+
 func (opts *DownloadOpts) Run(ctx context.Context) error {
 	if _, err := opts.SelectDeployments(ctx, opts.ConfigProjectID()); err != nil {
 		return err
 	}
 
+	if opts.IsLocalDeploymentType() {
+		return opts.RunLocal(ctx)
+	}
+
 	if opts.IsAtlasDeploymentType() {
-		return ErrAtlasNotSupported
+		if err := opts.validateAtlasFlags(); err != nil {
+			return err
+		}
+		return opts.RunAtlas()
 	}
 
-	logs, err := opts.PodmanClient.ContainerLogs(ctx, opts.LocalMongodHostname())
+	return errors.New("atlas deployments are not supported")
+}
+
+func (opts *DownloadOpts) RunAtlas() error {
+	if err := opts.downloadLogFile(); err != nil {
+		return err
+	}
+	defer opts.Fs.Remove(opts.Out) //nolint:errcheck
+
+	output, err := opts.unzipFile()
 	if err != nil {
 		return err
 	}
 
+	return opts.Print(output)
+}
+
+func (opts *DownloadOpts) downloadLogFile() error {
+	f, err := opts.NewWriteCloser()
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+
+	r := opts.newHostLogsParams()
+	if err = opts.downloadStore.DownloadLog(f, r); err != nil {
+		_ = opts.OnError(f)
+	}
+	return err
+}
+
+func (opts *DownloadOpts) unzipFile() (string, error) {
+	gzippedFile, err := opts.Fs.OpenFile(opts.Out, os.O_RDONLY, filePermission)
+	if err != nil {
+		return "", err
+	}
+	defer gzippedFile.Close()
+
+	gzReader, err := gzip.NewReader(gzippedFile)
+	if err != nil {
+		return "", err
+	}
+	defer gzReader.Close()
+
+	s, err := io.ReadAll(gzReader)
+	if err != nil {
+		return "", err
+	}
+
+	return string(s), nil
+}
+
+func (opts *DownloadOpts) newHostLogsParams() *admin.GetHostLogsApiParams {
+	fileBaseName := strings.TrimSuffix(opts.name, filepath.Ext(opts.name))
+	params := &admin.GetHostLogsApiParams{
+		GroupId:  opts.ConfigProjectID(),
+		HostName: opts.host,
+		LogName:  fileBaseName,
+	}
+	if opts.start > 0 {
+		params.StartDate = &opts.start
+	}
+	if opts.end > 0 {
+		params.StartDate = &opts.end
+	}
+	return params
+}
+
+func (opts *DownloadOpts) RunLocal(ctx context.Context) error {
+	logs, err := opts.PodmanClient.ContainerLogs(ctx, opts.LocalMongodHostname())
+	if err != nil {
+		return err
+	}
 	// format log entries into lines
 	if opts.IsJSONOutput() {
 		return opts.Print(logs)
 	}
 	return opts.Print(strings.Join(logs, "\n"))
 }
 
+func (opts *DownloadOpts) validateAtlasFlags() error {
+	if opts.host == "" {
+		return errors.New("missing --hostname flag")
+	}
+	if opts.name == "" {
+		return errors.New("missing --name flag")
+	}
+
+	validNameFlags := []string{"mongodb.gz", "mongos.gz", "mongosqld.gz", "mongodb-audit-log.gz", "mongos-audit-log.gz"}
+	if !search.StringInSliceFold(validNameFlags, opts.name) {
+		return fmt.Errorf("invalid --name flag: %s", opts.name)
+	}
+	return nil
+}
+
 // atlas deployments logs.
 func LogsBuilder() *cobra.Command {
 	opts := &DownloadOpts{}
@@ -68,19 +183,30 @@ func LogsBuilder() *cobra.Command {
 		GroupID: "local",
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			w := cmd.OutOrStdout()
-			log.SetWriter(w)
+			opts.Fs = afero.NewOsFs()
+			opts.Out = opts.name
 
 			return opts.PreRunE(
 				opts.InitStore(cmd.Context(), cmd.OutOrStdout()),
+				opts.initStore(cmd.Context()),
 				opts.InitOutput(w, ""))
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return opts.Run(cmd.Context())
 		},
 	}
 
+	cmd.Flags().StringVar(&opts.DeploymentType, flag.TypeFlag, "", usage.DeploymentType)
 	cmd.Flags().StringVarP(&opts.Output, flag.Output, flag.OutputShort, "", usage.FormatOut)
 	cmd.Flags().StringVar(&opts.DeploymentName, flag.DeploymentName, "", usage.DeploymentName)
 
+	// Atlas flags
+	cmd.Flags().Int64Var(&opts.start, flag.Start, 0, usage.LogStart)
+	cmd.Flags().Int64Var(&opts.end, flag.End, 0, usage.LogEnd)
+	cmd.Flags().BoolVar(&opts.Force, flag.Force, false, usage.ForceFile)
+	cmd.Flags().StringVar(&opts.ProjectID, flag.ProjectID, "", usage.ProjectID)
+	cmd.Flags().StringVar(&opts.host, flag.Hostname, "", usage.LogHostName)
+	cmd.Flags().StringVar(&opts.name, flag.Name, "", usage.LogName)
+
 	return cmd
 }

internal/cli/atlas/deployments/logs_test.go

@@ -18,7 +18,10 @@ package deployments
 
 import (
 	"bytes"
+	"compress/gzip"
 	"context"
+	"io"
+	"os"
 	"strings"
 	"testing"
 
@@ -27,7 +30,10 @@ import (
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/atlas/deployments/options"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/atlas/deployments/test/fixture"
 	"github.com/mongodb/mongodb-atlas-cli/internal/flag"
+	"github.com/mongodb/mongodb-atlas-cli/internal/mocks"
 	"github.com/mongodb/mongodb-atlas-cli/internal/test"
+	"github.com/spf13/afero"
+	"go.mongodb.org/atlas-sdk/v20230201008/admin"
 )
 
 func TestLogsBuilder(t *testing.T) {
@@ -46,7 +52,7 @@ func TestLogs_RunLocal(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	ctx := context.Background()
 	buf := new(bytes.Buffer)
-	expectedLocalDeployment := "localDeployment1"
+	expectedLocalDeployment := "localDeployment"
 	deploymentTest := fixture.NewMockLocalDeploymentOpts(ctrl, expectedLocalDeployment)
 	mockPodman := deploymentTest.MockPodman
 
@@ -75,3 +81,51 @@ func TestLogs_RunLocal(t *testing.T) {
 		t.Fatalf("Run() expected output: %s, got: %s", expectedLogs, buf.String())
 	}
 }
+
+func TestLogs_RunAtlas(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	ctx := context.Background()
+	buf := new(bytes.Buffer)
+	atlasDeployment := "localDeployment1"
+	mockStore := mocks.NewMockLogsDownloader(ctrl)
+	deploymentTest := fixture.NewMockAtlasDeploymentOpts(ctrl, atlasDeployment)
+
+	downloadOpts := &DownloadOpts{
+		OutputOpts:     cli.OutputOpts{OutWriter: buf},
+		GlobalOpts:     cli.GlobalOpts{ProjectID: "ProjectID"},
+		DownloaderOpts: cli.DownloaderOpts{},
+		DeploymentOpts: *deploymentTest.Opts,
+		downloadStore:  mockStore,
+		host:           "test",
+		name:           "mongodb.gz",
+	}
+
+	downloadOpts.Fs = afero.NewMemMapFs()
+	downloadOpts.Out = downloadOpts.name
+	deploymentTest.CommonAtlasMocks(downloadOpts.ProjectID)
+
+	mockStore.
+		EXPECT().
+		DownloadLog(gomock.Any(), downloadOpts.newHostLogsParams()).
+		Times(1).
+		DoAndReturn(func(_ io.Writer, _ *admin.GetHostLogsApiParams) error {
+			f, err := downloadOpts.Fs.OpenFile(downloadOpts.Out, os.O_WRONLY|os.O_CREATE, 0644)
+			if err != nil {
+				return err
+			}
+
+			zw := gzip.NewWriter(f)
+			defer zw.Close()
+			zw.Name = downloadOpts.Out
+
+			if _, err = zw.Write([]byte("log\nlog\n")); err != nil {
+				return err
+			}
+
+			return nil
+		})
+
+	if err := downloadOpts.Run(ctx); err != nil {
+		t.Fatalf("Run() unexpected error: %v", err)
+	}
+}

internal/cli/atlas/logs/download.go

@@ -57,6 +57,7 @@ func (opts *DownloadOpts) Run() error {
 	if err != nil {
 		return err
 	}
+	defer f.Close()
 
 	r := opts.newHostLogsParams()
 	if err := opts.store.DownloadLog(f, r); err != nil {
@@ -66,7 +67,8 @@ func (opts *DownloadOpts) Run() error {
 	if !opts.ShouldDownloadToStdout() {
 		fmt.Printf(downloadMessage, opts.Out)
 	}
-	return f.Close()
+
+	return nil
 }
 
 func (opts *DownloadOpts) initDefaultOut() error {

internal/usage/usage.go

@@ -465,4 +465,6 @@ dbName and collection are required only for built-in roles.`
 	ConnectWith                               = "Method for connecting to the deployment. Valid values are mongosh, compass, and skip."
 	AlertConfigFilename                       = "Path to the JSON configuration file that defines alert configuration settings."
 	DeploymentName                            = "Name of the deployment."
+	LogName                                   = "Name of the log file (e.g. mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz)."
+	LogHostName                               = "Name of the host that stores the log files that you want to download."
 )