From: Tomi Ollila Date: Fri, 12 Feb 2016 19:17:00 +0000 (+0200) Subject: [PATCH] test/README: have matching test script file names X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=099dac128df156af47a5a422a241ba9eef378f3e;p=notmuch-archives.git [PATCH] test/README: have matching test script file names --- diff --git a/53/38958ff06e9933934d2ce0cb07401958c42f0d b/53/38958ff06e9933934d2ce0cb07401958c42f0d new file mode 100644 index 000000000..8fc42bd56 --- /dev/null +++ b/53/38958ff06e9933934d2ce0cb07401958c42f0d @@ -0,0 +1,137 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by arlo.cworth.org (Postfix) with ESMTP id A439A6DE0FB0 + for ; Fri, 12 Feb 2016 11:16:49 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at cworth.org +X-Spam-Flag: NO +X-Spam-Score: 0.044 +X-Spam-Level: +X-Spam-Status: No, score=0.044 tagged_above=-999 required=5 tests=[AWL=0.584, + RP_MATCHES_RCVD=-0.55, T_HEADER_FROM_DIFFERENT_DOMAINS=0.01] + autolearn=disabled +Received: from arlo.cworth.org ([127.0.0.1]) + by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id YeuN-feF2Dd2 for ; + Fri, 12 Feb 2016 11:16:47 -0800 (PST) +Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34]) + by arlo.cworth.org (Postfix) with ESMTP id DC3336DE0C51 + for ; Fri, 12 Feb 2016 11:16:46 -0800 (PST) +Received: by guru.guru-group.fi (Postfix, from userid 501) + id 4468510008D; Fri, 12 Feb 2016 21:17:02 +0200 (EET) +From: Tomi Ollila +To: notmuch@notmuchmail.org +Cc: tomi.ollila@iki.fi +Subject: [PATCH] test/README: have matching test script file names +Date: Fri, 12 Feb 2016 21:17:00 +0200 +Message-Id: <1455304620-14588-1-git-send-email-tomi.ollila@iki.fi> +X-Mailer: git-send-email 2.6.4 +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.20 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Fri, 12 Feb 2016 19:16:49 -0000 + +A while ago test script names were changed to format +Tddd-basename.sh. Update README to reflect that. + +While at it, included some small requirements updates. +--- + +'A while ago' here means like 25 months (change was done Jan 2014). +I started doing this change in March 2014 but dropped after got +too exhaustive thoughts of how to continue. Now I did minor change +to make TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient make test +lines fit on 80 columns... + + test/README | 34 ++++++++++++++++++++++++++-------- + 1 file changed, 26 insertions(+), 8 deletions(-) + +diff --git a/test/README b/test/README +index e54e36b..bd9ab54 100644 +--- a/test/README ++++ b/test/README +@@ -8,10 +8,17 @@ enhance. + + Prerequisites + ------------- ++The test system itself requires: ++ ++ - bash(1) version 4.0 or newer ++ ++Without bash 4.0+ the tests just refuse to run. ++ + Some tests require external dependencies to run. Without them, they + will be skipped, or (rarely) marked failed. Please install these, so + that you know if you break anything. + ++ - GNU tar(1) + - dtach(1) + - emacs(1) + - emacsclient(1) +@@ -19,14 +26,21 @@ that you know if you break anything. + - gpg(1) + - python(1) + ++If your system lacks these tools or have older, non-upgreable versions ++of these, please (possibly compile and) install these to some other ++path, for example /usr/local/bin or /opt/gnu/bin. Then prepend the ++chosen directory to your PATH before running the tests. ++ ++e.g. env PATH=/opt/gnu/bin:$PATH make test ++ + Running Tests + ------------- + The easiest way to run tests is to say "make test", (or simply run the + notmuch-test script). Either command will run all available tests. + + Alternately, you can run a specific subset of tests by simply invoking +-one of the executable scripts in this directory, (such as ./search, +-./reply, etc). Note that you will probably want "make test-binaries" ++one of the executable scripts in this directory, (such as ./T*-search.sh, ++./T*-reply.sh, etc). Note that you will probably want "make test-binaries" + before running individual tests. + + The following command-line options are available when running tests: +@@ -80,9 +94,9 @@ can be specified as follows: + You can choose an emacs binary (and corresponding emacsclient) to run + the tests in one of the following ways. + +- TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient make test +- TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs +- make test TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ++ TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient make test ++ TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient ./T*-emacs.sh ++ make test TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient + + Some tests may require a c compiler. You can choose the name and flags similarly + to with emacs, e.g. +@@ -126,9 +140,13 @@ skipped by the user, as failures. + + Writing Tests + ------------- +-The test script is written as a shell script. It should start with +-the standard "#!/usr/bin/env bash" with copyright notices, and an +-assignment to variable 'test_description', like this: ++The test script is written as a shell script. It is to be named as ++Tddd-testname.sh where 'ddd' is three digits and 'testname' the "bare" ++name of your test. Tests will be run in order the 'ddd' part determines. ++ ++The test script should start with the standard "#!/usr/bin/env bash" ++with copyright notices, and an assignment to variable 'test_description', ++like this: + + #!/usr/bin/env bash + # +-- +1.9.3 +