GNU bug report logs - #38463
[PATCH] Telega test suite and change in revision

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 38463 in the body.
You can then email your comments to 38463 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Brett Gilio <brettg <at> posteo.net>
To: guix-patches <at> gnu.org
Subject: [PATCH] Telega test suite and change in revision
Date: Mon, 02 Dec 2019 15:33:18 -0600

Hi all, the following patches modify the emacs-telega package to
carefully use the ert and server test suites it has, and also includes
an increase in the revision to use a newer commit. Let me know what you think!

-- 
Brett M. Gilio
https://git.sr.ht/~brettgilio/

Message #8 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Brett Gilio <brettg <at> posteo.net>
To: 38463 <at> debbugs.gnu.org
Subject: [PATCH 1/2] gnu: emacs-telega: Use test suites.
Date: Mon, 02 Dec 2019 15:34:48 -0600

[Message part 1 (text/plain, inline)]

-- 
Brett M. Gilio
https://git.sr.ht/~brettgilio/

[0001-gnu-emacs-telega-Use-test-suites.patch (text/x-patch, inline)]

From 03a2617b29c92dc83828495305d73ec4074a5102 Mon Sep 17 00:00:00 2001
From: Brett Gilio <brettg <at> posteo.net>
Date: Mon, 2 Dec 2019 15:26:27 -0600
Subject: [PATCH 1/2] gnu: emacs-telega: Use test suites.

* gnu/packages/emacs-xyz.scm (emacs-telega)[arguments]: Adds support for
  running the ert and server test suites.
