Add first unit tests for auth-source.el

* test/automated/auth-source-tests.el: New file.

1 files changed, 178 insertions, 0 deletions

diff --git a/test/automated/auth-source-tests.el b/test/automated/auth-source-tests.el
new file mode 100644
index 00000000000..0b49b9013f7
--- /dev/null
+++ b/test/automated/auth-source-tests.el
@@ -0,0 +1,178 @@
+;;; auth-source-tests.el --- Tests for auth-source.el  -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2015 Free Software Foundation, Inc.
+
+;; Author: Damien Cassou <damien@cassou.me>,
+;;         Nicolas Petton <nicolas@petton.fr>
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;;
+
+;;; Code:
+
+(require 'ert)
+(require 'auth-source)
+
+(defvar secrets-enabled t
+  "Enable the secrets backend to test its features.")
+
+(defun auth-source-validate-backend (source validation-alist)
+  (let ((backend (auth-source-backend-parse source)))
+    (should (auth-source-backend-p backend))
+    (dolist (pair validation-alist)
+      (should (equal (eieio-oref backend (car pair)) (cdr pair))))))
+
+(ert-deftest auth-source-backend-parse-macos-keychain ()
+  (auth-source-validate-backend '(:source (:macos-keychain-generic foobar))
+                                '((:source . "foobar")
+                                  (:type . macos-keychain-generic)
+                                  (:search-function . auth-source-macos-keychain-search)
+                                  (:create-function . auth-source-macos-keychain-create))))
+
+(ert-deftest auth-source-backend-parse-macos-keychain-generic-string ()
+  (auth-source-validate-backend "macos-keychain-generic:foobar"
+                                '((:source . "foobar")
+                                  (:type . macos-keychain-generic)
+                                  (:search-function . auth-source-macos-keychain-search)
+                                  (:create-function . auth-source-macos-keychain-create))))
+
+(ert-deftest auth-source-backend-parse-macos-keychain-internet-string ()
+  (auth-source-validate-backend "macos-keychain-internet:foobar"
+                                '((:source . "foobar")
+                                  (:type . macos-keychain-internet)
+                                  (:search-function . auth-source-macos-keychain-search)
+                                  (:create-function . auth-source-macos-keychain-create))))
+
+(ert-deftest auth-source-backend-parse-macos-keychain-internet-symbol ()
+  (auth-source-validate-backend 'macos-keychain-internet
+                                '((:source . "default")
+                                  (:type . macos-keychain-internet)
+                                  (:search-function . auth-source-macos-keychain-search)
+                                  (:create-function . auth-source-macos-keychain-create))))
+
+(ert-deftest auth-source-backend-parse-macos-keychain-generic-symbol ()
+  (auth-source-validate-backend 'macos-keychain-generic
+                                '((:source . "default")
+                                  (:type . macos-keychain-generic)
+                                  (:search-function . auth-source-macos-keychain-search)
+                                  (:create-function . auth-source-macos-keychain-create))))
+
+(ert-deftest auth-source-backend-parse-macos-keychain-internet-default-string ()
+  (auth-source-validate-backend 'macos-keychain-internet
+                                '((:source . "default")
+                                  (:type . macos-keychain-internet)
+                                  (:search-function . auth-source-macos-keychain-search)
+                                  (:create-function . auth-source-macos-keychain-create))))
+
+(ert-deftest auth-source-backend-parse-plstore ()
+  (auth-source-validate-backend '(:source "foo.plist")
+                                '((:source . "foo.plist")
+                                  (:type . plstore)
+                                  (:search-function . auth-source-plstore-search)
+                                  (:create-function . auth-source-plstore-create))))
+
+(ert-deftest auth-source-backend-parse-netrc ()
+  (auth-source-validate-backend '(:source "foo")
+                                '((:source . "foo")
+                                  (:type . netrc)
+                                  (:search-function . auth-source-netrc-search)
+                                  (:create-function . auth-source-netrc-create))))
+
+(ert-deftest auth-source-backend-parse-netrc-string ()
+  (auth-source-validate-backend "foo"
+                                '((:source . "foo")
+                                  (:type . netrc)
+                                  (:search-function . auth-source-netrc-search)
+                                  (:create-function . auth-source-netrc-create))))
+
+(ert-deftest auth-source-backend-parse-secrets ()
+  (provide 'secrets) ; simulates the presence of the `secrets' package
+  (let ((secrets-enabled t))
+    (auth-source-validate-backend '(:source (:secrets "foo"))
+                                  '((:source . "foo")
+                                    (:type . secrets)
+                                    (:search-function . auth-source-secrets-search)
+                                    (:create-function . auth-source-secrets-create)))))
+
+(ert-deftest auth-source-backend-parse-secrets-strings ()
+  (provide 'secrets) ; simulates the presence of the `secrets' package
+  (let ((secrets-enabled t))
+    (auth-source-validate-backend "secrets:foo"
+                                  '((:source . "foo")
+                                    (:type . secrets)
+                                    (:search-function . auth-source-secrets-search)
+                                    (:create-function . auth-source-secrets-create)))))
+
+(ert-deftest auth-source-backend-parse-secrets-nil-source ()
+  (provide 'secrets) ; simulates the presence of the `secrets' package
+  (let ((secrets-enabled t))
+    (auth-source-validate-backend '(:source (:secrets nil))
+                                  '((:source . "session")
+                                    (:type . secrets)
+                                    (:search-function . auth-source-secrets-search)
+                                    (:create-function . auth-source-secrets-create)))))
+
+(ert-deftest auth-source-backend-parse-secrets-alias ()
+  (provide 'secrets) ; simulates the presence of the `secrets' package
+  (let ((secrets-enabled t))
+    ;; Redefine `secrets-get-alias' to map 'foo to "foo"
+    (cl-letf (((symbol-function 'secrets-get-alias) (lambda (_) "foo")))
+      (auth-source-validate-backend '(:source (:secrets foo))
+                                    '((:source . "foo")
+                                      (:type . secrets)
+                                      (:search-function . auth-source-secrets-search)
+                                      (:create-function . auth-source-secrets-create))))))
+
+(ert-deftest auth-source-backend-parse-secrets-symbol ()
+  (provide 'secrets) ; simulates the presence of the `secrets' package
+  (let ((secrets-enabled t))
+    ;; Redefine `secrets-get-alias' to map 'default to "foo"
+    (cl-letf (((symbol-function 'secrets-get-alias) (lambda (_) "foo")))
+      (auth-source-validate-backend 'default
+                                    '((:source . "foo")
+                                      (:type . secrets)
+                                      (:search-function . auth-source-secrets-search)
+                                      (:create-function . auth-source-secrets-create))))))
+
+(ert-deftest auth-source-backend-parse-secrets-no-alias ()
+  (provide 'secrets) ; simulates the presence of the `secrets' package
+  (let ((secrets-enabled t))
+    ;; Redefine `secrets-get-alias' to map 'foo to nil (so that
+    ;; "Login" is used by default
+    (cl-letf (((symbol-function 'secrets-get-alias) (lambda (_) nil)))
+      (auth-source-validate-backend '(:source (:secrets foo))
+                                    '((:source . "Login")
+                                      (:type . secrets)
+                                      (:search-function . auth-source-secrets-search)
+                                      (:create-function . auth-source-secrets-create))))))
+
+;; TODO This test shows suspicious behavior of auth-source: the
+;; "secrets" source is used even though nothing in the input indicates
+;; that is what we want
+(ert-deftest auth-source-backend-parse-secrets-no-source ()
+  (provide 'secrets) ; simulates the presence of the `secrets' package
+  (let ((secrets-enabled t))
+    (auth-source-validate-backend '(:source '(foo))
+                                  '((:source . "session")
+                                    (:type . secrets)
+                                    (:search-function . auth-source-secrets-search)
+                                    (:create-function . auth-source-secrets-create)))))
+
+(provide 'auth-source-tests)
+;;; auth-source-tests.el ends here