Skip to content

implement backup cmd for v4 #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amberxu25 merged 2 commits into from
Dec 3, 2025
Merged

implement backup cmd for v4 #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd76d2b
implement backup cmd for v4
amberxu25 Dec 2, 2025
b360bb5
rename v3 backup test
amberxu25 Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 186 additions & 67 deletions cmd/backup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,20 @@ import (
"strings"

"github.com/spf13/cobra"
"github.com/spf13/viper"
)

type backupDownloadV4 struct {
PackageName string `json:"packageName"`
}

type backupResourceV4 struct {
ResourceName string `json:"resourceName"`
PackagePath string `json:"packagePath"`
SuccessTopic string `json:"successTopic"`
FailureTopic string `json:"failureTopic"`
}

type backupFlags struct {
outputBackupFile string
backupResourceName string
Expand All @@ -22,12 +34,15 @@ type backupFlags struct {
backupSuccessTopic string
backupResource bool
suppressFileRename bool
apiVersion apiVersionFlag
}

type BackupResource struct {
Id int `json:"id"`
}

var backupV4BuildThreshold = 25208

// backupCmd represents the backup command
func newBackupCmd() *cobra.Command {
f := backupFlags{}
Expand All @@ -52,9 +67,10 @@ func newBackupCmd() *cobra.Command {
cmd.Flags().BoolVar(&f.backupResource, "resource", false, "Backup to a shared resource instead of downloading.")
cmd.Flags().StringVar(&f.backupResourceName, "resource-name", "FME_SHAREDRESOURCE_BACKUP", "Shared Resource Name where the exported package is saved.")
cmd.Flags().StringVar(&f.backupExportPackage, "export-package", "ServerConfigPackage.fsconfig", "Path and name of the export package.")
cmd.Flags().StringVar(&f.backupFailureTopic, "failure-topic", "", "Topic to notify on failure of the backup. Default is MIGRATION_ASYNC_JOB_FAILURE")
cmd.Flags().StringVar(&f.backupSuccessTopic, "success-topic", "", "Topic to notify on success of the backup. Default is MIGRATION_ASYNC_JOB_SUCCESS")
cmd.Flags().StringVar(&f.backupFailureTopic, "failure-topic", "", "Topic to notify on failure of the backup. In V3, default is MIGRATION_ASYNC_JOB_FAILURE")
cmd.Flags().StringVar(&f.backupSuccessTopic, "success-topic", "", "Topic to notify on success of the backup. In V3, default is MIGRATION_ASYNC_JOB_SUCCESS")
cmd.Flags().BoolVar(&f.suppressFileRename, "suppress-file-rename", false, "Specify this flag to not add .fsconfig to the output file automatically")
cmd.Flags().Var(&f.apiVersion, "api-version", "The api version to use when contacting FME Server. Must be one of v3 or v4")
cmd.MarkFlagsMutuallyExclusive("file", "resource")
cmd.MarkFlagsMutuallyExclusive("file", "resource-name")
cmd.MarkFlagsMutuallyExclusive("file", "export-package")
Expand All @@ -77,91 +93,194 @@ func backupRun(f *backupFlags) func(cmd *cobra.Command, args []string) error {
}
}

if !f.backupResource {

// add mandatory values
data := url.Values{
"exportPackageName": {f.outputBackupFile},
if f.apiVersion == "" {
if viper.GetInt("build") < backupV4BuildThreshold {
f.apiVersion = apiVersionFlagV3
} else {
f.apiVersion = apiVersionFlagV4
}
}

request, err := buildFmeFlowRequest("/fmerest/v3/migration/backup/download", "POST", strings.NewReader(data.Encode()))
if err != nil {
return err
}
if f.apiVersion == apiVersionFlagV4 {

request.Header.Add("Content-Type", "application/x-www-form-urlencoded")
request.Header.Add("Accept", "application/octet-stream")
if !f.backupResource {
var backupRequest backupDownloadV4
backupRequest.PackageName = f.outputBackupFile

fmt.Fprintln(cmd.OutOrStdout(), "Downloading backup file...")
requestBody, err := json.Marshal(backupRequest)
if err != nil {
return err
}

response, err := client.Do(&request)
if err != nil {
return err
} else if response.StatusCode != 200 {
return errors.New(response.Status)
}
defer response.Body.Close()
request, err := buildFmeFlowRequest("/fmeapiv4/migrations/backup/download", "POST", strings.NewReader(string(requestBody)))
if err != nil {
return err
}

// Create the output file
out, err := os.Create(f.outputBackupFile)
if err != nil {
return err
}
defer out.Close()
request.Header.Add("Content-Type", "application/json")

// use Copy so that it doesn't store the entire file in memory
_, err = io.Copy(out, response.Body)
if err != nil {
return err
}
fmt.Fprintln(cmd.OutOrStdout(), "Downloading backup file...")
response, err := client.Do(&request)
if err != nil {
return err
} else if response.StatusCode != 200 {
return errors.New(response.Status)
}
defer response.Body.Close()

fmt.Fprintln(cmd.OutOrStdout(), "FME Server backed up to "+f.outputBackupFile)
} else {
// backup to a resource
// add mandatory values
data := url.Values{
"exportPackage": {f.backupExportPackage},
"resourceName": {f.backupResourceName},
}
// Create the output file
out, err := os.Create(f.outputBackupFile)
if err != nil {
return err
}
defer out.Close()

// add optional values
if f.backupSuccessTopic != "" {
data.Add("successTopic", f.backupSuccessTopic)
}
if f.backupFailureTopic != "" {
data.Add("failureTopic", f.backupFailureTopic)
}
// use Copy so that it doesn't store the entire file in memory
_, err = io.Copy(out, response.Body)
if err != nil {
return err
}

request, err := buildFmeFlowRequest("/fmerest/v3/migration/backup/resource", "POST", strings.NewReader(data.Encode()))
if err != nil {
return err
}
fmt.Fprintln(cmd.OutOrStdout(), "FME Server backed up to "+f.outputBackupFile)

request.Header.Add("Content-Type", "application/x-www-form-urlencoded")
} else {
// backup to a resource
var backupRequest backupResourceV4
backupRequest.PackagePath = f.backupExportPackage
backupRequest.ResourceName = f.backupResourceName
if f.backupSuccessTopic != "" {
backupRequest.SuccessTopic = f.backupSuccessTopic
}
if f.backupFailureTopic != "" {
backupRequest.FailureTopic = f.backupFailureTopic
}
requestBody, err := json.Marshal(backupRequest)
if err != nil {
return err
}
request, err := buildFmeFlowRequest("/fmeapiv4/migrations/backup/resource", "POST", strings.NewReader(string(requestBody)))
if err != nil {
return err
}

response, err := client.Do(&request)
if err != nil {
return err
} else if response.StatusCode != http.StatusAccepted {
return errors.New(response.Status)
}
request.Header.Add("Content-Type", "application/json")

response, err := client.Do(&request)
if err != nil {
return err
} else if response.StatusCode != 202 && response.StatusCode != 200 {
if response.StatusCode == 401 {
return errors.New("failed to login")
} else {
return errors.New(response.Status)
}
}
responseData, err := io.ReadAll(response.Body)
if err != nil {
return err
}

var result BackupResource
if err := json.Unmarshal(responseData, &result); err != nil {
return err
} else {
if !jsonOutput {
fmt.Fprintln(cmd.OutOrStdout(), "Backup task submitted with id: "+strconv.Itoa(result.Id))
} else {
fmt.Fprintln(cmd.OutOrStdout(), string(responseData))
}
}

responseData, err := io.ReadAll(response.Body)
if err != nil {
return err
}

var result BackupResource
if err := json.Unmarshal(responseData, &result); err != nil {
return err
} else if f.apiVersion == apiVersionFlagV3 {
if !f.backupResource {

// add mandatory values
data := url.Values{
"exportPackageName": {f.outputBackupFile},
}

request, err := buildFmeFlowRequest("/fmerest/v3/migration/backup/download", "POST", strings.NewReader(data.Encode()))
if err != nil {
return err
}

request.Header.Add("Content-Type", "application/x-www-form-urlencoded")
request.Header.Add("Accept", "application/octet-stream")

fmt.Fprintln(cmd.OutOrStdout(), "Downloading backup file...")

response, err := client.Do(&request)
if err != nil {
return err
} else if response.StatusCode != 200 {
return errors.New(response.Status)
}
defer response.Body.Close()

// Create the output file
out, err := os.Create(f.outputBackupFile)
if err != nil {
return err
}
defer out.Close()

// use Copy so that it doesn't store the entire file in memory
_, err = io.Copy(out, response.Body)
if err != nil {
return err
}

fmt.Fprintln(cmd.OutOrStdout(), "FME Server backed up to "+f.outputBackupFile)
} else {
if !jsonOutput {
fmt.Fprintln(cmd.OutOrStdout(), "Backup task submitted with id: "+strconv.Itoa(result.Id))
// backup to a resource
// add mandatory values
data := url.Values{
"exportPackage": {f.backupExportPackage},
"resourceName": {f.backupResourceName},
}

// add optional values
if f.backupSuccessTopic != "" {
data.Add("successTopic", f.backupSuccessTopic)
}
if f.backupFailureTopic != "" {
data.Add("failureTopic", f.backupFailureTopic)
}

request, err := buildFmeFlowRequest("/fmerest/v3/migration/backup/resource", "POST", strings.NewReader(data.Encode()))
if err != nil {
return err
}

request.Header.Add("Content-Type", "application/x-www-form-urlencoded")

response, err := client.Do(&request)
if err != nil {
return err
} else if response.StatusCode != http.StatusAccepted {
return errors.New(response.Status)
}

responseData, err := io.ReadAll(response.Body)
if err != nil {
return err
}

var result BackupResource
if err := json.Unmarshal(responseData, &result); err != nil {
return err
} else {
fmt.Fprintln(cmd.OutOrStdout(), string(responseData))
if !jsonOutput {
fmt.Fprintln(cmd.OutOrStdout(), "Backup task submitted with id: "+strconv.Itoa(result.Id))
} else {
fmt.Fprintln(cmd.OutOrStdout(), string(responseData))
}
}
}
}

return nil
}
}
Loading