---
 gnu/packages/emacs-xyz.scm | 39 +++++++++++++++++++++++++++++++++-----
 1 file changed, 34 insertions(+), 5 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 8efa4a17c8..ad78209ebb 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -19974,7 +19974,7 @@ fish-completion.  It can be used in both Eshell and M-x shell.")
          (file-name (git-file-name name version))))
       (build-system gnu-build-system)
       (arguments
-       `(#:tests? #f
+       `(#:test-target "test"
          #:modules ((guix build gnu-build-system)
                     ((guix build emacs-build-system) #:prefix emacs:)
                     (guix build utils)
@@ -19984,17 +19984,45 @@ fish-completion.  It can be used in both Eshell and M-x shell.")
                              (guix build emacs-utils))
          #:phases
          (modify-phases %standard-phases
-           (add-after 'unpack 'unpack-patch
+           (add-after 'unpack 'prefix-patch
              (lambda _
                (substitute* "server/Makefile"
                  (("CC=cc")
                   "CC=gcc")
                  (("INSTALL_PREFIX=\\$\\(HOME\\)/.telega")
                   (string-append "INSTALL_PREFIX=" (assoc-ref %outputs "out")
-                                 "/bin")))
+                                 "/bin"))
+                 ;; Manually invoke `run_tests.py` after install phase.
+                 (("python3 run_tests.py")
+                  ""))
+               #t))
+           ;; The telega test suite checks for a version of Emacs
+           ;; compiled with imagemagick and svg support. Since we
+           ;; are using `emacs-minimal`, this step will fail.
+           ;; Grok the failing test, and remove problematic assertions.
+           (add-after 'unpack 'ert-suite-patch
+             (lambda _
+               (substitute* "telega-core.el"
+                 (("\\(image-type-available-p 'imagemagick\\) nil")
+                  "t")
+                 (("\\(image-type-available-p 'svg\\) nil")
+                  "t"))
+               #t))
+           ;; The server test suite has a hardcoded path.
+           ;; Reset this behavior to use the proper path.
+           (add-after 'unpack 'server-suite-patch
+             (lambda _
+               (substitute* "server/run_tests.py"
+                 (("~/.telega/telega-server")
+                  (string-append (assoc-ref %outputs "out")
+                                 "/bin/telega-server")))
+               #t))
+           (add-after 'install 'run-server-suite
+             (lambda _
+               (invoke "python3" "server/run_tests.py")
                #t))
            (delete 'configure)
-
+           
            ;; Build emacs-side using `emacs-build-system'
            (add-after 'compress-documentation 'emacs-add-source-to-load-path
              (assoc-ref emacs:%standard-phases 'add-source-to-load-path))
@@ -20008,7 +20036,8 @@ fish-completion.  It can be used in both Eshell and M-x shell.")
        `(("emacs-visual-fill-column" ,emacs-visual-fill-column)))
       (native-inputs
        `(("tdlib" ,tdlib)
-         ("emacs" ,emacs-minimal)))
+         ("emacs" ,emacs-minimal)
+         ("python" ,python)))
       (synopsis "GNU Emacs client for the Telegram messenger")
       (description
        "Telega is full-featured, unofficial client for the Telegram messaging
-- 
2.24.0

Message #11 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Brett Gilio <brettg <at> posteo.net>
To: 38463 <at> debbugs.gnu.org
Subject: [PATCH 2/2] gnu: emacs-telega: Update to 0.4.4-2
Date: Mon, 02 Dec 2019 15:35:02 -0600

[Message part 1 (text/plain, inline)]

-- 
Brett M. Gilio
https://git.sr.ht/~brettgilio/

[0002-gnu-emacs-telega-Update-to-0.4.4-2.patch (text/x-patch, inline)]

From 04e417466dcd7e1a39ce69d04b9afc60c41bd603 Mon Sep 17 00:00:00 2001
From: Brett Gilio <brettg <at> posteo.net>
Date: Mon, 2 Dec 2019 15:28:39 -0600
Subject: [PATCH 2/2] gnu: emacs-telega: Update to 0.4.4-2

* gnu/packages/emacs-xyz.scm (emacs-telega): Bump the package to use a newer
  git revision, which includes additional client features.
---
 gnu/packages/emacs-xyz.scm | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index ad78209ebb..4fa5cafd8d 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -19956,8 +19956,8 @@ fish-completion.  It can be used in both Eshell and M-x shell.")
       (license license:gpl3+))))
 
 (define-public emacs-telega
-  (let ((commit "019e923f933370d75dbe0a8473a18eb66fe94c0e")
-	(revision "1")
+  (let ((commit "56aef884921d99e5170d5425dbe0fce645620511")
+	(revision "2")
 	(version "0.4.4"))
     (package
       (name "emacs-telega")
@@ -19970,7 +19970,7 @@ fish-completion.  It can be used in both Eshell and M-x shell.")
                (commit commit)))
          (sha256
           (base32
-           "058814agkq8mp9ajpj8sz51rm9nigs2xpsdij05wjkxhfq30kqva"))
+           "0a8k3j20nz4xwswg9qp9xpaakk3q3ibiz8mkryk92zmrdmaah5mi"))
          (file-name (git-file-name name version))))
       (build-system gnu-build-system)
       (arguments
-- 
2.24.0

Message #14 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Brett Gilio <brettg <at> posteo.net>
To: 38463 <at> debbugs.gnu.org
Subject: Re: [bug#38463] [PATCH] Telega test suite and change in revision
Date: Wed, 04 Dec 2019 18:36:35 -0600

Brett Gilio <brettg <at> posteo.net> writes:

> Hi all, the following patches modify the emacs-telega package to
> carefully use the ert and server test suites it has, and also includes
> an increase in the revision to use a newer commit. Let me know what
> you think!

Is there any critique of this patch? Sorry for pestering!

-- 
Brett M. Gilio
https://git.sr.ht/~brettgilio/

Message #17 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Brett Gilio <brettg <at> posteo.net>
To: 38463 <at> debbugs.gnu.org
Subject: [PATCH 3/3] gnu: emacs-telega: Properly install alists.
Date: Thu, 05 Dec 2019 07:50:54 -0600

[0003-gnu-emacs-telega-Properly-install-alists.patch (text/x-patch, inline)]

From 5b4430dce26b607cc0ebf443a33a3607a3b33eb1 Mon Sep 17 00:00:00 2001
From: Brett Gilio <brettg <at> posteo.net>
Date: Thu, 5 Dec 2019 07:48:30 -0600
Subject: [PATCH 3/3] gnu: emacs-telega: Properly install alists.

* gnu/packages/emacs-xyz.scm (emacs-telega)[arguments]: Telega has an etc
  directory that needs to be installed to emacs site-lisp dir. This patch adds
  that functionality.
---
 gnu/packages/emacs-xyz.scm | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 60d27ca3de..d5110e96da 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -20019,11 +20019,23 @@ fish-completion.  It can be used in both Eshell and M-x shell.")
            ;; Build emacs-side using `emacs-build-system'
            (add-after 'compress-documentation 'emacs-add-source-to-load-path
              (assoc-ref emacs:%standard-phases 'add-source-to-load-path))
-           (add-after 'emacs-set-emacs-load-path 'emacs-install
+           (add-after 'emacs-add-source-to-load-path 'emacs-install
              (assoc-ref emacs:%standard-phases 'install))
-           (add-after 'emacs-install 'emacs-build
+           ;; This step adds subdir /etc to the site-lisp dir
+           ;; which is needed for images, notification sounds,
+           ;; and various alists.
+           ;; TODO: Replace with `#:include' method used by
+           ;; emacs-build-system.
+           (add-after 'emacs-install 'emacs-install-etc
+             (lambda* (#:key outputs #:allow-other-keys)
+               (with-directory-excursion "."
+                 (invoke "cp" "-r" "etc/"
+                         (string-append (assoc-ref outputs "out")
+                                        "/share/emacs/site-lisp/")))
+               #t))
+           (add-after 'emacs-install-etc 'emacs-build
              (assoc-ref emacs:%standard-phases 'build))
-           (add-after 'emacs-install 'emacs-make-autoloads
+           (add-after 'emacs-build 'emacs-make-autoloads
              (assoc-ref emacs:%standard-phases 'make-autoloads)))))
       (propagated-inputs
        `(("emacs-visual-fill-column" ,emacs-visual-fill-column)))
-- 
2.24.0

Message #20 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Leo Prikler <leo.prikler <at> student.tugraz.at>
To: brettg <at> posteo.net
Cc: 38463 <at> debbugs.gnu.org
Subject: [bug#38463] [PATCH 3/3] gnu: emacs-telega: Properly install alists.
Date: Thu, 05 Dec 2019 18:31:26 +0100

Hi Brett,

Am Donnerstag, den 05.12.2019, 07:48 -0600 schrieb Brett Gilio
> * gnu/packages/emacs-xyz.scm (emacs-telega)[arguments]: Telega has an
> etc
>   directory that needs to be installed to emacs site-lisp dir. This
> patch adds
>   that functionality.

Out of curiosity, would it be possible to make this a subfolder of the
telega installation directory?  It appears, as though these files are
accessed via telega-etc-file in telega-util.el, so it should still
function in the same way with the right substitutions.

Regards,
Leo

Message #23 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Brett Gilio <brettg <at> posteo.net>
To: Leo Prikler <leo.prikler <at> student.tugraz.at>
Cc: 38463 <at> debbugs.gnu.org
Subject: Re: [bug#38463] [PATCH 3/3] gnu: emacs-telega: Properly install
 alists.
Date: Thu, 05 Dec 2019 12:00:28 -0600

Leo Prikler <leo.prikler <at> student.tugraz.at> writes:

> Out of curiosity, would it be possible to make this a subfolder of the
> telega installation directory?  It appears, as though these files are
> accessed via telega-etc-file in telega-util.el, so it should still
> function in the same way with the right substitutions.
>
> Regards,
> Leo
>

Hi Leo,

I want to make sure I understand clearly what you are saying. The telega
installation directory seems to be just the
<profile>/share/emacs/site-lisp. What subdirectory are you speaking of
exactly? I will send a revised patch once I get some more information
:).

Thanks!

-- 
Brett M. Gilio
https://git.sr.ht/~brettgilio/

Message #26 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Leo Prikler <leo.prikler <at> student.tugraz.at>
To: Brett Gilio <brettg <at> posteo.net>
Cc: 38463 <at> debbugs.gnu.org
Subject: Re: [bug#38463] [PATCH 3/3] gnu: emacs-telega: Properly install
 alists.
Date: Thu, 05 Dec 2019 19:18:27 +0100

Am Donnerstag, den 05.12.2019, 12:00 -0600 schrieb Brett Gilio:
> Leo Prikler <leo.prikler <at> student.tugraz.at> writes:
> 
> > Out of curiosity, would it be possible to make this a subfolder of
> > the
> > telega installation directory?  It appears, as though these files
> > are
> > accessed via telega-etc-file in telega-util.el, so it should still
> > function in the same way with the right substitutions.
> > 
> > Regards,
> > Leo
> > 
> 
> Hi Leo,
> 
> I want to make sure I understand clearly what you are saying. The
> telega
> installation directory seems to be just the
> <profile>/share/emacs/site-lisp. What subdirectory are you speaking
> of
> exactly? I will send a revised patch once I get some more information
> :).
> 
> Thanks!

Hi Brett,

That's my bad, I haven't looked at the structure of share/emacs/site-
lisp since the last change has been made.  I expected, that packages
still had their own folders, just with guix.d in the middle being
removed, but just now found out that everything is at top-level.

I still don't feel comfortable with data being at the top of site-lisp, 
though.  Perhaps something similar to emacs-yasnippet-snippets, where
you store the data in share/emacs/telega-data would be more
appropriate.

WDYT?
Leo

Message #29 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Brett Gilio <brettg <at> posteo.net>
To: Leo Prikler <leo.prikler <at> student.tugraz.at>
Cc: 38463 <at> debbugs.gnu.org
Subject: Re: [bug#38463] [PATCH 3/3] gnu: emacs-telega: Properly install
 alists.
Date: Thu, 05 Dec 2019 12:46:55 -0600

Leo Prikler <leo.prikler <at> student.tugraz.at> writes:

>
> Hi Brett,
>
> That's my bad, I haven't looked at the structure of share/emacs/site-
> lisp since the last change has been made.  I expected, that packages
> still had their own folders, just with guix.d in the middle being
> removed, but just now found out that everything is at top-level.

I know how you feel. The recent changes has thrown me into a whirlpool
of confusion. That is why I made the note about eventually replacing the
installation of that directory to use the system usually used by
`emacs-build-system` because I figure this would cause less issues in
the future if for some reason the emacs site-lisp directory structure
were to change again.

--8<---------------cut here---------------start------------->8---
;; TODO: Replace with `#:include' method used by
;; emacs-build-system.
--8<---------------cut here---------------end--------------->8---

But I don't think it is a pressing issue to do it so cleanly.
Or maybe it is. Idk.


> I still don't feel comfortable with data being at the top of site-lisp, 
> though.  Perhaps something similar to emacs-yasnippet-snippets, where
> you store the data in share/emacs/telega-data would be more
> appropriate.

I was ACTUALLY going to do it this way originally, but I was really
uncertain of it so I just sent the patch as is. I like the idea more, so
I am going to revise the patch. Otherwise, once I get this revision in
everything should be good to go. I'll also substitute the functions to
reflect that changed path.

While I am at it, I want to do a shameless plug for Evgeny Zajcev who
has been supportive of me making additions to his repository to include
instructions on installing `telega` from Guix, including a local-build
`guix.scm`, adding a tag for Guix on the repo description, and adding an
issue label for Guix as well. If any of you are reading this and use
Telegram as a messaging client, join https://t.me/emacs_telega and give
him (@zevlg) and I (@brettmg) a hello. The work he has been doing has
been great, even though the build recipe for it for Guix is well over
100 LoC now. Ha.

Alright, carry on! Patch will be available soon.

-- 
Brett M. Gilio
https://git.sr.ht/~brettgilio/

Message #32 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Brett Gilio <brettg <at> posteo.net>
To: 38463 <at> debbugs.gnu.org
Subject: [PATCH 3/3] gnu: emacs-telega: Install telega-data to site-lisp.
Date: Thu, 05 Dec 2019 14:01:13 -0600

[Message part 1 (text/plain, inline)]

This patch is a reworked version of [PATCH 3/3] sent earlier in the
list. Thanks to Leo Prikler who I have marked as a co-author for their
help.

Everything should be good to merge now!

-- 
Brett M. Gilio
https://git.sr.ht/~brettgilio/

[0003-gnu-emacs-telega-Install-telega-data-to-site-lisp.patch (text/x-patch, inline)]

From 62ad3f8a8a62fddc4e83cdbc43d2701dcd476224 Mon Sep 17 00:00:00 2001
From: Brett Gilio <brettg <at> posteo.net>
Date: Thu, 5 Dec 2019 13:51:14 -0600
Subject: [PATCH 3/3] gnu: emacs-telega: Install telega-data to site-lisp.

* gnu/packages/emacs-xyz.scm (emacs-telega)[arguments]: This commit revises a
  previous patch and gives the source etc/ directory a unique installation pth
  in the site-lisp directory stucture.

Co-authored-by: Leo Prikler <leo.prikler <at> student.tugraz.at>
---
 gnu/packages/emacs-xyz.scm | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 60d27ca3de..1c0a5acc38 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -19989,6 +19989,13 @@ fish-completion.  It can be used in both Eshell and M-x shell.")
                  (("python3 run_tests.py")
                   ""))
                #t))
+           ;; Modify telega-util to reflect unique dir name in
+           ;; `telega-install-data' phase.
+           (add-after 'unpack 'telega-data-patch
+             (lambda _
+               (substitute* "telega-util.el"
+                 (("etc/") "telega-data/"))
+               #t))
            ;; The telega test suite checks for a version of Emacs
            ;; compiled with imagemagick and svg support. Since we
            ;; are using `emacs-minimal`, this step will fail.
@@ -20019,11 +20026,24 @@ fish-completion.  It can be used in both Eshell and M-x shell.")
            ;; Build emacs-side using `emacs-build-system'
            (add-after 'compress-documentation 'emacs-add-source-to-load-path
              (assoc-ref emacs:%standard-phases 'add-source-to-load-path))
-           (add-after 'emacs-set-emacs-load-path 'emacs-install
+           (add-after 'emacs-add-source-to-load-path 'emacs-install
              (assoc-ref emacs:%standard-phases 'install))
-           (add-after 'emacs-install 'emacs-build
+           ;; This step adds subdir /etc to the site-lisp dir and
+           ;; gives it a unique name which is needed for images,
+           ;; notification sounds, and various alists.
+           ;; TODO: Replace with `#:include' method used by
+           ;; emacs-build-system.
+           (add-after 'emacs-install 'telega-install-data
+             (lambda* (#:key outputs #:allow-other-keys)
+               (with-directory-excursion "."
+                 (invoke "cp" "-r" "etc/"
+                         (string-append (assoc-ref outputs "out")
+                                        "/share/emacs/site-lisp/"
+                                        "telega-data/")))
+               #t))
+           (add-after 'telega-install-data 'emacs-build
              (assoc-ref emacs:%standard-phases 'build))
-           (add-after 'emacs-install 'emacs-make-autoloads
+           (add-after 'emacs-build 'emacs-make-autoloads
              (assoc-ref emacs:%standard-phases 'make-autoloads)))))
       (propagated-inputs
        `(("emacs-visual-fill-column" ,emacs-visual-fill-column)))
-- 
2.24.0

Message #35 received at 38463 <at> debbugs.gnu.org (full text, mbox):

From: Leo Prikler <leo.prikler <at> student.tugraz.at>
To: Brett Gilio <brettg <at> posteo.net>
Cc: 38463 <at> debbugs.gnu.org
Subject: Re: [bug#38463] [PATCH 3/3] gnu: emacs-telega: Properly install
 alists.
Date: Thu, 05 Dec 2019 23:55:09 +0100

[Message part 1 (text/plain, inline)]

Am Donnerstag, den 05.12.2019, 12:46 -0600 schrieb Brett Gilio:
> That is why I made the note about eventually replacing the
> installation of that directory to use the system usually used by
> `emacs-build-system` because I figure this would cause less issues in
> the future if for some reason the emacs site-lisp directory structure
> were to change again.
> 
> --8<---------------cut here---------------start------------->8---
> ;; TODO: Replace with `#:include' method used by
> ;; emacs-build-system.
> --8<---------------cut here---------------end--------------->8---
> 
> But I don't think it is a pressing issue to do it so cleanly.
> Or maybe it is. Idk.
Perhaps you're right, but as far as I can see the Emacs build system
does not yet tell us how to proceed with data.  It also has a unique
way of handling documentation, first putting it into site-lisp before
moving it to share/info where it should belong.

> > I still don't feel comfortable with data being at the top of site-
> > lisp, 
> > though.  Perhaps something similar to emacs-yasnippet-snippets,
> > where
> > you store the data in share/emacs/telega-data would be more
> > appropriate.
> 
> I was ACTUALLY going to do it this way originally, but I was really
> uncertain of it so I just sent the patch as is. I like the idea more,
> so
> I am going to revise the patch. Otherwise, once I get this revision
> in
> everything should be good to go. I'll also substitute the functions
> to
> reflect that changed path.
> 
> [...] 
> 
> Alright, carry on! Patch will be available soon.
Looking at your revised patch, I still feel a bit uneasy about putting
data into the load-path.  I therefore proprose a revised revised (R^2,
if you will) patch, which I've attached to this message.

Regards,
Leo

[0003-gnu-emacs-telega-Install-telega-data-to-site-lisp.patch (text/x-patch, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.