├── copyright_exceptions ├── test ├── .gitignore ├── Makefile.am ├── test-no-clear.el ├── test-buffer.el ├── test-basic.el └── test-fns.el ├── NEWS ├── Cask ├── AUTHORS ├── THANKS ├── common.mk ├── autogen.sh ├── .gitignore ├── .travis.yml ├── run-travis-ci.sh ├── make-check-filter.rb ├── INSTALL ├── compute-lispdir.sh ├── example ├── gcd.el └── gcd-tests.el ├── configure.ac ├── Makefile.am ├── install-from-git.sh ├── elisp-comp ├── README.md ├── ChangeLog ├── test-simple.el └── COPYING /copyright_exceptions: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/.gitignore: -------------------------------------------------------------------------------- 1 | /Makefile 2 | /Makefile.in 3 | -------------------------------------------------------------------------------- /NEWS: -------------------------------------------------------------------------------- 1 | 1.0 2 | Initial Melpa release 3 | 4 | 0.2 5 | Initial Release 6 | -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (source gnu) 2 | (source melpa) 3 | 4 | (package-file "test-simple.el") 5 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Rocky Bernstein (rocky@gnu.org) adapted from Phil Hagelberg's behave.el 2 | 3 | -------------------------------------------------------------------------------- /THANKS: -------------------------------------------------------------------------------- 1 | Lars Andersen (expez) - Getting this packaged and put on to Melpa. 2 | rubyikitch: Greatly improved noninteractive testing. 3 | -------------------------------------------------------------------------------- /common.mk: -------------------------------------------------------------------------------- 1 | short: 2 | $(MAKE) 2>&1 >/dev/null | ruby $(top_srcdir)/make-check-filter.rb 3 | 4 | %.short: 5 | $(MAKE) $(@:.short=) 2>&1 >/dev/null 6 | -------------------------------------------------------------------------------- /autogen.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | cp README.md README 3 | autoreconf -vi && \ 4 | autoconf && { 5 | echo "Running configure with --enable-maintainer-mode $@" 6 | ./configure --enable-maintainer-mode $@ 7 | } 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *elc 2 | *~ 3 | /Makefile 4 | /Makefile.in 5 | /aclocal.m4 6 | /autom4te.cache 7 | /config.log 8 | /config.status 9 | /configure 10 | /elc-stamp 11 | /install-sh 12 | /missing 13 | /script 14 | /README 15 | /.cask/ 16 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: emacs-lisp 2 | 3 | env: 4 | - EVM_EMACS=emacs-25.3-travis 5 | 6 | install: 7 | - curl -fsSkL https://gist.github.com/rejeep/ebcd57c3af83b049833b/raw > travis.sh && source ./travis.sh 8 | - evm install $EVM_EMACS --use --skip 9 | 10 | # run the tests 11 | script: 12 | - ./run-travis-ci.sh 13 | -------------------------------------------------------------------------------- /run-travis-ci.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | cd "$(dirname "$0")" 4 | 5 | set_default () { 6 | eval " 7 | if [ -z \$$1 ]; then 8 | $1=$2 9 | fi 10 | " 11 | } 12 | 13 | set_default EMACS "$(which emacs)" 14 | 15 | echo "*** Emacs version ***" 16 | echo "EMACS =" $(which $EMACS) 17 | $EMACS --version 18 | echo 19 | 20 | NO_CHECK_EMACS_PACKAGES=1 /bin/bash ./autogen.sh && cd test && make check 21 | -------------------------------------------------------------------------------- /make-check-filter.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # Use this to cut out the crud from make check. 3 | # Use like this: 4 | # make check 2>&1 | ruby ../make-check-filter.rb 5 | # See Makefile.am 6 | pats = ["^(?:Loading", 7 | 'make\[', 8 | "Making check in", 9 | '\(cd \.\.', 10 | "make -C", 11 | "Test-Unit", 12 | "Fontifying", 13 | '\s*$' 14 | ].join('|') + ')' 15 | # puts pats 16 | skip_re = /#{pats}/ 17 | 18 | while gets() 19 | next if $_ =~ skip_re 20 | puts $_ 21 | end 22 | -------------------------------------------------------------------------------- /INSTALL: -------------------------------------------------------------------------------- 1 | This package is now installable from inside Emacs and melpa. 2 | 3 | We have an old-style GNU autoconf configuration as well and an install 4 | script to pick that up from git sources. For this, you will need: 5 | 6 | * Emacs, of course. Version 23 or better 7 | * _autoconf_ and _autoreconf_ to build the configure script. Usually _autoreconf_ comes with an "autoconf" package 8 | * GNU Make -- or even better "remake":http//bashdb.sf.net/remake 9 | 10 | If you are feeling lucky, you can try running the install script from the github repository: 11 | 12 | $ bash < <( curl https://raw.github.com/rocky/emacs-test-simple/master/install-from-git.sh ) 13 | 14 | Otherwise: 15 | 16 | git clone http://github.com/rocky/emacs-test-simple 17 | cd emacs-test-simple 18 | ./configure && make && [sudo] make install 19 | -------------------------------------------------------------------------------- /test/Makefile.am: -------------------------------------------------------------------------------- 1 | include $(top_srcdir)/common.mk 2 | 3 | cask_test_files := test-basic.el test-fns.el test-no-clear.el 4 | 5 | EL_GET_CHECK_FILES = $(notdir $(cask_test_files:.el=.elrun)) 6 | 7 | PHONY=check test all check-elget test-elget help 8 | EXTRA_DIST=gcd.py gcd.rb 9 | 10 | all: 11 | 12 | #: same thing as "check" 13 | test: check 14 | 15 | test_files := $(wildcard test-*.el) 16 | 17 | CHECK_FILES = $(notdir $(test_files:.el=.run)) 18 | 19 | #: Run all tests 20 | check: $(CHECK_FILES) 21 | 22 | #: Run all tests with minimum verbosity 23 | check-short: 24 | $(MAKE) check 2>&1 | ruby ../make-check-filter.rb 25 | 26 | install-lispLISP: $(lisp_LISP) $(ELCFILES) 27 | 28 | test-%.run: 29 | (cd $(top_srcdir)/test && EMACSLOADPATH=$(EMACSLOADPATH) $(EMACS) --batch --no-site-file --no-splash --load $(@:.run=.el)) 30 | 31 | #: Run tests 32 | test-%.elrun: 33 | (cd $(top_srcdir)/test && $(EMACS) --batch --no-site-file --no-splash --load $(@:.elrun=.el)) 34 | 35 | # Whatever it is you want to do, it should be forwarded to the 36 | # to top-level directories 37 | %: 38 | $(MAKE) -C .. $@ 39 | -------------------------------------------------------------------------------- /compute-lispdir.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Figures out a reasonable --prefix 3 | typeset -i rc=0 4 | typeset -i DEBUG=${DEBUG:-0} 5 | EMACS_PROG=${EMACS_PROG:-emacs} 6 | list=$($EMACS_PROG --batch --no-splash --eval '(message (substring (format "%s" load-path) 1 -1))' 2>&1) 7 | rc=$? 8 | if (( rc != 0 )) ; then 9 | echo >&2 "Something went running $EMACS_PROG" 10 | exit $rc 11 | $cmd 12 | fi 13 | for dir in $list ; do 14 | if [[ -d $dir ]] ; then 15 | case $dir in 16 | */emacs/site-lisp) 17 | ((DEBUG)) && echo "site lisp: $dir" 18 | echo "$dir" 19 | exit 0 20 | ;; 21 | esac 22 | fi 23 | done 24 | for dir in $list ; do 25 | if [[ -d $dir ]] ; then 26 | case $dir in 27 | */emacs/2[34]\.[0-9]/site-lisp) 28 | ((DEBUG)) && echo "versioned site lisp: $dir" 29 | echo "$dir" 30 | exit 0 31 | ;; 32 | esac 33 | fi 34 | done 35 | for dir in $list ; do 36 | if [[ -d $dir ]] ; then 37 | case $dir in 38 | */emacs/2[34]\.[0-9]/site-lisp) 39 | ((DEBUG)) && echo "versioned site lisp: $dir" 40 | echo "$dir" 41 | exit 0 42 | ;; 43 | esac 44 | fi 45 | done 46 | exit 0 47 | -------------------------------------------------------------------------------- /test/test-no-clear.el: -------------------------------------------------------------------------------- 1 | ;;; test-simple.el --- Simple Unit Test Framework for Emacs Lisp 2 | ;; Copyright (C) 2015 Free Software Foundation, Inc 3 | ;; Author: Rocky Bernstein 4 | ;; This program is free software: you can redistribute it and/or 5 | ;; modify it under the terms of the GNU General Public License as 6 | ;; published by the Free Software Foundation, either version 3 of the 7 | ;; License, or (at your option) any later version. 8 | 9 | ;; This program is distributed in the hope that it will be useful, but 10 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | ;; General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. If not, see 16 | ;; . 17 | (require 'cl-lib) 18 | (load-file "../test-simple.el") 19 | ;; We don't do this or test-simple-start 20 | ;; (test-simple-clear) 21 | 22 | (note "no-test-start") 23 | (assert-t (memq 'test-simple features) "'test-simple provided") 24 | 25 | (assert-nil nil) 26 | 27 | (end-tests) 28 | -------------------------------------------------------------------------------- /test/test-buffer.el: -------------------------------------------------------------------------------- 1 | ;;; test-simple.el --- Simple Unit Test Framework for Emacs Lisp 2 | ;; Copyright (C) 2023 Free Software Foundation, Inc 3 | ;; Author: 813gan 4 | ;; This program is free software: you can redistribute it and/or 5 | ;; modify it under the terms of the GNU General Public License as 6 | ;; published by the Free Software Foundation, either version 3 of the 7 | ;; License, or (at your option) any later version. 8 | 9 | ;; This program is distributed in the hope that it will be useful, but 10 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | ;; General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. If not, see 16 | ;; . 17 | (load-file "../test-simple.el") 18 | (test-simple-start "test-simple.el") 19 | 20 | (note "make sure test-simple don't flush buffer") 21 | (with-temp-buffer 22 | (insert "test") 23 | (assert-t 't) 24 | (assert-nil (equal (point-min) (point-max)) "test-simple is breaking buffers.") ) 25 | 26 | (end-tests) 27 | -------------------------------------------------------------------------------- /test/test-basic.el: -------------------------------------------------------------------------------- 1 | ;;; test-simple.el --- Simple Unit Test Framework for Emacs Lisp 2 | ;; Copyright (C) 2015 Free Software Foundation, Inc 3 | ;; Author: Rocky Bernstein 4 | ;; This program is free software: you can redistribute it and/or 5 | ;; modify it under the terms of the GNU General Public License as 6 | ;; published by the Free Software Foundation, either version 3 of the 7 | ;; License, or (at your option) any later version. 8 | 9 | ;; This program is distributed in the hope that it will be useful, but 10 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | ;; General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. If not, see 16 | ;; . 17 | (require 'cl-lib) 18 | (load-file "../test-simple.el") 19 | (test-simple-start "test-simple.el") 20 | 21 | (note "basic-tests") 22 | (assert-t (memq 'test-simple features) "'test-simple provided") 23 | 24 | (assert-nil nil "Knights of ni") 25 | (assert-equal 5 (+ 1 4) "assert-equal") 26 | (assert-raises error (error "you should not see this") "assert-raises") 27 | 28 | (end-tests) 29 | -------------------------------------------------------------------------------- /example/gcd.el: -------------------------------------------------------------------------------- 1 | ;;; test-simple.el --- Simple Unit Test Framework for Emacs Lisp 2 | ;; Copyright (C) 2015 Free Software Foundation, Inc 3 | 4 | ;; Author: Rocky Bernstein 5 | ;; URL: http://github.com/rocky/emacs-test-simple 6 | ;; Keywords: unit-test 7 | ;; Version: 1.0 8 | 9 | ;; This program is free software: you can redistribute it and/or 10 | ;; modify it under the terms of the GNU General Public License as 11 | ;; published by the Free Software Foundation, either version 3 of the 12 | ;; License, or (at your option) any later version. 13 | 14 | ;; This program is distributed in the hope that it will be useful, but 15 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of 16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 | ;; General Public License for more details. 18 | 19 | ;; You should have received a copy of the GNU General Public License 20 | ;; along with this program. If not, see 21 | ;; . 22 | (defun gcd(a b) 23 | "Greatest Common Divisor of A and B" 24 | ;; Make a < b 25 | (if (> a b) 26 | (let ((c a)) 27 | (setq a b) 28 | (setq b c))) 29 | (cond 30 | ((< a 0) nil) 31 | ((or (= 0 (- b a)) (= a 1)) a) 32 | (t (gcd (- b a) a)) 33 | ) 34 | ) 35 | -------------------------------------------------------------------------------- /configure.ac: -------------------------------------------------------------------------------- 1 | dnl FIXME: pick up from test-simple.el 2 | AC_INIT(emacs-test-simple, 1.0,) 3 | AC_CONFIG_SRCDIR(test-simple.el) 4 | AM_INIT_AUTOMAKE([foreign]) 5 | AM_MAINTAINER_MODE 6 | 7 | AC_PATH_PROG([EMACS], [emacs], [emacs]) 8 | AC_MSG_NOTICE("Checking emacs version and prerequiste packages") 9 | $EMACS -batch -q -no-site-file -eval \ 10 | '(if (<= emacs-major-version 22) 11 | (progn 12 | (error "You need GNU Emacs 23 or better.") 13 | (kill-emacs 1) 14 | ) 15 | )' 16 | if test $? -ne 0 ; then 17 | AC_MSG_ERROR([Can't continue until above error is corrected.]) 18 | fi 19 | 20 | ################################################################## 21 | # See if --with-lispdir was set. If not, set it to a reasonable default 22 | # based on where bash thinks bashdb is supposed to be installed. 23 | ################################################################## 24 | 25 | AM_MISSING_PROG(GIT2CL, git2cl, $missing_dir) 26 | 27 | # Check whether --with-lispdir was given. 28 | if test "${with_lispdir+set}" = set -o "${prefix+set}" = set; then : 29 | else 30 | my_lispdir=$(EMACS_PROG=$EMACS $SH_PROG $(dirname $0)/compute-lispdir.sh) 31 | if test "${my_lispdir+set}" = set; then : 32 | with_lispdir=$my_lispdir 33 | echo "'compute-lispdir.sh' lispdir install directory override: '$with_lispdir'" 34 | fi 35 | fi 36 | 37 | ## 38 | ## Find out where to install the debugger emacs lisp files 39 | ## 40 | AM_PATH_LISPDIR 41 | AM_CONDITIONAL(INSTALL_EMACS_LISP, test "x$lispdir" != "x") 42 | 43 | AC_CONFIG_FILES([Makefile test/Makefile]) 44 | AC_OUTPUT 45 | -------------------------------------------------------------------------------- /example/gcd-tests.el: -------------------------------------------------------------------------------- 1 | ;;; gcd-tests.el 2 | ;; Copyright (C) 2015 Free Software Foundation, Inc 3 | 4 | ;; Author: Rocky Bernstein 5 | ;; URL: http://github.com/rocky/emacs-test-simple 6 | ;; Keywords: unit-test 7 | ;; Version: 1.0 8 | 9 | ;; This program is free software: you can redistribute it and/or 10 | ;; modify it under the terms of the GNU General Public License as 11 | ;; published by the Free Software Foundation, either version 3 of the 12 | ;; License, or (at your option) any later version. 13 | 14 | ;; This program is distributed in the hope that it will be useful, but 15 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of 16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 | ;; General Public License for more details. 18 | 19 | ;; You should have received a copy of the GNU General Public License 20 | ;; along with this program. If not, see 21 | ;; . 22 | ;;;; (test-simple-run "emacs -batch -L %s -l %s" (file-name-directory (locate-library "test-simple.elc")) buffer-file-name) 23 | (require 'test-simple) 24 | 25 | (test-simple-start) 26 | 27 | (assert-t (load-file "./gcd.el") 28 | "Can't load gcd.el - are you in the right directory?" ) 29 | 30 | (note "degenereate cases") 31 | 32 | (assert-nil (gcd 5 -1) "using positive numbers") 33 | (assert-nil (gcd -4 1) "using positive numbers, switched order") 34 | 35 | (note "GCD computations") 36 | (assert-equal 1 (gcd 3 5) "gcd(3,5)") 37 | (assert-equal 8 (gcd 8 32) "gcd(8,32)") 38 | 39 | (assert-raises error (gcd "a" 32) 40 | "Passing a string value should raise an error") 41 | 42 | (end-tests) 43 | -------------------------------------------------------------------------------- /test/test-fns.el: -------------------------------------------------------------------------------- 1 | ;;; test-simple.el --- Simple Unit Test Framework for Emacs Lisp 2 | ;; Copyright (C) 2015 Free Software Foundation, Inc 3 | ;; Author: Rocky Bernstein 4 | ;; This program is free software: you can redistribute it and/or 5 | ;; modify it under the terms of the GNU General Public License as 6 | ;; published by the Free Software Foundation, either version 3 of the 7 | ;; License, or (at your option) any later version. 8 | 9 | ;; This program is distributed in the hope that it will be useful, but 10 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of 11 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | ;; General Public License for more details. 13 | 14 | ;; You should have received a copy of the GNU General Public License 15 | ;; along with this program. If not, see 16 | ;; . 17 | (require 'cl-lib) 18 | (load-file "../test-simple.el") 19 | (test-simple-clear) 20 | 21 | (setq test-info (make-test-info)) 22 | (test-simple-clear test-info) 23 | 24 | (note "Initializing test information") 25 | (assert-equal 0 (test-info-assert-count test-info) "Count zeroed") 26 | (assert-equal 0 (test-info-failure-count test-info) "Failure zeroed") 27 | 28 | (note "Summary information") 29 | (assert-matches "0 failures in 0 assertions" (test-simple-summary-line test-info) 30 | "initial summary") 31 | (cl-incf (test-info-assert-count test-info)) 32 | (cl-incf (test-info-failure-count test-info)) 33 | (assert-matches "1 failure in 1 assertion" (test-simple-summary-line test-info) 34 | "handling singular correctly") 35 | (cl-incf (test-info-assert-count test-info)) 36 | (assert-matches "1 failure in 2 assertions" (test-simple-summary-line test-info) 37 | "back to plural for two assertions") 38 | 39 | (end-tests) 40 | -------------------------------------------------------------------------------- /Makefile.am: -------------------------------------------------------------------------------- 1 | # Note: This makefile include remake-style target comments. 2 | # These comments before the targets start with #: 3 | # remake --tasks to shows the targets and the comments 4 | 5 | GIT2CL ?= git2cl 6 | RUBY ?= ruby 7 | 8 | lisp_files := $(wildcard *.el) 9 | lisp_LISP = $(lisp_files) 10 | test_files := $(wildcard test/*.el) 11 | 12 | EXTRA_DIST = $(lisp_files) $(test_files) README THANKS README.md 13 | 14 | CHECK_FILES = $(notdir $(test_files:.el=.run)) 15 | 16 | 17 | check: $(test-files) 18 | $(MAKE) -C test check 19 | 20 | README: README.textile 21 | ln -s README.md README 22 | 23 | PHONY=check check_copyrights clean dist distclean test check-short check-terse install-short 24 | 25 | if MAINTAINER_MODE 26 | 27 | ChangeLog: 28 | git log --pretty --numstat --summary | $(GIT2CL) > $@ 29 | 30 | ACLOCAL_AMFLAGS=-I . 31 | 32 | endif 33 | 34 | #: Run all tests 35 | test: check 36 | 37 | #: Run all tests with reduced versbosity 38 | check-short: 39 | $(MAKE) -C test check 2>&1 | ruby make-check-filter.rb 40 | 41 | #: Run tests showing only the failure lines; See also check-short 42 | check-terse: 43 | $(MAKE) check 2>&1 | $(RUBY) make-check-filter.rb | grep failure 44 | 45 | #: Run "make install" with reduced verbosity 46 | install-short: 47 | $(MAKE) install 2>&1 | $(RUBY) make-check-filter.rb 48 | 49 | CR_EXCEPTIONS=copyright_exceptions 50 | #: Check for GNU Copyrights. 51 | check_copyrights: 52 | @echo "Compute exceptions >$(CR_EXCEPTIONS)~" 53 | @export LANG=C; \ 54 | find . -name '.git' -prune -o -name '*.el' -print0 | \ 55 | xargs -0 grep -L 'Free Software Foundation, Inc' | \ 56 | grep -v '\(\.dir-locals\|.-\(pkg\|autoloads\)\)\.el$$'; \ 57 | find . -name '.git' -prune -o -name '*.el' -print | \ 58 | while read f; do \ 59 | fquoted="$$(echo $$f|tr '|' '_')"; \ 60 | sed -n -e '/[Cc]opyright.*, *[1-9][-0-9]*,\?$$/N' \ 61 | -e '/Free Software Foundation/d' \ 62 | -e "s|^\\(.*[Cc]opyright\\)|$$fquoted:\\1|p" \ 63 | "$$f"; \ 64 | done | sort >$(CR_EXCEPTIONS)~ 65 | diff -u "$(CR_EXCEPTIONS)" "$(CR_EXCEPTIONS)~" 66 | -------------------------------------------------------------------------------- /install-from-git.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # This installs all emcs-test-simple and its prerequisites. If you are lucky 3 | # you can just run this: 4 | # 5 | # bash ./install-from-git.sh 6 | # 7 | # However we do provide for some customization... 8 | # 9 | # 1. GIT PROTOCOL 10 | # =============== 11 | # 12 | # If your "git clone" can't handle the "http" protocol, you might be 13 | # able to use the "git" protocol. To do this set the GIT_PROTOCOL 14 | # variable like this: 15 | # 16 | # GIT_PROTOCOL=git sh ./install-from-git.sh 17 | # 18 | # 2. configure options (e.g --prefix) 19 | # ==================================== 20 | 21 | # If you want to customize configuration parameters, for example, 22 | # choose where to install, you can pass configure options to this 23 | # script. For example:# can pass configure options. 24 | # 25 | # sh ./install-from-git.sh --prefix=/tmp 26 | # 27 | # 3. TO "sudo" or not to "sudo"? 28 | # ============================== 29 | # If you are running as root on a *Nix-like box, then there's no problem. 30 | # 31 | # If you are not running as root, "sudo" might be invoked to install 32 | # code. On systems that don't have a "sudo" command but need 33 | # filesystem permission, then you get by with setting SUDO_CMD to "su root-c" 34 | # For example: 35 | # 36 | # SUDO_CMD='su root -c' sh ./install-from-git.sh 37 | # 38 | # If you have sufficient filesystem permission (which is often the 39 | # case on Windows or cygwin) then you might not need or want sudo. So 40 | # here, set SUDO_CMD to a blank: 41 | # 42 | # SUDO_CMD=' ' sh ./install-from-git.sh 43 | # 44 | # 45 | # To finish here is an invocation using all 3 above options: 46 | # GIT_PROTOCOL='git' SUDO_CMD=' ' sh ./install-from-git.sh --prefix=/tmp 47 | 48 | GIT_PROTOCOL=${GIT_PROTOCOL:-http} 49 | 50 | run_cmd() { 51 | echo "--- Running command: $@" 52 | $@ 53 | rc=$? 54 | echo "--- $@ exit status is $?" 55 | return $rc 56 | } 57 | 58 | if (( $(id -u) != 0)) ; then 59 | if [[ -z "$SUDO_CMD" ]] ; then 60 | need_sudo='sudo' 61 | if which $need_sudo >/dev/null 2>&1 ; then 62 | try_cmd='' 63 | else 64 | need_sudo='su root -c' 65 | try_cmd='su' 66 | fi 67 | else 68 | need_sudo="$SUDO_CMD" 69 | fi 70 | else 71 | need_sudo='' 72 | try_cmd='' 73 | fi 74 | 75 | for program in git make $try_cmd ; do 76 | if ! which $program >/dev/null 2>&1 ; then 77 | echo "Cant find program $program in $PATH" 78 | exit 1 79 | fi 80 | done 81 | 82 | for pkg in emacs-test-simple ; do 83 | echo '******************************************' 84 | echo Trying to install ${pkg}... 85 | echo '******************************************' 86 | run_cmd git clone ${GIT_PROTOCOL}://github.com/rocky/${pkg}.git 87 | (cd $pkg && \ 88 | run_cmd $SHELL ./autogen.sh && \ 89 | run_cmd ./configure $@ && \ 90 | run_cmd make && \ 91 | run_cmd make check && \ 92 | run_cmd $need_sudo make install 93 | ) 94 | done 95 | -------------------------------------------------------------------------------- /elisp-comp: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # Copyright (C) 1995, 2000, 2003, 2004, 2005, 2009, 2010 Free Software 3 | # Foundation, Inc. 4 | 5 | scriptversion=2010-02-06.18; # UTC 6 | 7 | # Franc,ois Pinard , 1995. 8 | # 9 | # This program is free software; you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation; either version 2, or (at your option) 12 | # any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | # As a special exception to the GNU General Public License, if you 23 | # distribute this file as part of a program that contains a 24 | # configuration script generated by Autoconf, you may include it under 25 | # the same distribution terms that you use for the rest of that program. 26 | 27 | # This file is maintained in Automake, please report 28 | # bugs to or send patches to 29 | # . 30 | 31 | case $1 in 32 | '') 33 | echo "$0: No files. Try \`$0 --help' for more information." 1>&2 34 | exit 1; 35 | ;; 36 | -h | --h*) 37 | cat <<\EOF 38 | Usage: elisp-comp [--help] [--version] FILES... 39 | 40 | This script byte-compiles all `.el' files listed as FILES using GNU 41 | Emacs, and put the resulting `.elc' files into the current directory, 42 | so disregarding the original directories used in `.el' arguments. 43 | 44 | This script manages in such a way that all Emacs LISP files to 45 | be compiled are made visible between themselves, in the event 46 | they require or load-library one another. 47 | 48 | Report bugs to . 49 | EOF 50 | exit $? 51 | ;; 52 | -v | --v*) 53 | echo "elisp-comp $scriptversion" 54 | exit $? 55 | ;; 56 | esac 57 | 58 | if test -z "$EMACS" || test "$EMACS" = "t"; then 59 | # Value of "t" means we are running in a shell under Emacs. 60 | # Just assume Emacs is called "emacs". 61 | EMACS=emacs 62 | fi 63 | 64 | tempdir=elc.$$ 65 | 66 | # Cleanup the temporary directory on exit. 67 | trap 'ret=$?; rm -rf "$tempdir" && exit $ret' 0 68 | do_exit='(exit $ret); exit $ret' 69 | trap "ret=129; $do_exit" 1 70 | trap "ret=130; $do_exit" 2 71 | trap "ret=141; $do_exit" 13 72 | trap "ret=143; $do_exit" 15 73 | 74 | mkdir $tempdir 75 | cp "$@" $tempdir 76 | 77 | ( 78 | cd $tempdir 79 | echo "(setq load-path (cons nil load-path))" > script 80 | $EMACS -batch -q -l script -f batch-byte-compile *.el || exit $? 81 | mv *.elc .. 82 | ) || exit $? 83 | 84 | (exit 0); exit 0 85 | 86 | # Local Variables: 87 | # mode: shell-script 88 | # sh-indentation: 2 89 | # eval: (add-hook 'write-file-hooks 'time-stamp) 90 | # time-stamp-start: "scriptversion=" 91 | # time-stamp-format: "%:y-%02m-%02d.%02H" 92 | # time-stamp-time-zone: "UTC" 93 | # time-stamp-end: "; # UTC" 94 | # End: 95 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://travis-ci.org/rocky/emacs-test-simple.png)](https://travis-ci.org/rocky/emacs-test-simple) 2 | 3 | *test-simple.el* is : 4 | 5 | * Simple -- no need for context macros, enclosing specifications, or required test tags. But if you want, you still can add custom assert failure messages or add notes before a group of tests. 6 | * Accomodates both interactive and non-interactive use: 7 | * For interactive use one can use `eval-last-sexp`, `eval-region`, and `eval-buffer` 8 | * For non-interactive use run as: `emacs --batch --no-site-file --no-splash --load ` 9 | 10 | I use this in my [Debugger front end](https://github.com/rocky/emacs-dbgr). 11 | 12 | Here is an example found in the [examples directory](https://github.com/rocky/emacs-test-simple/tree/master/test). 13 | 14 | In file `gcd.el`: 15 | 16 | ```emacs-lisp 17 | (defun gcd(a b) 18 | "Greatest Common Divisor of A and B" 19 | ;; Make a < b 20 | (if (> a b) 21 | (let ((c a)) 22 | (setq a b) 23 | (setq b c))) 24 | (cond 25 | ((< a 0) nil) 26 | ((or (= 0 (- b a)) (= a 1)) a) 27 | (t (gcd (- b a) a)) 28 | ) 29 | ) 30 | ``` 31 | 32 | In file `test-gcd.el` in the same directory: 33 | 34 | ```emacs-lisp 35 | (require 'test-simple) 36 | (test-simple-start) ;; Zero counters and start the stop watch. 37 | 38 | ;; Use (load-file) below because we want to always to read the source. 39 | ;; Also, we don't want no stinking compiled source. 40 | (assert-t (load-file "./gcd.el") 41 | "Can't load gcd.el - are you in the right directory?" ) 42 | 43 | (note "degenerate cases") 44 | 45 | (assert-nil (gcd 5 -1) "using positive numbers") 46 | (assert-nil (gcd -4 1) "using positive numbers, switched order") 47 | (assert-raises error (gcd "a" 32) 48 | "Passing a string value should raise an error") 49 | 50 | (note "GCD computations") 51 | (assert-equal 1 (gcd 3 5) "gcd(3,5)") 52 | (assert-equal 8 (gcd 8 32) "gcd(8,32)") 53 | 54 | (end-tests) ;; Stop the clock and print a summary 55 | ``` 56 | 57 | 58 | Edit (with Emacs of course) `test-gcd.el` and run `M-x eval-current-buffer` 59 | 60 | You should see in buffer `*test-simple*`: 61 | 62 | test-gcd.el 63 | ...... 64 | 0 failures in 6 assertions (0.002646 seconds) 65 | 66 | Now let's try from a command line: 67 | 68 | $ emacs --batch --no-site-file --no-splash --load test-gcd.el 69 | Loading /src/external-vcs/emacs-test-simple/example/gcd.el (source)... 70 | *scratch* 71 | ...... 72 | 0 failures in 6 assertions (0.000723 seconds) 73 | 74 | You can run noninteractive tests inside Emacs by `test-simple-run`. 75 | Add the following at a test file: 76 | 77 | ;;;; (test-simple-run "emacs -batch -L %s -l %s" (file-name-directory (locate-library "test-simple.elc")) buffer-file-name) 78 | 79 | Press C-x C-e at the `test-simple-run` line to run this test file. 80 | Then press C-x C-z, which is customizable by `test-simple-runner-key`, to run it more. 81 | If you have installed `bpr` package, use it by default because it only pops up window when the running program exits abnormally. 82 | 83 | `test-simple-run` can be called interactively. 84 | In this case, the command line is set above as the simplest case. 85 | But you run test with dependency, you must use the sexp comment form. 86 | 87 | ;;;; (test-simple-run "emacs -batch -L %s -L %s -l %s" (file-name-directory (locate-library "test-simple.elc")) (file-name-directory (locate-library "foo")) buffer-file-name) 88 | 89 | *Author:* Rocky Bernstein
90 | [![endorse](https://api.coderwall.com/rocky/endorsecount.png)](https://coderwall.com/rocky) 91 | -------------------------------------------------------------------------------- /ChangeLog: -------------------------------------------------------------------------------- 1 | 2015-11-11 R. Bernstein 2 | 3 | * : Merge pull request #10 from syohex/switch-to-cask Switch from Carton to Cask 4 | 5 | 2015-11-10 rocky 6 | 7 | * README.md, test-simple.el: A spelling typo 8 | 9 | 2015-11-10 rocky 10 | 11 | * test-simple.el: Remove unused lexical variables noted in byte 12 | compilation 13 | 14 | 2015-11-10 R. Bernstein 15 | 16 | * : Merge pull request #9 from rubikitch/test-runner I improved noninteractive test. Thanks! 17 | 18 | 2015-11-11 rubikitch 19 | 20 | * test-simple.el: test-simple-run: make it a command. 21 | 22 | 2015-11-11 rubikitch 23 | 24 | * .travis.yml: .travis.yml: Drop support of Emacs23 (Test in 25 | Emacs24) 26 | 27 | 2015-11-10 rubikitch 28 | 29 | * README.md: Mention test-simple-run in README.md 30 | 31 | 2015-11-10 rubikitch 32 | 33 | * example/gcd-tests.el: gcd-tests.el: Add test-simple-run comment 34 | line 35 | 36 | 2015-11-10 rubikitch 37 | 38 | * test-simple.el: Emacs exits abnormally when noninteractive test 39 | fails. 40 | 41 | 2015-11-10 rubikitch 42 | 43 | * test-simple.el: New function `test-simple-run': register test You can run tests easily by pressing C-x C-z. 44 | 45 | 2015-10-25 rocky 46 | 47 | * Makefile.am: Document targets "check-short" and "install-short" 48 | 49 | 2015-10-25 R. Bernstein 50 | 51 | * : Merge pull request #8 from rubikitch/rename-test-filename Rename test-gcd.el -> gcd-tests.el to comply with Melpa 52 | 53 | 2015-10-22 R. Bernstein 54 | 55 | * : Merge pull request #6 from rubikitch/better-failure-message Use %S to print expected/actual message. 56 | 57 | 2015-03-31 rocky 58 | 59 | * Makefile.am, test-simple.el: Wrong number of args in test-raises 60 | 61 | 2015-02-16 rocky 62 | 63 | * test/test-basic.el, test/test-fns.el, test/test-no-clear.el: 64 | Reduce boilerplate verbiage 65 | 66 | 2015-02-15 rocky 67 | 68 | * test-simple.el: Bump version # 69 | 70 | 2015-02-15 rocky 71 | 72 | * Makefile.am, copyright_exceptions, example/gcd.el, 73 | example/test-gcd.el, test-simple.el, test/test-basic.el, 74 | test/test-fns.el, test/test-no-clear.el: Assign FSF Copyright and 75 | boilerplate. 76 | 77 | 2015-02-13 rocky 78 | 79 | * COPYING: Use GPL3 80 | 81 | 2014-12-16 rocky 82 | 83 | * test-simple.el: Release 1.0 84 | 85 | 2014-12-16 rocky 86 | 87 | * NEWS, configure.ac: 1.0 release 88 | 89 | 2014-08-04 rocky 90 | 91 | * Makefile.am, make-check-filter.rb: Go over Makefile.am. Add 92 | check-terse and install-terse 93 | 94 | 2014-08-04 R. Bernstein 95 | 96 | * : Merge pull request #4 from mar-kolya/fix-configure-prefix Fix configure --prefix 97 | 98 | 2014-03-26 rocky 99 | 100 | * test-simple.el: assert-raises was passing an extra arg to 101 | assert-t. 102 | 103 | 2013-09-23 R. Bernstein 104 | 105 | * : Merge pull request #2 from elbeardmorez/autoreconf autoreconf, don't force update 106 | 107 | 2013-09-23 Pete Beardmore 108 | 109 | * configure.ac: autoconf, fall back to default datadir install 110 | location 111 | 112 | 2013-09-23 Pete Beardmore 113 | 114 | * autogen.sh: autoreconf, don't force update 115 | 116 | 2013-07-10 rocky 117 | 118 | * README.md: grammar typo 119 | 120 | 2013-07-10 rocky 121 | 122 | * Carton, test-simple.el: Try using Carton packaging 123 | 124 | 2013-06-14 rocky 125 | 126 | * README.md: Add coderwall endorse 127 | 128 | 2013-06-13 rocky 129 | 130 | * install-from-git.sh: Put back in git clone of emacs-test-simple 131 | 132 | 2013-06-13 rocky 133 | 134 | * README.md: Correct travis status image link 135 | 136 | 2013-06-13 rocky 137 | 138 | * configure.ac, elisp-comp: This emacs package doesn't need any 139 | other of my emacs packages 140 | 141 | 2013-06-13 rocky 142 | 143 | * .travis.yml: Try travis build with emacs23-nox 144 | 145 | 2013-06-13 rocky 146 | 147 | * .travis.yml: Is this .travis.yml okay now? 148 | 149 | 2013-06-13 rocky 150 | 151 | * .gitignore, .travis.yml, README.md, autogen.sh: Try travis 152 | 153 | 2013-06-12 rocky 154 | 155 | * : commit 8dffab4a27d99dc78b9b6e35b300b90eccfa7078 Author: rocky 156 | Date: Wed Jun 12 05:22:14 2013 -0400 157 | 158 | 2013-04-10 rocky 159 | 160 | * test-simple.el: Go over documentation yet again. 161 | 162 | 2013-04-06 rocky 163 | 164 | * configure.ac: tidy organization of configure.ac 165 | 166 | 2013-04-06 rocky 167 | 168 | * compute-lispdir.sh, configure.ac, install-from-git.sh: 169 | install-from-git.sh: forgot to set protocol. rest: Attempt to figure 170 | out a reasonable lispdir setting (--with-lispdir). 171 | 172 | 2013-04-06 rocky 173 | 174 | * .gitignore, install-from-git.sh: Go over install-from-git.sh 175 | 176 | 2013-04-06 rocky 177 | 178 | * INSTALL: One more change 179 | 180 | 2013-04-06 rocky 181 | 182 | * INSTALL, Makefile.am, README.md, README.textile, test-simple.el: 183 | Go over install instructions. 184 | 185 | 2013-04-06 rocky 186 | 187 | * test-simple.el: Yet more doc text tweaking 188 | 189 | 2013-04-06 rocky 190 | 191 | * test-simple.el: More doc fixes 192 | 193 | 2013-04-05 rocky 194 | 195 | * test-simple.el: Revise documentation. 196 | 197 | 2013-04-01 rocky 198 | 199 | * elisp-comp: Reinstate old elisp-comp. 200 | 201 | 2013-04-01 rocky 202 | 203 | * test-simple.el: Add a couple of autoloads 204 | 205 | 2013-04-01 rocky 206 | 207 | * Makefile.am, THANKS: Thanks to Lars expez 208 | 209 | 2013-04-01 R. Bernstein 210 | 211 | * : Merge pull request #1 from expez/package Changes to be compatible with melpa 212 | 213 | 2013-03-27 Expez 214 | 215 | * test-simple.el: Add required version header. 216 | 217 | 2013-03-27 Expez 218 | 219 | * test-simple.el: Remove trailing whitespace. 220 | 221 | 2012-08-25 rocky 222 | 223 | * README.textile: The grammar again 224 | 225 | 2012-08-25 rocky 226 | 227 | * README.textile: The grammar again 228 | 229 | 2012-08-25 rocky 230 | 231 | * README.textile: The grammar again 232 | 233 | 2012-08-25 rocky 234 | 235 | * README.textile: See above 236 | 237 | 2012-08-25 rocky 238 | 239 | * README.textile: textile doesn't do backtick. 240 | 241 | 2012-08-25 rocky 242 | 243 | * Makefile.am, README.textile, example/gcd.el, example/test-gcd.el: 244 | Add a simple example showing how to use. 245 | 246 | 2012-06-17 rocky 247 | 248 | * : commit 56bf795427329ff51afdfe216348ef08314f9446 Author: rocky 249 | Date: Sun Jun 17 06:39:24 2012 -0400 250 | 251 | 2012-06-15 rocky 252 | 253 | * test-simple.el: See what happens with TAP output. 254 | 255 | 2012-06-15 rocky 256 | 257 | * README.textile: Correct textile markup 258 | 259 | 2012-06-15 rocky 260 | 261 | * README.textile: Fill in a little more. 262 | 263 | 2012-06-14 rocky 264 | 265 | * README.textile: Update what's afoot 266 | 267 | 2012-06-14 rocky 268 | 269 | * README.textile: Update what's afoot 270 | 271 | 2012-06-14 rocky 272 | 273 | * Makefile.am, test-simple.el, test/basic.el, test/fns.el, 274 | test/test-basic.el, test/test-fns.el, test/test-no-clear.el: 275 | test-simple no longer requires (test-simple-start). Just start. 276 | Straighten out Makefile system for making tests/checks. 277 | 278 | 2012-06-10 rocky 279 | 280 | * : commit b3485db554d15dce6e5fa8b7c3e77fe01ab57b0c Author: rocky 281 | Date: Sun Jun 10 12:48:30 2012 -0400 282 | 283 | 2012-06-10 rocky 284 | 285 | * test-simple.el: Insert file or buffer name into test info. 286 | 287 | 2012-06-10 rocky 288 | 289 | * test-simple.el, test/basic.el: Add test-eql and test-eq. Small 290 | improvement in interactive use. 291 | 292 | 2012-06-05 rocky 293 | 294 | * Makefile.am, common.mk, configure.ac, make-check-filter.rb, 295 | test-simple.el, test/.gitignore, test/Makefile.am, test/fns.el: Much 296 | improved. "make check-short" added. Give elapsed time in 297 | microseconds. test-imple-verbosity controls output verboseness. More 298 | normal test output now. 299 | 300 | 2012-06-04 rocky 301 | 302 | * test-simple.el, test/fns.el: "context" -> test-simple-info. Allow 303 | passing such a structure. 304 | 305 | 2012-06-03 rocky 306 | 307 | * .gitignore, Makefile.am, test-simple.el, test/basic.el, 308 | test/fns.el, test/test-simple-basic.el: Start writing tests for the 309 | test framework! 310 | 311 | 2012-06-03 rocky 312 | 313 | * test-simple.el, test/test-simple-basic.el: Rewrite more. 314 | 315 | 2012-06-02 rocky 316 | 317 | * .gitignore, test-simple.el, test/test-simple-basic.el: Not quite 318 | working correctly. But closer. 319 | 320 | 2012-06-02 rocky 321 | 322 | * Rework test-unit into something even simpler. 323 | 324 | -------------------------------------------------------------------------------- /test-simple.el: -------------------------------------------------------------------------------- 1 | ;;; test-simple.el --- Simple Unit Test Framework for Emacs Lisp -*- lexical-binding: t -*- 2 | ;; Rewritten from Phil Hagelberg's behave.el by rocky 3 | 4 | ;; Copyright (C) 2015, 2016, 2017, 2020, 2025 Free Software Foundation, Inc 5 | 6 | ;; Author: Rocky Bernstein 7 | ;; URL: https://github.com/rocky/emacs-test-simple 8 | ;; Keywords: unit-test 9 | ;; Package-Requires: ((cl-lib "0")) 10 | ;; Version: 1.3.1 11 | 12 | ;; This program is free software: you can redistribute it and/or 13 | ;; modify it under the terms of the GNU General Public License as 14 | ;; published by the Free Software Foundation, either version 3 of the 15 | ;; License, or (at your option) any later version. 16 | 17 | ;; This program is distributed in the hope that it will be useful, but 18 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 20 | ;; General Public License for more details. 21 | 22 | ;; You should have received a copy of the GNU General Public License 23 | ;; along with this program. If not, see 24 | ;; . 25 | 26 | ;;; Commentary: 27 | 28 | ;; test-simple.el is: 29 | ;; 30 | ;; * Simple. No need for 31 | ;; - context macros, 32 | ;; - enclosing specifications, 33 | ;; - required test tags. 34 | ;; 35 | ;; But if you want, you still can enclose tests in a local scope, 36 | ;; add customized assert failure messages, or add summary messages 37 | ;; before a group of tests. 38 | ;; 39 | ;; * Accommodates both interactive and non-interactive use. 40 | ;; - For interactive use, one can use `eval-last-sexp', `eval-region', 41 | ;; and `eval-buffer'. One can `edebug' the code. 42 | ;; - For non-interactive use, run: 43 | ;; emacs --batch --no-site-file --no-splash --load 44 | ;; 45 | ;; Here is an example using gcd.el found in the examples directory. 46 | ;; 47 | ;; (require 'test-simple) 48 | ;; (test-simple-start) ;; Zero counters and start the stop watch. 49 | ;; 50 | ;; ;; Use (load-file) below because we want to always to read the source. 51 | ;; ;; Also, we don't want no stinking compiled source. 52 | ;; (assert-t (load-file "./gcd.el") 53 | ;; "Can't load gcd.el - are you in the right directory?" ) 54 | ;; 55 | ;; (note "degenerate cases") 56 | ;; 57 | ;; (assert-nil (gcd 5 -1) "using positive numbers") 58 | ;; (assert-nil (gcd -4 1) "using positive numbers, switched order") 59 | ;; (assert-raises error (gcd "a" 32) 60 | ;; "Passing a string value should raise an error") 61 | ;; 62 | ;; (note "GCD computations") 63 | ;; (assert-equal 1 (gcd 3 5) "gcd(3,5)") 64 | ;; (assert-equal 8 (gcd 8 32) "gcd(8,32)") 65 | ;; (end-tests) ;; Stop the clock and print a summary 66 | ;; 67 | ;; Edit (with Emacs of course) gcd-tests.el and run M-x eval-current-buffer 68 | ;; 69 | ;; You should see in buffer *test-simple*: 70 | ;; 71 | ;; gcd-tests.el 72 | ;; ...... 73 | ;; 0 failures in 6 assertions (0.002646 seconds) 74 | ;; 75 | ;; Now let us try from a command line: 76 | ;; 77 | ;; $ emacs --batch --no-site-file --no-splash --load gcd-tests.el 78 | ;; Loading /src/external-vcs/emacs-test-simple/example/gcd.el (source)... 79 | ;; *scratch* 80 | ;; ...... 81 | ;; 0 failures in 6 assertions (0.000723 seconds) 82 | 83 | ;;; To do: 84 | 85 | ;; FIXME: Namespace is all messed up! 86 | ;; Main issues: more expect predicates 87 | 88 | (require 'time-date) 89 | 90 | ;;; Code: 91 | 92 | (require 'cl-lib) 93 | 94 | (defgroup test-simple nil 95 | "Simple Unit Test Framework for Emacs Lisp" 96 | :group 'lisp) 97 | 98 | (defcustom test-simple-runner-interface 99 | (if (fboundp 'bpr-spawn) 100 | 'bpr-spawn 101 | 'compile) 102 | "Function with one string argument when running tests non-interactively. 103 | Command line started with `emacs --batch' is passed as the argument. 104 | 105 | `bpr-spawn', which is in bpr package, is preferable because of no window popup. 106 | If bpr is not installed, fall back to `compile'." 107 | :type 'function 108 | :group 'test-simple) 109 | 110 | (defcustom test-simple-runner-key "C-x C-z" 111 | "Key to run non-interactive test after defining command line by `test-simple-run'." 112 | :type 'string 113 | :group 'test-simple) 114 | 115 | (defvar test-simple-debug-on-error nil 116 | "If non-nil raise an error on the first failure.") 117 | 118 | (defvar test-simple-verbosity 0 119 | "The greater the number the more verbose output.") 120 | 121 | (cl-defstruct 122 | test-info 123 | description ;; description of last group of tests 124 | (assert-count 0) ;; total number of assertions run 125 | (failure-count 0) ;; total number of failures seen 126 | (start-time (current-time)) ;; Time run started 127 | ) 128 | 129 | (defvar test-simple-info (make-test-info) 130 | "Variable to store testing information for a buffer.") 131 | 132 | (defun note (description &optional test-info) 133 | "Add a name to a group of tests." 134 | (if (getenv "USE_TAP") 135 | (test-simple-msg (format "# %s" description) 't) 136 | (if (> test-simple-verbosity 0) 137 | (test-simple-msg (concat "\n" description) 't)) 138 | (unless test-info 139 | (setq test-info test-simple-info)) 140 | (setf (test-info-description test-info) description))) 141 | 142 | ;;;###autoload 143 | (defmacro test-simple-start (&optional test-start-msg) 144 | `(test-simple-clear 145 | nil 146 | (or ,test-start-msg 147 | (if (and (functionp '__FILE__) (__FILE__)) 148 | (file-name-nondirectory (__FILE__)) 149 | (buffer-name))))) 150 | 151 | ;;;###autoload 152 | (defun test-simple-clear (&optional test-info test-start-msg) 153 | "Initialize and reset everything to run tests. 154 | You should run this before running any assertions. Running more than once 155 | clears out information from the previous run." 156 | 157 | (interactive) 158 | 159 | (unless test-info 160 | (unless test-simple-info 161 | (make-variable-buffer-local 162 | (defvar test-simple-info (make-test-info)))) 163 | (setq test-info test-simple-info)) 164 | 165 | (setf (test-info-description test-info) "none set") 166 | (setf (test-info-start-time test-info) (current-time)) 167 | (setf (test-info-assert-count test-info) 0) 168 | (setf (test-info-failure-count test-info) 0) 169 | 170 | (with-current-buffer (get-buffer-create "*test-simple*") 171 | (let ((old-read-only inhibit-read-only)) 172 | (setq inhibit-read-only 't) 173 | (delete-region (point-min) (point-max)) 174 | (if test-start-msg 175 | (insert (format "%s\n" test-start-msg))) 176 | (setq inhibit-read-only old-read-only))) 177 | (unless noninteractive 178 | (message "Test-Simple: test information cleared"))) 179 | 180 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 181 | ;; Assertion tests 182 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 183 | 184 | (defmacro assert-raises (error-condition body &optional fail-message) 185 | (let ((fail-message 186 | (or fail-message 187 | (format "assert-raises did not get expected %s" 188 | error-condition)))) 189 | (list 190 | 'condition-case 191 | nil 192 | (list 'progn body (list 'assert-t nil fail-message)) 193 | (list error-condition '(assert-t t))))) 194 | 195 | (defun assert-op (op expected actual &optional fail-message test-info) 196 | "Expectation is that ACTUAL should be equal to EXPECTED." 197 | (unless test-info 198 | (setq test-info test-simple-info)) 199 | (cl-incf (test-info-assert-count test-info)) 200 | (if (not (funcall op actual expected)) 201 | (let* ((fail-message 202 | (if fail-message 203 | (format "Message: %s" fail-message) 204 | "")) 205 | (expect-message 206 | (format "\n Expected: %S\n Got: %S" expected actual)) 207 | (test-info-mess 208 | (if (boundp 'test-info) 209 | (test-info-description test-info) 210 | "unset"))) 211 | (test-simple--add-failure 212 | (format "assert-%s" op) 213 | test-info-mess 214 | (concat fail-message expect-message))) 215 | (test-simple--ok-msg fail-message))) 216 | 217 | (defun assert-equal (expected actual &optional fail-message test-info) 218 | "Expectation is that ACTUAL should be equal to EXPECTED." 219 | (assert-op 'equal expected actual fail-message test-info)) 220 | 221 | (defun assert-eq (expected actual &optional fail-message test-info) 222 | "Expectation is that ACTUAL should be EQ to EXPECTED." 223 | (assert-op 'eq expected actual fail-message test-info)) 224 | 225 | (defun assert-eql (expected actual &optional fail-message test-info) 226 | "Expectation is that ACTUAL should be EQL to EXPECTED." 227 | (assert-op 'eql expected actual fail-message test-info)) 228 | 229 | (defun assert-matches 230 | (expected-regexp actual &optional fail-message test-info) 231 | "Expectation is that ACTUAL should match EXPECTED-REGEXP." 232 | (unless test-info 233 | (setq test-info test-simple-info)) 234 | (cl-incf (test-info-assert-count test-info)) 235 | (if (not (string-match expected-regexp actual)) 236 | (let* ((fail-message 237 | (if fail-message 238 | (format "\n\tMessage: %s" fail-message) 239 | "")) 240 | (expect-message 241 | (format "\tExpected Regexp: %s\n\tGot: %s" 242 | expected-regexp actual)) 243 | (test-info-mess 244 | (if (boundp 'test-info) 245 | (test-info-description test-info) 246 | "unset"))) 247 | (test-simple--add-failure 248 | "assert-equal" 249 | test-info-mess 250 | (concat expect-message fail-message))) 251 | (progn 252 | (test-simple-msg ".") 253 | t))) 254 | 255 | (defun assert-t (actual &optional fail-message test-info) 256 | "expectation is that ACTUAL is not nil." 257 | (assert-nil (not actual) fail-message test-info)) 258 | 259 | (defun assert-nil (actual &optional fail-message test-info) 260 | "expectation is that ACTUAL is nil. FAIL-MESSAGE is an optional 261 | additional message to be displayed." 262 | (unless test-info 263 | (setq test-info test-simple-info)) 264 | (cl-incf (test-info-assert-count test-info)) 265 | (if actual 266 | (let* ((fail-message 267 | (if fail-message 268 | (format "\n\tMessage: %s" fail-message) 269 | "")) 270 | (test-info-mess 271 | (if (boundp 'test-simple-info) 272 | (test-info-description test-simple-info) 273 | "unset"))) 274 | (test-simple--add-failure 275 | "assert-nil" test-info-mess fail-message 276 | test-info)) 277 | (test-simple--ok-msg fail-message))) 278 | 279 | (defun test-simple--add-failure 280 | (type test-info-msg fail-msg &optional test-info) 281 | (unless test-info 282 | (setq test-info test-simple-info)) 283 | (cl-incf (test-info-failure-count test-info)) 284 | (let ((failure-msg 285 | (format "\nDescription: %s, type %s\n%s" 286 | test-info-msg 287 | type 288 | fail-msg))) 289 | (save-excursion 290 | (test-simple--not-ok-msg fail-msg) 291 | (test-simple-msg failure-msg 't) 292 | (unless noninteractive 293 | (if test-simple-debug-on-error 294 | (signal 'test-simple-assert-failed failure-msg) 295 | ;;(message failure-msg) 296 | ))))) 297 | 298 | (defun end-tests (&optional test-info) 299 | "Give a tally of the tests run." 300 | (interactive) 301 | (unless test-info 302 | (setq test-info test-simple-info)) 303 | (test-simple-describe-failures test-info) 304 | (cond 305 | (noninteractive 306 | (set-buffer "*test-simple*") 307 | (cond 308 | ((getenv "USE_TAP") 309 | (princ (format "%s\n" (buffer-string)))) 310 | (t ;; non-TAP goes to stderr (backwards compatibility) 311 | (message "%s" (buffer-substring (point-min) (point-max)))))) 312 | (t ;; interactive 313 | (switch-to-buffer-other-window "*test-simple*")))) 314 | 315 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 316 | ;; Reporting 317 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 318 | 319 | (defun test-simple-msg (msg &optional newline) 320 | (with-current-buffer "*test-simple*" 321 | (let ((inhibit-read-only t)) 322 | (insert msg) 323 | (if newline 324 | (insert "\n"))))) 325 | 326 | (defun test-simple--ok-msg (fail-message &optional test-info) 327 | (unless test-info 328 | (setq test-info test-simple-info)) 329 | (let ((msg 330 | (if (getenv "USE_TAP") 331 | (if (equal fail-message "") 332 | (format "ok %d\n" (test-info-assert-count test-info)) 333 | (format "ok %d - %s\n" 334 | (test-info-assert-count test-info) 335 | fail-message)) 336 | "."))) 337 | (test-simple-msg msg)) 338 | 't) 339 | 340 | (defun test-simple--not-ok-msg (_fail-message &optional test-info) 341 | (unless test-info 342 | (setq test-info test-simple-info)) 343 | (let ((msg 344 | (if (getenv "USE_TAP") 345 | (format "not ok %d\n" (test-info-assert-count test-info)) 346 | "F"))) 347 | (test-simple-msg msg)) 348 | nil) 349 | 350 | (defun test-simple-summary-line (info) 351 | (let* ((failures (test-info-failure-count info)) 352 | (asserts (test-info-assert-count info)) 353 | (problems 354 | (concat 355 | (number-to-string failures) " failure" 356 | (unless (= 1 failures) 357 | "s"))) 358 | (tests 359 | (concat 360 | (number-to-string asserts) " assertion" 361 | (unless (= 1 asserts) 362 | "s"))) 363 | (elapsed-time (time-since (test-info-start-time info)))) 364 | (if (getenv "USE_TAP") 365 | (format "1..%d" asserts) 366 | (format "\n%s in %s (%g seconds)" 367 | problems 368 | tests 369 | (float-time elapsed-time))))) 370 | 371 | (defun test-simple-describe-failures (&optional test-info) 372 | (unless test-info 373 | (setq test-info test-simple-info)) 374 | (goto-char (point-max)) 375 | (test-simple-msg (test-simple-summary-line test-info))) 376 | 377 | ;;;###autoload 378 | (defun test-simple-run (&rest command-line-formats) 379 | "Register command line to run tests non-interactively and bind key to run test. 380 | After calling this function, you can run test by key specified by `test-simple-runner-key'. 381 | 382 | It is preferable to write at the first line of test files as a comment, e.g, 383 | ;;;; (test-simple-run \"emacs -batch -L %s -l %s\" (file-name-directory (locate-library \"test-simple.elc\")) buffer-file-name) 384 | 385 | Calling this function interactively, COMMAND-LINE-FORMATS is set above." 386 | (interactive) 387 | (setq command-line-formats 388 | (or command-line-formats 389 | (list 390 | "emacs -batch -L %s -l %s" 391 | (file-name-directory (locate-library "test-simple.elc")) 392 | buffer-file-name))) 393 | (let ((func 394 | (lambda () 395 | (interactive) 396 | (funcall test-simple-runner-interface 397 | (apply 'format command-line-formats))))) 398 | (global-set-key (kbd test-simple-runner-key) func) 399 | (funcall func))) 400 | 401 | (defun test-simple-noninteractive-kill-emacs-hook () 402 | "Emacs exits abnormally when noninteractive test fails." 403 | (when (and noninteractive 404 | test-simple-info 405 | (<= 1 (test-info-failure-count test-simple-info))) 406 | (let (kill-emacs-hook) 407 | (kill-emacs 1)))) 408 | (when noninteractive 409 | (add-hook 410 | 'kill-emacs-hook 'test-simple-noninteractive-kill-emacs-hook)) 411 | 412 | 413 | (provide 'test-simple) 414 | ;;; test-simple.el ends here 415 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------