Add keyword config for etest

Author: lionel-

test/etest/README.md

@@ -137,6 +137,34 @@ The `:cleanup` takes lisp expressions evaluated in LIFO order with unwind protec
 ```
 
 
+## Reusing mode-specific configuration
+
+Mode-specific configuration can be stored in a variable or created with a function. This typically includes an `:init` keyword that sets up the major-mode for the test buffer:
+
+```elisp
+(defvar my-config '(:init ((mode . text))))
+```
+
+The configuration may contain any valid etest code and is registered with the `:config` keyword. This keyword must appear before any other keywords:
+
+```elisp
+(etest-deftest my-test ()
+  :config my-config))
+```
+
+You can also set it with the buffer-local variable `etest-local-config`. It is convenient to set it as a file-local variable, this way `etest-update` is automatically aware of the configuration relevant to the test file.
+
+```elisp
+(etest-deftest my-test ())
+
+;; Local Variables:
+;; etest-local-config: my-config
+;; End:
+```
+
+If supplied, the `:config` keyword has precedence over the configuration stored in `etest-local-config` and completely replaces it.
+
+
 ## Checking the contents of an inferior buffer
 
 In addition to checking the side effects in the test buffer, it is often useful to check the side effects in an auxiliary buffer. For instance, checking the output in an inferior process buffer.

test/etest/etest.el

@@ -47,6 +47,13 @@ up a particular mode.")
                         (lambda (actual expected)
                           (should (string= actual expected)))))))
 
+(defmacro etest--setup-body (place)
+  `(progn
+     (when (eq (car ,place) :config)
+       (pop ,place)
+       (setq ,place (append (eval (pop ,place)) ,place)))
+     (etest--pop-init ,place)))
+
 (defmacro etest--pop-init (place)
   `(let (local)
      (while (eq (car ,place) :init)
@@ -56,14 +63,15 @@ up a particular mode.")
 
 ;; Evaluate symbols to make it easier to set local variables
 (defmacro etest--push-local-config (place)
-  `(let ((etest--config (cond ((not etest-local-config)
-                               nil)
-                              ((symbolp etest-local-config)
-                               (eval etest-local-config))
-                              (t
-                               etest-local-config))))
-     (when etest--config
-       (setq ,place (append etest--config ,place)))))
+  `(unless (eq (car ,place) :config)
+     (let ((etest--config (cond ((not etest-local-config)
+                                 nil)
+                                ((symbolp etest-local-config)
+                                 (eval etest-local-config))
+                                (t
+                                 etest-local-config))))
+       (when etest--config
+         (setq ,place (append etest--config ,place))))))
 
 (defmacro etest--with-test-buffer (init &rest body)
   (declare (indent 1)
@@ -104,7 +112,7 @@ buffer-local variable `etest-local-inferior-buffer'.
 
 `:messages' keywords check the contents of the messages buffers
 and are processed with DO-RESULT."
-  (etest--with-test-buffer (etest--pop-init body)
+  (etest--with-test-buffer (etest--setup-body body)
     (let ((etest--msg-sentinel (etest--make-message-sentinel))
           etest--cleanup)
       (unwind-protect

test/etest/test-etest.el

@@ -236,14 +236,37 @@ bar"
   :eval "<right>"
   :result "fo¶o×")
 
+
+(defun etest-make-config ()
+  '(:init ((mode . text))))
+
+(etest-deftest etest-config-fun-test ()
+  "Configuration is picked up from function."
+  :config (etest-make-config)
+  :eval (should (eq major-mode 'text-mode)))
+
+
+(defvar etest-some-config '(:init ((mode . text))))
+
+(etest-deftest etest-config-var-test ()
+  "Configuration is picked up from variable."
+  :config etest-some-config
+  :eval (should (eq major-mode 'text-mode)))
+
+
 ;; `let' doesn't seem to work here, perhaps an interaction between
 ;; scoping in macros and file-local variables
 (setq etest-local-config '(:init ((mode . text))))
 
-(etest-deftest etest-local-config-test ()
-  "Local configuration is picked up"
+(etest-deftest etest-config-local-test ()
+  "Local configuration is picked up."
   :eval (should (eq major-mode 'text-mode)))
 
+(etest-deftest etest-config-keyword-test ()
+  "Keyword config has precedence over local config."
+  :config nil
+  :eval (should (eq major-mode 'fundamental-mode)))
+
 (setq etest-local-config nil)
 
 (etest-deftest etest-default-mode ()