Merge pull request #2318 from nono/improve-cli

Improve CLI

Author: nono

cmd/fixer.go

@@ -376,20 +376,36 @@ done, the konnector is uninstalled again.
 		if len(args) != 1 {
 			return cmd.Usage()
 		}
-
 		domain := args[0]
-
 		c := newAdminClient()
 		path := fmt.Sprintf("/instances/%s/fixers/orphan-account", domain)
 		_, err := c.Req(&request.Options{
 			Method: "POST",
 			Path:   path,
 		})
-		if err != nil {
-			return err
-		}
+		return err
+	},
+}
 
-		return nil
+var indexesFixer = &cobra.Command{
+	Use:   "indexes <domain>",
+	Short: "Rebuild the CouchDB views and indexes",
+	Long: `
+This fixer ensures that the CouchDB views and indexes used by the stack for
+this instance are correctly set.
+`,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		if len(args) != 1 {
+			return cmd.Usage()
+		}
+		domain := args[0]
+		c := newAdminClient()
+		path := fmt.Sprintf("/instances/%s/fixers/indexes", domain)
+		_, err := c.Req(&request.Options{
+			Method: "POST",
+			Path:   path,
+		})
+		return err
 	},
 }
 
@@ -406,6 +422,7 @@ func init() {
 	fixerCmdGroup.AddCommand(contactEmailsFixer)
 	fixerCmdGroup.AddCommand(contentMismatch64Kfixer)
 	fixerCmdGroup.AddCommand(orphanAccountFixer)
+	fixerCmdGroup.AddCommand(indexesFixer)
 
 	RootCmd.AddCommand(fixerCmdGroup)
 }

cmd/serve.go

@@ -24,6 +24,7 @@ import (
 var flagAllowRoot bool
 var flagAppdirs []string
 var flagDevMode bool
+var flagMailhog bool
 
 // serveCmd represents the serve command
 var serveCmd = &cobra.Command{
@@ -82,6 +83,12 @@ example), you can use the --appdir flag like this:
 			}
 		}
 
