(address . guix-patches@gnu.org)
3add15b77522d6e9ebd715a19d966666@selfhosted.xyz
Hi,
This patch adds "bash-coding-utils" as the bash-bcu package.
Best regards,
David
[PATCH]: gnu: Add bash-bcu.
- Open
Details
- 3 participants
- david larsson
- Tobias Geerinckx-Rice
- (
- Owner
- unassigned
- Submitted by
- david larsson
- Severity
- normal
D
T
(name . david larsson)(address . david.larsson@selfhosted.xyz)
87r1bsqdy8.fsf@nckx
David,
Thank you!
(One fire's out, you'll be glad to hear, so in return here's most
of a review. I still reserve the right to tinker with the hunk
below — you'll see which — later today.)
david larsson ???
Toggle quote (2 lines)
> This patch adds "bash-coding-utils" as the bash-bcu package.
[…]
Toggle quote (2 lines)
> +(define-public bash-bcu
Let's keep ‘bash-coding-utils’ as the name then, both of the
variable and the package name string.
Toggle quote (4 lines)
> + (let ((pyver (version-major+minor (package-version python)))
> + (guilever (version-major+minor (package-version
> guile-3.0))))
These aren't used until #:builder, which already has a let* where
they'll do fine. Binding them this early implies otherwise &
indents the whole package. Let's not.
Toggle quote (4 lines)
> + (package
> + (name "bash-bcu")
> + (version "v0.2.0")
Don't repeat ‘v’ (or ‘version-’, ‘RELEASE_’ &c.) here.
Toggle quote (3 lines)
> + (home-page
> "https://gitlab.com/methuselah-0/bash-coding-utils.sh")
Not wrong, but I'd move this to the informal ‘metadata area’ at
the end of the package (synopsis &c.). It doesn't affect the
build or even the hash.
Toggle quote (9 lines)
> + (source
> + (origin
> + (method git-fetch)
> + (uri (git-reference
> + (commit
> "40d6527a9effb4e18778c37bebaa9f3a58de12d6")
> + (url
> "https://gitlab.com/methuselah-0/bash-coding-utils.sh.git")
+ ;; TODO: unbundle submodules/ some day.
Toggle quote (2 lines)
> + (recursive? #t)))
This will create
/gnu/store/ivnsnv2yhq9mawxvacmjwxw1z535x9aq-git-checkout.
Guix doesn't care, but please use
+ (file-name (git-file-name name version))
to make it more meaningful for humans.
Toggle quote (3 lines)
> + (base32
> + "007g6wfybjr0ms32qikb545r11lgm3p98cd7dbzpfyh0grgn9vj1"))))
This can be one line.
Toggle quote (35 lines)
> + (inputs `(("bash-full" ,bash)
> + ("bindutils" ,isc-bind "utils")
> + ("coreutils" ,coreutils)
> + ("ctypes.sh" ,bash-ctypes)
> + ("curl" ,curl)
> + ("diffutils" ,diffutils)
> + ("ed" ,ed)
> + ("expect" ,expect)
> + ("find" ,findutils)
> + ("gawk" ,gawk)
> + ("grep" ,grep)
> + ("guile" ,guile-3.0)
> + ("guile-bash" ,guile-bash)
> + ("guile-daemon" ,guile-daemon)
> + ("inetutils" ,inetutils)
> + ("jq" ,jq)
> + ("libxml2-xpath0" ,libxml2-xpath0)
> + ("netcat" ,netcat)
> + ("nmap" ,nmap)
> + ("pcre/bin" ,pcre "bin")
> + ("perl" ,perl)
> + ("php" ,php)
> + ("prips" ,prips)
> + ("python" ,python)
> + ("python-elementpath" ,python-elementpath)
> + ("python-lxml" ,python-lxml)
> + ("python-netaddr" ,python-netaddr)
> + ("python-yq" ,python-yq)
> + ("sed" ,sed)
> + ("socat" ,socat)
> + ("util-linux" ,util-linux)
> + ("which" ,which)
> + ("xdg-utils" ,xdg-utils)
> + ("yad" ,yad)))
So the de-facto ordering of common fields is something like:
name
version
source
build-system
outputs ; a bit inconsistent, yes, and sometimes put after *inputs
arguments ; to the build-system
native-inputs, inputs, propagated-inputs
metadata: synopsis, description, home-page, properties, license…
There's some minor variation in where to put inputs, but
(build-system trivial-build-system) definitely belongs here, above
arguments, no matter what.
Toggle quote (8 lines)
> + (arguments
> + `(#:modules ((guix build utils))
> + #:builder
> + (begin
> + (use-modules (guix build utils))
> + (let* ((bashfull (assoc-ref %build-inputs
> "bash-full"))
There's nothing with which to confuse it so just "bash" for both
the variable and label.
Toggle quote (9 lines)
> + ;; Some guile libraries such as gnu bash will
> need
> + ;; to be added to GUILE_LOAD_PATH
> + (guile-bash (assoc-ref %build-inputs
> "guile-bash"))
> + (g-bash-lib (string-append guile-bash
> + "/share/guile/site/"
> ,guilever))
So drop the top-level ‘let’ and just use ,(version-major+minor
(package-version guile-3.0) directly…
Toggle quote (3 lines)
> + ;; Some python libraries needs added to
> PYTHONPATH
…and add
+ (python-version ,(version-major+minor (package-version python)))
here for use ad of ‘pyver’ (Guile isn't C and hard drives not 5
MB).
Toggle quote (125 lines)
> + (p-elementpath-lib (string-append
> + (assoc-ref %build-inputs
> "python-elementpath")
> + "/lib/python" ,pyver
> "/site-packages"))
> + (p-lxml-lib (string-append
> + (assoc-ref %build-inputs
> "python-lxml")
> + "/lib/python" ,pyver
> "/site-packages"))
> + (p-netaddr-lib (string-append
> + (assoc-ref %build-inputs
> "python-netaddr")
> + "/lib/python" ,pyver
> "/site-packages"))
> + (p-lib (string-append
> + (assoc-ref %build-inputs "python")
> + "/lib/python" ,pyver
> "/site-packages"))
> + (pylibsline (string-append
> + p-elementpath-lib ":" p-lxml-lib
> + ":" p-netaddr-lib ":" p-lib))
> + (out (assoc-ref %outputs "out"))
> + (bin (string-append out "/bin"))
> + ;; Everything but bcu.sh itself is only
> accessed
> + ;; internally by bcu so we put it in libexec.
> + (libexec (string-append out "/libexec/bcu")))
> + (mkdir-p libexec)
> + (copy-recursively (assoc-ref %build-inputs
> "source") libexec)
> + ;; Create a bcu.sh wrapping script manually that
> ensures
> + ;; we prepend necessary PATHs.
> + (mkdir-p bin)
> + (let* ((binfile (string-append bin "/bcu.sh"))
> + (bcu-port (open-file binfile "a"))
> + (pathline (string-append
> + bashfull "/bin"
> + ":" (assoc-ref %build-inputs
> "bindutils") "/bin"
> + ":" (assoc-ref %build-inputs
> "coreutils") "/bin"
> + ":" (assoc-ref %build-inputs
> "ctypes.sh") "/bin"
> + ":" (assoc-ref %build-inputs
> "curl") "/bin"
> + ":" (assoc-ref %build-inputs
> "diffutils") "/bin"
> + ":" (assoc-ref %build-inputs
> "ed") "/bin"
> + ":" (assoc-ref %build-inputs
> "expect") "/bin"
> + ":" (assoc-ref %build-inputs
> "find") "/bin"
> + ":" (assoc-ref %build-inputs
> "gawk") "/bin"
> + ":" (assoc-ref %build-inputs
> "grep") "/bin"
> + ":" (assoc-ref %build-inputs
> "guile") "/bin"
> + ":" (assoc-ref %build-inputs
> "inetutils") "/bin"
> + ":" (assoc-ref %build-inputs
> "jq") "/bin"
> + ":" (assoc-ref %build-inputs
> "libxml2-xpath0") "/bin"
> + ":" (assoc-ref %build-inputs
> "netcat") "/bin"
> + ":" (assoc-ref %build-inputs
> "nmap") "/bin"
> + ":" (assoc-ref %build-inputs
> "pcre/bin") "/bin"
> + ":" (assoc-ref %build-inputs
> "perl") "/bin"
> + ":" (assoc-ref %build-inputs
> "php") "/bin"
> + ":" (assoc-ref %build-inputs
> "prips") "/bin"
> + ":" (assoc-ref %build-inputs
> "python") "/bin"
> + ":" (assoc-ref %build-inputs
> "python-yq") "/bin"
> + ":" (assoc-ref %build-inputs
> "sed") "/bin"
> + ":" (assoc-ref %build-inputs
> "socat") "/bin"
> + ":" (assoc-ref %build-inputs
> "util-linux") "/bin"
> + ":" (assoc-ref %build-inputs
> "which") "/bin"
> + ":" (assoc-ref %build-inputs
> "xdg-utils") "/bin"
> + ":" (assoc-ref %build-inputs
> "yad") "/bin")))
> + (display (string-append "#!" bashfull
> "/bin/bash\n") bcu-port)
> + (display
> + (string-append
> + "[[ \"$_BCU_SH_LOADED\" == YES ]] || {
> \nexport PATH=\""
> + pathline "${PATH:+:}${PATH}\"\nexport
> PYTHONPATH=\""
> + pylibsline
> "${PYTHONPATH:+:}${PYTHONPATH}\"\nexport GUILE_LOAD_PATH=\""
> + g-bash-lib
> "${GUILE_LOAD_PATH:+:}${GUILE_LOAD_PATH}\"\n"
> + ;; XDG_DATA_DIRS needs set for yad to load
> icons properly
> + "[[ -e /run/current-system/profile/share ]] &&
> export XDG_DATA_DIRS="
> + "/run/current-system/profile/share${XDG_DATA_DIRS:+:}${XDG_DATA_DIRS}\n"
> + ;; Ensure that the setuid version of ping is
> used
> + "[[ -e /run/setuid-programs/ping ]] && "
> + "ping(){ /run/setuid-programs/ping \"$@\" ; }
> && export -f ping\n"
> + "[[ -e /run/setuid-programs/ping6 ]] && "
> + "ping6(){ /run/setuid-programs/ping6 \"$@\" ;
> } && export -f ping6\n}\n")
> + bcu-port)
> + (display (string-append "source " libexec
> "/bcu.sh\n") bcu-port)
> + (close-port bcu-port)
[So this is the part I was waiting to finish :-) I still don't
have time now.]
I really want to rewrite this whole block, but for now I just have
1 question: why not simply append /run/setuid-programs to the
start of $PATH here? What's the difference, if any, and do we
care?
Toggle quote (2 lines)
> + (chmod binfile #o555)
s/binfile/wrapper/ or somesuch.
Toggle quote (3 lines)
> + (setenv "PATH" (string-append pathline ":"
> (getenv "PATH"))))
s/pathline/path/
Toggle quote (3 lines)
> + (for-each (lambda (file)
> + (substitute* file
substitute* supports a list of (found-)files as the first argument
directly. No need to call it multiple times.
Toggle quote (2 lines)
> + (find-files out ".*\\.sh"))
.* is noise: "\\.sh$"
Toggle quote (3 lines)
> + (find-files out
> ".*\\.(sh|scm|awk|php|py)$"))
…same here.
Wonderful that you took the trouble to run tests!
Let's visually separate the ‘test phase’:
+
+ ;;; Now that everything's installed, prepare & run
the tests.
+ ;; Set up PATH for tests.
Toggle quote (15 lines)
> + (setenv "PATH" (string-append bin ":" (getenv
> "PATH")))
> + ;; Some tests need a HOME-directory
> + (setenv "HOME" "/tmp")
> + ;; Disable network tests, and all tests for
> setopts which
> + ;; don't work inside the Guix build environment
> + (call-with-output-file (string-append libexec
> "/disabled_tests.txt")
> + (lambda (port)
> + (display (string-append
> + "ip_of_test_1\nsetopts_test_1\nsetopts_test_2\nsetopts_test_3"
> + "\nsetopts_test_4\nsetopts_test_5\nsetopts_test_6\n")
> + port)))
+ (with-output-to-file (string-append libexec
"/disabled_tests.txt")
+ (lambda _
+ (format #t "~{~a~%~}"
+ (list "ip_of_test_1"
+ "setopts_test_1"
+ "setopts_test_2"
+ "setopts_test_3"
+ "setopts_test_4"
+ "setopts_test_5"
+ "setopts_test_6"))))
Toggle quote (3 lines)
> + (synopsis "Bash functions and tools for software
> prototyping in Bash")
I dropped the leading ‘Bash ’ here.
Toggle quote (3 lines)
> + (description
> + (string-append
Just use
(description
"This package contains Bash functions and wrappers that can
be useful when writing quick implementations of new programs. It
helps you work with JSON, XML, and parallelization, and installs
some commonly used helper programs used in Bash scripting.
Run @command{bcu__docs} for the full HTML documentation.")
But wrapped at 80 characters—I used less to avoid turning it into
an unreadable mess in some MUAs.
Toggle quote (7 lines)
> + "Bash-bcu contains bash functions and wrappers that can
> be useful when"
> + " writing quick implementations of new programs. It
> helps you work with"
> + " JSON, XML, parallelization and installs some commonly
> used \"helper\""
Texinfo double quotes are ``thus'' but can just be dropped here.
Toggle quote (3 lines)
> + @command{TAB}
> + @command{ --help}
Even the (comfortable) subset of Texinfo that Guix supports has
more keywords than ‘command’! ;-) @key, @code, …
Toggle quote (2 lines)
> + Just run @command{. bcu.sh}, type
I left this out because we don't usually include ‘getting started’
instructions in package descriptions. There are exceptions, and
this package not including info (or man) pages is unfortunate, so
I kept the bcu__docs hint.
Acceptable?
Toggle quote (2 lines)
> + (license license:gpl3))))
Why not lgpl3+? I can't find the gpl3-only file(s).
Kind regards,
T G-R
-----BEGIN PGP SIGNATURE-----
iIMEARYKACsWIQT12iAyS4c9C3o4dnINsP+IT1VteQUCYYfX4A0cbWVAdG9iaWFz
LmdyAAoJEA2w/4hPVW15BH4BAI66CGDpcXE1T+t0wJDld2La2F1abNGwIkDJdDhH
bbCDAQDZ9wgsFR9sak430GhQwr87Ca6aZMH6bOgcFNlABCpEAg==
=H+/K
-----END PGP SIGNATURE-----
D
Re: [bug#51512] [PATCH v 2]: gnu: Add bash-bcu.
93d8232c104dc63f46f6b975073b56ca@selfhosted.xyz
On 2021-11-07 13:40, Tobias Geerinckx-Rice wrote:
Toggle quote (9 lines)
> David,
>
> Thank you!
>
> (One fire's out, you'll be glad to hear, so in return here's most of a
> review. I still reserve the right to tinker with the hunk below —
> you'll see which — later today.)
>
Thanks for the review, it feels like I learn a lot from this :-)
Not sure if u intended to attach ur modified version of the patch when
you replied or not. I have however made the changes you suggested in a
version2 and attached.
[...]
Toggle quote (34 lines)
>> + (display
>> + (string-append
>> + "[[ \"$_BCU_SH_LOADED\" == YES ]] || { \nexport
>> PATH=\""
>> + pathline "${PATH:+:}${PATH}\"\nexport PYTHONPATH=\""
>> + pylibsline "${PYTHONPATH:+:}${PYTHONPATH}\"\nexport
>> GUILE_LOAD_PATH=\""
>> + g-bash-lib
>> "${GUILE_LOAD_PATH:+:}${GUILE_LOAD_PATH}\"\n"
>> + ;; XDG_DATA_DIRS needs set for yad to load icons
>> properly
>> + "[[ -e /run/current-system/profile/share ]] &&
>> export XDG_DATA_DIRS="
>> +
>> "/run/current-system/profile/share${XDG_DATA_DIRS:+:}${XDG_DATA_DIRS}\n"
>> + ;; Ensure that the setuid version of ping is used
>> + "[[ -e /run/setuid-programs/ping ]] && "
>> + "ping(){ /run/setuid-programs/ping \"$@\" ; } &&
>> export -f ping\n"
>> + "[[ -e /run/setuid-programs/ping6 ]] && "
>> + "ping6(){ /run/setuid-programs/ping6 \"$@\" ; } &&
>> export -f ping6\n}\n")
>> + bcu-port)
>> + (display (string-append "source " libexec "/bcu.sh\n")
>> bcu-port)
>> + (close-port bcu-port)
>
> [So this is the part I was waiting to finish :-) I still don't have
> time now.]
>
> I really want to rewrite this whole block, but for now I just have 1
> question: why not simply append /run/setuid-programs to the start of
> $PATH here? What's the difference, if any, and do we care?
Basically just to make minimal disruption of the the current environment
when you source bcu.sh. Almost certainly a non-issue 99.9% of cases,
i.e. I think that just prepending /run/setuid-programs to PATH would be
fine as well.
Toggle quote (4 lines)
>> + (license license:gpl3))))
>
> Why not lgpl3+? I can't find the gpl3-only file(s).
I really don't know enough about licensing to answer this very well
unfortunately.. bash-coding-utils is to a large extent a remix of
stackoverflow contributions (CC-BY-SA-4.0) and other small libraries,
some of which have GPLv3+ stated at the top (e.g. src/csv/csv/csv.scm).
I want to apply whatever license must be applied based on the included
software and SO snippets. If it needs to be lgpl3+ or GPLv3 in the end
does not matter much to me (Im the author of bash-coding-utils).
Best regards,
David
T
(name . david larsson)(address . david.larsson@selfhosted.xyz)
87y25inbsu.fsf@nckx
David,
david larsson ???
Toggle quote (4 lines)
> Not sure if u intended to attach ur modified version of the
> patch when
> you replied or not.
Absolutely. Oops! Here it is, belatedly, and possibly
pointlessly.
Toggle quote (7 lines)
> Basically just to make minimal disruption of the the current
> environment when you source bcu.sh. Almost certainly a non-issue
> 99.9%
> of cases, i.e. I think that just prepending /run/setuid-programs
> to
> PATH would be fine as well.
The current package does much ‘worse’ comparatively:
Toggle quote (6 lines)
> + ":" (assoc-ref %build-inputs "bindutils") "/bin"
> + ":" (assoc-ref %build-inputs "coreutils") "/bin"
> + ":" (assoc-ref %build-inputs "ctypes.sh") "/bin"
> + ":" (assoc-ref %build-inputs "curl") "/bin"
> […many more…]
However, you make an excellent point, and this packages's intended
usage means that it will clobber the caller's environment, not
just its own.
If I were to use this package (and I might—it's neat) I would
almost certainly end up using it in a setting where changing PATH
at all would cause unexpected and frustrating ‘bugs’.
Hmm…
Kind regards,
T G-R
-----BEGIN PGP SIGNATURE-----
iIMEARYKACsWIQT12iAyS4c9C3o4dnINsP+IT1VteQUCYZkFgQ0cbWVAdG9iaWFz
LmdyAAoJEA2w/4hPVW15t5kA/1hUt6eWgsPInj1c+tgtc8Y1NLVCh1KL3T9iX5ME
s87jAQDSxy1Bv8+ki2J21Oea1bgjVUfKnmLw0/dxsoXPgRoNBw==
=7rK0
-----END PGP SIGNATURE-----
D
(name . Tobias Geerinckx-Rice)(address . me@tobias.gr)
d4c8d512dd211d920130cdf25c682954@selfhosted.xyz
Toggle quote (4 lines)
> However, you make an excellent point, and this packages's intended
> usage means that it will clobber the caller's environment, not just
> its own.
Yep, it will. Previously I had the dependencies as propagated inputs but
I think the current approach with putting them as inputs and creating a
wrapper script is better.
Toggle quote (6 lines)
> If I were to use this package (and I might—it's neat) I would almost
> certainly end up using it in a setting where changing PATH at all
> would cause unexpected and frustrating ‘bugs’.
>
> Hmm…
Im not sure I follow here.. can you give an example? Maybe some info or
warning can be added to the description?
Personally, I would be happy to see the current patch you provided
committed to master, except I would just update to the very most recent
commit again.
Thanks for reviewing this!
Best regards,
David
D
Re: [bug#51512] [PATCH v 3]: gnu: Add bash-bcu.
(address . 51512@debbugs.gnu.org)(name . Guix-patches)(address . guix-patches-bounces+david.larsson=selfhosted.xyz@gnu.org)
482320c017a2ab923b040cb83746e563@selfhosted.xyz
New version based on prior reviews and off-list (IRC) communication.
Best regards,
David L
(
[PATCH]: gnu: Add bash-bcu.
(address . 51512@debbugs.gnu.org)
CL76IJDONOSA.2D1R7QC88T550@guix-aspire
Hello! Following a request on IRC, I'll try to review this patch to the
best of my abilities. (I'm just sending this so that the thread appears
in my inbox, since it's from before I subscribed to guix-patches. I'm
sure there's a better way, but oh well :))
-- (
(
CL76QJLEG1FE.A9WDOEV5TDNO@guix-aspire
On Mon Jul 4, 2022 at 10:11 PM BST, ( via Guix-patches via wrote:
Toggle quote (2 lines)
> (I'm just sending this so that the thread appears in my inbox)
It didn't work. I should have looked harder, all I needed to do was
download and import the mbox.
-- (
D
Re: [bug#51512] [PATCH v 3]: gnu: Add bash-bcu.
(address . 51512@debbugs.gnu.org)(name . Guix-patches)(address . guix-patches-bounces+david.larsson=selfhosted.xyz@gnu.org)
0502a262288c12f706231f7bf55c9a21@selfhosted.xyz
Ping!
On 2022-07-01 20:13, david larsson wrote:
Toggle quote (4 lines)
> New version based on prior reviews and off-list (IRC) communication.
>
> Best regards,
> David L
D
(address . 51512@debbugs.gnu.org)(name . Guix-patches)(address . guix-patches-bounces+david.larsson=selfhosted.xyz@gnu.org)
c300f858bd110d54769ec626667aa7a2@selfhosted.xyz
Ping!
On 2022-08-02 22:21, david larsson wrote:
Toggle quote (7 lines)
> Ping!
>
> On 2022-07-01 20:13, david larsson wrote:
>> New version based on prior reviews and off-list (IRC) communication.
>>
>> Best regards,
>> David L
D
(address . 51512@debbugs.gnu.org)(address . me@tobias.gr)
71292d0dac4dbd1bb84be950dca2e9c4@selfhosted.xyz
New version with minified JS removed!
D
(address . 51512@debbugs.gnu.org)(address . me@tobias.gr)
ea47033291a9529bdbd6b616d334f79d@selfhosted.xyz
On 2023-05-20 21:23, david larsson wrote:
Toggle quote (2 lines)
> New version with minified JS removed!
Sorry, attached the wrong patch earlier. Here is the correct one
attached.
D
Re: [bug#51512] [PATCH v 4]: gnu: Add bash-bcu.
(address . 51512@debbugs.gnu.org)
916da2bcc898e4a8d87747729dff9eb0@selfhosted.xyz
New version without minified javascript!
D
Re: [PATCH v5]: gnu: Add bash-bcu.
(address . guix-patches@gnu.org)(address . me@tobias.gr)
fbcca6e0e0c80f5b90cb44ce6066268f@selfhosted.xyz
On 2021-10-30 16:59, david larsson wrote:
Toggle quote (6 lines)
> Hi,
> This patch adds "bash-coding-utils" as the bash-bcu package.
>
> Best regards,
> David
This new version 5 corrects the licenses (and still no minified
javascript, and the package is named bash-coding-utils not bash-bcu).
Best regards,
David
D
Re: [bug#51512] [PATCH v6 0/3]: gnu: Add bash-bcu.
(address . 51512@debbugs.gnu.org)(name . Guix-patches)(address . guix-patches-bounces+david.larsson=selfhosted.xyz@gnu.org)
85f7aa54e1e4b0e24afae35381af5977@selfhosted.xyz
On 2021-10-30 16:59, david larsson wrote:
Toggle quote (6 lines)
> Hi,
> This patch adds "bash-coding-utils" as the bash-bcu package.
>
> Best regards,
> David
Hi!
Based on review from IRC conversation, this version fixes:
- uses the new packaging style and some substitute* simplifications.
- breaks up the new packages to individual commits.
- more recent upstream commit.
Best regards,
David
D
Re: [bug#51512] [PATCH v6 1/3]: gnu: Add bash-bcu.
(address . 51512@debbugs.gnu.org)(name . Guix-patches)(address . guix-patches-bounces+david.larsson=selfhosted.xyz@gnu.org)
a547d109587966c125fdcc50a2a990df@selfhosted.xyz
From b0a982abeb698997bd124b56cb2d33f2fdbd5dac Mon Sep 17 00:00:00 2001
From: David Larsson <david.larsson@selfhosted.xyz>
Date: Tue, 23 May 2023 05:31:06 +0200
Subject: [PATCH 1/3] gnu: Add pydaemon
* gnu/packages/bash.scm (pydaemon): new variable.
---
gnu/packages/bash.scm | 58 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 58 insertions(+)
Toggle diff (112 lines)
diff --git a/gnu/packages/bash.scm b/gnu/packages/bash.scm
index 43f38303f7..1650fdeb72 100644
--- a/gnu/packages/bash.scm
+++ b/gnu/packages/bash.scm
@@ -26,16 +26,19 @@
(define-module (gnu packages bash)
#:use-module ((guix licenses) #:prefix license:)
#:use-module (gnu packages)
+ #:use-module (gnu packages admin)
#:use-module (gnu packages base)
#:use-module (gnu packages bootstrap)
#:use-module (gnu packages compression)
#:use-module (gnu packages elf)
#:use-module (gnu packages ncurses)
+ #:use-module (gnu packages networking)
#:use-module (gnu packages readline)
#:use-module (gnu packages bison)
#:use-module (gnu packages linux)
#:use-module (gnu packages libffi)
#:use-module (gnu packages pkg-config)
+ #:use-module (gnu packages python)
#:use-module (gnu packages guile)
#:use-module (gnu packages version-control)
#:use-module (gnu packages less)
@@ -46,6 +49,7 @@ (define-module (gnu packages bash)
#:use-module (guix gexp)
#:use-module (guix monads)
#:use-module (guix store)
+ #:use-module (guix build-system copy)
#:use-module (guix build-system gnu)
#:use-module (guix build-system trivial)
#:autoload (guix gnupg) (gnupg-verify*)
@@ -482,3 +486,57 @@ (define-public blesh
which replaces the default GNU Readline. It adds syntax highlighting,
auto
suggestions, vim modes, and more to Bash interactive sessions.")
(license license:bsd-3)))
+
+(define-public pydaemon
+ (let ((commit "dae2798a2c1caa56025c6da69c0d464f70d9c79a")
+ (revision "0"))
+ (package
+ (name "pydaemon")
+ (version (git-version "0.0.0" revision commit))
+ (source
+ (origin
+ (method git-fetch)
+ (uri (git-reference
+ (commit commit)
+ (url "https://gitlab.com/methuselah-0/pydaemon.git")))
+ (file-name (git-file-name name version))
+ (sha256
+ (base32
"1cbg48ljyjqw1vxcb0sqhg9cxx0vgs6ggsdg8yvj441s6gakp2sh"))))
+ (build-system trivial-build-system)
+ (arguments
+ (list #:modules '((guix build utils))
+ #:builder
+ #~(begin
+ (use-modules (guix build utils))
+ (with-directory-excursion #$(package-source
this-package)
+ (mkdir-p (string-append (assoc-ref %outputs "out")
"/bin"))
+ (copy-file "pydaemon.py" (string-append (assoc-ref
%outputs "out")
+ "/bin/pydaemon.py"))
+ (copy-file "py-net-daemon.py" (string-append
(assoc-ref %outputs "out")
+
"/bin/py-net-daemon.py"))
+ (copy-file "pydaemon.sh" (string-append (assoc-ref
%outputs "out")
+ "/bin/pydaemon.sh"))
+ ;; Substitute paths to binaries directly in the
shell scripts
+ (substitute* (find-files (string-append #$output
"/bin") "\\.sh$")
+ (("flock ") (string-append #$(this-package-input
"util-linux") "/bin/flock "))
+ (("socat ") (string-append #$(this-package-input
"socat") "/bin/socat "))
+ (("nc ") (string-append #$(this-package-input
"netcat") "/bin/nc "))
+ (("( )(mkdir|cat|sleep|chown|id|kill|dirname) "
all pre command _)
+ (string-append pre #$(this-package-input
"coreutils") "/bin/" command " "))
+ (("(\\()(mkdir|cat|sleep|chown|id|kill|dirname)
" all pre command _)
+ (string-append pre #$(this-package-input
"coreutils") "/bin/" command " "))
+ (("(python3) " library _)
+ (string-append #$(file-append
(this-package-input "python")
+ "/bin/python"
+
(version-major+minor
+ (package-version
+
(this-package-input
+ "python"))))
+ " ")))))))
+ (inputs (list coreutils netcat python socat util-linux))
+ (synopsis "Use python from bash")
+ (description "With pydaemon you can pipe strings of python code
to one
+or multiple persistent python processes that keeps state, and get the
results
+back as strings. Can be used over either of a unix or tcp socket.")
+ (home-page "https://gitlab.com/methuselah-0/pydaemon")
+ (license license:gpl3))))
--
2.39.1
D
Re: [bug#51512] [PATCH v6 2/3]: gnu: Add guile-bash-for-bash-coding-utils
(address . 51512@debbugs.gnu.org)(name . Guix-patches)(address . guix-patches-bounces+david.larsson=selfhosted.xyz@gnu.org)
b9336e4ef177af5e3b4c02b40012d01a@selfhosted.xyz
From 7f2df5fd5b6ec44170b44ac74cae554405d939b6 Mon Sep 17 00:00:00 2001
From: David Larsson <david.larsson@selfhosted.xyz>
Date: Tue, 23 May 2023 05:38:36 +0200
Subject: [PATCH 2/3] gnu: Add guile-bash-for-bash-coding-utils
* gnu/packages/bash.scm (guile-bash-for-bash-coding-utils): New
variable.
---
gnu/local.mk | 1 +
gnu/packages/bash.scm | 34 +++++++++++++++
.../patches/guile-bash-args-from-stdin.patch | 42 +++++++++++++++++++
3 files changed, 77 insertions(+)
create mode 100644
gnu/packages/patches/guile-bash-args-from-stdin.patch
Toggle diff (126 lines)
diff --git a/gnu/local.mk b/gnu/local.mk
index c10fb01bb3..1db38d093c 100644
--- a/gnu/local.mk
+++ b/gnu/local.mk
@@ -1302,6 +1302,7 @@ dist_patch_DATA = \
%D%/packages/patches/guile-1.8-cpp-4.5.patch \
%D%/packages/patches/guile-2.2-skip-oom-test.patch \
%D%/packages/patches/guile-2.2-skip-so-test.patch \
+ %D%/packages/patches/guile-bash-args-from-stdin.patch \
%D%/packages/patches/guile-default-utf8.patch \
%D%/packages/patches/guile-2.2-default-utf8.patch \
%D%/packages/patches/guile-relocatable.patch \
diff --git a/gnu/packages/bash.scm b/gnu/packages/bash.scm
index 1650fdeb72..64d6e8d65e 100644
--- a/gnu/packages/bash.scm
+++ b/gnu/packages/bash.scm
@@ -40,6 +40,7 @@ (define-module (gnu packages bash)
#:use-module (gnu packages pkg-config)
#:use-module (gnu packages python)
#:use-module (gnu packages guile)
+ #:use-module (gnu packages guile-xyz)
#:use-module (gnu packages version-control)
#:use-module (gnu packages less)
#:use-module (guix packages)
@@ -540,3 +541,36 @@ (define-public pydaemon
back as strings. Can be used over either of a unix or tcp socket.")
(home-page "https://gitlab.com/methuselah-0/pydaemon")
(license license:gpl3))))
+
+(define-public guile-bash-for-bash-coding-utils
+ (let ((commit "1eabc563ca5692b3e08d84f1f0e6fd2283284469")
+ (revision "0"))
+ (package
+ (inherit guile2.0-bash)
+ (version (string-append "0.1.6-" revision "." (string-take commit
7)))
+ (name "guile-bash-for-bash-coding-utils")
+ (home-page (package-home-page guile2.0-bash))
+ (source (origin
+ (method git-fetch)
+ (uri (git-reference
+ (commit commit)
+ (url home-page)))
+ (sha256
+ (base32
+
"097vny990wp2qpjij6a5a5gwc6fxzg5wk56inhy18iki5v6pif1p"))
+ (file-name (string-append name "-" version
"-checkout"))
+ (patches (search-patches
"guile-bash-args-from-stdin.patch"))))
+ (arguments (substitute-keyword-arguments (package-arguments
guile2.0-bash)
+ ((#:tests? _ #f) #f)
+ ((#:phases phases #~%standard-phases)
+ #~(modify-phases #$phases
+ (add-after 'install 'install-guile
+ (lambda* (#:key inputs outputs
#:allow-other-keys)
+ (copy-recursively
+ (string-append (assoc-ref outputs "out")
+ (assoc-ref inputs "guile")
"/share")
+ (string-append (assoc-ref outputs "out")
"/share"))
+ #t))))))
+ (inputs (modify-inputs (package-inputs guile2.0-bash)
+ (replace "guile" guile-3.0-latest)))
+ (propagated-inputs (list bash)))))
diff --git a/gnu/packages/patches/guile-bash-args-from-stdin.patch
b/gnu/packages/patches/guile-bash-args-from-stdin.patch
new file mode 100644
index 0000000000..ad42616c70
--- /dev/null
+++ b/gnu/packages/patches/guile-bash-args-from-stdin.patch
@@ -0,0 +1,42 @@
+From a124921666a16cb4e93f59a653f98b99c78eb2ca Mon Sep 17 00:00:00 2001
+From: David Larsson <david.larsson@selfhosted.xyz>
+Date: Thu, 11 Nov 2021 14:07:04 +0100
+Subject: [PATCH] Enable reading arguments from bash via stdin
+
+* lisp/gnu/bash.scm(define-bash-function): read from stdin
+to SCM_ARGS array when it is open, and separate args by null
+instead of newline if -z option is passed as $1.
+---
+ lisp/gnu/bash.scm | 16 ++++++++++++----
+ 1 file changed, 12 insertions(+), 4 deletions(-)
+
+diff --git a/lisp/gnu/bash.scm b/lisp/gnu/bash.scm
+index 199ebc0..e9dcea5 100644
+--- a/lisp/gnu/bash.scm
++++ b/lisp/gnu/bash.scm
+@@ -326,10 +326,18 @@
+ (hashq-set! *funcs* symbol thunk)
+ (unsafe-format/eval
+ "function ~a {
+- SCM_ARGS=($@) ;
+- local retval=$~a ;
+- unset SCM_ARGS ;
+- return $retval ;
++ local -a Input SCM_ARGS
;
++ [[ ! -t 0 ]] && mapfile -d '' Input
;
++ if [[ -n \"${Input[@]}\" ]]; then
++ if [[ \"$1\" == -z ]]; then
++ local -a SCM_ARGS=\"(${Input[*]@Q})\"
;
++ else
++ mapfile -t SCM_ARGS < <(printf '%s'
\"${Input[@]}\"); fi ;
++ else
++ SCM_ARGS=(\"$@\"); fi
;
++ local retval=$~a
;
++ unset SCM_ARGS
;
++ return $retval
;
+ }"
+ symbol special-varname))))
+
+--
+2.31.0
+
--
2.39.1
D
Re: [bug#51512] [PATCH v6 3/3]: gnu: Add bash-coding-utils
(address . 51512@debbugs.gnu.org)(name . Guix-patches)(address . guix-patches-bounces+david.larsson=selfhosted.xyz@gnu.org)
a4683e55381b68ab9c1ec79dad7701d0@selfhosted.xyz
From bb7ab11b11058d609a89cad164308b5b52ebadca Mon Sep 17 00:00:00 2001
From: David Larsson <david.larsson@selfhosted.xyz>
Date: Tue, 23 May 2023 06:42:03 +0200
Subject: [PATCH 3/3] gnu: Add bash-coding-utils
* gnu/packages/bash.scm (bash-coding-utils)
(org-html-themes/methuselah-0): new variables.
---
gnu/packages/bash.scm | 260 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 260 insertions(+)
Toggle diff (357 lines)
diff --git a/gnu/packages/bash.scm b/gnu/packages/bash.scm
index 64d6e8d65e..986ec68b3f 100644
--- a/gnu/packages/bash.scm
+++ b/gnu/packages/bash.scm
@@ -31,17 +31,28 @@ (define-module (gnu packages bash)
#:use-module (gnu packages bootstrap)
#:use-module (gnu packages compression)
#:use-module (gnu packages elf)
+ #:use-module (gnu packages file)
+ #:use-module (gnu packages freedesktop)
+ #:use-module (gnu packages gawk)
#:use-module (gnu packages ncurses)
#:use-module (gnu packages networking)
#:use-module (gnu packages readline)
#:use-module (gnu packages bison)
#:use-module (gnu packages linux)
#:use-module (gnu packages libffi)
+ #:use-module (gnu packages lsof)
+ #:use-module (gnu packages pcre)
+ #:use-module (gnu packages perl)
+ #:use-module (gnu packages php)
#:use-module (gnu packages pkg-config)
#:use-module (gnu packages python)
+ #:use-module (gnu packages python-xyz)
#:use-module (gnu packages guile)
#:use-module (gnu packages guile-xyz)
+ #:use-module (gnu packages search)
#:use-module (gnu packages version-control)
+ #:use-module (gnu packages web)
+ #:use-module (gnu packages xml)
#:use-module (gnu packages less)
#:use-module (guix packages)
#:use-module (guix download)
@@ -574,3 +585,252 @@ (define-public guile-bash-for-bash-coding-utils
(inputs (modify-inputs (package-inputs guile2.0-bash)
(replace "guile" guile-3.0-latest)))
(propagated-inputs (list bash)))))
+
+(define org-html-themes/methuselah-0
+ ;; A form of https://github.com/fniessen/org-html-themes but not
+ ;; drop-in compatible (using that would break the BCU docs).
+ (let ((commit "cce6e288649d6555cb74583f3c02a1e4e97fa1f8")
+ (revision "0"))
+ (package
+ (name "org-html-themes")
+ (version (git-version "0.0.0" revision commit))
+ (source
+ (origin
+ (method git-fetch)
+ (uri (git-reference
+ (commit commit)
+ (url
"https://gitlab.com/methuselah-0/org-html-themes.git")))
+ (file-name (git-file-name name version))
+ (sha256
+ (base32
"1ka40r5a7xc522wc03v3rwfwq3abb8c1h8sr3hw5v1gsws9s18y9"))))
+ (build-system copy-build-system)
+ (home-page "https://gitlab.com/methuselah-0/org-html-themes")
+ (synopsis "Export Org mode files to HTML")
+ (description
+ "The Org-HMTL framework provides cross-browser themes for
exporting Org
+documents to cross-browser HTML mark-up.")
+ (license license:gpl3))))
+
+(define-public bash-coding-utils
+ (let ((commit "f1f0ed8bc39db2d5a2b6d3c5aca3e5cbadebfb29")
+ (revision "0"))
+ (package
+ (name "bash-coding-utils")
+ (version (git-version "0.3.0" revision commit))
+ (source
+ (origin
+ (method git-fetch)
+ (uri
+ (git-reference
+ (commit commit)
+ (url "https://git.sr.ht/~methuselah-0/bash-coding-utils")
+ (recursive? #t)) )
+ (sha256
+ (base32
"1vpp91nsp0gyp5n4kkq0cjsndry9wclxrcr5y41fi1g35vw3m3zz"))
+ (file-name (git-file-name name version))))
+ (build-system trivial-build-system)
+ (arguments
+ (list #:modules '((guix build utils))
+ #:builder
+ #~(begin
+ (use-modules (guix build utils)
+ (ice-9 ftw)
+ (ice-9 match)
+ (srfi srfi-26))
+ (let* ((bash #$(this-package-input "bash"))
+ (bin (string-append #$output "/bin"))
+ (bcu.sh (string-append bin "/bcu.sh"))
+ (share (string-append #$output "/share"))
+ (doc (string-append share "/doc/" #$name))
+ ;; Everything but bcu.sh itself is only ever
accessed
+ ;; internally by bcu, so put it all in share/.
+ (bcu-root (string-append share "/bcu"))
+ ;; XXX We should honour the without-tests
transformation!
+ (tests? (not #$(%current-target-system))))
+
+ ;; Copy the ‘source’ to the output and replace
submodules.
+ (let ((source #$(package-source this-package)))
+ (with-directory-excursion source
+ (mkdir-p (string-append bcu-root "/submodules"))
+ (for-each (lambda (file)
+ (copy-recursively file
+ (string-append
bcu-root
+ "/"
file)))
+ (list "bcu.sh"
+ "dependency_paths.sh"
+ "bcu-test.sh"
+ "docs"
+ "src"))
+ (copy-recursively
+ #$(package-source (this-package-input
+ "org-html-themes"))
+ (string-append bcu-root
+
"/submodules/org-html-themes"))))
+ ;; Patch absolute file name references.
+ (let* ((original-path (getenv "PATH"))
+ (shebang-inputs '(#$@(map (lambda (name)
+
(this-package-input name))
+ '("guile"
+ "python"))))
+ (shebang-path (string-join
+ (map (cut string-append <>
"/bin")
+ (cons bash
shebang-inputs))
+ ":")))
+ (setenv "PATH" shebang-path)
+ (for-each patch-shebang
+ (find-files #$output "\\.(sh|scm|py)$"))
+ (setenv "PATH" original-path))
+
+ ;; Add paths to dependencies - defined in
+ ;; dependency_paths.sh, except the libguile-bash.so
+ ;; file.
+ (substitute* (find-files #$output "\\.sh$")
+ (("[^ ]*(/lib/bash/libguile-bash\\.so)" _ library)
+ (string-append
+ #$(this-package-input
"guile-bash-for-bash-coding-utils")
+ library)))
+
+ (substitute* (find-files #$output
"dependency_paths\\.sh$")
+ (("=ctypes.sh") (string-append "="
#$(this-package-input "bash-ctypes") "/bin/ctypes.sh"))
+ (("=diff") (string-append "="
#$(this-package-input "diffutils") "/bin/diff"))
+ (("=ping") (string-append "="
"/run/setuid-programs/ping"))
+ (("=ps") (string-append "=" #$(this-package-input
"procps") "/bin/ps"))
+ (("=file") (string-append "="
#$(this-package-input "findutils") "/bin/file"))
+ (("=find") (string-append "="
#$(this-package-input "findutils") "/bin/find"))
+ (("=flock") (string-append "="
#$(this-package-input "util-linux") "/bin/flock"))
+ (("=gawk") (string-append "="
#$(this-package-input "gawk") "/bin/gawk"))
+ (("=ugrep") (string-append "="
#$(this-package-input "ugrep") "/bin/ugrep"))
+ (("=jq") (string-append "=" #$(this-package-input
"jq") "/bin/jq"))
+ (("=lsof") (string-append "="
#$(this-package-input "lsof") "/bin/lsof"))
+ (("=nmap") (string-append "="
#$(this-package-input "nmap") "/bin/nmap"))
+ (("=perl") (string-append "="
#$(this-package-input "perl") "/bin/perl"))
+ (("=php") (string-append "=" #$(this-package-input
"php") "/bin/php"))
+ (("=ps") (string-append "=" #$(this-package-input
"procps") "/bin/ps"))
+ (("=pydaemon.sh") (string-append "="
#$(this-package-input "pydaemon") "/bin/pydaemon.sh"))
+ (("=sed") (string-append "=" #$(this-package-input
"sed") "/bin/sed"))
+ (("=socat") (string-append "="
#$(this-package-input "socat") "/bin/socat"))
+ (("=tree") (string-append "="
#$(this-package-input "tree") "/bin/tree"))
+ (("=pcre2grep") (string-append "="
#$(this-package-input "pcre2") "/bin/pcre2grep"))
+ (("=which") (string-append "="
#$(this-package-input "which") "/bin/which"))
+ (("=xargs") (string-append "="
#$(this-package-input "findutils") "/bin/xargs"))
+ (("=xdg-open") (string-append "="
#$(this-package-input "xdg-utils") "/bin/xdg-open"))
+ (("=xmllint") (string-append "="
#$(this-package-input "libxml2-xpath0") "/bin/xmllint"))
+ (("export GUILE_LOAD_PATH=(.*)$")
+ (string-append "export GUILE_LOAD_PATH=\""
+ (string-join
+ '(#$@(map (lambda (name)
+ (file-append
(this-package-input name)
+
"/share/guile/site/"
+
(version-major+minor
+
(package-version
+
(this-package-input
+
"guile")))))
+
'("guile-bash-for-bash-coding-utils")))
+ ":")
+
"${GUILE_LOAD_PATH:+:}${GUILE_LOAD_PATH}\"\n"))
+ (("export BCUPYTHONVERSION=(.*)$" _)
+ (string-append "export BCUPYTHONVERSION="
+ #$(version-major+minor
+ (package-version
+ (this-package-input
+ "python")))))
+ (("export BCUPYTHON=python(.*)$" _)
+ (string-append "export BCUPYTHON="
+ #$(file-append (this-package-input
"python")
+ "/bin/python"
+
(version-major+minor
+ (package-version
+
(this-package-input
+ "python"))))
+ "\n"))
+ (("export PYTHONPATH=.*" all)
+ (string-append "export PYTHONPATH=\""
+ (string-join
+ '(#$@(map (lambda (name)
+ (file-append
(this-package-input name)
+
"/lib/python"
+
(version-major+minor
+
(package-version
+
(this-package-input
+
"python")))
+
"/site-packages"))
+ '("python"
+ "python-elementpath"
+ "python-lxml"
+ "python-netaddr")))
+ ":")
+
"${PYTHONPATH:+:}${PYTHONPATH}\"\n"))
+ (("export XDG_DATA_DIRS=(.*)$")
+ (string-append
+ "[[ -e /run/current-system/profile/share ]] && "
+ "export XDG_DATA_DIRS="
+ "/run/current-system/profile/share"
+ "${XDG_DATA_DIRS:+:}${XDG_DATA_DIRS}\n")))
+
+ ;; Symlink to bcu.sh from the output bin directory.
+ (mkdir-p bin)
+ (symlink (string-append bcu-root "/bcu.sh") bcu.sh)
+ (chmod bcu.sh #o555)
+
+ ;; Disable network and gui tests, and one test for
setopts which
+ ;; doesn't work inside the Guix build environment.
+ (with-output-to-file (string-append bcu-root
"/disabled_tests.txt")
+ (lambda _
+ (format #t "~{~a~%~}"
+ (list "ip_of_test_1"
+ "setopts_test_4"
+ "web_media_server_test_1"
+ "web_api_server_test_1"
+ "find_gui_test_1"))))
+
+ ;; Set up a minimal test environment & run the
tests.
+ (when tests?
+ (setenv "PATH" (string-append bin ":"
+ bash "/bin:"
+ (getenv "PATH")))
+ (setenv "SHELL"
+ (string-append bash "/bin/bash"))
+ (for-each (lambda (test-input)
+ (setenv "PATH"
+ (string-append
+ (assoc-ref %build-inputs
test-input)
+ "/bin:" (getenv "PATH"))))
+ (list "coreutils"))
+ (setenv "HOME" "/tmp")
+ (with-directory-excursion bcu-root
+ (invoke "./bcu-test.sh")
+ ;; No need to keep passed tests in the final
output
+ (for-each delete-file
+ (list "bcu-test.sh"
+ "disabled_tests.txt"))))))))
+ (inputs (list bash bash-ctypes coreutils
+ diffutils file findutils
+ gawk guile-3.0 guile-bash-for-bash-coding-utils
+ jq libxml2-xpath0
+ lsof
+ nmap
+ ;; org-html-themes is bundled upstream as a git
submodule,
+ ;; but we package it separately and copy it
manually above.
+ org-html-themes/methuselah-0
+ pcre2 perl php
+ procps
+ pydaemon python python-elementpath python-lxml
+ python-netaddr python-yq
+ sed
+ socat
+ tree ugrep util-linux which
+ xdg-utils ))
+ ;; the bash shell needs to be the same version
+ ;; as guile-bash is compiled against
+ (propagated-inputs (list bash))
+ (home-page "https://git.sr.ht/~methuselah-0/bash-coding-utils")
+ (synopsis "Functions and tools for software prototyping in Bash")
+ (description
+ "Bash-Coding-Utils is a library of Bash functions and wrappers
that can
+be useful when writing quick implementations of new programs. It helps
you
+work with JSON, XML, API's and parallelization, and installs some
helper
+programs commonly used in Bash scripting. Just run @command{. bcu.sh},
type
+@command{bcu__}, hit @key{TAB} to see available functions and give any
of them
+the @code{--help} flag to see how to use it, or run @command{bcu__docs}
for
+the full HTML documentation.")
+ (license license:gpl3))))
--
2.39.1
?