test/lisp/files-x-tests.el

   1 ;;; files-x-tests.el --- tests for files-x.el.
   2
   3 ;; Copyright (C) 2016-2017 Free Software Foundation, Inc.
   4
   5 ;; Author: Michael Albinus <michael.albinus@gmx.de>
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software: you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation, either version 3 of the License, or
  12 ;; (at your option) any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 ;;; Code:
  23
  24 (require 'ert)
  25 (require 'files-x)
  26
  27 (defvar files-x-test--criteria1 "my-user@my-remote-host")
  28 (defvar files-x-test--criteria2
  29   (lambda (identification)
  30     (string-match "another-user@my-remote-host" identification)))
  31 (defvar files-x-test--criteria3 nil)
  32
  33 (defvar files-x-test--variables1
  34   '((remote-shell-file-name . "/bin/bash")
  35     (remote-shell-command-switch . "-c")
  36     (remote-shell-interactive-switch . "-i")
  37     (remote-shell-login-switch . "-l")))
  38 (defvar files-x-test--variables2
  39   '((remote-shell-file-name . "/bin/ksh")))
  40 (defvar files-x-test--variables3
  41   '((remote-null-device . "/dev/null")))
  42 (defvar files-x-test--variables4
  43   '((remote-null-device . "null")))
  44
  45 (ert-deftest files-x-test-connection-local-set-class-variables ()
  46   "Test setting connection-local class variables."
  47
  48   ;; Declare (CLASS VARIABLES) objects.
  49   (let (connection-local-class-alist connection-local-criteria-alist)
  50     (connection-local-set-class-variables 'remote-bash files-x-test--variables1)
  51     (should
  52      (equal
  53       (connection-local-get-class-variables 'remote-bash)
  54       files-x-test--variables1))
  55
  56     (connection-local-set-class-variables 'remote-ksh files-x-test--variables2)
  57     (should
  58      (equal
  59       (connection-local-get-class-variables 'remote-ksh)
  60       files-x-test--variables2))
  61
  62     (connection-local-set-class-variables
  63      'remote-nullfile files-x-test--variables3)
  64     (should
  65      (equal
  66       (connection-local-get-class-variables 'remote-nullfile)
  67       files-x-test--variables3))
  68
  69     ;; A redefinition overwrites existing values.
  70     (connection-local-set-class-variables
  71      'remote-nullfile files-x-test--variables4)
  72     (should
  73      (equal
  74       (connection-local-get-class-variables 'remote-nullfile)
  75       files-x-test--variables4))))
  76
  77 (ert-deftest files-x-test-connection-local-set-classes ()
  78   "Test setting connection-local classes."
  79
  80   ;; Declare (CRITERIA CLASSES) objects.
  81   (let (connection-local-class-alist connection-local-criteria-alist)
  82     (connection-local-set-class-variables 'remote-bash files-x-test--variables1)
  83     (connection-local-set-class-variables 'remote-ksh files-x-test--variables2)
  84     (connection-local-set-class-variables
  85      'remote-nullfile files-x-test--variables3)
  86
  87     (connection-local-set-classes
  88      files-x-test--criteria1 'remote-bash 'remote-ksh)
  89     (should
  90      (equal
  91       (connection-local-get-classes files-x-test--criteria1)
  92       '(remote-bash remote-ksh)))
  93
  94     (connection-local-set-classes files-x-test--criteria2 'remote-ksh)
  95     (should
  96      (equal
  97       (connection-local-get-classes files-x-test--criteria2)
  98       '(remote-ksh)))
  99     ;; A further call adds classes.
 100     (connection-local-set-classes files-x-test--criteria2 'remote-nullfile)
 101     (should
 102      (equal
 103       (connection-local-get-classes files-x-test--criteria2)
 104       '(remote-ksh remote-nullfile)))
 105     ;; Adding existing classes doesn't matter.
 106     (connection-local-set-classes
 107      files-x-test--criteria2 'remote-bash 'remote-nullfile)
 108     (should
 109      (equal
 110       (connection-local-get-classes files-x-test--criteria2)
 111       '(remote-ksh remote-nullfile remote-bash)))
 112
 113     ;; An empty variable list is accepted (but makes no sense).
 114     (connection-local-set-classes files-x-test--criteria3)
 115     (should-not (connection-local-get-classes files-x-test--criteria3))
 116
 117     ;; Using a nil criteria also works.  Duplicate classes are trashed.
 118     (connection-local-set-classes
 119      files-x-test--criteria3 'remote-bash 'remote-ksh 'remote-ksh 'remote-bash)
 120     (should
 121      (equal
 122       (connection-local-get-classes files-x-test--criteria3)
 123       '(remote-bash remote-ksh)))
 124
 125     ;; A criteria other than nil, regexp or lambda function is wrong.
 126     (should-error (connection-local-set-classes 'dummy))))
 127
 128 (ert-deftest files-x-test-hack-connection-local-variables-apply ()
 129   "Test setting connection-local variables."
 130
 131   (let (connection-local-class-alist connection-local-criteria-alist)
 132
 133     (connection-local-set-class-variables 'remote-bash files-x-test--variables1)
 134     (connection-local-set-class-variables 'remote-ksh files-x-test--variables2)
 135     (connection-local-set-class-variables
 136      'remote-nullfile files-x-test--variables3)
 137
 138     (connection-local-set-classes
 139      files-x-test--criteria1 'remote-bash 'remote-ksh)
 140     (connection-local-set-classes
 141      files-x-test--criteria2 'remote-ksh 'remote-nullfile)
 142
 143     ;; Apply the variables.
 144     (with-temp-buffer
 145       (let ((enable-connection-local-variables t)
 146             (default-directory "/sudo:my-user@my-remote-host:"))
 147         (should-not connection-local-variables-alist)
 148         (should-not (local-variable-p 'remote-shell-file-name))
 149         (should-not (boundp 'remote-shell-file-name))
 150         (hack-connection-local-variables-apply)
 151         ;; All connection-local variables are set.  They apply in
 152         ;; reverse order in `connection-local-variables-alist'.  The
 153         ;; settings from `remote-ksh' are not contained, because they
 154         ;; declare same variables as in `remote-bash'.
 155         (should
 156          (equal connection-local-variables-alist
 157                 (nreverse (copy-tree files-x-test--variables1))))
 158         ;; The variables exist also as local variables.
 159         (should (local-variable-p 'remote-shell-file-name))
 160         ;; The proper variable value is set.
 161         (should
 162          (string-equal (symbol-value 'remote-shell-file-name) "/bin/bash"))))
 163
 164     ;; The second test case.
 165     (with-temp-buffer
 166       (let ((enable-connection-local-variables t)
 167             (default-directory "/ssh:another-user@my-remote-host:"))
 168         (should-not connection-local-variables-alist)
 169         (should-not (local-variable-p 'remote-shell-file-name))
 170         (should-not (boundp 'remote-shell-file-name))
 171         (hack-connection-local-variables-apply)
 172         ;; All connection-local variables are set.  They apply in
 173         ;; reverse order in `connection-local-variables-alist'.
 174         (should
 175          (equal connection-local-variables-alist
 176                 (append
 177                  (nreverse (copy-tree files-x-test--variables3))
 178                  (nreverse (copy-tree files-x-test--variables2)))))
 179         ;; The variables exist also as local variables.
 180         (should (local-variable-p 'remote-shell-file-name))
 181         ;; The proper variable value is set.
 182         (should
 183          (string-equal (symbol-value 'remote-shell-file-name) "/bin/ksh"))))
 184
 185     ;; The third test case.  Both `files-x-test--criteria1' and
 186     ;; `files-x-test--criteria3' apply, but there are no double
 187     ;; entries.
 188     (connection-local-set-classes
 189      files-x-test--criteria3 'remote-bash 'remote-ksh)
 190     (with-temp-buffer
 191       (let ((enable-connection-local-variables t)
 192             (default-directory "/sudo:my-user@my-remote-host:"))
 193         (should-not connection-local-variables-alist)
 194         (should-not (local-variable-p 'remote-shell-file-name))
 195         (should-not (boundp 'remote-shell-file-name))
 196         (hack-connection-local-variables-apply)
 197         ;; All connection-local variables are set.  They apply in
 198         ;; reverse order in `connection-local-variables-alist'.  The
 199         ;; settings from `remote-ksh' are not contained, because they
 200         ;; declare same variables as in `remote-bash'.
 201         (should
 202          (equal connection-local-variables-alist
 203                 (nreverse (copy-tree files-x-test--variables1))))
 204         ;; The variables exist also as local variables.
 205         (should (local-variable-p 'remote-shell-file-name))
 206         ;; The proper variable value is set.
 207         (should
 208          (string-equal (symbol-value 'remote-shell-file-name) "/bin/bash"))))
 209
 210     ;; When `enable-connection-local-variables' is nil, nothing happens.
 211     (with-temp-buffer
 212       (let ((enable-connection-local-variables nil)
 213             (default-directory "/ssh:another-user@my-remote-host:"))
 214         (should-not connection-local-variables-alist)
 215         (should-not (local-variable-p 'remote-shell-file-name))
 216         (should-not (boundp 'remote-shell-file-name))
 217         (hack-connection-local-variables-apply)
 218         (should-not connection-local-variables-alist)
 219         (should-not (local-variable-p 'remote-shell-file-name))
 220         (should-not (boundp 'remote-shell-file-name))))))
 221
 222 (ert-deftest files-x-test-with-connection-local-classes ()
 223   "Test setting connection-local variables."
 224
 225   (let (connection-local-class-alist connection-local-criteria-alist)
 226     (connection-local-set-class-variables 'remote-bash files-x-test--variables1)
 227     (connection-local-set-class-variables 'remote-ksh files-x-test--variables2)
 228     (connection-local-set-class-variables
 229      'remote-nullfile files-x-test--variables3)
 230     (connection-local-set-classes
 231      files-x-test--criteria3 'remote-ksh 'remote-nullfile)
 232
 233     (with-temp-buffer
 234       (let ((enable-connection-local-variables t)
 235             (default-directory "/sudo:my-user@my-remote-host:"))
 236         (hack-connection-local-variables-apply)
 237
 238         ;; All connection-local variables are set.  They apply in
 239         ;; reverse order in `connection-local-variables-alist'.
 240         (should
 241          (equal connection-local-variables-alist
 242                 (append
 243                  (nreverse (copy-tree files-x-test--variables3))
 244                  (nreverse (copy-tree files-x-test--variables2)))))
 245         ;; The variables exist also as local variables.
 246         (should (local-variable-p 'remote-shell-file-name))
 247         (should (local-variable-p 'remote-null-device))
 248         ;; The proper variable values are set.
 249         (should
 250          (string-equal (symbol-value 'remote-shell-file-name) "/bin/ksh"))
 251         (should
 252          (string-equal (symbol-value 'remote-null-device) "/dev/null"))
 253
 254         ;; A candidate connection-local variable is not bound yet.
 255         (should-not (local-variable-p 'remote-shell-command-switch))
 256
 257         ;; Use the macro.
 258         (with-connection-local-classes '(remote-bash remote-ksh)
 259           ;; All connection-local variables are set.  They apply in
 260           ;; reverse order in `connection-local-variables-alist'.
 261           ;; This variable keeps only the variables to be set inside
 262           ;; the macro.
 263           (should
 264            (equal connection-local-variables-alist
 265                   (nreverse (copy-tree files-x-test--variables1))))
 266           ;; The variables exist also as local variables.
 267           (should (local-variable-p 'remote-shell-file-name))
 268           (should (local-variable-p 'remote-shell-command-switch))
 269           ;; The proper variable values are set.  The settings from
 270           ;; `remote-bash' overwrite the same variables as in
 271           ;; `remote-ksh'.
 272           (should
 273            (string-equal (symbol-value 'remote-shell-file-name) "/bin/bash"))
 274           (should
 275            (string-equal (symbol-value 'remote-shell-command-switch) "-c")))
 276
 277         ;; Everything is rewound.  The old variable values are reset.
 278         (should
 279          (equal connection-local-variables-alist
 280                 (append
 281                  (nreverse (copy-tree files-x-test--variables3))
 282                  (nreverse (copy-tree files-x-test--variables2)))))
 283         ;; The variables exist also as local variables.
 284         (should (local-variable-p 'remote-shell-file-name))
 285         (should (local-variable-p 'remote-null-device))
 286         ;; The proper variable values are set.  The settings from
 287         ;; `remote-ksh' are back.
 288         (should
 289          (string-equal (symbol-value 'remote-shell-file-name) "/bin/ksh"))
 290         (should
 291          (string-equal (symbol-value 'remote-null-device) "/dev/null"))
 292
 293         ;; The variable set temporarily is not unbound, again.
 294         (should-not (local-variable-p 'remote-shell-command-switch))))))
 295
 296 (provide 'files-x-tests)
 297 ;;; files-x-tests.el ends here