MMCTL: Add import delete cmd for removing the import files (#29764)

Co-authored-by: Ben Schumacher <ben.schumacher@mattermost.com>
Этот коммит содержится в:
Harsh Aulakh
2025-06-10 15:36:38 +05:30
коммит произвёл GitHub
родитель 0cf6361139
Коммит 09a2037b61
17 изменённых файлов: 348 добавлений и 35 удалений

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

@@ -126,6 +126,7 @@ type Routes struct {
Cloud *mux.Router // 'api/v4/cloud'
Imports *mux.Router // 'api/v4/imports'
Import *mux.Router // 'api/v4/imports/{import_name:.+\\.zip}'
Exports *mux.Router // 'api/v4/exports'
Export *mux.Router // 'api/v4/exports/{export_name:.+\\.zip}'
@@ -273,6 +274,7 @@ func Init(srv *app.Server) (*API, error) {
api.BaseRoutes.Cloud = api.BaseRoutes.APIRoot.PathPrefix("/cloud").Subrouter()
api.BaseRoutes.Imports = api.BaseRoutes.APIRoot.PathPrefix("/imports").Subrouter()
api.BaseRoutes.Import = api.BaseRoutes.Imports.PathPrefix("/{import_name:.+\\.zip}").Subrouter()
api.BaseRoutes.Exports = api.BaseRoutes.APIRoot.PathPrefix("/exports").Subrouter()
api.BaseRoutes.Export = api.BaseRoutes.Exports.PathPrefix("/{export_name:.+\\.zip}").Subrouter()
@@ -436,6 +438,7 @@ func InitLocal(srv *app.Server) *API {
api.BaseRoutes.Upload = api.BaseRoutes.Uploads.PathPrefix("/{upload_id:[A-Za-z0-9]+}").Subrouter()
api.BaseRoutes.Imports = api.BaseRoutes.APIRoot.PathPrefix("/imports").Subrouter()
api.BaseRoutes.Import = api.BaseRoutes.Imports.PathPrefix("/{import_name:.+\\.zip}").Subrouter()
api.BaseRoutes.Exports = api.BaseRoutes.APIRoot.PathPrefix("/exports").Subrouter()
api.BaseRoutes.Export = api.BaseRoutes.Exports.PathPrefix("/{export_name:.+\\.zip}").Subrouter()

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

@@ -9,10 +9,12 @@ import (
"github.com/mattermost/mattermost/server/public/model"
"github.com/mattermost/mattermost/server/public/shared/mlog"
"github.com/mattermost/mattermost/server/v8/channels/audit"
)
func (api *API) InitImport() {
api.BaseRoutes.Imports.Handle("", api.APISessionRequired(listImports)).Methods(http.MethodGet)
api.BaseRoutes.Import.Handle("", api.APISessionRequired(deleteImport)).Methods(http.MethodDelete)
}
func listImports(c *Context, w http.ResponseWriter, r *http.Request) {
@@ -31,3 +33,23 @@ func listImports(c *Context, w http.ResponseWriter, r *http.Request) {
c.Logger.Warn("Error writing imports", mlog.Err(err))
}
}
func deleteImport(c *Context, w http.ResponseWriter, r *http.Request) {
importName := c.Params.ImportName
auditRec := c.MakeAuditRecord("deleteImport", audit.Fail)
defer c.LogAuditRec(auditRec)
auditRec.AddMeta("import_name", importName)
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionManageSystem) {
c.SetPermissionError(model.PermissionManageSystem)
return
}
if err := c.App.DeleteImport(importName); err != nil {
c.Err = err
return
}
auditRec.Success()
ReturnStatusOK(w)
}

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

@@ -7,4 +7,5 @@ import "net/http"
func (api *API) InitImportLocal() {
api.BaseRoutes.Imports.Handle("", api.APILocal(listImports)).Methods(http.MethodGet)
api.BaseRoutes.Import.Handle("", api.APILocal(deleteImport)).Methods(http.MethodDelete)
}

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

@@ -19,42 +19,43 @@ import (
"github.com/mattermost/mattermost/server/v8/channels/utils/fileutils"
)
// Helper function to upload a new import file
func uploadNewImport(th *TestHelper, c *model.Client4, t *testing.T) string {
testsDir, _ := fileutils.FindDir("tests")
require.NotEmpty(t, testsDir)
file, err := os.Open(testsDir + "/import_test.zip")
require.NoError(t, err)
info, err := file.Stat()
require.NoError(t, err)
us := &model.UploadSession{
Filename: info.Name(),
FileSize: info.Size(),
Type: model.UploadTypeImport,
}
if c == th.LocalClient {
us.UserId = model.UploadNoUserID
}
u, _, err := c.CreateUpload(context.Background(), us)
require.NoError(t, err)
require.NotNil(t, u)
finfo, _, err := c.UploadData(context.Background(), u.Id, file)
require.NoError(t, err)
require.NotNil(t, finfo)
return u.Id
}
func TestListImports(t *testing.T) {
mainHelper.Parallel(t)
th := Setup(t)
defer th.TearDown()
testsDir, _ := fileutils.FindDir("tests")
require.NotEmpty(t, testsDir)
uploadNewImport := func(c *model.Client4, t *testing.T) string {
file, err := os.Open(testsDir + "/import_test.zip")
require.NoError(t, err)
info, err := file.Stat()
require.NoError(t, err)
us := &model.UploadSession{
Filename: info.Name(),
FileSize: info.Size(),
Type: model.UploadTypeImport,
}
if c == th.LocalClient {
us.UserId = model.UploadNoUserID
}
u, _, err := c.CreateUpload(context.Background(), us)
require.NoError(t, err)
require.NotNil(t, u)
finfo, _, err := c.UploadData(context.Background(), u.Id, file)
require.NoError(t, err)
require.NotNil(t, finfo)
return u.Id
}
t.Run("no permissions", func(t *testing.T) {
imports, _, err := th.Client.ListImports(context.Background())
require.Error(t, err)
@@ -71,8 +72,8 @@ func TestListImports(t *testing.T) {
}, "no imports")
th.TestForSystemAdminAndLocal(t, func(t *testing.T, c *model.Client4) {
id := uploadNewImport(c, t)
id2 := uploadNewImport(c, t)
id := uploadNewImport(th, c, t)
id2 := uploadNewImport(th, c, t)
importDir := filepath.Join(dataDir, "import")
f, err := os.Create(filepath.Join(importDir, "import.zip.tmp"))
@@ -99,7 +100,7 @@ func TestListImports(t *testing.T) {
require.NoError(t, err)
require.Empty(t, imports)
id := uploadNewImport(c, t)
id := uploadNewImport(th, c, t)
imports, _, err = c.ListImports(context.Background())
require.NoError(t, err)
require.NotEmpty(t, imports)
@@ -151,3 +152,36 @@ func TestImportInLocalMode(t *testing.T) {
// Just a sanity check to ensure new posts are actually added in the system.
require.Greater(t, cnt2, cnt1)
}
func TestDeleteImport(t *testing.T) {
th := Setup(t)
defer th.TearDown()
t.Run("no delete permissions", func(t *testing.T) {
response, err := th.Client.DeleteImport(context.Background(), "import_test.zip")
require.Error(t, err)
CheckErrorID(t, err, "api.context.permissions.app_error")
require.Equal(t, 403, response.StatusCode)
})
th.TestForSystemAdminAndLocal(t, func(t *testing.T, c *model.Client4) {
id := uploadNewImport(th, th.SystemAdminClient, t)
id2 := uploadNewImport(th, th.SystemAdminClient, t)
response, delErr := th.SystemAdminClient.DeleteImport(context.Background(), id+"_import_test.zip")
require.Equal(t, 200, response.StatusCode)
require.NoError(t, delErr)
imports, _, err := th.SystemAdminClient.ListImports(context.Background())
require.NoError(t, err)
require.NotEmpty(t, imports)
require.Len(t, imports, 1)
require.Contains(t, imports, id2+"_import_test.zip")
require.NotContains(t, imports, id+"_import_test.zip")
_, err = th.SystemAdminClient.DeleteImport(context.Background(), id2+"_import_test.zip")
require.NoError(t, err)
//idempotency check
_, err = th.SystemAdminClient.DeleteImport(context.Background(), id2+"_import_test.zip")
require.NoError(t, err)
}, "successful deletion")
}

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

@@ -410,3 +410,15 @@ func (a *App) ListImports() ([]string, *model.AppError) {
return results, nil
}
func (a *App) DeleteImport(name string) *model.AppError {
filePath := filepath.Join(*a.Config().ImportSettings.Directory, name)
if ok, err := a.FileExists(filePath); err != nil {
return err
} else if !ok {
return nil
}
return a.RemoveFile(filePath)
}

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

@@ -679,3 +679,37 @@ func TestImportBulkImportWithAttachments(t *testing.T) {
files := GetAttachments(adminUser.Id, th, t)
require.Len(t, files, 11)
}
func TestDeleteImport(t *testing.T) {
th := Setup(t)
defer th.TearDown()
importDir := filepath.Join(th.tempWorkspace, "data", "import")
err := os.MkdirAll(importDir, os.ModePerm)
require.NoError(t, err)
f, err := os.Create(filepath.Join(importDir, "import.zip"))
require.NoError(t, err)
f.Close()
defer func() {
err = os.RemoveAll(importDir)
require.NoError(t, err)
}()
t.Run("delete import successful", func(t *testing.T) {
imports, err := th.App.ListImports()
require.Nil(t, err)
require.Equal(t, 1, len(imports))
require.Equal(t, "import.zip", imports[0])
delErr := th.App.DeleteImport("import.zip")
require.Nil(t, delErr)
imports, err = th.App.ListImports()
require.Nil(t, err)
require.Equal(t, 0, len(imports))
//idempotency check
delErr = th.App.DeleteImport("import.zip")
require.Nil(t, delErr)
})
}

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

@@ -88,6 +88,7 @@ type Params struct {
FilterParentTeamPermitted bool
CategoryId string
ExportName string
ImportName string
ExcludePolicyConstrained bool
GroupSource model.GroupSource
FilterHasMember string
@@ -278,6 +279,7 @@ func ParamsFromRequest(r *http.Request) *Params {
params.IncludeTotalCount, _ = strconv.ParseBool(query.Get("include_total_count"))
params.IncludeDeleted, _ = strconv.ParseBool(query.Get("include_deleted"))
params.ExportName = props["export_name"]
params.ImportName = props["import_name"]
params.ExcludePolicyConstrained, _ = strconv.ParseBool(query.Get("exclude_policy_constrained"))
params.AccessControlPolicyEnforced, _ = strconv.ParseBool(query.Get("access_control_policy_enforced"))
params.ExcludeAccessControlPolicyEnforced, _ = strconv.ParseBool(query.Get("exclude_access_control_policy_enforced"))