+		if flagMailhog {
+			cfg := config.GetConfig()
+			cfg.Mail.DisableTLS = true
+			cfg.Mail.Port = 1025
+		}
+
 		processes, err := stack.Start()
 		if err != nil {
 			return err
@@ -213,6 +220,7 @@ func init() {
 	flags.String("password-reset-interval", "15m", "minimal duration between two password reset")
 	checkNoErr(viper.BindPFlag("password_reset_interval", flags.Lookup("password-reset-interval")))
 
+	flags.BoolVar(&flagMailhog, "mailhog", false, "Alias of --mail-disable-tls --mail-port 1025, useful for MailHog")
 	flags.BoolVar(&flagDevMode, "dev", false, "Allow to run in dev mode for a prod release (disabled by default)")
 	flags.BoolVar(&flagAllowRoot, "allow-root", false, "Allow to start as root (disabled by default)")
 	flags.StringSliceVar(&flagAppdirs, "appdir", nil, "Mount a directory as the 'app' application")

docs/cli/cozy-stack_features.md

@@ -25,9 +25,9 @@ Manage the feature flags
 ### SEE ALSO
 
 * [cozy-stack](cozy-stack.md)	 - cozy-stack is the main command
-* [cozy-stack features context](cozy-stack_features_context.md)	 - Display and update the feature flags for a context
 * [cozy-stack features defaults](cozy-stack_features_defaults.md)	 - Display and update the default values for feature flags
 * [cozy-stack features flags](cozy-stack_features_flags.md)	 - Display and update the feature flags for an instance
+* [cozy-stack features ratio](cozy-stack_features_ratio.md)	 - Display and update the feature flags for a context
 * [cozy-stack features sets](cozy-stack_features_sets.md)	 - Display and update the feature sets for an instance
 * [cozy-stack features show](cozy-stack_features_show.md)	 - Display the computed feature flags for an instance
 

docs/cli/cozy-stack_features_context.md renamed to docs/cli/cozy-stack_features_ratio.md

@@ -1,4 +1,4 @@
-## cozy-stack features context
+## cozy-stack features ratio
 
 Display and update the feature flags for a context
 
@@ -13,7 +13,7 @@ To remove a flag, set it to an empty array (or null).
 
 
 ```
-cozy-stack features context <context-name> [flags]
+cozy-stack features ratio <context-name> [flags]
 ```
 
 ### Examples
@@ -26,7 +26,7 @@ $ cozy-stack feature ratio --context beta '{"set_this_flag": [{"ratio": 0.1, "va
 
 ```
       --context string   The context for the feature flags
-  -h, --help             help for context
+  -h, --help             help for ratio
 ```
 
 ### Options inherited from parent commands

docs/cli/cozy-stack_fixer.md

@@ -31,6 +31,7 @@ cozy-stack fixer <command> [flags]
 * [cozy-stack](cozy-stack.md)	 - cozy-stack is the main command
 * [cozy-stack fixer contact-emails](cozy-stack_fixer_contact-emails.md)	 - Detect and try to fix invalid emails on contacts
 * [cozy-stack fixer content-mismatch](cozy-stack_fixer_content-mismatch.md)	 - Fix the content mismatch differences for 64K issue
+* [cozy-stack fixer indexes](cozy-stack_fixer_indexes.md)	 - Rebuild the CouchDB views and indexes
 * [cozy-stack fixer jobs](cozy-stack_fixer_jobs.md)	 - Take a look at the consistency of the jobs
 * [cozy-stack fixer md5](cozy-stack_fixer_md5.md)	 - Fix missing md5 from contents in the vfs
 * [cozy-stack fixer mime](cozy-stack_fixer_mime.md)	 - Fix the class computed from the mime-type

docs/cli/cozy-stack_fixer_indexes.md

@@ -0,0 +1,35 @@
+## cozy-stack fixer indexes
+
+Rebuild the CouchDB views and indexes
+
+### Synopsis
+
+
+This fixer ensures that the CouchDB views and indexes used by the stack for
+this instance are correctly set.
+
+
+```
+cozy-stack fixer indexes <domain> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for indexes
+```
+
+### Options inherited from parent commands
+
+```
+      --admin-host string   administration server host (default "localhost")
+      --admin-port int      administration server port (default 6060)
+  -c, --config string       configuration file (default "$HOME/.cozy.yaml")
+      --host string         server host (default "localhost")
+  -p, --port int            server port (default 8080)
+```
+
+### SEE ALSO
+
+* [cozy-stack fixer](cozy-stack_fixer.md)	 - A set of tools to fix issues or migrate content for retro-compatibility.
+

docs/cli/cozy-stack_serve.md

@@ -65,6 +65,7 @@ example), you can use the --appdir flag like this:
       --mail-password string             mail smtp password
       --mail-port int                    mail smtp port (default 465)
       --mail-username string             mail smtp username
+      --mailhog                          Alias of --mail-disable-tls --mail-port 1025, useful for MailHog
       --password-reset-interval string   minimal duration between two password reset (default "15m")
       --rate-limiting-url string         URL for rate-limiting counters, redis or in-memory
       --realtime-url string              URL for realtime in the browser via webocket, redis or in-memory

model/instance/lifecycle/create.go

@@ -176,7 +176,7 @@ func CreateWithoutHooks(opts *Options) (*instance.Instance, error) {
 	if err := couchdb.CreateNamedDocWithDB(i, settings); err != nil {
 		return nil, err
 	}
-	if err := defineViewsAndIndex(i); err != nil {
+	if err := DefineViewsAndIndex(i); err != nil {
 		return nil, err
 	}
 	if err := createDefaultFilesTree(i); err != nil {

model/instance/lifecycle/get.go

@@ -33,7 +33,7 @@ func GetInstance(domain string) (*instance.Instance, error) {
 		}
 
 		i.Logger().Debugf("Indexes outdated: wanted %d; got %d", couchdb.IndexViewsVersion, i.IndexViewsVersion)
-		if err = defineViewsAndIndex(i); err != nil {
+		if err = DefineViewsAndIndex(i); err != nil {
 			i.Logger().Errorf("Could not re-define indexes and views: %s", err.Error())
 			return nil, err
 		}

model/instance/lifecycle/helpers.go

@@ -38,7 +38,9 @@ func installApp(inst *instance.Instance, slug string) error {
 	return err
 }
 
-func defineViewsAndIndex(inst *instance.Instance) error {
+// DefineViewsAndIndex can be used to ensure that the CouchDB views and indexes
+// used by the stack are correctly set.
+func DefineViewsAndIndex(inst *instance.Instance) error {
 	if err := couchdb.DefineIndexes(inst, couchdb.Indexes); err != nil {
 		return err
 	}

scripts/completion/cozy-stack.bash

@@ -1623,6 +1623,38 @@ _cozy-stack_fixer_content-mismatch()
     noun_aliases=()
 }
 
+_cozy-stack_fixer_indexes()
+{
+    last_command="cozy-stack_fixer_indexes"
+
+    command_aliases=()
+
+    commands=()
+
+    flags=()
+    two_word_flags=()
+    local_nonpersistent_flags=()
+    flags_with_completion=()
+    flags_completion=()
+
+    flags+=("--admin-host=")
+    two_word_flags+=("--admin-host")
+    flags+=("--admin-port=")
+    two_word_flags+=("--admin-port")
+    flags+=("--config=")
+    two_word_flags+=("--config")
+    two_word_flags+=("-c")
+    flags+=("--host=")
+    two_word_flags+=("--host")
+    flags+=("--port=")
+    two_word_flags+=("--port")
+    two_word_flags+=("-p")
+
+    must_have_one_flag=()
+    must_have_one_noun=()
+    noun_aliases=()
+}
+
 _cozy-stack_fixer_jobs()
 {
     last_command="cozy-stack_fixer_jobs"
@@ -1828,6 +1860,7 @@ _cozy-stack_fixer()
     commands=()
     commands+=("contact-emails")
     commands+=("content-mismatch")
+    commands+=("indexes")
     commands+=("jobs")
     commands+=("md5")
     commands+=("mime")
@@ -3268,6 +3301,7 @@ _cozy-stack_serve()
     two_word_flags+=("--mail-port")
     flags+=("--mail-username=")
     two_word_flags+=("--mail-username")
+    flags+=("--mailhog")
     flags+=("--password-reset-interval=")
     two_word_flags+=("--password-reset-interval")
     flags+=("--rate-limiting-url=")

scripts/completion/cozy-stack.zsh

@@ -689,6 +689,7 @@ function _cozy-stack_fixer {
     commands=(
       "contact-emails:Detect and try to fix invalid emails on contacts"
       "content-mismatch:Fix the content mismatch differences for 64K issue"
+      "indexes:Rebuild the CouchDB views and indexes"
       "jobs:Take a look at the consistency of the jobs"
       "md5:Fix missing md5 from contents in the vfs"
       "mime:Fix the class computed from the mime-type"
@@ -707,6 +708,9 @@ function _cozy-stack_fixer {
   content-mismatch)
     _cozy-stack_fixer_content-mismatch
     ;;
+  indexes)
+    _cozy-stack_fixer_indexes
+    ;;
   jobs)
     _cozy-stack_fixer_jobs
     ;;
@@ -747,6 +751,15 @@ function _cozy-stack_fixer_content-mismatch {
     '(-p --port)'{-p,--port}'[server port]:'
 }
 
+function _cozy-stack_fixer_indexes {
+  _arguments \
+    '--admin-host[administration server host]:' \
+    '--admin-port[administration server port]:' \
+    '(-c --config)'{-c,--config}'[configuration file (default "$HOME/.cozy.yaml")]:' \
+    '--host[server host]:' \
+    '(-p --port)'{-p,--port}'[server port]:'
+}
+
 function _cozy-stack_fixer_jobs {
   _arguments \
     '--admin-host[administration server host]:' \
@@ -1405,6 +1418,7 @@ function _cozy-stack_serve {
     '--mail-password[mail smtp password]:' \
     '--mail-port[mail smtp port]:' \
     '--mail-username[mail smtp username]:' \
+    '--mailhog[Alias of --mail-disable-tls --mail-port 1025, useful for MailHog]' \
     '--password-reset-interval[minimal duration between two password reset]:' \
     '--rate-limiting-url[URL for rate-limiting counters, redis or in-memory]:' \
     '--realtime-url[URL for realtime in the browser via webocket, redis or in-memory]:' \

scripts/cozy-app-dev.sh

@@ -108,8 +108,7 @@ do_start() {
 		--port "${COZY_STACK_PORT}" \
 		--admin-port "${COZY_STACK_ADMIN_PORT}" \
 		--couchdb-url "${COUCHDB_URL}" \
-		--mail-port 1025 \
-		--mail-disable-tls \
+		--mailhog \
 		--fs-url "file://localhost${vfsdir}" &
 
 	wait_for "${COZY_STACK_HOST}:${COZY_STACK_PORT}/version/" "cozy-stack"

tests/integration/lib/stack.rb

@@ -39,7 +39,7 @@ def start
     end
     system("cozy-stack config gen-keys '#{vault}/key'") unless File.exist?("#{vault}/key.enc")
     cmd = ["cozy-stack", "serve", "--log-level", "debug",
-           "--mail-disable-tls", "--mail-port", "1025",
+           "--mailhog",
            "--port", @port, "--admin-port", @admin,
            "--fs-url", fsurl,
            "--vault-encryptor-key", "#{vault}/key.enc",

web/instances/fixers.go

@@ -301,5 +301,19 @@ func orphanAccountFixer(c echo.Context) error {
 		}
 	}
 
-	return c.JSON(http.StatusNoContent, nil)
+	return c.NoContent(http.StatusNoContent)
+}
+
+func indexesFixer(c echo.Context) error {
+	domain := c.Param("domain")
+	inst, err := instance.GetFromCouch(domain)
+	if err != nil {
+		return err
+	}
+
+	if err := lifecycle.DefineViewsAndIndex(inst); err != nil {
+		return err
+	}
+
+	return c.NoContent(http.StatusNoContent)
 }

web/instances/instances.go

@@ -488,4 +488,5 @@ func Routes(router *echo.Group) {
 	// Fixers
 	router.POST("/:domain/fixers/content-mismatch", contentMismatchFixer)
 	router.POST("/:domain/fixers/orphan-account", orphanAccountFixer)
+	router.POST("/:domain/fixers/indexes", indexesFixer)
 }