* bug#63627: Improve plstore.el and fix various issues of it
@ 2023-05-21 15:45 Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-05-22 20:11 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-05-21 15:45 UTC (permalink / raw)
To: 63627
Placeholder bug for a number of patches related to plstore.el, hopefully
soon to follow. Please leave open for the time being.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-05-21 15:45 bug#63627: Improve plstore.el and fix various issues of it Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-05-22 20:11 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-05-31 12:54 ` Eli Zaretskii
0 siblings, 1 reply; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-05-22 20:11 UTC (permalink / raw)
To: 63627
[-- Attachment #1: Type: text/plain, Size: 814 bytes --]
Tag: patch
Here come the first two patches:
0001-Add-internal-documentation-on-plstore.el.patch
Few but large changes, mostly in the commentary section, to describe
internal structures and nail down terminology.
0002-Brush-up-doc-strings-and-terminology-in-plstore.el.patch
Many but small changes, building on the work from the first patch.
All of these changes so far are doc fixes or message changes, none of
them touches any code. Not sure whether they qualify for emacs-29, but
I guess it would be easier to have them there to have the diff context
ready for any following bug fixes.
The further plan is: Provide bug fixes, ERT tests for existing code, new
features, ERT tests for new features (roughly in that order, new
features last). So please don't close this bug yet.
Comments welcome.
[-- Attachment #2: 0001-Add-internal-documentation-on-plstore.el.patch --]
[-- Type: text/x-patch, Size: 7865 bytes --]
From 6b0fc4bc93717e6ff34bfb05bf66a79d9370ab5d Mon Sep 17 00:00:00 2001
From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
Date: Sun, 21 May 2023 21:37:35 +0200
Subject: [PATCH 1/2] Add internal documentation on plstore.el
* lisp/plstore.el: Add internal documentation and some words of
warning in the user documentation. (Bug#63627)
---
lisp/plstore.el | 133 +++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 131 insertions(+), 2 deletions(-)
diff --git a/lisp/plstore.el b/lisp/plstore.el
index 0276a752a0f..1a0dacffb01 100644
--- a/lisp/plstore.el
+++ b/lisp/plstore.el
@@ -24,6 +24,14 @@
;; Plist based data store providing search and partial encryption.
;;
+;; By default, this package uses symmetric encryption, which means
+;; that you have to enter the password protecting your store more
+;; often than you probably expect to. To use public key encryption
+;; with this package, create a GnuPG key and customize user option
+;; `plstore-encrypt-to' to use it. You can then configure the GnuPG
+;; agent to adjust caching and expiration of the passphrase for your
+;; store.
+;;
;; Creating:
;;
;; ;; Open a new store associated with ~/.emacs.d/auth.plist.
@@ -43,12 +51,16 @@
;; ;; Kill the buffer visiting ~/.emacs.d/auth.plist.
;; (plstore-close store)
;;
+;; Avoid marking one property both as public *and* secret, as the
+;; behavior of this package with respect to such duplicate properties
+;; is not (yet) defined.
+;;
;; Searching:
;;
;; (setq store (plstore-open (expand-file-name "~/.emacs.d/auth.plist")))
;;
;; ;; As the entry "foo" associated with "foo.example.org" has no
-;; ;; secret properties, no need to decryption.
+;; ;; secret properties, no need for decryption.
;; (plstore-find store '(:host ("foo.example.org")))
;;
;; ;; As the entry "bar" associated with "bar.example.org" has a
@@ -73,10 +85,112 @@
;;
;; where the prefixing `:secret-' means the property (without
;; `:secret-' prefix) is marked as secret. Thus, when you save the
-;; buffer, the `:secret-user' property is encrypted as `:user'.
+;; buffer, the `:secret-user' property is encrypted as `:user'. Do
+;; not use a property consisting solely of the prefix, as the behavior
+;; of this package with respect to such properties is not (yet)
+;; defined.
;;
;; You can toggle the view between encrypted form and the decrypted
;; form with C-c C-c.
+;;
+;; If you have opened a plstore with `plstore-open' you should not
+;; edit its underlying buffer in `plstore-mode' or in any other way at
+;; the same time, since your manual changes will be overwritten when
+;; `plstore-save' is called on that plstore.
+;;
+;; Internals:
+;;
+;; This is information on the internal data structure and functions of
+;; this package. None of it should be necessary to actually use it.
+;; For easier reading, we usually do not distinguish in this internal
+;; documentation between a Lisp object and its printed representation.
+;;
+;; A plstore corresponds to an alist mapping strings to property
+;; lists. Internally, that alist is organized as two alists, one
+;; mapping to the non-secret properties and placeholders for the
+;; secret properties (called "template alist" with identifier ALIST)
+;; and one mapping to the secret properties ("secret alist",
+;; SECRET-ALIST). The secret alist is read from and written to file
+;; as pgp-encrypted printed representation of the alist ("encrypted
+;; data", ENCRYPTED-DATA).
+;;
+;; During the lifetime of a plstore, a third type of alist may pop up,
+;; which maps to the merged non-secret properties and plain-text
+;; secret properties ("merged alist", MERGED-ALIST).
+;;
+;; After executing the "foo", "bar", "baz" example from above the
+;; alists described above look like the following:
+;;
+;; Template Alist:
+;;
+;; (("foo" :host "foo.example.org" :port 80)
+;; ("bar" :secret-user t :host "bar.example.org")
+;; ("baz" :secret-password t :host "baz.example.org"))
+;;
+;; Secret Alist:
+;;
+;; (("bar" :user "test")
+;; ("baz" :password "test"))
+;;
+;; Merged Alist:
+;;
+;; (("foo" :host "foo.example.org" :port 80)
+;; ("bar" :user "test" :host "bar.example.org")
+;; ("baz" :password "test" :host "baz.example.org"))
+;;
+;; Finally, a plstore requires a buffer ("plstore buffer", BUFFER) for
+;; conversion between its Lisp objects and its file representation.
+;; It is important to note that this buffer is *not* continuously
+;; synchronized as the plstore changes. During the lifetime of a
+;; plstore, its buffer is read from in function `plstore-open' and
+;; (destructively) written to in `plstore-save', but not touched
+;; otherwise. We call the file visited by the plstore buffer the
+;; associated file of the plstore.
+;;
+;; With the identifiers defined above a plstore is a vector with the
+;; following elements and accessor functions:
+;;
+;; [
+;; BUFFER ; plstore--get/set-buffer
+;; ALIST ; plstore--get/set-alist
+;; ENCRYPTED-DATA ; plstore--get/set-encrypted-data
+;; SECRET-ALIST ; plstore--get/set-secret-alist
+;; MERGED-ALIST ; plstore--get/set-merged-alist
+;; ]
+;;
+;; When a plstore is created through `plstore-open', its ALIST and
+;; ENCRYPTED-DATA are initialized from the contents of BUFFER without
+;; any decryption taking place, and MERGED-ALIST is initialized as a
+;; copy of ALIST. (Which means that at that stage the merged alist
+;; still contains the secret property placeholders!)
+;;
+;; During on-demand decryption of a plstore through function
+;; `plstore--decrypt', SECRET-ALIST is populated from ENCRYPTED-DATA,
+;; which is in turn replaced by value nil. (Which further serves as
+;; an indicator that the plstore has been decrypted already.) In
+;; addition, MERGED-ALIST is recomputed by function
+;; `plstore--merge-secret' to replace the secret property placeholders
+;; by their plain-text secret property equivalents.
+;;
+;; The file representation of a plstore consists of two Lisp forms plus
+;; markers to introduce them:
+;;
+;; ;;; public entries
+;; ALIST
+;; ;;; secret entries
+;; ENCRYPTED-DATA
+;;
+;; Both of these are optional, but the first section must be present
+;; if the second one is. If both sections are missing, the plstore is
+;; empty. If the second section is missing, it contains only
+;; non-secret data. If present, the printed representation of the
+;; encrypted data includes the delimiting double quotes.
+;;
+;; The plstore API (`plstore-open', `plstore-put', etc.) and the
+;; plstore mode implemented by `plstore-mode' are orthogonal to each
+;; other and should not be mixed up. In particular, encoding and
+;; decoding a plstore mode buffer with `plstore-mode-toggle-display'
+;; is not related in any way to the state of the plstore buffer.
;;; Code:
@@ -457,6 +571,21 @@ plstore-save
(plstore--insert-buffer plstore)
(save-buffer)))
+;; The functions related to plstore mode unfortunately introduce yet
+;; another alist format ("decoded alist"). After executing the "foo",
+;; "bar", "baz" example from above the decoded alist of the plstore
+;; would look like the following:
+;;
+;; (("foo" :host "foo.example.org" :port 80)
+;; ("bar" :secret-user "test" :host "bar.example.org")
+;; ("baz" :secret-password "test" :host "baz.example.org"))
+;;
+;; Even more unfortunately, variable and function names of the
+;; following are a bit mixed up IMHO: With the current names, the
+;; result of function `plstore--encode' is used to create what is
+;; presented as "decoded form of a plstore" to the user. And variable
+;; `plstore-encoded' is non-nil if a buffer shows the decoded form.
+
(defun plstore--encode (plstore)
(plstore--decrypt plstore)
(let ((merged-alist (plstore--get-merged-alist plstore)))
--
2.30.2
[-- Attachment #3: 0002-Brush-up-doc-strings-and-terminology-in-plstore.el.patch --]
[-- Type: text/x-patch, Size: 10289 bytes --]
From 4568056f2154794c03109f3a78534fe63c6537cb Mon Sep 17 00:00:00 2001
From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
Date: Mon, 22 May 2023 21:47:13 +0200
Subject: [PATCH 2/2] Brush up doc strings and terminology in plstore.el
* lisp/plstore.el (plstore-encoded, plstore-passphrase-callback-function)
(plstore--init-from-buffer, plstore-revert, plstore-close)
(plstore--merge-secret, plstore--decrypt, plstore--match, plstore-find)
(plstore-get, plstore-put, plstore-delete, plstore--insert-buffer)
(plstore-save, plstore--encode, plstore--decode)
(plstore--write-contents-functions, plstore-mode-decoded)
(plstore-mode): Brush up doc strings and documentation in general.
Fix terminology, in particular spurious occurences of all uppercase
"PLSTORE". (Bug#63627)
---
lisp/plstore.el | 70 ++++++++++++++++++++++++++++++++++++-------------
1 file changed, 52 insertions(+), 18 deletions(-)
diff --git a/lisp/plstore.el b/lisp/plstore.el
index 1a0dacffb01..d18d461d7d1 100644
--- a/lisp/plstore.el
+++ b/lisp/plstore.el
@@ -78,7 +78,7 @@
;; Editing:
;;
;; This file also provides `plstore-mode', a major mode for editing
-;; the PLSTORE format file. Visit a non-existing file and put the
+;; the plstore format file. Visit a non-existing file and put the
;; following line:
;;
;; (("foo" :host "foo.example.org" :secret-user "user"))
@@ -235,10 +235,13 @@ plstore-encrypt-to
(put 'plstore-encrypt-to 'permanent-local t)
-(defvar plstore-encoded nil)
+(defvar plstore-encoded nil
+ "Non-nil if the current buffer shows the decoded alist.") ; [sic!]
(put 'plstore-encoded 'permanent-local t)
+;;; EasyPG callback functions.
+
(defvar plstore-cache-passphrase-for-symmetric-encryption nil)
(defvar plstore-passphrase-alist nil)
@@ -255,11 +258,11 @@ plstore-passphrase-callback-function
(cons entry
plstore-passphrase-alist)))
(setq passphrase
- (read-passwd (format "Passphrase for PLSTORE %s: "
+ (read-passwd (format "Passphrase for plstore %s: "
(plstore--get-buffer plstore))))
(setcdr entry (copy-sequence passphrase))
passphrase)))
- (read-passwd (format "Passphrase for PLSTORE %s: "
+ (read-passwd (format "Passphrase for plstore %s: "
(plstore--get-buffer plstore)))))
(defun plstore-progress-callback-function (_context _what _char current total
@@ -269,6 +272,8 @@ plstore-progress-callback-function
(message "%s...%d%%" handback
(if (> total 0) (floor (* (/ current (float total)) 100)) 0))))
+;;; Core functions.
+
(defun plstore--get-buffer (arg)
(aref arg 0))
@@ -307,6 +312,7 @@ plstore--make
(vector buffer alist encrypted-data secret-alist merged-alist))
(defun plstore--init-from-buffer (plstore)
+ "Parse current buffer and initialize PLSTORE from it."
(goto-char (point-min))
(when (looking-at ";;; public entries")
(forward-line)
@@ -337,16 +343,20 @@ plstore-open
store)))
(defun plstore-revert (plstore)
- "Replace current data in PLSTORE with the file on disk."
+ "Replace current data in PLSTORE from its associated file."
(with-current-buffer (plstore--get-buffer plstore)
(revert-buffer t t)
(plstore--init-from-buffer plstore)))
(defun plstore-close (plstore)
- "Destroy a plstore instance PLSTORE."
+ "Destroy plstore instance PLSTORE."
(kill-buffer (plstore--get-buffer plstore)))
(defun plstore--merge-secret (plstore)
+ "Determine the merged alist of PLSTORE.
+Create the merged alist as a copy of the template alist with all
+placeholder properties that have corresponding properties in the
+secret alist replaced by their plain-text secret properties."
(let ((alist (plstore--get-secret-alist plstore))
modified-alist
modified-plist
@@ -365,19 +375,26 @@ plstore--merge-secret
modified-entry (assoc (car entry) modified-alist)
modified-plist (cdr modified-entry))
(while plist
+ ;; Search for a placeholder property in the merged alist
+ ;; corresponding to the current secret property.
(setq placeholder
(plist-member
modified-plist
(intern (concat ":secret-"
(substring (symbol-name (car plist)) 1)))))
+ ;; Replace its name with the real, secret property name.
(if placeholder
(setcar placeholder (car plist)))
+ ;; Update its value to the plain-text secret property value.
(setq modified-plist
(plist-put modified-plist (car plist) (car (cdr plist))))
(setq plist (nthcdr 2 plist)))
(setcdr modified-entry modified-plist))))
(defun plstore--decrypt (plstore)
+ "Decrypt the encrypted data of PLSTORE.
+Update its internal alists and other data structures
+accordingly."
(if (plstore--get-encrypted-data plstore)
(let ((context (epg-make-context 'OpenPGP))
plain)
@@ -404,6 +421,11 @@ plstore--decrypt
(plstore--set-encrypted-data plstore nil))))
(defun plstore--match (entry keys skip-if-secret-found)
+ "Return whether plist KEYS matches ENTRY.
+ENTRY should be a key of the merged alist of a PLSTORE. This
+function returns nil if KEYS do not match ENTRY, t if they match,
+and symbol `secret' if the secret alist needs to be consulted to
+perform a match."
(let ((result t) key-name key-value prop-value secret-name)
(while keys
(setq key-name (car keys)
@@ -425,11 +447,10 @@ plstore--match
result))
(defun plstore-find (plstore keys)
- "Perform search on PLSTORE with KEYS.
-KEYS is a plist."
+ "Return all PLSTORE entries matching plist KEYS."
(let (entries alist entry match decrypt plist)
- ;; First, go through the merged plist alist and collect entries
- ;; matched with keys.
+ ;; First, go through the merged alist and collect entries matched
+ ;; by the keys.
(setq alist (plstore--get-merged-alist plstore))
(while alist
(setq entry (car alist)
@@ -445,7 +466,7 @@ plstore-find
plist nil))
(setq plist (nthcdr 2 plist)))
(setq entries (cons entry entries)))))
- ;; Second, decrypt the encrypted plist and try again.
+ ;; Second, decrypt the plstore and try again.
(when decrypt
(setq entries nil)
(plstore--decrypt plstore)
@@ -459,7 +480,8 @@ plstore-find
(nreverse entries)))
(defun plstore-get (plstore name)
- "Get an entry with NAME in PLSTORE."
+ "Return the entry named NAME in PLSTORE.
+Return nil if there is none."
(let ((entry (assoc name (plstore--get-merged-alist plstore)))
plist)
(setq plist (cdr entry))
@@ -473,7 +495,7 @@ plstore-get
entry))
(defun plstore-put (plstore name keys secret-keys)
- "Put an entry with NAME in PLSTORE.
+ "Put an entry named NAME in PLSTORE.
KEYS is a plist containing non-secret data.
SECRET-KEYS is a plist containing secret data."
(let (entry
@@ -512,7 +534,7 @@ plstore-put
(plstore--merge-secret plstore)))
(defun plstore-delete (plstore name)
- "Delete an entry with NAME from PLSTORE."
+ "Delete the first entry named NAME from PLSTORE."
(let ((entry (assoc name (plstore--get-alist plstore))))
(if entry
(plstore--set-alist
@@ -531,6 +553,8 @@ plstore-delete
(defvar pp-escape-newlines)
(defun plstore--insert-buffer (plstore)
+ "Insert the file representation of PLSTORE at point.
+Assumes that PLSTORE has been decrypted."
(insert ";;; public entries -*- mode: plstore -*- \n"
(pp-to-string (plstore--get-alist plstore)))
(if (plstore--get-secret-alist plstore)
@@ -565,12 +589,14 @@ plstore--insert-buffer
(insert ";;; secret entries\n" (pp-to-string cipher)))))
(defun plstore-save (plstore)
- "Save the contents of PLSTORE associated with a FILE."
+ "Save PLSTORE to its associated file."
(with-current-buffer (plstore--get-buffer plstore)
(erase-buffer)
(plstore--insert-buffer plstore)
(save-buffer)))
+;;; plstore mode.
+
;; The functions related to plstore mode unfortunately introduce yet
;; another alist format ("decoded alist"). After executing the "foo",
;; "bar", "baz" example from above the decoded alist of the plstore
@@ -587,6 +613,7 @@ plstore-save
;; `plstore-encoded' is non-nil if a buffer shows the decoded form.
(defun plstore--encode (plstore)
+ "Return the printed representation of the decoded alist of PLSTORE."
(plstore--decrypt plstore)
(let ((merged-alist (plstore--get-merged-alist plstore)))
(concat "("
@@ -611,6 +638,9 @@ plstore--encode
")")))
(defun plstore--decode (string)
+ "Create a plstore instance from STRING.
+STRING should be the printed representation of a decoded alist of
+some plstore."
(let* ((alist (car (read-from-string string)))
(pointer alist)
secret-alist
@@ -618,7 +648,7 @@ plstore--decode
entry)
(while pointer
(unless (stringp (car (car pointer)))
- (error "Invalid PLSTORE format %s" string))
+ (error "Invalid plstore format %s" string))
(setq plist (cdr (car pointer)))
(while plist
(when (string-match "\\`:secret-" (symbol-name (car plist)))
@@ -638,6 +668,10 @@ plstore--decode
(plstore--make nil alist nil secret-alist)))
(defun plstore--write-contents-functions ()
+ "Convert the decoded form of a plstore in the current buffer.
+Convert it to the regular file representation of a plstore if
+needed. This function is used on hook `write-contents-functions'
+in plstore mode buffers."
(when plstore-encoded
(let ((store (plstore--decode (buffer-string)))
(file (buffer-file-name)))
@@ -675,7 +709,7 @@ plstore-mode-decoded
(erase-buffer)
(insert
(substitute-command-keys "\
-;;; You are looking at the decoded form of the PLSTORE file.\n\
+;;; You are looking at the decoded form of the plstore file.\n\
;;; To see the original form content, do \\[plstore-mode-toggle-display]\n\n"))
(insert (plstore--encode store))
(set-buffer-modified-p nil)
@@ -690,7 +724,7 @@ plstore-mode-toggle-display
;;;###autoload
(define-derived-mode plstore-mode emacs-lisp-mode "PLSTORE"
- "Major mode for editing PLSTORE files."
+ "Major mode for editing plstore files."
(make-local-variable 'plstore-encoded)
(add-hook 'write-contents-functions #'plstore--write-contents-functions)
(define-key plstore-mode-map "\C-c\C-c" #'plstore-mode-toggle-display)
--
2.30.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-05-22 20:11 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-05-31 12:54 ` Eli Zaretskii
2023-06-16 19:43 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-30 19:28 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 2 replies; 19+ messages in thread
From: Eli Zaretskii @ 2023-05-31 12:54 UTC (permalink / raw)
To: Jens Schmidt; +Cc: 63627
> Date: Mon, 22 May 2023 22:11:19 +0200
> From: Jens Schmidt via "Bug reports for GNU Emacs,
> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>
> All of these changes so far are doc fixes or message changes, none of
> them touches any code. Not sure whether they qualify for emacs-29, but
> I guess it would be easier to have them there to have the diff context
> ready for any following bug fixes.
Thanks, installed on the emacs-29 branch.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-05-31 12:54 ` Eli Zaretskii
@ 2023-06-16 19:43 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-30 19:28 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
1 sibling, 0 replies; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-06-16 19:43 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 63627
Eli, if you have some time could you probably give this patch
https://lists.gnu.org/archive/html/emacs-devel/2023-06/msg00260.html
a cursory review? I started writing user documentation for plstore when
I thought that this would fit better into the EasyPG Assistant's manual.
What do you think?
If I should go for the EPA manual, would this ("missing documentation
for existing emacs-29 features") go on emacs-29?
Thanks
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-05-31 12:54 ` Eli Zaretskii
2023-06-16 19:43 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-08-30 19:28 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-31 4:46 ` Eli Zaretskii
1 sibling, 1 reply; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-08-30 19:28 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 63627
[-- Attachment #1: Type: text/plain, Size: 970 bytes --]
On 2023-05-31 14:54, Eli Zaretskii wrote:
>> Date: Mon, 22 May 2023 22:11:19 +0200
>> From: Jens Schmidt via "Bug reports for GNU Emacs,
>> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>>
>> All of these changes so far are doc fixes or message changes, none of
>> them touches any code. Not sure whether they qualify for emacs-29, but
>> I guess it would be easier to have them there to have the diff context
>> ready for any following bug fixes.
>
> Thanks, installed on the emacs-29 branch.
Next set of patches, I hope they are still eligible for emacs-29.
The first patch fixes more documentation and terminology issues in
plstore.el, still without touching any code. The second patch
comprise ERT tests for plstore.el. Since that requires interaction
with GnuPG, these tests are rather platform-dependent. Test setup
should ensure that all tests are skipped if GnuPG is missing or not
appropriate for the tests.
Please check.
Thanks.
[-- Attachment #2: 0001-Add-documentation-to-plstore.el.patch --]
[-- Type: text/x-patch, Size: 4442 bytes --]
From 41c92e4522fb7535aa18746aa99bc7c5d65b60e2 Mon Sep 17 00:00:00 2001
From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
Date: Wed, 16 Aug 2023 23:31:30 +0200
Subject: [PATCH 1/2] Add documentation to plstore.el
* lisp/plstore.el: Add link to epa manual. Describe more
restrictions. Fix a typo in the examples. Fix terminology. Mark
FIXMEs as such.
* lisp/plstore.el (plstore-save): Describe edge case when no recipient
matches and mark as FIXME. (Bug#63627)
---
lisp/plstore.el | 39 ++++++++++++++++++++++++++++++---------
1 file changed, 30 insertions(+), 9 deletions(-)
diff --git a/lisp/plstore.el b/lisp/plstore.el
index d18d461d7d1..7dc991aeec7 100644
--- a/lisp/plstore.el
+++ b/lisp/plstore.el
@@ -24,14 +24,31 @@
;; Plist based data store providing search and partial encryption.
;;
-;; By default, this package uses symmetric encryption, which means
+;; By default, this library uses symmetric encryption, which means
;; that you have to enter the password protecting your store more
;; often than you probably expect to. To use public key encryption
-;; with this package, create a GnuPG key and customize user option
+;; with this library, create a GnuPG key and customize user option
;; `plstore-encrypt-to' to use it. You can then configure the GnuPG
;; agent to adjust caching and expiration of the passphrase for your
;; store.
;;
+;; You can read more on these topics in the EasyPG Assistant user's
+;; manual (Info node `(epa)'), of which much information also applies
+;; to this library. Most notably:
+;;
+;; - Info node `(epa)GnuPG version compatibility'
+;; - Info node `(epa)GnuPG Pinentry'
+;; - Info node `(epa)Caching Passphrases'
+;;
+;; Use only keyword symbols (starting with a colon) as property names
+;; in any plist stored with this library. While this library does not
+;; actively enforce the use of keyword symbols, it silently assumes
+;; that the first character of all property names can be discarded
+;; without sacrificing uniqueness of names (FIXME). Likewise, this
+;; library does not enforce that the plists provided as input are
+;; actually valid and can behave in undefined ways if they are not
+;; (FIXME).
+;;
;; Creating:
;;
;; ;; Open a new store associated with ~/.emacs.d/auth.plist.
@@ -52,8 +69,8 @@
;; (plstore-close store)
;;
;; Avoid marking one property both as public *and* secret, as the
-;; behavior of this package with respect to such duplicate properties
-;; is not (yet) defined.
+;; behavior of this library with respect to such duplicate properties
+;; is not defined (FIXME).
;;
;; Searching:
;;
@@ -71,7 +88,7 @@
;; ;; While the entry "baz" associated with "baz.example.org" has also
;; ;; a secret property `:password', it is encrypted together with
;; ;; `:user' of "bar", so no need to decrypt the secret.
-;; (plstore-find store '(:host ("bar.example.org")))
+;; (plstore-find store '(:host ("baz.example.org")))
;;
;; (plstore-close store)
;;
@@ -87,8 +104,8 @@
;; `:secret-' prefix) is marked as secret. Thus, when you save the
;; buffer, the `:secret-user' property is encrypted as `:user'. Do
;; not use a property consisting solely of the prefix, as the behavior
-;; of this package with respect to such properties is not (yet)
-;; defined.
+;; of this library with respect to such properties is not defined
+;; (FIXME).
;;
;; You can toggle the view between encrypted form and the decrypted
;; form with C-c C-c.
@@ -101,7 +118,7 @@
;; Internals:
;;
;; This is information on the internal data structure and functions of
-;; this package. None of it should be necessary to actually use it.
+;; this library. None of it should be necessary to actually use it.
;; For easier reading, we usually do not distinguish in this internal
;; documentation between a Lisp object and its printed representation.
;;
@@ -589,7 +606,11 @@ plstore--insert-buffer
(insert ";;; secret entries\n" (pp-to-string cipher)))))
(defun plstore-save (plstore)
- "Save PLSTORE to its associated file."
+ "Save PLSTORE to its associated file.
+Save with symmetric encryption or public key encryption depending
+on `plstore-encrypt-to'. If `plstore-encrypt-to' is non-nil but
+none of the recipients from `plstore-encrypt-to' matches any
+GnuPG key, silently save with symmetric encryption." ; (FIXME)
(with-current-buffer (plstore--get-buffer plstore)
(erase-buffer)
(plstore--insert-buffer plstore)
--
2.30.2
[-- Attachment #3: 0002-Add-tests-for-plstore.el.patch --]
[-- Type: text/x-patch, Size: 32341 bytes --]
From 3b8d629d7b3ab638e164ce292b6ba6300e9de740 Mon Sep 17 00:00:00 2001
From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
Date: Wed, 16 Aug 2023 23:42:11 +0200
Subject: [PATCH 2/2] Add tests for plstore.el
* test/lisp/plstore-resources/plstore-tests.pubkey:
* test/lisp/plstore-resources/plstore-tests.seckey:
* test/lisp/plstore-tests.el: Add new files. (Bug#63627)
---
.../plstore-resources/plstore-tests.pubkey | 40 ++
.../plstore-resources/plstore-tests.seckey | 83 +++
test/lisp/plstore-tests.el | 535 ++++++++++++++++++
3 files changed, 658 insertions(+)
create mode 100644 test/lisp/plstore-resources/plstore-tests.pubkey
create mode 100644 test/lisp/plstore-resources/plstore-tests.seckey
create mode 100644 test/lisp/plstore-tests.el
diff --git a/test/lisp/plstore-resources/plstore-tests.pubkey b/test/lisp/plstore-resources/plstore-tests.pubkey
new file mode 100644
index 00000000000..f006ce9c071
--- /dev/null
+++ b/test/lisp/plstore-resources/plstore-tests.pubkey
@@ -0,0 +1,40 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQGNBGSB/poBDACkSkNrg5nkN1J4BoJTgqkSQQa89B88hP+C83UuKZZ90Y2RySbC
+IR8OnARimtOaokEn+k3gMYiVDxmYcPcCM5OYt1diByjbv018MYyq+sPTWvfjSLQM
+k4ZEHho4ucSdP8u+jgbTY8n+qIco07kXR0LjB4D5cvwHPsYmOaXci2DiPaVZ2KSB
+PqIXHL2jXWZKo7yAwRym+gP7SOAXIRbI5Fgnjm4R8xPZI9i67hsVrn4iLEvNdPXN
+C4nZVsKshWCfko5IDAsyZR+SVfoXYj+BpweGZhpcAOrUupGHagDUhvqY9DDz352J
+pWu/852oMfTVvV6h3JevniPd2ZBPWKOyteYBWP+7Cy6KE8wEEXTTpyoGN9UVcXup
+Jrb2rlkmlIBi7rRssgW/uEnfTiNiCF5y90tpvdl0kHhuWU1Mx4+JqYFOjXi7IpCA
+kyObW4nZ0iZrxt5yVqi2r00FJChMWOrzuPtaQgELyJLHVSOjexegpPTv56dV+Eko
+Dvy40PsGxCmgUR8AEQEAAbQScGxzdG9yZS10ZXN0cy1yY3B0iQHOBBMBCgA4FiEE
+AahVzTjV+MwdUQd1HBcSKC4CYkQFAmSB/poCGwMFCwkIBwIGFQoJCAsCBBYCAwEC
+HgECF4AACgkQHBcSKC4CYkRxmwv+OmFgU8JsBGZGj12/RBQu4wXwryS2r5AJf6Cp
+RCLD0ilEe5wX3zvJu1vpSyc79xTSvlXf/thRCHfgXw+m+IkY101rt2pVEBHgLC98
+ql0JDvY5dsd0S98bMgilULFGgSvfJYxY+Zlgf4jiWuo3b/43We4IbCXpF7C2356U
+rJEImZo7PC/wbsb4VUTUACLlaspoXByz0GrnvzpfQjmoZHLQlKtMN1EZnQLooxv/
+0CKmBRXD08rJrO46+wgTKKptxd5hgmCHnRIbmaP3I1nvNDKp1BINUYJEsVNBEQuU
+sScHWXdbzb64zhyQvynad85tdP+srVcRTCJhiTJu7VAFgDvqXK8CZ6ApSvqwN9xa
+euw4LjZi4TjA5Qd9SWUyP/TNtiqg8SsipjRvCeE7UfV7jA/W63uKgsbA48QY337O
+b69bA5HQuBbsNd1oF74mlEd0q/sOog6hVxzT2FplOTJfUlNhQK6QcwQ5HoiMOafI
+8WSDVaAgewjBfpQzhcd0LIK6oKzquQGNBGSB/poBDADB9ioE+o8mfybEce2aGmq8
+4ouwb5k3NHAt3+d4AcVQ+prCe4Hy2Exyk+iiDleAt6LX2sf2eS7+NZ1RsDSNS8iL
+5dwRwFoTc7cVa2sz6EPtHBpwwfdBaihzySxdKl4MEevr2skAcBJ7vC2ALhA02/98
+7CRGxEs8/Zof63/NlMJHdL9Ektsl4dm6SiSijcJlikML6qA7DpN6+l7SXk0ot1AT
+NKGMmmY5n3rpEu6yKKd8kNWxlrhlSDGPXPijBzyOElKG7vfuzaMbisxGBaIF44qb
+n24nwXxlSmiotJHsV+HfxoJaGIJwhd+BW35FFLgGLJ1F+TwUPhPnv+N0b4mtebBs
+MjwbyFCSGMkP7mMPtsNlTRaWlX0Fk5SR7eePhS2+wa/CfYPEOrwf5mpsu/65sAmI
+qBKuNz7xskuwCv5SJG9XdLYHbJcKxTQaJNOizHiRCLT2tHqLbF+B7kEZrm+uDWLU
+XOe8YZRVQltryuwtu7HeaNa1aOCXTgTfbC4E2/5myGEAEQEAAYkBtgQYAQoAIBYh
+BAGoVc041fjMHVEHdRwXEiguAmJEBQJkgf6aAhsMAAoJEBwXEiguAmJErL8L+waA
+JRvLggz1s+SznyV3iXqq9fOJ1ETbu13sJ0+KOih9pn5tbN9eDgH39wmiPw+wZTMi
+Lu+LIy07gEMsVwjK6B9khX0lwXHgWCdEgj8le2c00sQpUHEJx6wBwwu2mk4xbOSg
+U1Y5No8IRhJYC+fchWqOtJYAkBbpRkCPnlVwEoDnF4/S1u6hNBPM7MqJVIc07g9f
+1EiVOzO/XV5Jt8ngZr0BaCa9LHFCxIySH2nkOO2akne+TS/brGRmyC4cKId5vf7a
+NKF7jePh3JSui9nAz6kqqWqCPQTPFN9wGNB9MPLsXoOU8ucjCNZ027S1z/QuDQvt
+JCfR1NICHxjg6UAII5gT/Xw9CGlj3AB/sOVI0khi9nWtI8j7kgmBA33fthuJWD9d
+XkLwpVr6c8NLH5oi7WHVAJM8Qz/QOZeIhF5+CF4KVj5qqNBsZcSfMQLjAHwx+UeY
+PApR0Z2bXjSpcT1hTJVg2kwmKj7Ol6FvAgOyssCi5jMWmGXMiny7zfF86AKaOA==
+=0gx/
+-----END PGP PUBLIC KEY BLOCK-----
diff --git a/test/lisp/plstore-resources/plstore-tests.seckey b/test/lisp/plstore-resources/plstore-tests.seckey
new file mode 100644
index 00000000000..a148c9c2026
--- /dev/null
+++ b/test/lisp/plstore-resources/plstore-tests.seckey
@@ -0,0 +1,83 @@
+-----BEGIN PGP PRIVATE KEY BLOCK-----
+
+lQWGBGSB/poBDACkSkNrg5nkN1J4BoJTgqkSQQa89B88hP+C83UuKZZ90Y2RySbC
+IR8OnARimtOaokEn+k3gMYiVDxmYcPcCM5OYt1diByjbv018MYyq+sPTWvfjSLQM
+k4ZEHho4ucSdP8u+jgbTY8n+qIco07kXR0LjB4D5cvwHPsYmOaXci2DiPaVZ2KSB
+PqIXHL2jXWZKo7yAwRym+gP7SOAXIRbI5Fgnjm4R8xPZI9i67hsVrn4iLEvNdPXN
+C4nZVsKshWCfko5IDAsyZR+SVfoXYj+BpweGZhpcAOrUupGHagDUhvqY9DDz352J
+pWu/852oMfTVvV6h3JevniPd2ZBPWKOyteYBWP+7Cy6KE8wEEXTTpyoGN9UVcXup
+Jrb2rlkmlIBi7rRssgW/uEnfTiNiCF5y90tpvdl0kHhuWU1Mx4+JqYFOjXi7IpCA
+kyObW4nZ0iZrxt5yVqi2r00FJChMWOrzuPtaQgELyJLHVSOjexegpPTv56dV+Eko
+Dvy40PsGxCmgUR8AEQEAAf4HAwLhaRlLy4u4Ff96uoRLTaN8TElz55OLBt4esjTl
+mefUVnYI/OBlTizBjtmOD0Rp6Sf5a94L0g/ZLI7OV9JXwFPKS8X2OjcoqwApzs5N
+X61Fp3JoH6i5lqh6qoTELaz6hPqeEM97oBdls6m808l76ztDnzFVXCOu41gGwev+
+/S7kdwi2+jx3OkL4P+a3PEU45IXc4vvRtby3gFAZ6yN0Kh/SES8wACTyXriJ8c5x
+LZ6+qtnAyMdMHf17YwCm3Sisr3+e6RTt4ruWRQjyp3gVsT9eTCqzuyUhQRh9vnjs
+XxjYPzxuo5MKyZXgZ3D+Wlp7RN1Tm/s8J5ug517oXlJEYEKVOz/MPSOwzkDF1skf
+A6K9pC/os5cf6gx1NqiasPGrd2GHRrg6qEe0g2xqVJPVnGZWb6u9RmJsJU8OH+yA
+z1v1/ZygdM2HOtwt/pZTpk4JBgGIPhnBQBZC5XBmcr0zVWXfRIyRhLUtL1QAGLqm
+bKodi3PqY4+p1+Qd9SAeG+y0OmfqAjghNikv2csehKG7S0DoCdQ0ku8YsTqzFLO7
+eR15sKJrFLhyerRwlE7WjCsQC2DXqDTFdIQkz9j0Jkmv2UTEzllmjK+jNcP4ieHX
+BSnft/lUvLVFIXP/5MTMbOruSRES2vtX7q7tv62Qc6KjCZKCH8ghk+1552ZdDkFb
+mNhai+XJ7JEClx85VjAmweh4XwqTHtCLsR2zHttEctb9jT1fAK3VNJWOqpni9/3G
+EvhDD0qVO69Fn002QlNhwDy0WxQpqH3kKeEb1/5/QnaF0xFz1nM48y7iG+ITUdoO
+tWUKxqVuw8yntk8Ngmkc8n0ebBKxLU0sDQViYSKGJOAS3htY5Dovq4KVDXxW+/iw
+83YLaivvDG3Gr16uysiHAvNnK91StWPOvKvtxE5ADw39mcMnOkCF1/q4qDafB3RG
++7bXrXPEuuYQ4CCFO6v+g0aHqQxFx/Cre3804CsIBg3yKN5AXxO6rJUcKTytC0zJ
+cJXDbZZV05CBDg3x+6xJn2kPk0oTe/uCSYN6xWPiJi4RjS9UL/ATir/2m4z7/o18
+rVUr1oZ8/HtJoPezfhNtJqqbDu+Q3DkqEfXLdBDMF71vT/0zUMvoE6l98VMAq6wm
+Phrk299mgr1EQOYTWKAnbXQ1gKh2JwegbJG738MwYtixkp6ITDPw71j5x/SYinHj
+WeTZ9sooufXyw6P7JhqRKrZbGRwbDAo4hCMJAyi2Z1VMuR7IH0tf5A4o46l91Izh
+9Z4RewlS5bto3TPhUGwfD+3wywjtiT7d/Xp/IgmhEkcXdsjBNlz4f9oVX/ZtsUj9
+BPRAeeRPcA2GgzFNFGf4iyidzgiEJlqIGbQScGxzdG9yZS10ZXN0cy1yY3B0iQHO
+BBMBCgA4FiEEAahVzTjV+MwdUQd1HBcSKC4CYkQFAmSB/poCGwMFCwkIBwIGFQoJ
+CAsCBBYCAwECHgECF4AACgkQHBcSKC4CYkRxmwv+OmFgU8JsBGZGj12/RBQu4wXw
+ryS2r5AJf6CpRCLD0ilEe5wX3zvJu1vpSyc79xTSvlXf/thRCHfgXw+m+IkY101r
+t2pVEBHgLC98ql0JDvY5dsd0S98bMgilULFGgSvfJYxY+Zlgf4jiWuo3b/43We4I
+bCXpF7C2356UrJEImZo7PC/wbsb4VUTUACLlaspoXByz0GrnvzpfQjmoZHLQlKtM
+N1EZnQLooxv/0CKmBRXD08rJrO46+wgTKKptxd5hgmCHnRIbmaP3I1nvNDKp1BIN
+UYJEsVNBEQuUsScHWXdbzb64zhyQvynad85tdP+srVcRTCJhiTJu7VAFgDvqXK8C
+Z6ApSvqwN9xaeuw4LjZi4TjA5Qd9SWUyP/TNtiqg8SsipjRvCeE7UfV7jA/W63uK
+gsbA48QY337Ob69bA5HQuBbsNd1oF74mlEd0q/sOog6hVxzT2FplOTJfUlNhQK6Q
+cwQ5HoiMOafI8WSDVaAgewjBfpQzhcd0LIK6oKzqnQWGBGSB/poBDADB9ioE+o8m
+fybEce2aGmq84ouwb5k3NHAt3+d4AcVQ+prCe4Hy2Exyk+iiDleAt6LX2sf2eS7+
+NZ1RsDSNS8iL5dwRwFoTc7cVa2sz6EPtHBpwwfdBaihzySxdKl4MEevr2skAcBJ7
+vC2ALhA02/987CRGxEs8/Zof63/NlMJHdL9Ektsl4dm6SiSijcJlikML6qA7DpN6
++l7SXk0ot1ATNKGMmmY5n3rpEu6yKKd8kNWxlrhlSDGPXPijBzyOElKG7vfuzaMb
+isxGBaIF44qbn24nwXxlSmiotJHsV+HfxoJaGIJwhd+BW35FFLgGLJ1F+TwUPhPn
+v+N0b4mtebBsMjwbyFCSGMkP7mMPtsNlTRaWlX0Fk5SR7eePhS2+wa/CfYPEOrwf
+5mpsu/65sAmIqBKuNz7xskuwCv5SJG9XdLYHbJcKxTQaJNOizHiRCLT2tHqLbF+B
+7kEZrm+uDWLUXOe8YZRVQltryuwtu7HeaNa1aOCXTgTfbC4E2/5myGEAEQEAAf4H
+AwKcZyirnVxOrP9hZNgnoid0GKAjq14dnwWifuTCJwQNpjoI9uMZigvvLmTlaRY9
+gl+yjSH/Y+aTyA7Ja/T6Oal8Wb60HF/RTtywDImVmbjXHNpzJ9tGrbNn8cgrHzrp
+njYByKnyE6P8LWmlAf1UBtMyDwGlJJKnLPomIgh4RAllLMEqXScb4j0TYtcpq/gF
+GHE271aL0+cHREBhaIED/B2RfWV1T1lY8T4FvppuGBy/EqrtiDTeEPhvJCgd3KYt
+5bFnktTkMxZCXZ4RFA7x7ad7DR1DoNHUb48lnSy0bjXjyDrFSIw9acdqrGt1ZiZh
+1Kyu3INC3itAKnWw0JWgXPVq3QCOtjXgEdPIiAxwmOvnskAMQGW43B/DPgnpOnch
+lP50KLXyudbvdAVdewjGiaC5/kQzQOEMlIdsnO0UB/6NtDqE5E8MUIfXtnkafDmA
+cP/8YwWlH73lo5bE6AVzAXqlyyq6lXo/BOqY44tDArXEeauZiUVPu3vtHb3YgGqh
+eTXz8NtDkWZsMQ9+ITDlj8hNsET+pa3sVE/FlzNQMLQwtUnjOA+wOW+lbfEjhr8/
+x1/TrF8cHaCeOuhWRl6yJNDN7PBtJ+AgAMxGaCiy/CcByAO38cSaDpLD37N2ZovN
+cgikbCNVsALM0ZbIr979OGmmWW2jK3trXBGvE4K1TUZuN9j/GG/q66dn7cIp9VJw
+I+XiAMCLKaxyAWEHqeqppvLsKcw/HAWkQ2pJsTpcCxj8famuUI9302lNOdg7SfLi
+FDtMVPdnMtzzZTHwTaklMzpEICex8BLOazGVjkp0CqnI6twjbvBJkViXQMRtttdJ
+P+r/hSfNDyhqVj0O4iiLo+S6GEpBQYJl/t0wln/NvgeQ2yNIj/vexDX910u1Emz2
+DqMtygfVYXB0ggEe7ueMBcRr+pIamIRiB2YLOp3NS4wLiizLjHgW3ObyD/aJmlrF
+dm4d1hXUm0Kgq3l2+V/9p8ZmUDqh/OE+IBanAvKSSnjoQgV3JIt9yagE3KCSayCC
+Tfxe0FW37Xl5C9cIkn/lgdacMDRwHUZp9MOr8UKO/tnmaBrKObWacumYrE/QQWF8
+gxlvZrssqMa09QpL7ZVqNwWRUZ+zICm/asLIYgwDZdmQIpkSEJPK+H3ymuZd2EVt
+9+8p+G+BgjSD8BqRZxa9I71xIMuEAjOVV5q99u2LwyDJHu8jIgzeCGPdJ7PBGn8+
+BkOVjjOrd/+jKokgPiiE8JmKaKKa/lLUwRgAcFSU4T6/JppThdGE250CzB50IKeg
+64UhH6hYlPyKCrW23UIZi+AtYQu4N4AeqsYs3yfQ0fFLgy7XoHdvJhJ1rMBD6Sw7
+4lhQ03uLm4kBtgQYAQoAIBYhBAGoVc041fjMHVEHdRwXEiguAmJEBQJkgf6aAhsM
+AAoJEBwXEiguAmJErL8L+waAJRvLggz1s+SznyV3iXqq9fOJ1ETbu13sJ0+KOih9
+pn5tbN9eDgH39wmiPw+wZTMiLu+LIy07gEMsVwjK6B9khX0lwXHgWCdEgj8le2c0
+0sQpUHEJx6wBwwu2mk4xbOSgU1Y5No8IRhJYC+fchWqOtJYAkBbpRkCPnlVwEoDn
+F4/S1u6hNBPM7MqJVIc07g9f1EiVOzO/XV5Jt8ngZr0BaCa9LHFCxIySH2nkOO2a
+kne+TS/brGRmyC4cKId5vf7aNKF7jePh3JSui9nAz6kqqWqCPQTPFN9wGNB9MPLs
+XoOU8ucjCNZ027S1z/QuDQvtJCfR1NICHxjg6UAII5gT/Xw9CGlj3AB/sOVI0khi
+9nWtI8j7kgmBA33fthuJWD9dXkLwpVr6c8NLH5oi7WHVAJM8Qz/QOZeIhF5+CF4K
+Vj5qqNBsZcSfMQLjAHwx+UeYPApR0Z2bXjSpcT1hTJVg2kwmKj7Ol6FvAgOyssCi
+5jMWmGXMiny7zfF86AKaOA==
+=VmVt
+-----END PGP PRIVATE KEY BLOCK-----
diff --git a/test/lisp/plstore-tests.el b/test/lisp/plstore-tests.el
new file mode 100644
index 00000000000..da1fe6163d5
--- /dev/null
+++ b/test/lisp/plstore-tests.el
@@ -0,0 +1,535 @@
+;;; plstore-tests.el --- Test suite for plstore.el -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023 Free Software Foundation, Inc.
+
+;; Author: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
+;; Keywords: PGP, GnuPG
+
+;; 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 <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; These tests depend on EPG finding a usable GnuPG configuration with
+;; a sufficiently new GnuPG version, see `plstore-tests-set-up-epg'.
+;; If EPG cannot find any, this test suite skips all tests requiring
+;; GnuPG.
+
+;;; Code:
+
+(require 'cl-lib)
+(require 'ert)
+(require 'ert-x)
+(require 'plstore)
+
+(defconst plstore-tests-recipient "plstore-tests-rcpt")
+
+(defconst plstore-tests-recipient-passphrase "plstore-tests-passphrase")
+
+\f
+
+;;; plist and alist handling.
+
+;; Return whether OBJECT is a valid plstore alist. That is, a
+;; string-indexed alist of plists having keyword symbols as property
+;; names.
+(defun plstore-tests-alist-p (object)
+ (and (listp object)
+ (cl-every
+ (lambda (entry)
+ (and
+ (consp entry)
+ (stringp (car entry))
+ (listp (cdr entry))
+ (cl-loop
+ for member on (cdr entry) by #'cddr
+ for pname = (car member)
+ for kwsymp = (and (symbolp pname)
+ (eq (aref (symbol-name pname) 0) ?:))
+ unless kwsymp return nil
+ finally return t)))
+ object)))
+
+;; Sort PLIST in a stable manner and return the result as a new plist.
+;; Assume that all property names are symbols and default a missing
+;; trailing property value to nil.
+(defun plstore-tests-plist-sort (plist)
+ ;; Keep this readable instead of functional: Convert PLIST to an
+ ;; alist, sort that, and convert the sorted alist back to a plist.
+ (let (alist)
+ (setq alist
+ (cl-loop
+ for member on plist by #'cddr
+ collect (cons (symbol-name (car member)) (cadr member))))
+ (setq alist
+ (cl-stable-sort alist
+ #'string-lessp :key #'car))
+ (setq plist
+ (cl-loop
+ for (key . value) in alist
+ collect (intern key)
+ collect value))
+ plist))
+
+;; Sort plstore alist ALIST both on alist and on plist level. Sort it
+;; in a stable manner on all levels and return the result as a new
+;; alist, without modifying ALIST.
+(defun plstore-tests-alist-sort (alist)
+ (cl-stable-sort
+ (mapcar
+ (lambda (entry)
+ (cons (car entry)
+ (plstore-tests-plist-sort (cdr entry))))
+ alist)
+ #'string-lessp :key #'car))
+
+;; Return whether ALIST is a plstore alist and whether it equals
+;; (after plstore-alist-sorting) REF-ALIST.
+(defun plstore-tests-alists-equal-p (alist ref-alist)
+ (and
+ (plstore-tests-alist-p alist)
+ (equal (plstore-tests-alist-sort alist) ref-alist)))
+
+\f
+
+;;; Passphrase handling.
+
+;; The items on this page care about:
+;;
+;; - Providing some response to loopbacked passphrase requests; and
+;;
+;; - tracking whether and which responses have been provided during
+;; execution of some form.
+
+;; Response to provide to passphrase requests done through function
+;; `plstore-tests-handle-passphrase-request'. One of:
+;;
+;; - `ok': provide the correct passphrase from
+;; `plstore-tests-recipient-passphrase'
+;;
+;; - `wrong': provide an invalid (empty) passphrase
+;;
+;; - `quit': quit passphrase request with function `keyboard-quit'
+;;
+;; - any other symbol: signal an error
+;;
+;; Let-bound by macro `with-plstore-tests-passphrase' and (as default)
+;; by macro `with-plstore-tests'.
+(defvar plstore-tests-passphrase-response nil)
+
+;; History of passphrase responses provided through function
+;; `plstore-tests-handle-passphrase-request'. This is a stack of
+;; stacks of the collected passphrase responses.
+(defvar plstore-tests-passphrase-history nil)
+
+;; Handle a passphrase request according to
+;; `plstore-tests-passphrase-response' and record the provided
+;; response in `plstore-tests-passphrase-history'.
+(defun plstore-tests-handle-passphrase-request ()
+ (push plstore-tests-passphrase-response
+ (car plstore-tests-passphrase-history))
+ (pcase plstore-tests-passphrase-response
+ ('ok (copy-sequence plstore-tests-recipient-passphrase))
+ ('wrong "")
+ ('quit (keyboard-quit))
+ (_ (error "Invalid passphrase request"))))
+
+;; Let-bind `plstore-tests-passphrase-response' to provide RESPONSE to
+;; all passphrase requests done during execution of BODY. If
+;; PASSPHRASE-EXPECTED equals `no', ensure that no passphrases have
+;; been requested during execution of BODY, if it equals `yes', ensure
+;; that at least one passphrase has been requested, otherwise do not
+;; assume anything on the number of passphrase requests.
+;;
+;; This macro is mostly intended to test for *absence* of passphrase
+;; requests, since library `plstore' promises to use decryption and
+;; encryption (and, accordingly, to request passphrases) only when
+;; actually needed.
+;;
+;; This could be extended to track presence or absence of requests
+;; even more closely, but the rules when to expect requests and when
+;; not depend on agent caching and on encryption type, which would
+;; make such tests rather tricky.
+(cl-defmacro with-plstore-tests-passphrase ((&key
+ (response ''ok)
+ (passphrase-expected ''maybe))
+ &rest body)
+ (declare (indent 1) (debug (sexp body)))
+ `(unwind-protect
+ (let ((plstore-tests-passphrase-response ,response))
+ (push nil plstore-tests-passphrase-history)
+ ,@body
+ (when (eq ,passphrase-expected 'no)
+ (should (not (car plstore-tests-passphrase-history))))
+ (when (eq ,passphrase-expected 'yes)
+ (should (car plstore-tests-passphrase-history))))
+ (pop plstore-tests-passphrase-history)))
+
+\f
+
+;;; Test execution infrastructure.
+
+;; Create and return a new plstore test environment from TESTDIR.
+;;
+;; The test environment is a plist which gets successively filled by
+;; the setup functions below with the following members:
+;;
+;; :status
+;; Symbol describing environment status. One of `initial',
+;; `epg-set-up', `gpg-home-directory-set-up', `skip-tests'.
+;; :skip-reason
+;; String describing the reason for the tests to be skipped if
+;; status equals `skip-tests', otherwise nil.
+;; :epg-homedir, :epg-config, :epg-context
+;; Self-explaining.
+;;
+;; The EPG configuration and context stored in the plstore test
+;; environment are used only for the key management done by this test
+;; suite, and not for the encryption and decryption operations done by
+;; plstore. For these, plstore sets up its own EPG context mainly
+;; from `epg-gpg-home-directory' and `epg-pinentry-mode', which macro
+;; `with-plstore-tests' sets as needed.
+(defun plstore-tests-make-environment (testdir)
+ (list
+ :status 'initial
+ :skip-reason nil
+ :epg-homedir (expand-file-name ".gnupg" testdir)))
+
+;; Set up EPG, determine a usable GnuPG configuration, and store the
+;; resulting information in plstore test environment ENVIRONMENT.
+;;
+;; GnuPG 2.1.5 should already have a usable loopback pinentry (see
+;; Info node `(epa) GnuPG version compatibility)', but
+;; `epg-gpg2-minimum-version' mentions 2.1.6, so require that.
+(defun plstore-tests-set-up-epg (environment)
+ (if-let ((config (epg-find-configuration
+ 'OpenPGP nil
+ '((OpenPGP epg-gpg-program
+ ("gpg" . "2.1.6")
+ ("gpg2" . "2.1.6")))))
+ (context (epg-make-context 'OpenPGP)))
+ (progn
+ (setf (epg-context-program context)
+ (alist-get 'program config))
+ (setf (epg-context-home-directory context)
+ (plist-get environment :epg-homedir))
+ (setf (epg-context-pinentry-mode context) 'loopback)
+ (plist-put environment :epg-config config)
+ (plist-put environment :epg-context context)
+ (plist-put environment :status 'epg-set-up))
+ (plist-put environment :status 'skip-tests)
+ (plist-put environment :skip-reason "no usable GnuPG configuration")))
+
+;; Set up a GnuPG home directory for our tests below the path pointed
+;; to by member `:epg-homedir' in plstore test environment
+;; ENVIRONMENT. Use the predefined public and private key from the
+;; ERT resources to do so. Perform a final encrypt-decrypt round-trip
+;; test.
+;;
+;; The keys used below have been created with GnuPG 2.2.7 and exported
+;; to the ERT resource directory as follows:
+;;
+;; mkdir .gnupgtmphome && chmod 0700 .gnupgtmphome
+;; echo plstore-tests-passphrase |
+;; gpg --homedir .gnupgtmphome --quiet \
+;; --pinentry-mode loopback --passphrase-fd 0 \
+;; --quick-generate-key plstore-tests-rcpt default default 0
+;; gpg --homedir .gnupgtmphome --quiet \
+;; --armor --export plstore-tests-rcpt \
+;; > test/lisp/plstore-resources/plstore-tests.pubkey
+;; echo plstore-tests-passphrase |
+;; gpg --homedir .gnupgtmphome --quiet \
+;; --pinentry-mode loopback --passphrase-fd 0 \
+;; --armor --export-secret-key plstore-tests-rcpt \
+;; > test/lisp/plstore-resources/plstore-tests.seckey
+;; rm -rf .gnupgtmphome
+(defun plstore-tests-set-up-gpg-home-directory (environment)
+ (let ((homedir (plist-get environment :epg-homedir))
+ (context (plist-get environment :epg-context))
+ key (state 0) timeout-timer)
+
+ ;; Create GnuPG home directory.
+ (make-directory homedir)
+ (set-file-modes homedir #o0700)
+
+ ;; Configure passphrase handling to some sane defaults, even if
+ ;; these should be already in effect as GnuPG agent defaults,
+ ;; since the GnuPG agent gets started anew for every new GnuPG
+ ;; home directory.
+ (with-temp-file (expand-file-name "gpg-agent.conf" homedir)
+ (insert "allow-loopback-pinentry\n")
+ (insert "default-cache-ttl 600\n")
+ (insert "max-cache-ttl 7200\n"))
+
+ ;; Import and configure keys. This step, most notably the import
+ ;; of the private key, is expensive in terms of wall-clock time.
+ (setf (epg-context-passphrase-callback context)
+ '((lambda (_ _ _) (copy-sequence plstore-tests-recipient-passphrase))))
+ (epg-import-keys-from-file context (ert-resource-file "plstore-tests.pubkey"))
+ (epg-import-keys-from-file context (ert-resource-file "plstore-tests.seckey"))
+ (setq key (car-safe (epg-list-keys context plstore-tests-recipient)))
+ (cl-assert (cl-typep key 'epg-key))
+ ;; Trust first subkey of KEY ultimately.
+ (epg-edit-key
+ context key
+ (lambda (context status string _handback)
+ (pcase (vector state status string)
+ (`[0 "KEY_CONSIDERED" ,_])
+ ('[1 "GET_LINE" "keyedit.prompt"]
+ (process-send-string (epg-context-process context) "1\n"))
+ ('[2 "GOT_IT" ""])
+ ('[3 "GET_LINE" "keyedit.prompt"]
+ (process-send-string (epg-context-process context) "trust\n"))
+ ('[4 "GOT_IT" ""])
+ ('[5 "GET_LINE" "edit_ownertrust.value"]
+ (process-send-string (epg-context-process context) "5\n"))
+ ('[6 "GOT_IT" ""])
+ ('[7 "GET_BOOL" "edit_ownertrust.set_ultimate.okay"]
+ (process-send-string (epg-context-process context) "yes\n"))
+ ('[8 "GOT_IT" ""])
+ ('[9 "GET_LINE" "keyedit.prompt"]
+ (process-send-string (epg-context-process context) "quit\n"))
+ ('[10 "GOT_IT" ""])
+ (_
+ (error "Key edit protocol error in state %d" state)))
+ (setq state (1+ state)))
+ nil)
+
+ ;; Ensure an encrypt-decrypt round-trip works, in particular
+ ;; without hangs related to GnuPG 2.4.* and its bug T6481.
+ (unwind-protect
+ (progn
+ (setq timeout-timer
+ (run-at-time
+ 5 nil
+ (lambda ()
+ (when-let
+ ((process (epg-context-process context))
+ ((eq (process-status process) 'run)))
+ (kill-process process)
+ (plist-put environment :status 'skip-tests)
+ (plist-put environment :skip-reason "GnuPG process timeout")))))
+ (pcase (condition-case err
+ (equal
+ (epg-decrypt-string
+ context
+ (epg-encrypt-string
+ context "foobarbaz" (list key)))
+ "foobarbaz")
+ (error err))
+ ('t (plist-put environment :status 'gpg-home-directory-set-up))
+ ('nil (plist-put environment :status 'skip-tests)
+ (plist-put environment :skip-reason "GnuPG round-trip failure"))
+ (err (unless (eq (plist-get environment :status) 'skip-tests)
+ (plist-put environment :status 'skip-tests)
+ (plist-put environment :skip-reason (error-message-string err))))))
+ (cancel-timer timeout-timer))))
+
+;; Set up plstore test environment and execute BODY. Execute BODY
+;; with symmetric encryption if ENCRYPTION-TYPE equals `symmetric',
+;; with public-key encryption if ENCRYPTION-TYPE equals `public-key',
+;; otherwise execute BODY once for each of these encryption types.
+;;
+;; BODY can use the following lexical variables:
+;;
+;; `plstore-encrypt-to'
+;; Non-nil for public-key encryption, nil for symmetric
+;; encryption.
+;;
+;; `plstore-test-directory'
+;; Points to a test directory which is removed after the test.
+;; The test directory is initially empty except for the ".gnupg"
+;; GnuPG home directory.
+;;
+;; `plstore-test-file'
+;; Points to a non-existent file below above directory.
+;; Initialized to a different file name for each execution of
+;; BODY.
+;;
+;; `plstore'
+;; Scratch variable initialized to nil for each execution of BODY.
+;;
+;; Any form in BODY that potentially requests a passphrase must be
+;; wrapped into an appropriate `with-plstore-tests-passphrase' macro.
+;; Passphrase requests done outside that macro result in an error
+;; being signaled.
+;;
+;; Test environment setup includes creation of a temporary GnuPG home
+;; directory and startup of a corresponding GnuPG agent, which is a
+;; somewhat expensive process in terms of wall-clock time.
+;;
+;; Started working off a similar macro and the test resources from
+;; epg-tests.el, but there is not much left from that, probably.
+(cl-defmacro with-plstore-tests ((&key encryption-type)
+ &rest body)
+ (declare (indent 1) (debug (sexp body)))
+ `(ert-with-temp-directory testdir
+ (let ((environment (plstore-tests-make-environment testdir)))
+ ;; Set up plstore test environment.
+ (when (eq (plist-get environment :status) 'initial)
+ (plstore-tests-set-up-epg environment))
+ (when (eq (plist-get environment :status) 'epg-set-up)
+ (plstore-tests-set-up-gpg-home-directory environment))
+ (when (eq (plist-get environment :status) 'skip-tests)
+ (ert-skip (format "EPG or GnuPG setup failed (%s)"
+ (plist-get environment :skip-reason))))
+ (cl-assert (eq (plist-get environment :status)
+ 'gpg-home-directory-set-up))
+
+ (dolist (recipient
+ (pcase ,encryption-type
+ ('symmetric (list nil))
+ ('public-key (list plstore-tests-recipient))
+ (_ (list nil plstore-tests-recipient))))
+ (let (;; Silence plstore.
+ (inhibit-message t)
+ ;; Set up EPG (for use by plstore) and plstore itself.
+ (epg-gpg-home-directory (plist-get environment :epg-homedir))
+ (epg-pinentry-mode 'loopback)
+ (plstore-encrypt-to recipient)
+ (plstore-select-keys 'silent)
+ ;; Prepare these to detect passphrase requests done
+ ;; outside of any `with-plstore-tests-passphrase'
+ ;; macros.
+ (plstore-tests-passphrase-response 'error)
+ (plstore-tests-passphrase-history '(nil))
+ ;; Provide utility variables for BODY.
+ (plstore-test-directory testdir)
+ (plstore-test-file
+ (expand-file-name (if plstore-encrypt-to
+ (format "auth.%s.plist"
+ plstore-encrypt-to)
+ "auth.symmetric.plist")
+ testdir))
+ (plstore nil))
+ (cl-letf
+ (((symbol-function 'plstore-passphrase-callback-function)
+ (lambda (_ _ _) (plstore-tests-handle-passphrase-request))))
+ ;; Silence byte compiler warnings related to unused
+ ;; lexical utility variables.
+ (when nil
+ (ignore plstore-test-directory
+ plstore-test-file
+ plstore))
+ ,@body)
+ (should (equal plstore-tests-passphrase-history '(nil))))))))
+
+\f
+
+;;; The tests!
+
+;; Ensure the test primitives work as intended.
+(ert-deftest plstore-primitives ()
+ ;; plstore-tests-alist-p
+ (should (plstore-tests-alist-p nil))
+ (should-not (plstore-tests-alist-p 'foo))
+ (should-not (plstore-tests-alist-p '(foo)))
+ (should-not (plstore-tests-alist-p '((foo . foo))))
+ (should-not (plstore-tests-alist-p '(("foo" . foo))))
+ (should-not (plstore-tests-alist-p '(("foo" . ("foo")))))
+ (should-not (plstore-tests-alist-p '(("foo" . (foo)))))
+ (should (plstore-tests-alist-p '(("foo" . (:foo)))))
+ ;; plstore-tests-plist-sort
+ (should (equal (plstore-tests-plist-sort nil) nil))
+ (should (equal (plstore-tests-plist-sort '(:foo "foo")) '(:foo "foo")))
+ (should (equal (plstore-tests-plist-sort '(:foo "foo" :bar "bar")) '(:bar "bar" :foo "foo")))
+ (let* ((plist '(:foo "foo" :baz "baz" :bar "bar"))
+ (cars (copy-sequence plist))
+ (cdrs (cl-maplist #'identity plist)))
+ (plstore-tests-plist-sort plist)
+ (should (and (cl-every #'eq plist cars)
+ (cl-every #'eq (cl-maplist #'identity plist) cdrs))))
+ ;; plstore-tests-alist-sort
+ (should (equal (plstore-tests-alist-sort nil) nil))
+ (should (equal (plstore-tests-alist-sort '(("foo"))) '(("foo"))))
+ (should (equal (plstore-tests-alist-sort '(("foo") ("bar"))) '(("bar") ("foo"))))
+ (should (equal (plstore-tests-alist-sort
+ '(("foo" . (:foo "foo"))
+ ("baz" . (:foo "foo" :baz "baz" :bar "bar"))
+ ("bar" . (:foo "foo" :bar "bar"))))
+ '(("bar" . (:bar "bar" :foo "foo"))
+ ("baz" . (:bar "bar" :baz "baz" :foo "foo"))
+ ("foo" . (:foo "foo")))))
+ (let* ((alist '(("foo") ("baz") ("bar")))
+ (cars (copy-sequence alist))
+ (cdrs (cl-maplist #'identity alist)))
+ (plstore-tests-alist-sort alist)
+ (should (and (cl-every #'eq alist cars)
+ (cl-every #'eq (cl-maplist #'identity alist) cdrs)))))
+
+;; Ensure passphrase handling works as intended.
+(ert-deftest plstore-passphrase-handling ()
+ (with-plstore-tests-passphrase (:passphrase-expected 'maybe)
+ (should (string= (plstore-tests-handle-passphrase-request)
+ plstore-tests-recipient-passphrase)))
+ (with-plstore-tests-passphrase (:response 'ok
+ :passphrase-expected 'maybe)
+ (should (string= (plstore-tests-handle-passphrase-request)
+ plstore-tests-recipient-passphrase)))
+ (with-plstore-tests-passphrase (:response 'wrong
+ :passphrase-expected 'maybe)
+ (should (string= (plstore-tests-handle-passphrase-request) "")))
+ (with-plstore-tests-passphrase (:response 'quit
+ :passphrase-expected 'maybe)
+ (should (condition-case nil
+ (plstore-tests-handle-passphrase-request)
+ (quit t) (:success nil))))
+ (with-plstore-tests-passphrase (:passphrase-expected 'no))
+ (with-plstore-tests-passphrase (:response 'ok
+ :passphrase-expected 'yes)
+ (plstore-tests-handle-passphrase-request)))
+
+;; Ensure the examples from the plstore.el header come through without
+;; errors.
+(ert-deftest plstore-example-01 ()
+ (with-plstore-tests (:encryption-type 'both)
+ (setq plstore (plstore-open plstore-test-file))
+ (plstore-put plstore "foo" '(:host "foo.example.org" :port 80) nil)
+ (plstore-save plstore)
+ (plstore-put plstore "bar" '(:host "bar.example.org") '(:user "test"))
+ (plstore-put plstore "baz" '(:host "baz.example.org") '(:password "test"))
+ ;; symmetric encryption: 'yes
+ ;; public-key encryption: 'no
+ (with-plstore-tests-passphrase (:passphrase-expected 'maybe)
+ (plstore-save plstore))
+ (plstore-close plstore)
+
+ (should
+ (> (file-attribute-size (file-attributes plstore-test-file)) 0))
+
+ (setq plstore (plstore-open plstore-test-file))
+ (should
+ (plstore-tests-alists-equal-p
+ (plstore-find plstore '(:host ("foo.example.org")))
+ '(("foo" . (:host "foo.example.org" :port 80)))))
+ ;; symmetric decryption: 'no (agent cache)
+ ;; public-key decryption: 'yes
+ (with-plstore-tests-passphrase (:passphrase-expected 'maybe)
+ (should
+ (plstore-tests-alists-equal-p
+ (plstore-find plstore '(:host ("bar.example.org")))
+ '(("bar" . (:host "bar.example.org" :user "test"))))))
+ ;; symmetric decryption: 'no (agent cache)
+ ;; public-key decryption: 'no (agent cache)
+ (with-plstore-tests-passphrase (:passphrase-expected 'no)
+ (should
+ (plstore-tests-alists-equal-p
+ (plstore-find plstore '(:host ("baz.example.org")))
+ '(("baz" . (:host "baz.example.org" :password "test"))))))
+ (plstore-close plstore)))
+
+(provide 'plstore-tests)
+
+;;; plstore-tests.el ends here
--
2.30.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-08-30 19:28 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-08-31 4:46 ` Eli Zaretskii
2023-08-31 10:21 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 19+ messages in thread
From: Eli Zaretskii @ 2023-08-31 4:46 UTC (permalink / raw)
To: Jens Schmidt; +Cc: 63627
> Date: Wed, 30 Aug 2023 21:28:10 +0200
> Cc: 63627@debbugs.gnu.org
> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>
> On 2023-05-31 14:54, Eli Zaretskii wrote:
> >> Date: Mon, 22 May 2023 22:11:19 +0200
> >> From: Jens Schmidt via "Bug reports for GNU Emacs,
> >> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> >>
> >> All of these changes so far are doc fixes or message changes, none of
> >> them touches any code. Not sure whether they qualify for emacs-29, but
> >> I guess it would be easier to have them there to have the diff context
> >> ready for any following bug fixes.
> >
> > Thanks, installed on the emacs-29 branch.
>
> Next set of patches, I hope they are still eligible for emacs-29.
>
> The first patch fixes more documentation and terminology issues in
> plstore.el, still without touching any code. The second patch
> comprise ERT tests for plstore.el. Since that requires interaction
> with GnuPG, these tests are rather platform-dependent. Test setup
> should ensure that all tests are skipped if GnuPG is missing or not
> appropriate for the tests.
Documentation fixes are always welcome on the release branch.
As for tests: I don't really object, but what would be the purpose of
extending the test suite on the release branch? why not install that
on master instead?
> Please check.
What would you like me to check?
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-08-31 4:46 ` Eli Zaretskii
@ 2023-08-31 10:21 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-02 7:41 ` Eli Zaretskii
0 siblings, 1 reply; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-08-31 10:21 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 63627
On 2023-08-31 06:46, Eli Zaretskii wrote:
>> Date: Wed, 30 Aug 2023 21:28:10 +0200
>> Cc: 63627@debbugs.gnu.org
>> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>> Next set of patches, I hope they are still eligible for emacs-29.
>>
>> The first patch fixes more documentation and terminology issues in
>> plstore.el, still without touching any code. The second patch
>> comprise ERT tests for plstore.el. Since that requires interaction
>> with GnuPG, these tests are rather platform-dependent. Test setup
>> should ensure that all tests are skipped if GnuPG is missing or not
>> appropriate for the tests.
>
> Documentation fixes are always welcome on the release branch.
>
> As for tests: I don't really object, but what would be the purpose of
> extending the test suite on the release branch? why not install that
> on master instead?
I thought about adding tests for 1-2 pending bugs in plstore.el in near
future. But OTOH, these bugs are really not that significant, so
probably it makes indeed more sense to add the tests to master only.
>> Please check.
>
> What would you like me to check?
Nothing in particular. Like: "Please check whatever you must check
before committing such changes."
Actually, it *would* be interesting to know what you check in such a
situation, if it could be easily described.
Thanks.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-08-31 10:21 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-02 7:41 ` Eli Zaretskii
2023-09-03 22:22 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 19+ messages in thread
From: Eli Zaretskii @ 2023-09-02 7:41 UTC (permalink / raw)
To: Jens Schmidt; +Cc: 63627
> Date: Thu, 31 Aug 2023 12:21:38 +0200
> Cc: 63627@debbugs.gnu.org
> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>
> On 2023-08-31 06:46, Eli Zaretskii wrote:
> >> Date: Wed, 30 Aug 2023 21:28:10 +0200
> >> Cc: 63627@debbugs.gnu.org
> >> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>
> >> Next set of patches, I hope they are still eligible for emacs-29.
> >>
> >> The first patch fixes more documentation and terminology issues in
> >> plstore.el, still without touching any code. The second patch
> >> comprise ERT tests for plstore.el. Since that requires interaction
> >> with GnuPG, these tests are rather platform-dependent. Test setup
> >> should ensure that all tests are skipped if GnuPG is missing or not
> >> appropriate for the tests.
> >
> > Documentation fixes are always welcome on the release branch.
> >
> > As for tests: I don't really object, but what would be the purpose of
> > extending the test suite on the release branch? why not install that
> > on master instead?
>
> I thought about adding tests for 1-2 pending bugs in plstore.el in near
> future. But OTOH, these bugs are really not that significant, so
> probably it makes indeed more sense to add the tests to master only.
OK, so I've now installed the documentation changes on emacs-29.
Please prepare the other patch for master, and let's install it there.
> >> Please check.
> >
> > What would you like me to check?
>
> Nothing in particular. Like: "Please check whatever you must check
> before committing such changes."
>
> Actually, it *would* be interesting to know what you check in such a
> situation, if it could be easily described.
I look at the commit log message, make sure the relevant tests still
pass, and do anything else my eyes suggest while looking at the patch.
Thanks.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-02 7:41 ` Eli Zaretskii
@ 2023-09-03 22:22 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-07 9:12 ` Eli Zaretskii
0 siblings, 1 reply; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-03 22:22 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 63627
[-- Attachment #1: Type: text/plain, Size: 1209 bytes --]
On 2023-09-02 09:41, Eli Zaretskii wrote:
> Date: Thu, 31 Aug 2023 12:21:38 +0200
> Cc: 63627@debbugs.gnu.org
> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
> OK, so I've now installed the documentation changes on emacs-29.
Thanks.
> Please prepare the other patch for master, and let's install it there.
Done, please see attached patch.
>> Actually, it *would* be interesting to know what you check in such a
>> situation, if it could be easily described.
>
> I look at the commit log message, make sure the relevant tests still
> pass, and do anything else my eyes suggest while looking at the patch.
Ok.
Please let your eyes rest in particular on lines 310 and following of
test/lisp/plstore-tests.el, where I have tried to detect and avoid
hangs related to GnuPG 2.4.*.
I have executed the new tests on GNU/Linux only, since that is the only
platform I have available. Should I take extra steps to get these tests
executed on other platforms than GNU/Linux *before* you commit them? If
yes, which steps?
The rest of the tests should be more or less standard. Except
probably for the fact that there is still much infrastructure and few
actual tests, but I plan to change that.
Thanks.
[-- Attachment #2: 0001-Add-tests-for-plstore.el.patch --]
[-- Type: text/x-patch, Size: 32337 bytes --]
From 90626839cc14b32f74acae16d2d7dc1d0d728460 Mon Sep 17 00:00:00 2001
From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
Date: Wed, 16 Aug 2023 23:42:11 +0200
Subject: [PATCH] Add tests for plstore.el
* test/lisp/plstore-resources/plstore-tests.pubkey:
* test/lisp/plstore-resources/plstore-tests.seckey:
* test/lisp/plstore-tests.el: Add new files. (Bug#63627)
---
.../plstore-resources/plstore-tests.pubkey | 40 ++
.../plstore-resources/plstore-tests.seckey | 83 +++
test/lisp/plstore-tests.el | 535 ++++++++++++++++++
3 files changed, 658 insertions(+)
create mode 100644 test/lisp/plstore-resources/plstore-tests.pubkey
create mode 100644 test/lisp/plstore-resources/plstore-tests.seckey
create mode 100644 test/lisp/plstore-tests.el
diff --git a/test/lisp/plstore-resources/plstore-tests.pubkey b/test/lisp/plstore-resources/plstore-tests.pubkey
new file mode 100644
index 00000000000..f006ce9c071
--- /dev/null
+++ b/test/lisp/plstore-resources/plstore-tests.pubkey
@@ -0,0 +1,40 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQGNBGSB/poBDACkSkNrg5nkN1J4BoJTgqkSQQa89B88hP+C83UuKZZ90Y2RySbC
+IR8OnARimtOaokEn+k3gMYiVDxmYcPcCM5OYt1diByjbv018MYyq+sPTWvfjSLQM
+k4ZEHho4ucSdP8u+jgbTY8n+qIco07kXR0LjB4D5cvwHPsYmOaXci2DiPaVZ2KSB
+PqIXHL2jXWZKo7yAwRym+gP7SOAXIRbI5Fgnjm4R8xPZI9i67hsVrn4iLEvNdPXN
+C4nZVsKshWCfko5IDAsyZR+SVfoXYj+BpweGZhpcAOrUupGHagDUhvqY9DDz352J
+pWu/852oMfTVvV6h3JevniPd2ZBPWKOyteYBWP+7Cy6KE8wEEXTTpyoGN9UVcXup
+Jrb2rlkmlIBi7rRssgW/uEnfTiNiCF5y90tpvdl0kHhuWU1Mx4+JqYFOjXi7IpCA
+kyObW4nZ0iZrxt5yVqi2r00FJChMWOrzuPtaQgELyJLHVSOjexegpPTv56dV+Eko
+Dvy40PsGxCmgUR8AEQEAAbQScGxzdG9yZS10ZXN0cy1yY3B0iQHOBBMBCgA4FiEE
+AahVzTjV+MwdUQd1HBcSKC4CYkQFAmSB/poCGwMFCwkIBwIGFQoJCAsCBBYCAwEC
+HgECF4AACgkQHBcSKC4CYkRxmwv+OmFgU8JsBGZGj12/RBQu4wXwryS2r5AJf6Cp
+RCLD0ilEe5wX3zvJu1vpSyc79xTSvlXf/thRCHfgXw+m+IkY101rt2pVEBHgLC98
+ql0JDvY5dsd0S98bMgilULFGgSvfJYxY+Zlgf4jiWuo3b/43We4IbCXpF7C2356U
+rJEImZo7PC/wbsb4VUTUACLlaspoXByz0GrnvzpfQjmoZHLQlKtMN1EZnQLooxv/
+0CKmBRXD08rJrO46+wgTKKptxd5hgmCHnRIbmaP3I1nvNDKp1BINUYJEsVNBEQuU
+sScHWXdbzb64zhyQvynad85tdP+srVcRTCJhiTJu7VAFgDvqXK8CZ6ApSvqwN9xa
+euw4LjZi4TjA5Qd9SWUyP/TNtiqg8SsipjRvCeE7UfV7jA/W63uKgsbA48QY337O
+b69bA5HQuBbsNd1oF74mlEd0q/sOog6hVxzT2FplOTJfUlNhQK6QcwQ5HoiMOafI
+8WSDVaAgewjBfpQzhcd0LIK6oKzquQGNBGSB/poBDADB9ioE+o8mfybEce2aGmq8
+4ouwb5k3NHAt3+d4AcVQ+prCe4Hy2Exyk+iiDleAt6LX2sf2eS7+NZ1RsDSNS8iL
+5dwRwFoTc7cVa2sz6EPtHBpwwfdBaihzySxdKl4MEevr2skAcBJ7vC2ALhA02/98
+7CRGxEs8/Zof63/NlMJHdL9Ektsl4dm6SiSijcJlikML6qA7DpN6+l7SXk0ot1AT
+NKGMmmY5n3rpEu6yKKd8kNWxlrhlSDGPXPijBzyOElKG7vfuzaMbisxGBaIF44qb
+n24nwXxlSmiotJHsV+HfxoJaGIJwhd+BW35FFLgGLJ1F+TwUPhPnv+N0b4mtebBs
+MjwbyFCSGMkP7mMPtsNlTRaWlX0Fk5SR7eePhS2+wa/CfYPEOrwf5mpsu/65sAmI
+qBKuNz7xskuwCv5SJG9XdLYHbJcKxTQaJNOizHiRCLT2tHqLbF+B7kEZrm+uDWLU
+XOe8YZRVQltryuwtu7HeaNa1aOCXTgTfbC4E2/5myGEAEQEAAYkBtgQYAQoAIBYh
+BAGoVc041fjMHVEHdRwXEiguAmJEBQJkgf6aAhsMAAoJEBwXEiguAmJErL8L+waA
+JRvLggz1s+SznyV3iXqq9fOJ1ETbu13sJ0+KOih9pn5tbN9eDgH39wmiPw+wZTMi
+Lu+LIy07gEMsVwjK6B9khX0lwXHgWCdEgj8le2c00sQpUHEJx6wBwwu2mk4xbOSg
+U1Y5No8IRhJYC+fchWqOtJYAkBbpRkCPnlVwEoDnF4/S1u6hNBPM7MqJVIc07g9f
+1EiVOzO/XV5Jt8ngZr0BaCa9LHFCxIySH2nkOO2akne+TS/brGRmyC4cKId5vf7a
+NKF7jePh3JSui9nAz6kqqWqCPQTPFN9wGNB9MPLsXoOU8ucjCNZ027S1z/QuDQvt
+JCfR1NICHxjg6UAII5gT/Xw9CGlj3AB/sOVI0khi9nWtI8j7kgmBA33fthuJWD9d
+XkLwpVr6c8NLH5oi7WHVAJM8Qz/QOZeIhF5+CF4KVj5qqNBsZcSfMQLjAHwx+UeY
+PApR0Z2bXjSpcT1hTJVg2kwmKj7Ol6FvAgOyssCi5jMWmGXMiny7zfF86AKaOA==
+=0gx/
+-----END PGP PUBLIC KEY BLOCK-----
diff --git a/test/lisp/plstore-resources/plstore-tests.seckey b/test/lisp/plstore-resources/plstore-tests.seckey
new file mode 100644
index 00000000000..a148c9c2026
--- /dev/null
+++ b/test/lisp/plstore-resources/plstore-tests.seckey
@@ -0,0 +1,83 @@
+-----BEGIN PGP PRIVATE KEY BLOCK-----
+
+lQWGBGSB/poBDACkSkNrg5nkN1J4BoJTgqkSQQa89B88hP+C83UuKZZ90Y2RySbC
+IR8OnARimtOaokEn+k3gMYiVDxmYcPcCM5OYt1diByjbv018MYyq+sPTWvfjSLQM
+k4ZEHho4ucSdP8u+jgbTY8n+qIco07kXR0LjB4D5cvwHPsYmOaXci2DiPaVZ2KSB
+PqIXHL2jXWZKo7yAwRym+gP7SOAXIRbI5Fgnjm4R8xPZI9i67hsVrn4iLEvNdPXN
+C4nZVsKshWCfko5IDAsyZR+SVfoXYj+BpweGZhpcAOrUupGHagDUhvqY9DDz352J
+pWu/852oMfTVvV6h3JevniPd2ZBPWKOyteYBWP+7Cy6KE8wEEXTTpyoGN9UVcXup
+Jrb2rlkmlIBi7rRssgW/uEnfTiNiCF5y90tpvdl0kHhuWU1Mx4+JqYFOjXi7IpCA
+kyObW4nZ0iZrxt5yVqi2r00FJChMWOrzuPtaQgELyJLHVSOjexegpPTv56dV+Eko
+Dvy40PsGxCmgUR8AEQEAAf4HAwLhaRlLy4u4Ff96uoRLTaN8TElz55OLBt4esjTl
+mefUVnYI/OBlTizBjtmOD0Rp6Sf5a94L0g/ZLI7OV9JXwFPKS8X2OjcoqwApzs5N
+X61Fp3JoH6i5lqh6qoTELaz6hPqeEM97oBdls6m808l76ztDnzFVXCOu41gGwev+
+/S7kdwi2+jx3OkL4P+a3PEU45IXc4vvRtby3gFAZ6yN0Kh/SES8wACTyXriJ8c5x
+LZ6+qtnAyMdMHf17YwCm3Sisr3+e6RTt4ruWRQjyp3gVsT9eTCqzuyUhQRh9vnjs
+XxjYPzxuo5MKyZXgZ3D+Wlp7RN1Tm/s8J5ug517oXlJEYEKVOz/MPSOwzkDF1skf
+A6K9pC/os5cf6gx1NqiasPGrd2GHRrg6qEe0g2xqVJPVnGZWb6u9RmJsJU8OH+yA
+z1v1/ZygdM2HOtwt/pZTpk4JBgGIPhnBQBZC5XBmcr0zVWXfRIyRhLUtL1QAGLqm
+bKodi3PqY4+p1+Qd9SAeG+y0OmfqAjghNikv2csehKG7S0DoCdQ0ku8YsTqzFLO7
+eR15sKJrFLhyerRwlE7WjCsQC2DXqDTFdIQkz9j0Jkmv2UTEzllmjK+jNcP4ieHX
+BSnft/lUvLVFIXP/5MTMbOruSRES2vtX7q7tv62Qc6KjCZKCH8ghk+1552ZdDkFb
+mNhai+XJ7JEClx85VjAmweh4XwqTHtCLsR2zHttEctb9jT1fAK3VNJWOqpni9/3G
+EvhDD0qVO69Fn002QlNhwDy0WxQpqH3kKeEb1/5/QnaF0xFz1nM48y7iG+ITUdoO
+tWUKxqVuw8yntk8Ngmkc8n0ebBKxLU0sDQViYSKGJOAS3htY5Dovq4KVDXxW+/iw
+83YLaivvDG3Gr16uysiHAvNnK91StWPOvKvtxE5ADw39mcMnOkCF1/q4qDafB3RG
++7bXrXPEuuYQ4CCFO6v+g0aHqQxFx/Cre3804CsIBg3yKN5AXxO6rJUcKTytC0zJ
+cJXDbZZV05CBDg3x+6xJn2kPk0oTe/uCSYN6xWPiJi4RjS9UL/ATir/2m4z7/o18
+rVUr1oZ8/HtJoPezfhNtJqqbDu+Q3DkqEfXLdBDMF71vT/0zUMvoE6l98VMAq6wm
+Phrk299mgr1EQOYTWKAnbXQ1gKh2JwegbJG738MwYtixkp6ITDPw71j5x/SYinHj
+WeTZ9sooufXyw6P7JhqRKrZbGRwbDAo4hCMJAyi2Z1VMuR7IH0tf5A4o46l91Izh
+9Z4RewlS5bto3TPhUGwfD+3wywjtiT7d/Xp/IgmhEkcXdsjBNlz4f9oVX/ZtsUj9
+BPRAeeRPcA2GgzFNFGf4iyidzgiEJlqIGbQScGxzdG9yZS10ZXN0cy1yY3B0iQHO
+BBMBCgA4FiEEAahVzTjV+MwdUQd1HBcSKC4CYkQFAmSB/poCGwMFCwkIBwIGFQoJ
+CAsCBBYCAwECHgECF4AACgkQHBcSKC4CYkRxmwv+OmFgU8JsBGZGj12/RBQu4wXw
+ryS2r5AJf6CpRCLD0ilEe5wX3zvJu1vpSyc79xTSvlXf/thRCHfgXw+m+IkY101r
+t2pVEBHgLC98ql0JDvY5dsd0S98bMgilULFGgSvfJYxY+Zlgf4jiWuo3b/43We4I
+bCXpF7C2356UrJEImZo7PC/wbsb4VUTUACLlaspoXByz0GrnvzpfQjmoZHLQlKtM
+N1EZnQLooxv/0CKmBRXD08rJrO46+wgTKKptxd5hgmCHnRIbmaP3I1nvNDKp1BIN
+UYJEsVNBEQuUsScHWXdbzb64zhyQvynad85tdP+srVcRTCJhiTJu7VAFgDvqXK8C
+Z6ApSvqwN9xaeuw4LjZi4TjA5Qd9SWUyP/TNtiqg8SsipjRvCeE7UfV7jA/W63uK
+gsbA48QY337Ob69bA5HQuBbsNd1oF74mlEd0q/sOog6hVxzT2FplOTJfUlNhQK6Q
+cwQ5HoiMOafI8WSDVaAgewjBfpQzhcd0LIK6oKzqnQWGBGSB/poBDADB9ioE+o8m
+fybEce2aGmq84ouwb5k3NHAt3+d4AcVQ+prCe4Hy2Exyk+iiDleAt6LX2sf2eS7+
+NZ1RsDSNS8iL5dwRwFoTc7cVa2sz6EPtHBpwwfdBaihzySxdKl4MEevr2skAcBJ7
+vC2ALhA02/987CRGxEs8/Zof63/NlMJHdL9Ektsl4dm6SiSijcJlikML6qA7DpN6
++l7SXk0ot1ATNKGMmmY5n3rpEu6yKKd8kNWxlrhlSDGPXPijBzyOElKG7vfuzaMb
+isxGBaIF44qbn24nwXxlSmiotJHsV+HfxoJaGIJwhd+BW35FFLgGLJ1F+TwUPhPn
+v+N0b4mtebBsMjwbyFCSGMkP7mMPtsNlTRaWlX0Fk5SR7eePhS2+wa/CfYPEOrwf
+5mpsu/65sAmIqBKuNz7xskuwCv5SJG9XdLYHbJcKxTQaJNOizHiRCLT2tHqLbF+B
+7kEZrm+uDWLUXOe8YZRVQltryuwtu7HeaNa1aOCXTgTfbC4E2/5myGEAEQEAAf4H
+AwKcZyirnVxOrP9hZNgnoid0GKAjq14dnwWifuTCJwQNpjoI9uMZigvvLmTlaRY9
+gl+yjSH/Y+aTyA7Ja/T6Oal8Wb60HF/RTtywDImVmbjXHNpzJ9tGrbNn8cgrHzrp
+njYByKnyE6P8LWmlAf1UBtMyDwGlJJKnLPomIgh4RAllLMEqXScb4j0TYtcpq/gF
+GHE271aL0+cHREBhaIED/B2RfWV1T1lY8T4FvppuGBy/EqrtiDTeEPhvJCgd3KYt
+5bFnktTkMxZCXZ4RFA7x7ad7DR1DoNHUb48lnSy0bjXjyDrFSIw9acdqrGt1ZiZh
+1Kyu3INC3itAKnWw0JWgXPVq3QCOtjXgEdPIiAxwmOvnskAMQGW43B/DPgnpOnch
+lP50KLXyudbvdAVdewjGiaC5/kQzQOEMlIdsnO0UB/6NtDqE5E8MUIfXtnkafDmA
+cP/8YwWlH73lo5bE6AVzAXqlyyq6lXo/BOqY44tDArXEeauZiUVPu3vtHb3YgGqh
+eTXz8NtDkWZsMQ9+ITDlj8hNsET+pa3sVE/FlzNQMLQwtUnjOA+wOW+lbfEjhr8/
+x1/TrF8cHaCeOuhWRl6yJNDN7PBtJ+AgAMxGaCiy/CcByAO38cSaDpLD37N2ZovN
+cgikbCNVsALM0ZbIr979OGmmWW2jK3trXBGvE4K1TUZuN9j/GG/q66dn7cIp9VJw
+I+XiAMCLKaxyAWEHqeqppvLsKcw/HAWkQ2pJsTpcCxj8famuUI9302lNOdg7SfLi
+FDtMVPdnMtzzZTHwTaklMzpEICex8BLOazGVjkp0CqnI6twjbvBJkViXQMRtttdJ
+P+r/hSfNDyhqVj0O4iiLo+S6GEpBQYJl/t0wln/NvgeQ2yNIj/vexDX910u1Emz2
+DqMtygfVYXB0ggEe7ueMBcRr+pIamIRiB2YLOp3NS4wLiizLjHgW3ObyD/aJmlrF
+dm4d1hXUm0Kgq3l2+V/9p8ZmUDqh/OE+IBanAvKSSnjoQgV3JIt9yagE3KCSayCC
+Tfxe0FW37Xl5C9cIkn/lgdacMDRwHUZp9MOr8UKO/tnmaBrKObWacumYrE/QQWF8
+gxlvZrssqMa09QpL7ZVqNwWRUZ+zICm/asLIYgwDZdmQIpkSEJPK+H3ymuZd2EVt
+9+8p+G+BgjSD8BqRZxa9I71xIMuEAjOVV5q99u2LwyDJHu8jIgzeCGPdJ7PBGn8+
+BkOVjjOrd/+jKokgPiiE8JmKaKKa/lLUwRgAcFSU4T6/JppThdGE250CzB50IKeg
+64UhH6hYlPyKCrW23UIZi+AtYQu4N4AeqsYs3yfQ0fFLgy7XoHdvJhJ1rMBD6Sw7
+4lhQ03uLm4kBtgQYAQoAIBYhBAGoVc041fjMHVEHdRwXEiguAmJEBQJkgf6aAhsM
+AAoJEBwXEiguAmJErL8L+waAJRvLggz1s+SznyV3iXqq9fOJ1ETbu13sJ0+KOih9
+pn5tbN9eDgH39wmiPw+wZTMiLu+LIy07gEMsVwjK6B9khX0lwXHgWCdEgj8le2c0
+0sQpUHEJx6wBwwu2mk4xbOSgU1Y5No8IRhJYC+fchWqOtJYAkBbpRkCPnlVwEoDn
+F4/S1u6hNBPM7MqJVIc07g9f1EiVOzO/XV5Jt8ngZr0BaCa9LHFCxIySH2nkOO2a
+kne+TS/brGRmyC4cKId5vf7aNKF7jePh3JSui9nAz6kqqWqCPQTPFN9wGNB9MPLs
+XoOU8ucjCNZ027S1z/QuDQvtJCfR1NICHxjg6UAII5gT/Xw9CGlj3AB/sOVI0khi
+9nWtI8j7kgmBA33fthuJWD9dXkLwpVr6c8NLH5oi7WHVAJM8Qz/QOZeIhF5+CF4K
+Vj5qqNBsZcSfMQLjAHwx+UeYPApR0Z2bXjSpcT1hTJVg2kwmKj7Ol6FvAgOyssCi
+5jMWmGXMiny7zfF86AKaOA==
+=VmVt
+-----END PGP PRIVATE KEY BLOCK-----
diff --git a/test/lisp/plstore-tests.el b/test/lisp/plstore-tests.el
new file mode 100644
index 00000000000..da1fe6163d5
--- /dev/null
+++ b/test/lisp/plstore-tests.el
@@ -0,0 +1,535 @@
+;;; plstore-tests.el --- Test suite for plstore.el -*- lexical-binding: t -*-
+
+;; Copyright (C) 2023 Free Software Foundation, Inc.
+
+;; Author: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
+;; Keywords: PGP, GnuPG
+
+;; 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 <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; These tests depend on EPG finding a usable GnuPG configuration with
+;; a sufficiently new GnuPG version, see `plstore-tests-set-up-epg'.
+;; If EPG cannot find any, this test suite skips all tests requiring
+;; GnuPG.
+
+;;; Code:
+
+(require 'cl-lib)
+(require 'ert)
+(require 'ert-x)
+(require 'plstore)
+
+(defconst plstore-tests-recipient "plstore-tests-rcpt")
+
+(defconst plstore-tests-recipient-passphrase "plstore-tests-passphrase")
+
+\f
+
+;;; plist and alist handling.
+
+;; Return whether OBJECT is a valid plstore alist. That is, a
+;; string-indexed alist of plists having keyword symbols as property
+;; names.
+(defun plstore-tests-alist-p (object)
+ (and (listp object)
+ (cl-every
+ (lambda (entry)
+ (and
+ (consp entry)
+ (stringp (car entry))
+ (listp (cdr entry))
+ (cl-loop
+ for member on (cdr entry) by #'cddr
+ for pname = (car member)
+ for kwsymp = (and (symbolp pname)
+ (eq (aref (symbol-name pname) 0) ?:))
+ unless kwsymp return nil
+ finally return t)))
+ object)))
+
+;; Sort PLIST in a stable manner and return the result as a new plist.
+;; Assume that all property names are symbols and default a missing
+;; trailing property value to nil.
+(defun plstore-tests-plist-sort (plist)
+ ;; Keep this readable instead of functional: Convert PLIST to an
+ ;; alist, sort that, and convert the sorted alist back to a plist.
+ (let (alist)
+ (setq alist
+ (cl-loop
+ for member on plist by #'cddr
+ collect (cons (symbol-name (car member)) (cadr member))))
+ (setq alist
+ (cl-stable-sort alist
+ #'string-lessp :key #'car))
+ (setq plist
+ (cl-loop
+ for (key . value) in alist
+ collect (intern key)
+ collect value))
+ plist))
+
+;; Sort plstore alist ALIST both on alist and on plist level. Sort it
+;; in a stable manner on all levels and return the result as a new
+;; alist, without modifying ALIST.
+(defun plstore-tests-alist-sort (alist)
+ (cl-stable-sort
+ (mapcar
+ (lambda (entry)
+ (cons (car entry)
+ (plstore-tests-plist-sort (cdr entry))))
+ alist)
+ #'string-lessp :key #'car))
+
+;; Return whether ALIST is a plstore alist and whether it equals
+;; (after plstore-alist-sorting) REF-ALIST.
+(defun plstore-tests-alists-equal-p (alist ref-alist)
+ (and
+ (plstore-tests-alist-p alist)
+ (equal (plstore-tests-alist-sort alist) ref-alist)))
+
+\f
+
+;;; Passphrase handling.
+
+;; The items on this page care about:
+;;
+;; - Providing some response to loopbacked passphrase requests; and
+;;
+;; - tracking whether and which responses have been provided during
+;; execution of some form.
+
+;; Response to provide to passphrase requests done through function
+;; `plstore-tests-handle-passphrase-request'. One of:
+;;
+;; - `ok': provide the correct passphrase from
+;; `plstore-tests-recipient-passphrase'
+;;
+;; - `wrong': provide an invalid (empty) passphrase
+;;
+;; - `quit': quit passphrase request with function `keyboard-quit'
+;;
+;; - any other symbol: signal an error
+;;
+;; Let-bound by macro `with-plstore-tests-passphrase' and (as default)
+;; by macro `with-plstore-tests'.
+(defvar plstore-tests-passphrase-response nil)
+
+;; History of passphrase responses provided through function
+;; `plstore-tests-handle-passphrase-request'. This is a stack of
+;; stacks of the collected passphrase responses.
+(defvar plstore-tests-passphrase-history nil)
+
+;; Handle a passphrase request according to
+;; `plstore-tests-passphrase-response' and record the provided
+;; response in `plstore-tests-passphrase-history'.
+(defun plstore-tests-handle-passphrase-request ()
+ (push plstore-tests-passphrase-response
+ (car plstore-tests-passphrase-history))
+ (pcase plstore-tests-passphrase-response
+ ('ok (copy-sequence plstore-tests-recipient-passphrase))
+ ('wrong "")
+ ('quit (keyboard-quit))
+ (_ (error "Invalid passphrase request"))))
+
+;; Let-bind `plstore-tests-passphrase-response' to provide RESPONSE to
+;; all passphrase requests done during execution of BODY. If
+;; PASSPHRASE-EXPECTED equals `no', ensure that no passphrases have
+;; been requested during execution of BODY, if it equals `yes', ensure
+;; that at least one passphrase has been requested, otherwise do not
+;; assume anything on the number of passphrase requests.
+;;
+;; This macro is mostly intended to test for *absence* of passphrase
+;; requests, since library `plstore' promises to use decryption and
+;; encryption (and, accordingly, to request passphrases) only when
+;; actually needed.
+;;
+;; This could be extended to track presence or absence of requests
+;; even more closely, but the rules when to expect requests and when
+;; not depend on agent caching and on encryption type, which would
+;; make such tests rather tricky.
+(cl-defmacro with-plstore-tests-passphrase ((&key
+ (response ''ok)
+ (passphrase-expected ''maybe))
+ &rest body)
+ (declare (indent 1) (debug (sexp body)))
+ `(unwind-protect
+ (let ((plstore-tests-passphrase-response ,response))
+ (push nil plstore-tests-passphrase-history)
+ ,@body
+ (when (eq ,passphrase-expected 'no)
+ (should (not (car plstore-tests-passphrase-history))))
+ (when (eq ,passphrase-expected 'yes)
+ (should (car plstore-tests-passphrase-history))))
+ (pop plstore-tests-passphrase-history)))
+
+\f
+
+;;; Test execution infrastructure.
+
+;; Create and return a new plstore test environment from TESTDIR.
+;;
+;; The test environment is a plist which gets successively filled by
+;; the setup functions below with the following members:
+;;
+;; :status
+;; Symbol describing environment status. One of `initial',
+;; `epg-set-up', `gpg-home-directory-set-up', `skip-tests'.
+;; :skip-reason
+;; String describing the reason for the tests to be skipped if
+;; status equals `skip-tests', otherwise nil.
+;; :epg-homedir, :epg-config, :epg-context
+;; Self-explaining.
+;;
+;; The EPG configuration and context stored in the plstore test
+;; environment are used only for the key management done by this test
+;; suite, and not for the encryption and decryption operations done by
+;; plstore. For these, plstore sets up its own EPG context mainly
+;; from `epg-gpg-home-directory' and `epg-pinentry-mode', which macro
+;; `with-plstore-tests' sets as needed.
+(defun plstore-tests-make-environment (testdir)
+ (list
+ :status 'initial
+ :skip-reason nil
+ :epg-homedir (expand-file-name ".gnupg" testdir)))
+
+;; Set up EPG, determine a usable GnuPG configuration, and store the
+;; resulting information in plstore test environment ENVIRONMENT.
+;;
+;; GnuPG 2.1.5 should already have a usable loopback pinentry (see
+;; Info node `(epa) GnuPG version compatibility)', but
+;; `epg-gpg2-minimum-version' mentions 2.1.6, so require that.
+(defun plstore-tests-set-up-epg (environment)
+ (if-let ((config (epg-find-configuration
+ 'OpenPGP nil
+ '((OpenPGP epg-gpg-program
+ ("gpg" . "2.1.6")
+ ("gpg2" . "2.1.6")))))
+ (context (epg-make-context 'OpenPGP)))
+ (progn
+ (setf (epg-context-program context)
+ (alist-get 'program config))
+ (setf (epg-context-home-directory context)
+ (plist-get environment :epg-homedir))
+ (setf (epg-context-pinentry-mode context) 'loopback)
+ (plist-put environment :epg-config config)
+ (plist-put environment :epg-context context)
+ (plist-put environment :status 'epg-set-up))
+ (plist-put environment :status 'skip-tests)
+ (plist-put environment :skip-reason "no usable GnuPG configuration")))
+
+;; Set up a GnuPG home directory for our tests below the path pointed
+;; to by member `:epg-homedir' in plstore test environment
+;; ENVIRONMENT. Use the predefined public and private key from the
+;; ERT resources to do so. Perform a final encrypt-decrypt round-trip
+;; test.
+;;
+;; The keys used below have been created with GnuPG 2.2.7 and exported
+;; to the ERT resource directory as follows:
+;;
+;; mkdir .gnupgtmphome && chmod 0700 .gnupgtmphome
+;; echo plstore-tests-passphrase |
+;; gpg --homedir .gnupgtmphome --quiet \
+;; --pinentry-mode loopback --passphrase-fd 0 \
+;; --quick-generate-key plstore-tests-rcpt default default 0
+;; gpg --homedir .gnupgtmphome --quiet \
+;; --armor --export plstore-tests-rcpt \
+;; > test/lisp/plstore-resources/plstore-tests.pubkey
+;; echo plstore-tests-passphrase |
+;; gpg --homedir .gnupgtmphome --quiet \
+;; --pinentry-mode loopback --passphrase-fd 0 \
+;; --armor --export-secret-key plstore-tests-rcpt \
+;; > test/lisp/plstore-resources/plstore-tests.seckey
+;; rm -rf .gnupgtmphome
+(defun plstore-tests-set-up-gpg-home-directory (environment)
+ (let ((homedir (plist-get environment :epg-homedir))
+ (context (plist-get environment :epg-context))
+ key (state 0) timeout-timer)
+
+ ;; Create GnuPG home directory.
+ (make-directory homedir)
+ (set-file-modes homedir #o0700)
+
+ ;; Configure passphrase handling to some sane defaults, even if
+ ;; these should be already in effect as GnuPG agent defaults,
+ ;; since the GnuPG agent gets started anew for every new GnuPG
+ ;; home directory.
+ (with-temp-file (expand-file-name "gpg-agent.conf" homedir)
+ (insert "allow-loopback-pinentry\n")
+ (insert "default-cache-ttl 600\n")
+ (insert "max-cache-ttl 7200\n"))
+
+ ;; Import and configure keys. This step, most notably the import
+ ;; of the private key, is expensive in terms of wall-clock time.
+ (setf (epg-context-passphrase-callback context)
+ '((lambda (_ _ _) (copy-sequence plstore-tests-recipient-passphrase))))
+ (epg-import-keys-from-file context (ert-resource-file "plstore-tests.pubkey"))
+ (epg-import-keys-from-file context (ert-resource-file "plstore-tests.seckey"))
+ (setq key (car-safe (epg-list-keys context plstore-tests-recipient)))
+ (cl-assert (cl-typep key 'epg-key))
+ ;; Trust first subkey of KEY ultimately.
+ (epg-edit-key
+ context key
+ (lambda (context status string _handback)
+ (pcase (vector state status string)
+ (`[0 "KEY_CONSIDERED" ,_])
+ ('[1 "GET_LINE" "keyedit.prompt"]
+ (process-send-string (epg-context-process context) "1\n"))
+ ('[2 "GOT_IT" ""])
+ ('[3 "GET_LINE" "keyedit.prompt"]
+ (process-send-string (epg-context-process context) "trust\n"))
+ ('[4 "GOT_IT" ""])
+ ('[5 "GET_LINE" "edit_ownertrust.value"]
+ (process-send-string (epg-context-process context) "5\n"))
+ ('[6 "GOT_IT" ""])
+ ('[7 "GET_BOOL" "edit_ownertrust.set_ultimate.okay"]
+ (process-send-string (epg-context-process context) "yes\n"))
+ ('[8 "GOT_IT" ""])
+ ('[9 "GET_LINE" "keyedit.prompt"]
+ (process-send-string (epg-context-process context) "quit\n"))
+ ('[10 "GOT_IT" ""])
+ (_
+ (error "Key edit protocol error in state %d" state)))
+ (setq state (1+ state)))
+ nil)
+
+ ;; Ensure an encrypt-decrypt round-trip works, in particular
+ ;; without hangs related to GnuPG 2.4.* and its bug T6481.
+ (unwind-protect
+ (progn
+ (setq timeout-timer
+ (run-at-time
+ 5 nil
+ (lambda ()
+ (when-let
+ ((process (epg-context-process context))
+ ((eq (process-status process) 'run)))
+ (kill-process process)
+ (plist-put environment :status 'skip-tests)
+ (plist-put environment :skip-reason "GnuPG process timeout")))))
+ (pcase (condition-case err
+ (equal
+ (epg-decrypt-string
+ context
+ (epg-encrypt-string
+ context "foobarbaz" (list key)))
+ "foobarbaz")
+ (error err))
+ ('t (plist-put environment :status 'gpg-home-directory-set-up))
+ ('nil (plist-put environment :status 'skip-tests)
+ (plist-put environment :skip-reason "GnuPG round-trip failure"))
+ (err (unless (eq (plist-get environment :status) 'skip-tests)
+ (plist-put environment :status 'skip-tests)
+ (plist-put environment :skip-reason (error-message-string err))))))
+ (cancel-timer timeout-timer))))
+
+;; Set up plstore test environment and execute BODY. Execute BODY
+;; with symmetric encryption if ENCRYPTION-TYPE equals `symmetric',
+;; with public-key encryption if ENCRYPTION-TYPE equals `public-key',
+;; otherwise execute BODY once for each of these encryption types.
+;;
+;; BODY can use the following lexical variables:
+;;
+;; `plstore-encrypt-to'
+;; Non-nil for public-key encryption, nil for symmetric
+;; encryption.
+;;
+;; `plstore-test-directory'
+;; Points to a test directory which is removed after the test.
+;; The test directory is initially empty except for the ".gnupg"
+;; GnuPG home directory.
+;;
+;; `plstore-test-file'
+;; Points to a non-existent file below above directory.
+;; Initialized to a different file name for each execution of
+;; BODY.
+;;
+;; `plstore'
+;; Scratch variable initialized to nil for each execution of BODY.
+;;
+;; Any form in BODY that potentially requests a passphrase must be
+;; wrapped into an appropriate `with-plstore-tests-passphrase' macro.
+;; Passphrase requests done outside that macro result in an error
+;; being signaled.
+;;
+;; Test environment setup includes creation of a temporary GnuPG home
+;; directory and startup of a corresponding GnuPG agent, which is a
+;; somewhat expensive process in terms of wall-clock time.
+;;
+;; Started working off a similar macro and the test resources from
+;; epg-tests.el, but there is not much left from that, probably.
+(cl-defmacro with-plstore-tests ((&key encryption-type)
+ &rest body)
+ (declare (indent 1) (debug (sexp body)))
+ `(ert-with-temp-directory testdir
+ (let ((environment (plstore-tests-make-environment testdir)))
+ ;; Set up plstore test environment.
+ (when (eq (plist-get environment :status) 'initial)
+ (plstore-tests-set-up-epg environment))
+ (when (eq (plist-get environment :status) 'epg-set-up)
+ (plstore-tests-set-up-gpg-home-directory environment))
+ (when (eq (plist-get environment :status) 'skip-tests)
+ (ert-skip (format "EPG or GnuPG setup failed (%s)"
+ (plist-get environment :skip-reason))))
+ (cl-assert (eq (plist-get environment :status)
+ 'gpg-home-directory-set-up))
+
+ (dolist (recipient
+ (pcase ,encryption-type
+ ('symmetric (list nil))
+ ('public-key (list plstore-tests-recipient))
+ (_ (list nil plstore-tests-recipient))))
+ (let (;; Silence plstore.
+ (inhibit-message t)
+ ;; Set up EPG (for use by plstore) and plstore itself.
+ (epg-gpg-home-directory (plist-get environment :epg-homedir))
+ (epg-pinentry-mode 'loopback)
+ (plstore-encrypt-to recipient)
+ (plstore-select-keys 'silent)
+ ;; Prepare these to detect passphrase requests done
+ ;; outside of any `with-plstore-tests-passphrase'
+ ;; macros.
+ (plstore-tests-passphrase-response 'error)
+ (plstore-tests-passphrase-history '(nil))
+ ;; Provide utility variables for BODY.
+ (plstore-test-directory testdir)
+ (plstore-test-file
+ (expand-file-name (if plstore-encrypt-to
+ (format "auth.%s.plist"
+ plstore-encrypt-to)
+ "auth.symmetric.plist")
+ testdir))
+ (plstore nil))
+ (cl-letf
+ (((symbol-function 'plstore-passphrase-callback-function)
+ (lambda (_ _ _) (plstore-tests-handle-passphrase-request))))
+ ;; Silence byte compiler warnings related to unused
+ ;; lexical utility variables.
+ (when nil
+ (ignore plstore-test-directory
+ plstore-test-file
+ plstore))
+ ,@body)
+ (should (equal plstore-tests-passphrase-history '(nil))))))))
+
+\f
+
+;;; The tests!
+
+;; Ensure the test primitives work as intended.
+(ert-deftest plstore-primitives ()
+ ;; plstore-tests-alist-p
+ (should (plstore-tests-alist-p nil))
+ (should-not (plstore-tests-alist-p 'foo))
+ (should-not (plstore-tests-alist-p '(foo)))
+ (should-not (plstore-tests-alist-p '((foo . foo))))
+ (should-not (plstore-tests-alist-p '(("foo" . foo))))
+ (should-not (plstore-tests-alist-p '(("foo" . ("foo")))))
+ (should-not (plstore-tests-alist-p '(("foo" . (foo)))))
+ (should (plstore-tests-alist-p '(("foo" . (:foo)))))
+ ;; plstore-tests-plist-sort
+ (should (equal (plstore-tests-plist-sort nil) nil))
+ (should (equal (plstore-tests-plist-sort '(:foo "foo")) '(:foo "foo")))
+ (should (equal (plstore-tests-plist-sort '(:foo "foo" :bar "bar")) '(:bar "bar" :foo "foo")))
+ (let* ((plist '(:foo "foo" :baz "baz" :bar "bar"))
+ (cars (copy-sequence plist))
+ (cdrs (cl-maplist #'identity plist)))
+ (plstore-tests-plist-sort plist)
+ (should (and (cl-every #'eq plist cars)
+ (cl-every #'eq (cl-maplist #'identity plist) cdrs))))
+ ;; plstore-tests-alist-sort
+ (should (equal (plstore-tests-alist-sort nil) nil))
+ (should (equal (plstore-tests-alist-sort '(("foo"))) '(("foo"))))
+ (should (equal (plstore-tests-alist-sort '(("foo") ("bar"))) '(("bar") ("foo"))))
+ (should (equal (plstore-tests-alist-sort
+ '(("foo" . (:foo "foo"))
+ ("baz" . (:foo "foo" :baz "baz" :bar "bar"))
+ ("bar" . (:foo "foo" :bar "bar"))))
+ '(("bar" . (:bar "bar" :foo "foo"))
+ ("baz" . (:bar "bar" :baz "baz" :foo "foo"))
+ ("foo" . (:foo "foo")))))
+ (let* ((alist '(("foo") ("baz") ("bar")))
+ (cars (copy-sequence alist))
+ (cdrs (cl-maplist #'identity alist)))
+ (plstore-tests-alist-sort alist)
+ (should (and (cl-every #'eq alist cars)
+ (cl-every #'eq (cl-maplist #'identity alist) cdrs)))))
+
+;; Ensure passphrase handling works as intended.
+(ert-deftest plstore-passphrase-handling ()
+ (with-plstore-tests-passphrase (:passphrase-expected 'maybe)
+ (should (string= (plstore-tests-handle-passphrase-request)
+ plstore-tests-recipient-passphrase)))
+ (with-plstore-tests-passphrase (:response 'ok
+ :passphrase-expected 'maybe)
+ (should (string= (plstore-tests-handle-passphrase-request)
+ plstore-tests-recipient-passphrase)))
+ (with-plstore-tests-passphrase (:response 'wrong
+ :passphrase-expected 'maybe)
+ (should (string= (plstore-tests-handle-passphrase-request) "")))
+ (with-plstore-tests-passphrase (:response 'quit
+ :passphrase-expected 'maybe)
+ (should (condition-case nil
+ (plstore-tests-handle-passphrase-request)
+ (quit t) (:success nil))))
+ (with-plstore-tests-passphrase (:passphrase-expected 'no))
+ (with-plstore-tests-passphrase (:response 'ok
+ :passphrase-expected 'yes)
+ (plstore-tests-handle-passphrase-request)))
+
+;; Ensure the examples from the plstore.el header come through without
+;; errors.
+(ert-deftest plstore-example-01 ()
+ (with-plstore-tests (:encryption-type 'both)
+ (setq plstore (plstore-open plstore-test-file))
+ (plstore-put plstore "foo" '(:host "foo.example.org" :port 80) nil)
+ (plstore-save plstore)
+ (plstore-put plstore "bar" '(:host "bar.example.org") '(:user "test"))
+ (plstore-put plstore "baz" '(:host "baz.example.org") '(:password "test"))
+ ;; symmetric encryption: 'yes
+ ;; public-key encryption: 'no
+ (with-plstore-tests-passphrase (:passphrase-expected 'maybe)
+ (plstore-save plstore))
+ (plstore-close plstore)
+
+ (should
+ (> (file-attribute-size (file-attributes plstore-test-file)) 0))
+
+ (setq plstore (plstore-open plstore-test-file))
+ (should
+ (plstore-tests-alists-equal-p
+ (plstore-find plstore '(:host ("foo.example.org")))
+ '(("foo" . (:host "foo.example.org" :port 80)))))
+ ;; symmetric decryption: 'no (agent cache)
+ ;; public-key decryption: 'yes
+ (with-plstore-tests-passphrase (:passphrase-expected 'maybe)
+ (should
+ (plstore-tests-alists-equal-p
+ (plstore-find plstore '(:host ("bar.example.org")))
+ '(("bar" . (:host "bar.example.org" :user "test"))))))
+ ;; symmetric decryption: 'no (agent cache)
+ ;; public-key decryption: 'no (agent cache)
+ (with-plstore-tests-passphrase (:passphrase-expected 'no)
+ (should
+ (plstore-tests-alists-equal-p
+ (plstore-find plstore '(:host ("baz.example.org")))
+ '(("baz" . (:host "baz.example.org" :password "test"))))))
+ (plstore-close plstore)))
+
+(provide 'plstore-tests)
+
+;;; plstore-tests.el ends here
--
2.30.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-03 22:22 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-07 9:12 ` Eli Zaretskii
2023-09-07 19:27 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 19+ messages in thread
From: Eli Zaretskii @ 2023-09-07 9:12 UTC (permalink / raw)
To: Jens Schmidt; +Cc: 63627
> Date: Mon, 4 Sep 2023 00:22:52 +0200
> Cc: 63627@debbugs.gnu.org
> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>
> Please let your eyes rest in particular on lines 310 and following of
> test/lisp/plstore-tests.el, where I have tried to detect and avoid
> hangs related to GnuPG 2.4.*.
Looks reasonable.
> I have executed the new tests on GNU/Linux only, since that is the only
> platform I have available. Should I take extra steps to get these tests
> executed on other platforms than GNU/Linux *before* you commit them? If
> yes, which steps?
I think GNU/Linux alone is good enough.
If the changeset is now ready to be installed on master, please tell.
> The rest of the tests should be more or less standard. Except
> probably for the fact that there is still much infrastructure and few
> actual tests, but I plan to change that.
This seems to imply that you are still working on this changeset?
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-07 9:12 ` Eli Zaretskii
@ 2023-09-07 19:27 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-08 5:40 ` Eli Zaretskii
0 siblings, 1 reply; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-07 19:27 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 63627
On 2023-09-07 11:12, Eli Zaretskii wrote:
>> Date: Mon, 4 Sep 2023 00:22:52 +0200
>> Cc: 63627@debbugs.gnu.org
>> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>
> If the changeset is now ready to be installed on master, please tell.
I consider it ready to be installed on master, yes, and self-contained,
but:
>> The rest of the tests should be more or less standard. Except
>> probably for the fact that there is still much infrastructure and few
>> actual tests, but I plan to change that.
>
> This seems to imply that you are still working on this changeset?
I plan for plstore.el:
1. Two bug fixes on emacs-29 that I would like to add tests for on
master once the bug fixes have made their way to master.
2. More tests and new features on emacs-master.
All of the above will still take some time to implement due to time
constraints.
For all of the above it would be convenient to have the infrastructure
of the plstore tests committed on master or at least agreed upon so
that I can build on that.
Not sure how you prefer to get such long-running projects presented -
as a series of minor (but self-contained!) patches over time or at
once as one big set of patches.
Thanks.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-07 19:27 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-08 5:40 ` Eli Zaretskii
2023-09-08 9:16 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 19+ messages in thread
From: Eli Zaretskii @ 2023-09-08 5:40 UTC (permalink / raw)
To: Jens Schmidt; +Cc: 63627
> Date: Thu, 7 Sep 2023 21:27:13 +0200
> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
> Cc: 63627@debbugs.gnu.org
>
> > This seems to imply that you are still working on this changeset?
>
> I plan for plstore.el:
>
> 1. Two bug fixes on emacs-29 that I would like to add tests for on
> master once the bug fixes have made their way to master.
>
> 2. More tests and new features on emacs-master.
>
> All of the above will still take some time to implement due to time
> constraints.
>
> For all of the above it would be convenient to have the infrastructure
> of the plstore tests committed on master or at least agreed upon so
> that I can build on that.
>
> Not sure how you prefer to get such long-running projects presented -
> as a series of minor (but self-contained!) patches over time or at
> once as one big set of patches.
It is preferable to install separate patches only if each one of them
has merit on its own. E.g., imagine that some "force majeure" will
prevent you from working on further changes, and ask yourself whether
what you already have would make an improvement if installed.
Changes that only make sense together are better submitted and
installed as a single patch.
But if you personally prefer to submit a series of patches even when
they should be installed together, that's fine, it will just make them
slightly harder to review, especially if they touch the same code.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-08 5:40 ` Eli Zaretskii
@ 2023-09-08 9:16 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-08 11:34 ` Eli Zaretskii
0 siblings, 1 reply; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-08 9:16 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 63627
On 2023-09-08 07:40, Eli Zaretskii wrote:
>> Date: Thu, 7 Sep 2023 21:27:13 +0200
>> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>> Cc: 63627@debbugs.gnu.org
>> Not sure how you prefer to get such long-running projects presented -
>> as a series of minor (but self-contained!) patches over time or at
>> once as one big set of patches.
>
> It is preferable to install separate patches only if each one of them
> has merit on its own. E.g., imagine that some "force majeure" will
> prevent you from working on further changes, and ask yourself whether
> what you already have would make an improvement if installed.
>
> Changes that only make sense together are better submitted and
> installed as a single patch.
Good to know, thanks.
> But if you personally prefer to submit a series of patches even when> they should be installed together, that's fine, it will just make them
> slightly harder to review, especially if they touch the same code.
Let's postpone the addition of the last outstanding patch, then. I'll
add more tests to it and will come back to you later on this bug.
Independently of the tests, I'll do the Emacs 29 bugs next, also on this
bug.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-08 9:16 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-08 11:34 ` Eli Zaretskii
2023-09-08 21:24 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-14 21:24 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 2 replies; 19+ messages in thread
From: Eli Zaretskii @ 2023-09-08 11:34 UTC (permalink / raw)
To: Jens Schmidt; +Cc: 63627
> Date: Fri, 8 Sep 2023 11:16:50 +0200
> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
> Cc: 63627@debbugs.gnu.org
>
> > But if you personally prefer to submit a series of patches even when> they should be installed together, that's fine, it will just make them
> > slightly harder to review, especially if they touch the same code.
>
> Let's postpone the addition of the last outstanding patch, then. I'll
> add more tests to it and will come back to you later on this bug.
You mean the patch you posted in
https://debbugs.gnu.org/cgi/bugreport.cgi?bug=63627#29
should not yet be installed? (Please try to identify patches in as
clear way as possible, as it is very hard for me to understand vague
descriptions like "last outstanding patch" in a thread where several
patches were posted.)
> Independently of the tests, I'll do the Emacs 29 bugs next, also on this
> bug.
Thanks.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-08 11:34 ` Eli Zaretskii
@ 2023-09-08 21:24 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-14 21:24 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
1 sibling, 0 replies; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-08 21:24 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 63627
On 2023-09-08 13:34, Eli Zaretskii wrote:
>> Date: Fri, 8 Sep 2023 11:16:50 +0200
>> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>> Cc: 63627@debbugs.gnu.org
>> Let's postpone the addition of the last outstanding patch, then. I'll
>> add more tests to it and will come back to you later on this bug.
>
> You mean the patch you posted in
>
> https://debbugs.gnu.org/cgi/bugreport.cgi?bug=63627#29
>
> should not yet be installed?
Exactly.
> (Please try to identify patches in as
> clear way as possible, as it is very hard for me to understand vague
> descriptions like "last outstanding patch" in a thread where several
> patches were posted.)
Will do.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-08 11:34 ` Eli Zaretskii
2023-09-08 21:24 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-14 21:24 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-16 10:13 ` Eli Zaretskii
1 sibling, 1 reply; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-14 21:24 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 63627
[-- Attachment #1: Type: text/plain, Size: 685 bytes --]
On 2023-09-08 13:34, Eli Zaretskii wrote:
>> Date: Fri, 8 Sep 2023 11:16:50 +0200
>> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>> Cc: 63627@debbugs.gnu.org
>>
>> Independently of the tests, I'll do the Emacs 29 bugs next, also on this
>> bug.
>
> Thanks.
After some consideration actually only one Emacs 29 bug requires fixing.
Namely that the sequence:
(setq plstore (plstore-open plstore-test-file))
(plstore-save plstore)
(plstore-close plstore)
silently drops any encrypted data in PLSTORE. Verified in my local
master with the new ERT tests, and also verified that the attached patch
fixes the issue.
Please consider for committing on emacs-29.
Thanks
[-- Attachment #2: 0001-Fix-loss-of-encrypted-data-in-plstore.el.patch --]
[-- Type: text/x-patch, Size: 2353 bytes --]
From 70ebdcee78202070a59cc9dbb1fe96eabefd93c1 Mon Sep 17 00:00:00 2001
From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
Date: Tue, 30 May 2023 23:00:56 +0200
Subject: [PATCH] Fix loss of encrypted data in plstore.el
* lisp/plstore.el (plstore--insert-buffer): Fix loss of encrypted data
when a plstore gets opened and saved without being decrypted between
these steps. (Bug#63627)
---
lisp/plstore.el | 24 +++++++++++++++---------
1 file changed, 15 insertions(+), 9 deletions(-)
diff --git a/lisp/plstore.el b/lisp/plstore.el
index 7dc991aeec7..758f9fc7292 100644
--- a/lisp/plstore.el
+++ b/lisp/plstore.el
@@ -570,18 +570,23 @@ plstore-delete
(defvar pp-escape-newlines)
(defun plstore--insert-buffer (plstore)
- "Insert the file representation of PLSTORE at point.
-Assumes that PLSTORE has been decrypted."
+ "Insert the file representation of PLSTORE at point."
(insert ";;; public entries -*- mode: plstore -*- \n"
(pp-to-string (plstore--get-alist plstore)))
- (if (plstore--get-secret-alist plstore)
+ (let ((pp-escape-newlines nil)
+ (cipher nil))
+ (cond
+ ;; Reuse the encrypted data as cipher text if this store has not
+ ;; been decrypted yet.
+ ((plstore--get-encrypted-data plstore)
+ (setq cipher (plstore--get-encrypted-data plstore)))
+ ;; Encrypt the secret alist to generate the cipher text.
+ ((plstore--get-secret-alist plstore)
(let ((context (epg-make-context 'OpenPGP))
- (pp-escape-newlines nil)
(recipients
(cond
((listp plstore-encrypt-to) plstore-encrypt-to)
- ((stringp plstore-encrypt-to) (list plstore-encrypt-to))))
- cipher)
+ ((stringp plstore-encrypt-to) (list plstore-encrypt-to)))))
(setf (epg-context-armor context) t)
(epg-context-set-passphrase-callback
context
@@ -601,9 +606,10 @@ plstore--insert-buffer
If no one is selected, symmetric encryption will be performed. "
recipients)
(if plstore-encrypt-to
- (epg-list-keys context recipients)))))
- (goto-char (point-max))
- (insert ";;; secret entries\n" (pp-to-string cipher)))))
+ (epg-list-keys context recipients))))))))
+ (when cipher
+ (goto-char (point-max))
+ (insert ";;; secret entries\n" (pp-to-string cipher)))))
(defun plstore-save (plstore)
"Save PLSTORE to its associated file.
--
2.30.2
^ permalink raw reply related [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-14 21:24 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-16 10:13 ` Eli Zaretskii
2023-09-16 10:35 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 19+ messages in thread
From: Eli Zaretskii @ 2023-09-16 10:13 UTC (permalink / raw)
To: Jens Schmidt; +Cc: 63627
> Date: Thu, 14 Sep 2023 23:24:54 +0200
> Cc: 63627@debbugs.gnu.org
> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>
> After some consideration actually only one Emacs 29 bug requires fixing.
> Namely that the sequence:
>
> (setq plstore (plstore-open plstore-test-file))
> (plstore-save plstore)
> (plstore-close plstore)
>
> silently drops any encrypted data in PLSTORE. Verified in my local
> master with the new ERT tests, and also verified that the attached patch
> fixes the issue.
>
> Please consider for committing on emacs-29.
Thanks, but did you mean to say this should not be subsequently merged
to master? If so, you should tell that in the commit log message.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-16 10:13 ` Eli Zaretskii
@ 2023-09-16 10:35 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-16 11:07 ` Eli Zaretskii
0 siblings, 1 reply; 19+ messages in thread
From: Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-16 10:35 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 63627
On 2023-09-16 12:13, Eli Zaretskii wrote:
>> Date: Thu, 14 Sep 2023 23:24:54 +0200
>> Cc: 63627@debbugs.gnu.org
>> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>>
>> Please consider for committing on emacs-29.
>
> Thanks, but did you mean to say this should not be subsequently merged
> to master? If so, you should tell that in the commit log message.
No, this should go to both emacs-29 and (by "automatic" subsequent
merging) also to master. Sorry, I thought that was the default.
Thanks.
^ permalink raw reply [flat|nested] 19+ messages in thread
* bug#63627: Improve plstore.el and fix various issues of it
2023-09-16 10:35 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-16 11:07 ` Eli Zaretskii
0 siblings, 0 replies; 19+ messages in thread
From: Eli Zaretskii @ 2023-09-16 11:07 UTC (permalink / raw)
To: Jens Schmidt; +Cc: 63627-done
> Date: Sat, 16 Sep 2023 12:35:51 +0200
> Cc: 63627@debbugs.gnu.org
> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
>
> On 2023-09-16 12:13, Eli Zaretskii wrote:
> >> Date: Thu, 14 Sep 2023 23:24:54 +0200
> >> Cc: 63627@debbugs.gnu.org
> >> From: Jens Schmidt <jschmidt4gnu@vodafonemail.de>
> >>
> >> Please consider for committing on emacs-29.
> >
> > Thanks, but did you mean to say this should not be subsequently merged
> > to master? If so, you should tell that in the commit log message.
>
> No, this should go to both emacs-29 and (by "automatic" subsequent
> merging) also to master.
Thanks, installed on the emacs-29 branch, and closing the bug.
> Sorry, I thought that was the default.
It is indeed the default, but the non-trivial changes and something
you said about "only emacs-29 bugs" made me doubt that.
^ permalink raw reply [flat|nested] 19+ messages in thread
end of thread, other threads:[~2023-09-16 11:07 UTC | newest]
Thread overview: 19+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-05-21 15:45 bug#63627: Improve plstore.el and fix various issues of it Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-05-22 20:11 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-05-31 12:54 ` Eli Zaretskii
2023-06-16 19:43 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-30 19:28 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-08-31 4:46 ` Eli Zaretskii
2023-08-31 10:21 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-02 7:41 ` Eli Zaretskii
2023-09-03 22:22 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-07 9:12 ` Eli Zaretskii
2023-09-07 19:27 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-08 5:40 ` Eli Zaretskii
2023-09-08 9:16 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-08 11:34 ` Eli Zaretskii
2023-09-08 21:24 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-14 21:24 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-16 10:13 ` Eli Zaretskii
2023-09-16 10:35 ` Jens Schmidt via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-16 11:07 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).