From 37ca6c159184964f7264ee7e6dc037f3e858dd88 Mon Sep 17 00:00:00 2001 From: Vivianne Langdon Date: Wed, 6 Mar 2024 13:11:06 -0500 Subject: [PATCH] Extricate hall and simplify --- .gitignore | 3 - .guix-channel | 3 - HACKING | 12 +-- Makefile.am | 73 ++++++++++++++++ README.org | 2 - build-aux/test-driver.scm | 179 ++++++++++++++++++++++++++++++++++++++ configure.ac | 36 ++++++++ guix.scm | 59 +------------ hall.scm | 59 ------------- pre-inst-env.in | 13 +++ termenv/hconfig.scm | 35 -------- 11 files changed, 304 insertions(+), 170 deletions(-) delete mode 100644 .guix-channel create mode 100644 Makefile.am create mode 100644 build-aux/test-driver.scm create mode 100644 configure.ac delete mode 100644 hall.scm create mode 100644 pre-inst-env.in delete mode 100644 termenv/hconfig.scm diff --git a/.gitignore b/.gitignore index e78ee84..0a123e7 100644 --- a/.gitignore +++ b/.gitignore @@ -27,7 +27,6 @@ /build-aux/texinfo.tex /config.status /configure -/configure.ac /doc/*.1 /doc/.dirstamp /doc/contributing.*.texi @@ -51,7 +50,6 @@ /doc/version-*.texi /m4/* /pre-inst-env -/pre-inst-env.in /test-env /test-tmp /tests/*.trs @@ -60,7 +58,6 @@ GRTAGS GTAGS Makefile Makefile.in -Makefile.am config.cache stamp-h[0-9] tmp diff --git a/.guix-channel b/.guix-channel deleted file mode 100644 index 4ce1288..0000000 --- a/.guix-channel +++ /dev/null @@ -1,3 +0,0 @@ -(channel - (version 0) - (directory ".guix/modules")) diff --git a/HACKING b/HACKING index 9ff45e8..8297645 100644 --- a/HACKING +++ b/HACKING @@ -11,7 +11,7 @@ By far the easiest way to hack on guile-termenv is to develop using Guix: cd /path/to/source-code guix shell -Df guix.scm # In the new shell, run: - hall build --execute && autoreconf -vif && ./configure && make check + autoreconf -vif && ./configure && make check #+END_SRC You may also want to set your directory as an authorized directory for @@ -30,13 +30,6 @@ To try out any scripts in the project you can now use ./pre-inst-env scripts/${script-name} #+END_SRC -If you'd like to tidy the project again, but retain the ability to test the -project from the commandline, simply run: - -#+BEGIN_SRC bash - ./hall clean --skip "scripts/${script-name},pre-inst-env" --execute -#+END_SRC - ** Manual Installation If you do not yet use Guix, you will have to install this project's @@ -45,10 +38,9 @@ dependencies manually: - automake - pkg-config - texinfo - - guile-hall Once those dependencies are installed you can run: #+BEGIN_SRC bash - hall build -x && autoreconf -vif && ./configure && make check + autoreconf -vif && ./configure && make check #+END_SRC diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..f31778c --- /dev/null +++ b/Makefile.am @@ -0,0 +1,73 @@ +bin_SCRIPTS = + +nodist_noinst_SCRIPTS = pre-inst-env + +GOBJECTS = $(SOURCES:%.scm=%.go) + +moddir=$(prefix)/share/guile/site/$(GUILE_EFFECTIVE_VERSION) +godir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache +ccachedir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache + +nobase_dist_mod_DATA = $(SOURCES) $(NOCOMP_SOURCES) +nobase_go_DATA = $(GOBJECTS) + +# Make sure source files are installed first, so that the mtime of +# installed compiled files is greater than that of installed source +# files. See +# +# for details. +guile_install_go_files = install-nobase_goDATA +$(guile_install_go_files): install-nobase_dist_modDATA + +GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat +SUFFIXES = .scm .go +.scm.go: + $(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE_TOOLS) compile $(GUILE_TARGET) $(GUILE_WARNINGS) -o "$@" "$<" + +SOURCES = termenv/style.scm \ + termenv/unix.scm \ + termenv/hyperlink.scm \ + termenv/screen.scm \ + termenv/color.scm \ + termenv.scm \ + tests/utils.scm + +TESTS = tests/test-screen.scm \ + tests/test-style.scm + +TEST_EXTENSIONS = .scm +SCM_LOG_DRIVER = \ + $(top_builddir)/pre-inst-env \ + $(GUILE) --no-auto-compile -e main \ + $(top_srcdir)/build-aux/test-driver.scm + +# Tell 'build-aux/test-driver.scm' to display only source file names, +# not indivdual test names. +AM_SCM_LOG_DRIVER_FLAGS = --brief=yes + +AM_SCM_LOG_FLAGS = --no-auto-compile -L "$(top_srcdir)" + +AM_TESTS_ENVIRONMENT = abs_top_srcdir="$(abs_top_srcdir)" + +info_TEXINFOS = doc/guile-termenv.texi + +EXTRA_DIST = README.org \ + HACKING \ + COPYING \ + guix.scm \ + .gitignore \ + build-aux/test-driver.scm \ + $(TESTS) + +ACLOCAL_AMFLAGS = -I m4 + +AM_DISTCHECK_DVI_TARGET = info # Disable DVI as part of distcheck + +clean-go: + -$(RM) $(GOBJECTS) +.PHONY: clean-go + +CLEANFILES = \ + $(BUILT_SOURCES) \ + $(GOBJECTS) \ + $(TESTS:tests/%.scm=%.log) diff --git a/README.org b/README.org index 4b7cff9..1628c34 100644 --- a/README.org +++ b/README.org @@ -23,7 +23,6 @@ steps like so: #+BEGIN_SRC shell guix shell -Df guix.scm - hall build -x autoreconf -vif ./configure make -j @@ -36,7 +35,6 @@ following dependencies to build: - autoconf - automake -- guile-hall - pkg-config - texinfo diff --git a/build-aux/test-driver.scm b/build-aux/test-driver.scm new file mode 100644 index 0000000..0c555ea --- /dev/null +++ b/build-aux/test-driver.scm @@ -0,0 +1,179 @@ +;;;; test-driver.scm - Guile test driver for Automake testsuite harness + +(define script-version "2019-01-15.13") ;UTC + +;;; Copyright © 2015, 2016 Mathieu Lirzin +;;; Copyright © 2019 Alex Sassmannshausen +;;; +;;; This program 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. +;;; +;;; This program 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 this program. If not, see . + +;;;; Commentary: +;;; +;;; This script provides a Guile test driver using the SRFI-64 Scheme API for +;;; test suites. SRFI-64 is distributed with Guile since version 2.0.9. +;;; +;;; This script is a lightly modified version of the orignal written by +;;; Matthieu Lirzin. The changes make it suitable for use as part of the +;;; guile-hall infrastructure. +;;; +;;;; Code: + +(use-modules (ice-9 getopt-long) + (ice-9 pretty-print) + (srfi srfi-26) + (srfi srfi-64)) + +(define (show-help) + (display "Usage: + test-driver --test-name=NAME --log-file=PATH --trs-file=PATH + [--expect-failure={yes|no}] [--color-tests={yes|no}] + [--enable-hard-errors={yes|no}] [--brief={yes|no}}] [--] + TEST-SCRIPT [TEST-SCRIPT-ARGUMENTS] +The '--test-name', '--log-file' and '--trs-file' options are mandatory. +")) + +(define %options + '((test-name (value #t)) + (log-file (value #t)) + (trs-file (value #t)) + (color-tests (value #t)) + (expect-failure (value #t)) ;XXX: not implemented yet + (enable-hard-errors (value #t)) ;not implemented in SRFI-64 + (brief (value #t)) + (help (single-char #\h) (value #f)) + (version (single-char #\V) (value #f)))) + +(define (option->boolean options key) + "Return #t if the value associated with KEY in OPTIONS is 'yes'." + (and=> (option-ref options key #f) (cut string=? <> "yes"))) + +(define* (test-display field value #:optional (port (current-output-port)) + #:key pretty?) + "Display 'FIELD: VALUE\n' on PORT." + (if pretty? + (begin + (format port "~A:~%" field) + (pretty-print value port #:per-line-prefix "+ ")) + (format port "~A: ~S~%" field value))) + +(define* (result->string symbol #:key colorize?) + "Return SYMBOL as an upper case string. Use colors when COLORIZE is #t." + (let ((result (string-upcase (symbol->string symbol)))) + (if colorize? + (string-append (case symbol + ((pass) "") ;green + ((xfail) "") ;light green + ((skip) "") ;blue + ((fail xpass) "") ;red + ((error) "")) ;magenta + result + "") ;no color + result))) + +(define* (test-runner-gnu test-name #:key color? brief? out-port trs-port) + "Return an custom SRFI-64 test runner. TEST-NAME is a string specifying the +file name of the current the test. COLOR? specifies whether to use colors, +and BRIEF?, well, you know. OUT-PORT and TRS-PORT must be output ports. The +current output port is supposed to be redirected to a '.log' file." + + (define (test-on-test-begin-gnu runner) + ;; Procedure called at the start of an individual test case, before the + ;; test expression (and expected value) are evaluated. + (let ((result (cute assq-ref (test-result-alist runner) <>))) + (format #t "test-name: ~A~%" (result 'test-name)) + (format #t "location: ~A~%" + (string-append (result 'source-file) ":" + (number->string (result 'source-line)))) + (test-display "source" (result 'source-form) #:pretty? #t))) + + (define (test-on-test-end-gnu runner) + ;; Procedure called at the end of an individual test case, when the result + ;; of the test is available. + (let* ((results (test-result-alist runner)) + (result? (cut assq <> results)) + (result (cut assq-ref results <>))) + (unless brief? + ;; Display the result of each test case on the console. + (format out-port "~A: ~A - ~A~%" + (result->string (test-result-kind runner) #:colorize? color?) + test-name (test-runner-test-name runner))) + (when (result? 'expected-value) + (test-display "expected-value" (result 'expected-value))) + (when (result? 'expected-error) + (test-display "expected-error" (result 'expected-error) #:pretty? #t)) + (when (result? 'actual-value) + (test-display "actual-value" (result 'actual-value))) + (when (result? 'actual-error) + (test-display "actual-error" (result 'actual-error) #:pretty? #t)) + (format #t "result: ~a~%" (result->string (result 'result-kind))) + (newline) + (format trs-port ":test-result: ~A ~A~%" + (result->string (test-result-kind runner)) + (test-runner-test-name runner)))) + + (define (test-on-group-end-gnu runner) + ;; Procedure called by a 'test-end', including at the end of a test-group. + (let ((fail (or (positive? (test-runner-fail-count runner)) + (positive? (test-runner-xpass-count runner)))) + (skip (or (positive? (test-runner-skip-count runner)) + (positive? (test-runner-xfail-count runner))))) + ;; XXX: The global results need some refinements for XPASS. + (format trs-port ":global-test-result: ~A~%" + (if fail "FAIL" (if skip "SKIP" "PASS"))) + (format trs-port ":recheck: ~A~%" + (if fail "yes" "no")) + (format trs-port ":copy-in-global-log: ~A~%" + (if (or fail skip) "yes" "no")) + (when brief? + ;; Display the global test group result on the console. + (format out-port "~A: ~A~%" + (result->string (if fail 'fail (if skip 'skip 'pass)) + #:colorize? color?) + test-name)) + #f)) + + (let ((runner (test-runner-null))) + (test-runner-on-test-begin! runner test-on-test-begin-gnu) + (test-runner-on-test-end! runner test-on-test-end-gnu) + (test-runner-on-group-end! runner test-on-group-end-gnu) + (test-runner-on-bad-end-name! runner test-on-bad-end-name-simple) + runner)) + +;;; +;;; Entry point. +;;; + +(define (main . args) + (let* ((opts (getopt-long (command-line) %options)) + (option (cut option-ref opts <> <>))) + (cond + ((option 'help #f) (show-help)) + ((option 'version #f) (format #t "test-driver.scm ~A" script-version)) + (else + (let ((log (open-file (option 'log-file "") "w0")) + (trs (open-file (option 'trs-file "") "wl")) + (out (duplicate-port (current-output-port) "wl"))) + (redirect-port log (current-output-port)) + (redirect-port log (current-warning-port)) + (redirect-port log (current-error-port)) + (test-with-runner + (test-runner-gnu (option 'test-name #f) + #:color? (option->boolean opts 'color-tests) + #:brief? (option->boolean opts 'brief) + #:out-port out #:trs-port trs) + (load-from-path (option 'test-name #f))) + (close-port log) + (close-port trs) + (close-port out)))) + (exit 0))) diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..07e9477 --- /dev/null +++ b/configure.ac @@ -0,0 +1,36 @@ +dnl -*- Autoconf -*- + +AC_INIT(guile-termenv, 0.1) +AC_SUBST(HVERSION, "\"0.1\"") +AC_SUBST(AUTHOR, "\"\"") +AC_SUBST(COPYRIGHT, "'(2024)") +AC_SUBST(LICENSE, gpl3+) +AC_CONFIG_SRCDIR(scripts) +AC_CONFIG_AUX_DIR([build-aux]) +AM_INIT_AUTOMAKE([1.12 foreign silent-rules subdir-objects color-tests parallel-tests -Woverride -Wno-portability]) +AM_SILENT_RULES([yes]) + +AC_CONFIG_FILES([Makefile]) +AC_CONFIG_FILES([pre-inst-env], [chmod +x pre-inst-env]) + +dnl Search for 'guile' and 'guild'. This macro defines +dnl 'GUILE_EFFECTIVE_VERSION'. +GUILE_PKG([3.0 2.2 2.0]) +GUILE_PROGS +GUILE_SITE_DIR +if test "x$GUILD" = "x"; then + AC_MSG_ERROR(['guild' binary not found; please check your guile-2.x installation.]) +fi + +if test "$cross_compiling" != no; then + GUILE_TARGET="--target=$host_alias" + AC_SUBST([GUILE_TARGET]) +fi + +dnl Installation directories for .scm and .go files. +guilemoduledir="${datarootdir}/guile/site/$GUILE_EFFECTIVE_VERSION" +guileobjectdir="${libdir}/guile/$GUILE_EFFECTIVE_VERSION/site-ccache" +AC_SUBST([guilemoduledir]) +AC_SUBST([guileobjectdir]) + +AC_OUTPUT diff --git a/guix.scm b/guix.scm index ff36bcd..3735d72 100644 --- a/guix.scm +++ b/guix.scm @@ -26,64 +26,7 @@ (string-contains file my-string)) (list ".git" ".dir-locals.el" "guix.scm")))))) (build-system gnu-build-system) - (arguments - `(#:modules - ((ice-9 match) - (ice-9 ftw) - ,@%gnu-build-system-modules) - #:phases - (modify-phases - %standard-phases - (add-after - 'install - 'hall-wrap-binaries - (lambda* (#:key inputs outputs #:allow-other-keys) - (let* ((compiled-dir - (lambda (out version) - (string-append - out - "/lib/guile/" - version - "/site-ccache"))) - (uncompiled-dir - (lambda (out version) - (string-append - out - "/share/guile/site" - (if (string-null? version) "" "/") - version))) - (dep-path - (lambda (env modules path) - (list env - ":" - 'prefix - (cons modules - (map (lambda (input) - (string-append - (assoc-ref inputs input) - path)) - ,''()))))) - (out (assoc-ref outputs "out")) - (bin (string-append out "/bin/")) - (site (uncompiled-dir out ""))) - (match (scandir site) - (("." ".." version) - (for-each - (lambda (file) - (wrap-program - (string-append bin file) - (dep-path - "GUILE_LOAD_PATH" - (uncompiled-dir out version) - (uncompiled-dir "" version)) - (dep-path - "GUILE_LOAD_COMPILED_PATH" - (compiled-dir out version) - (compiled-dir "" version)))) - ,''("generate-eastasian" - "generate-emoji" - "generate-graphemes")) - #t)))))))) + (arguments `()) (native-inputs (list autoconf automake pkg-config texinfo)) (inputs (list guile-3.0)) diff --git a/hall.scm b/hall.scm deleted file mode 100644 index df83358..0000000 --- a/hall.scm +++ /dev/null @@ -1,59 +0,0 @@ -(hall-description - (name "termenv") - (prefix "guile") - (version "0.1") - (author "Vivanne Langdon") - (email "") - (copyright (2024)) - (synopsis "Guile port of termenv") - (description - "A library to provide easy control of terminals from Guile using terminal control codes.") - (home-page - "https://git.solarpunk.moe/solarpunk-guile/guile-termenv") - (license gpl3+) - (dependencies `()) - (skip ()) - (features - ((guix #t) - (use-guix-specs-for-dependencies #f) - (native-language-support #f) - (licensing #f))) - (files (libraries - ((scheme-file "termenv") - (directory - "termenv" - ((scheme-file "screen") - (scheme-file "style") - (scheme-file "hconfig") - (scheme-file "color") - (scheme-file "unix") - (scheme-file "hyperlink"))))) - (tests ((directory - "tests" - ((scheme-file "utils") - (scheme-file "test-style") - (scheme-file "test-screen"))))) - (programs ()) - (documentation - ((org-file "README") - (symlink "README" "README.org") - (text-file "HACKING") - (text-file "COPYING") - (directory "doc" ((texi-file "guile-termenv"))))) - (infrastructure - ((text-file ".guix-channel") - (directory - ".guix" - ((directory - "modules" - ((scheme-file "guile-termenv"))))) - (symlink - "guix.scm" - ".guix/modules/guile-termenv.scm") - (text-file ".gitignore") - (scheme-file "hall") - (directory - "tests" - ((scheme-file "utils") - (scheme-file "test-style") - (scheme-file "test-screen"))))))) diff --git a/pre-inst-env.in b/pre-inst-env.in new file mode 100644 index 0000000..31c499d --- /dev/null +++ b/pre-inst-env.in @@ -0,0 +1,13 @@ +#!/bin/sh + +abs_top_srcdir="`cd "@abs_top_srcdir@" > /dev/null; pwd`" +abs_top_builddir="`cd "@abs_top_builddir@" > /dev/null; pwd`" + +GUILE_LOAD_COMPILED_PATH="$abs_top_builddir${GUILE_LOAD_COMPILED_PATH:+:}$GUILE_LOAD_COMPILED_PATH" +GUILE_LOAD_PATH="$abs_top_builddir:$abs_top_srcdir${GUILE_LOAD_PATH:+:}:$GUILE_LOAD_PATH" +export GUILE_LOAD_COMPILED_PATH GUILE_LOAD_PATH + +PATH="$abs_top_builddir/scripts:$PATH" +export PATH + +exec "$@" diff --git a/termenv/hconfig.scm b/termenv/hconfig.scm deleted file mode 100644 index 0d57d40..0000000 --- a/termenv/hconfig.scm +++ /dev/null @@ -1,35 +0,0 @@ -(define-module - (guile-termenv hconfig) - #:use-module - (srfi srfi-26) - #:export - (%version - %author - %license - %copyright - %gettext-domain - G_ - N_ - init-nls - init-locale)) - -(define %version "0.1") - -(define %author "") - -(define %license 'gpl3+) - -(define %copyright '(2024)) - -(define %gettext-domain "guile-termenv") - -(define G_ identity) - -(define N_ identity) - -(define (init-nls) "Dummy as no NLS is used" #t) - -(define (init-locale) - "Dummy as no NLS is used" - #t) -