MM-41184: Throw a warning if config migrate wasn't run in local mode (m…

…attermost#435)

Also added a note in the docs.

Co-authored-by: Mattermod <[email protected]>

commands/config.go

@@ -96,7 +96,7 @@ var ConfigReloadCmd = &cobra.Command{
 var ConfigMigrateCmd = &cobra.Command{
 	Use:     "migrate [from_config] [to_config]",
 	Short:   "Migrate existing config between backends",
-	Long:    "Migrate a file-based configuration to (or from) a database-based configuration. Point the Mattermost server at the target configuration to start using it",
+	Long:    "Migrate a file-based configuration to (or from) a database-based configuration. Point the Mattermost server at the target configuration to start using it. Note that this command is only available in `--local` mode.",
 	Example: `config migrate path/to/config.json "postgres://mmuser:mostest@localhost:5432/mattermost_test?sslmode=disable&connect_timeout=10"`,
 	Args:    cobra.ExactArgs(2),
 	RunE:    withClient(configMigrateCmdF),
@@ -499,7 +499,12 @@ func configReloadCmdF(c client.Client, _ *cobra.Command, _ []string) error {
 	return nil
 }
 
-func configMigrateCmdF(c client.Client, _ *cobra.Command, args []string) error {
+func configMigrateCmdF(c client.Client, cmd *cobra.Command, args []string) error {
+	isLocal, _ := cmd.Flags().GetBool("local")
+	if !isLocal {
+		return errors.New("this command is only available in local mode. Please set the --local flag")
+	}
+
 	_, err := c.MigrateConfig(args[0], args[1])
 	if err != nil {
 		return err

commands/config_test.go

@@ -757,6 +757,14 @@ func (s *MmctlUnitTestSuite) TestConfigReloadCmd() {
 }
 
 func (s *MmctlUnitTestSuite) TestConfigMigrateCmd() {
+	s.Run("Should fail without the --local flag", func() {
+		printer.Clean()
+		args := []string{"from", "to"}
+
+		err := configMigrateCmdF(s.client, &cobra.Command{}, args)
+		s.Require().Error(err)
+	})
+
 	s.Run("Should be able to migrate config", func() {
 		printer.Clean()
 		args := []string{"from", "to"}
@@ -767,7 +775,10 @@ func (s *MmctlUnitTestSuite) TestConfigMigrateCmd() {
 			Return(&model.Response{StatusCode: http.StatusOK}, nil).
 			Times(1)
 
-		err := configMigrateCmdF(s.client, &cobra.Command{}, args)
+		cmd := &cobra.Command{}
+		cmd.Flags().Bool("local", true, "")
+
+		err := configMigrateCmdF(s.client, cmd, args)
 		s.Require().Nil(err)
 		s.Len(printer.GetErrorLines(), 0)
 	})
@@ -782,7 +793,10 @@ func (s *MmctlUnitTestSuite) TestConfigMigrateCmd() {
 			Return(&model.Response{StatusCode: http.StatusBadRequest}, errors.New("some-error")).
 			Times(1)
 
-		err := configMigrateCmdF(s.client, &cobra.Command{}, args)
+		cmd := &cobra.Command{}
+		cmd.Flags().Bool("local", true, "")
+
+		err := configMigrateCmdF(s.client, cmd, args)
 		s.Require().NotNil(err)
 	})
 }

docs/mmctl_config_migrate.rst

@@ -9,7 +9,7 @@ Synopsis
 ~~~~~~~~
 
 
-Migrate a file-based configuration to (or from) a database-based configuration. Point the Mattermost server at the target configuration to start using it
+Migrate a file-based configuration to (or from) a database-based configuration. Point the Mattermost server at the target configuration to start using it. Note that this command is only available in `--local` mode.
 
 ::