[MM-63556] mmctl: Add compliance export download cmd (#30576)

* add mmctl compliance export download command and tests

- Introduced `ComplianceExportDownloadCmd` to facilitate downloading compliance export files.
- Implemented the `DownloadComplianceExport` method in the Client interface for handling file downloads.
- Added unit tests for the download command, covering successful downloads, error handling for non-existent jobs, and retries on failure.
- Included end-to-end tests to validate the command's functionality.
- Updated documentation to include usage examples and options for the new command.

* don't know why this was left out

* PR comments

* adjust test for new retry logic

* refactored download fn for compliance_export and export

* fix test due to fixed logic

* docs
Этот коммит содержится в:
Christopher Poile
2025-06-24 16:27:54 -04:00
коммит произвёл GitHub
родитель 60a747f975
Коммит b33a7e362f
12 изменённых файлов: 548 добавлений и 22 удалений

Просмотреть файл

@@ -5,7 +5,10 @@ package commands
import (
"context"
"fmt"
"os"
gomock "github.com/golang/mock/gomock"
"github.com/mattermost/mattermost/server/public/model"
"github.com/mattermost/mattermost/server/v8/cmd/mmctl/printer"
"github.com/spf13/cobra"
@@ -224,6 +227,77 @@ func (s *MmctlUnitTestSuite) TestComplianceExportCancelCmdF() {
})
}
func (s *MmctlUnitTestSuite) TestComplianceExportDownloadCmdF() {
mockJob := &model.Job{
Id: model.NewId(),
CreateAt: model.GetMillis(),
Type: model.JobTypeMessageExport,
}
s.Run("download job file successfully", func() {
printer.Clean()
defer func() {
_ = os.Remove("suggested-filename.zip")
}()
s.client.
EXPECT().
DownloadComplianceExport(gomock.Any(), mockJob.Id, gomock.Any()).
Return("suggested-filename.zip", nil).
Times(1)
cmd := makeCmd()
cmd.Flags().Int("num-retries", 5, "")
err := complianceExportDownloadCmdF(s.client, cmd, []string{mockJob.Id})
s.Require().Nil(err)
s.Len(printer.GetLines(), 1)
s.Len(printer.GetErrorLines(), 0)
s.Equal(fmt.Sprintf("Compliance export file downloaded to %q", "suggested-filename.zip"), printer.GetLines()[0])
})
s.Run("download job file with explicit path", func() {
printer.Clean()
defer func() {
_ = os.Remove("custom-path.zip")
}()
s.client.
EXPECT().
DownloadComplianceExport(context.TODO(), mockJob.Id, gomock.Any()).
Return("", nil).
Times(1)
cmd := makeCmd()
cmd.Flags().Int("num-retries", 5, "")
err := complianceExportDownloadCmdF(s.client, cmd, []string{mockJob.Id, "custom-path.zip"})
s.Require().Nil(err)
s.Len(printer.GetLines(), 1)
s.Len(printer.GetErrorLines(), 0)
s.Equal(fmt.Sprintf("Compliance export file downloaded to %q", "custom-path.zip"), printer.GetLines()[0])
})
s.Run("download job with error", func() {
printer.Clean()
mockError := &model.AppError{
Message: "failed to download file",
}
s.client.
EXPECT().
DownloadComplianceExport(context.TODO(), mockJob.Id, gomock.Any()).
Return("", mockError).
Times(6) // Initial attempt + 5 retries
cmd := makeCmd()
cmd.Flags().Int("num-retries", 5, "")
err := complianceExportDownloadCmdF(s.client, cmd, []string{mockJob.Id})
s.Require().NotNil(err)
s.EqualError(err, "failed to download compliance export after 5 retries: failed to download file")
s.Len(printer.GetLines(), 0)
s.Len(printer.GetErrorLines(), 0)
})
}
func makeCmd() *cobra.Command {
cmd := &cobra.Command{}
cmd.Flags().Int("page", 0, "")