From 14e373d3f14c9fe1946dc4ab5de3689e009de670 Mon Sep 17 00:00:00 2001 From: David Paleino Date: Sun, 22 Nov 2009 08:30:16 +0100 Subject: [PATCH] Remove generated HTML documentation, add it to gitignore --- .gitignore | 2 + doc/html~/main.html | 202 -------------------------------------------- 2 files changed, 2 insertions(+), 202 deletions(-) delete mode 100644 doc/html~/main.html diff --git a/.gitignore b/.gitignore index 8f8a93ce..012d65b3 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ configure install-sh missing doc/*.xml +*~ +doc/html* diff --git a/doc/html~/main.html b/doc/html~/main.html deleted file mode 100644 index a4e5d6ef..00000000 --- a/doc/html~/main.html +++ /dev/null @@ -1,202 +0,0 @@ - -Bash-completion

Bash-completion

Freddy Vulto (FVu)

Revision History
Revision 1.0Mar 2009FV(

Table of Contents

Preface
I. Bash completion
1. Environment variables
II. Coding Style Guide
2. Introduction
III. Automated testing
3. Introduction
4. Installing dependencies
4.1. Debian/Ubuntu
4.2. Fedora/RHEL/CentOS
5. Structure
5.1. Main areas (DejaGnu tools)
6. Running the tests
6.1. Running tests via cron
6.2. Specifying bash binary
7. Maintenance
7.1. Adding a completion test
7.2. Fixing a completion test
7.3. Fixing a unit test
8. Rationale
8.1. Naming conventions
8.1.1. Test suite or testsuite
8.1.2. script/generate
9. Reference
10. Test context
10.1. What happens when tests are run?
10.1.1. completion
10.1.2. install
10.1.3. unit
10.2. bashrc
10.3. inputrc
Index

List of Examples

10.1. What happens when completion tests are run?
10.2. What happens when install tests are run?
10.3. What happens when unit tests are run?

Preface

Bash completion extends bashs standard completion behavior to achieve -complex command lines with just a few keystrokes. This project was -conceived to produce programmable completion routines for the most -common Linux/UNIX commands, reducing the amount of typing sysadmins -and programmers need to do on a daily basis.

Part I. Bash completion

Table of Contents

1. Environment variables

Chapter 1. Environment variables

-COMP_CONFIGURE_HINTS -
- If set and not null, configure completion will return the entire option - string (e.g. --this-option=DESCRIPTION) so one can see what kind of data - is required and then simply delete the descriptive text and add one’s own - data. If unset or null (default), configure completion will strip - everything after the = when returning completions. -
-COMP_CVS_REMOTE -
- If set and not null, cvs commit completion will try to complete on - remotely checked-out files. This requires passwordless access to the - remote repository. Default is unset. -
-COMP_KNOWN_HOSTS_WITH_HOSTFILE -
- If set and not null (default), known_hosts completion will complement - hostnames from ssh’s known_hosts_files with hostnames taken from the file - specified by the HOSTFILE shell variable (compgen -A hostname). If null, - known_hosts completion will omit hostnames from HOSTFILE. Omitting - hostnames from HOSTFILE is useful if HOSTFILE contains many entries for - local web development or ad-blocking. -
-COMP_TAR_INTERNAL_PATHS -
- If set and not null before sourcing bash_completion, ‘tar` completion - will do correct path completion for tar file contents. If unset or null, - `tar’ completion will do correct completion for paths to tar files. See - also README. -

Part II. Coding Style Guide

Table of Contents

2. Introduction

Chapter 2. Introduction

This document attempts to explain the basic styles and patterns that are used in the bash completion. New code should try to conform to these standards so that it is as easy to maintain as existing code. Of course every rule has an exception, but it’s important to know the rules nonetheless!

This is particularly directed at people new to the bash completion codebase, who are in the process of getting their code reviewed. Before getting a review, please read over this document and make sure your code conforms to the recommendations here.

Part III. Automated testing

Table of Contents

3. Introduction
4. Installing dependencies
4.1. Debian/Ubuntu
4.2. Fedora/RHEL/CentOS
5. Structure
5.1. Main areas (DejaGnu tools)
6. Running the tests
6.1. Running tests via cron
6.2. Specifying bash binary
7. Maintenance
7.1. Adding a completion test
7.2. Fixing a completion test
7.3. Fixing a unit test
8. Rationale
8.1. Naming conventions
8.1.1. Test suite or testsuite
8.1.2. script/generate
9. Reference
10. Test context
10.1. What happens when tests are run?
10.1.1. completion
10.1.2. install
10.1.3. unit
10.2. bashrc
10.3. inputrc

Chapter 3. Introduction

The bash-completion package contains an automated test suite. Running the tests should help verifying that bash-completion works as expected. The tests are also very helpful in uncovering software regressions at an early stage.

The bash-completion test suite is written on top of the DejaGnu testing framework. DejaGnu is written in Expect, which in turn uses Tcl — Tool command language.

Chapter 4. Installing dependencies

Table of Contents

4.1. Debian/Ubuntu
4.2. Fedora/RHEL/CentOS

Installing dependencies should be easy using your local package manager.

4.1. Debian/Ubuntu

On Debian/Ubuntu you can use apt-get:

sudo apt-get install dejagnu tcllib

This should also install the necessary expect and tcl packages.

4.2. Fedora/RHEL/CentOS

On Fedora and RHEL/CentOS (with EPEL) you can use yum:

sudo yum install dejagnu tcllib

This should also install the necessary expect and tcl packages.

Chapter 5. Structure

Table of Contents

5.1. Main areas (DejaGnu tools)

5.1. Main areas (DejaGnu tools)

The tests are grouped into different areas, called tool in DejaGnu:

-completion -
- Functional tests per completion. -
-install -
- Functional tests for installation and caching of the main bash-completion package. -
-unit -
- Unit tests for bash-completion helper functions. -

Each tool has a slightly different way of loading the test fixtures, see Test context below.

Chapter 6. Running the tests

Table of Contents

6.1. Running tests via cron
6.2. Specifying bash binary

The tests are run by calling runtest in the test directory:

runtest --outdir log --tool completion
-runtest --outdir log --tool install
-runtest --outdir log --tool unit

The commands above are already wrapped up in shell scripts within the test directory:

./runCompletion
-./runInstall
-./runUnit

6.1. Running tests via cron

The test suite requires a connected terminal (tty). When invoked via cron, no tty is connected and the test suite may respond with this error:

can't read "multipass_name": no such variable

To run the tests successfully via cron, connect a terminal by redirecting stdin from a tty, e.g. /dev/tty50:

./runUnit < /dev/tty50

If the process doesn’t run as root, root will have to change the owner and -permissions of the tty.

In Linux, you can press alt-Fx or ctrl-alt-Fx to switch the console from -/dev/tty1 to tty7. There are many more /dev/tty* which are not accessed via -function keys. To be safe, use a tty greater than tty7?

6.2. Specifying bash binary

The test suite standard uses bash as found in the tcl path (/bin/bash). Using --tool_exec you can specify which bash binary you want to run the test suite against, e.g.:

./runUnit --tool_exec /opt/bash-4.0/bin/bash

Chapter 7. Maintenance

Table of Contents

7.1. Adding a completion test
7.2. Fixing a completion test
7.3. Fixing a unit test

7.1. Adding a completion test

You can run cd test && ./generate to add a test.

7.2. Fixing a completion test

Let’s consider this real-life example where an ssh completion bug is fixed. First you’re triggered by unsuccessful tests:

$ ./runCompletion
-...
-                === completion Summary ===
-
-# of expected passes            283
-# of unexpected failures        8
-# of unresolved testcases       2
-# of unsupported tests          47

Take a look in log/completion.log to find out which specific command is failing.

$ vi log/completion.log

Search for UNRESOLVED or FAIL. From there scroll up to see which .exp test is failing:

/@Running ./completion/ssh.exp ...
-...
-UNRESOLVED: Tab should complete ssh known-hosts at prompt

In this case it appears ssh.exp is causing the problem. Isolate the ssh tests by specifying just ssh.exp to run. Furthermore add the --debug flag, so output gets logged in dbg.log:

$ ./runCompletion ssh.exp --debug
-...
-                === completion Summary ===
-
-# of expected passes            1
-# of unresolved testcases       1

Now we can have a detailed look in dbg.log to find out what’s going wrong. Open dbg.log and search for UNRESOLVED (or FAIL if that’s what you’re looking for):

UNRESOLVED: Tab should complete ssh known-hosts at prompt

From there, search up for the first line saying:

expect: does "..." match regular expression "..."

This tells you where the actual output differs from the expected output. In this case it looks like the test "ssh -F fixtures/ssh/config <TAB>" is expecting just hostnames, whereas the actual completion is containing commands - but no hostnames. -So what should be expected after "ssh -F fixtures/ssh/config <TAB>" are both commands and hostnames. This means both the test and the completion need fixing. Let’s start with the test.

$ vi lib/completions/ssh.exp

Search for the test "Tab should complete ssh known-hosts". Here you could’ve seen that what was expected were hostnames ($hosts):

set expected "^$cmd\r\n$hosts\r\n/@$cmd$"

Adding all commands (which could well be over 2000) to expected, seems a bit overdone so we’re gonna change things here. Lets expect the unit test for _known_hosts assures all hosts are returned. Then all we need to do here is expect one host and one command, just to be kind of sure that both hosts and commands are completed.

Looking in the fixture for ssh:

$ vi fixtures/ssh/known_hosts

it looks like we can add an additional host ls_known_host. Now if we would perform the test "ssh -F fixtures/ssh/config ls<TAB>" both the command ls and the host ls_known_host should come up. Let’s modify the test so:

$ vi lib/completions/ssh.exp
-...
-set expected "^$cmd\r\n.*ls.*ls_known_host.*\r\n/@$cmd$"

Running the test reveals we still have an unresolved test:

$ ./runCompletion ssh.exp --debug
-...
-                === completion Summary ===
-
-# of expected passes            1
-# of unresolved testcases       1

But if now look into the log file ‘dbg.log` we can see the completion only returns commands starting with ls but fails to match our regular expression which also expects the hostname `ls_known_host’:

$ vi dbg.log
-...
-expect: does "ssh -F fixtures/ssh/config ls\r\nls           lsattr       lsb_release  lshal        lshw         lsmod        lsof         lspci        lspcmcia     lspgpot      lss16toppm\r\nlsusb\r\n/@ssh -F fixtures/ssh/config ls" (spawn_id exp9) match regular expression "^ssh -F fixtures/ssh/config ls\r\n.*ls.*ls_known_host.*\r\n/@ssh -F fixtures/ssh/config ls$"? no

Now let’s fix ssh completion:

$ vi ../contrib/ssh
-...

until the test shows:

$ ./runCompletion ssh.exp
-...
-                === completion Summary ===
-
-# of expected passes            2

7.3. Fixing a unit test

Now let’s consider a unit test failure. First you’re triggered by unsuccessful tests:

$ ./runUnit
-...
-                === unit Summary ===
-
-# of expected passes            1
-# of unexpected failures        1

Take a look in log/unit.log to find out which specific command is failing.

$ vi log/unit.log

Search for UNRESOLVED or FAIL. From there scroll up to see which .exp test is failing:

/@Running ./unit/_known_hosts_real.exp ...
-...
-FAIL: Environment should stay clean

In this case it appears _known_hosts_real.exp is causing the problem. Isolate the _known_hosts_real test by specifying just _known_hosts_real.exp to run. Furthermore add the --debug flag, so output gets logged in dbg.log:

$ ./runUnit _known_hosts_real.exp --debug
-...
-                === completion Summary ===
-
-# of expected passes            1
-# of unexpected failures        1

Now, if we haven’t already figured out the problem, we can have a detailed look in dbg.log to find out what’s going wrong. Open dbg.log and search for UNRESOLVED (or FAIL if that’s what you’re looking for):

FAIL: Environment should stay clean

From there, search up for the first line saying:

expect: does "..." match regular expression "..."

This tells you where the actual output differs from the expected output. In this case it looks like the the function _known_hosts_real is unexpectedly modifying global variables cur and flag. In case you need to modify the test:

$ vi lib/unit/_known_hosts_real.exp

Chapter 8. Rationale

Table of Contents

8.1. Naming conventions
8.1.1. Test suite or testsuite
8.1.2. script/generate

8.1. Naming conventions

8.1.1. Test suite or testsuite

The primary Wikipedia page is called -test suite and not testsuite, so that’s what this -document sticks to.

8.1.2. script/generate

The name and location of this code generation script come from Ruby on Rails' script/generate.

Chapter 9. Reference

Within test scripts the following library functions can be used:

Chapter 10. Test context

Table of Contents

10.1. What happens when tests are run?
10.1.1. completion
10.1.2. install
10.1.3. unit
10.2. bashrc
10.3. inputrc

The test environment needs to be put to fixed states when testing. For instance the bash prompt (PS1) is set to the current test directory, followed by an ampersand (@). The default settings for bash reside in config/bashrc and config/inputrc.

For each tool (completion, install, unit) a slightly different context is in effect.

10.1. What happens when tests are run?

10.1.1. completion

When the completions are tested, invoking DejaGnu will result in a call to completion_start() which in turn will start bash --rcfile config/bashrc.

Example 10.1. What happens when completion tests are run?

               | runtest --tool completion
-               V
-    +----------+-----------+
-    |  lib/completion.exp  |
-    |  lib/library.exp     |
-    |  config/default.exp  |
-    +----------+-----------+
-               :
-               V
-    +----------+-----------+    +---------------+    +----------------+
-    |  completion_start()  +<---+ config/bashrc +<---| config/inputrc |
-    | (lib/completion.exp) |    +---------------+    +----------------+
-    +----------+-----------+
-               |                                   ,+----------------------------+
-               |                               ,--+-+  "Actual completion tests" |
-               V                              /   +------------------------------+
-    +----------+-----------+    +-----------------------+
-    |   completion/*.exp   +<---| lib/completions/*.exp |
-    +----------+-----------+    +-----------------------+
-               |          \                        ,+--------------------------------+
-               |           `----------------------+-+  "Completion invocation tests" |
-               V                                  +----------------------------------+
-    +----------+-----------+
-    |   completion_exit()  |
-    | (lib/completion.exp) |
-    +----------------------+

Setting up bash once within completion_start() has the speed advantage that bash - and bash-completion - need only initialize once when testing multiple completions, e.g.:

    runtest --tool completion alias.exp cd.exp

10.1.2. install

Example 10.2. What happens when install tests are run?

                 | runtest --tool install
-                 V
-            +----+----+
-            | DejaGnu |
-            +----+----+
-                 |
-                 V
-    +------------+---------------+
-    | (file: config/default.exp) |
-    +------------+---------------+
-                 |
-                 V
-    +------------+------------+
-    | (file: lib/install.exp) |
-    +-------------------------+

10.1.3. unit

Example 10.3. What happens when unit tests are run?

               | runtest --tool unit
-               V
-          +----+----+
-          | DejaGnu |
-          +----+----+
-               |
-               V
-    +----------+-----------+
-    |          -           |
-    | (file: lib/unit.exp) |
-    +----------------------+

10.2. bashrc

This is the bash configuration file (bashrc) used for testing:

# bashrc file for DejaGnu testsuite
-
-        # Use emacs key bindings
-set -o emacs
-        # Use bash strict mode
-set -o posix
-        # Unset `command_not_found_handle' as defined on Debian/Ubuntu, because this
-        # troubles and slows down testing
-unset -f command_not_found_handle
-        # Set prompt to ignore current root directory; display path starting
-        # from here.  E.g. prompt: /fixtures/@
-TESTDIR=$(pwd)
-export PS1='$(wd=$(pwd); echo ${wd#$TESTDIR}/)@'
-export PS2='> '
-        # Configure readline
-export INPUTRC=$TESTDIR/config/inputrc
-        # Ensure enough columns so expect doesn't have to care about line breaks
-stty columns 150
-
-        # Make sure default settings are in effect
-unset -v \
-    COMP_CONFIGURE_HINTS \
-    COMP_CVS_REMOTE \
-    COMP_KNOWN_HOSTS_WITH_HOSTFILE \
-    COMP_TAR_INTERNAL_PATHS
-
-        # Load bash testsuite helper functions
-. lib/library.sh
-
-# Local variables:
-# mode: shell-script
-# sh-basic-offset: 8
-# sh-indent-comment: t
-# indent-tabs-mode: t
-# End:
-# ex: ts=8 sw=8 noet filetype=sh

10.3. inputrc

This is the readline configuration file (inputrc) used for testing:

# Readline init file for DejaGnu testsuite
-# See: info readline
-
-        # Press TAB once (instead of twice) to auto-complete
-set show-all-if-ambiguous on
-        # No bell.  No ^G in output
-set bell-style none
-        # Don't query user about viewing the number of possible completions
-set completion-query-items -1
-        # Display completions sorted horizontally, not vertically
-set print-completions-horizontally on
-        # Don't use pager when showing completions
-set page-completions off
-
-# Local variables:
-# mode: shell-script
-# sh-basic-offset: 8
-# sh-indent-comment: t
-# indent-tabs-mode: t
-# End:
-# ex: ts=8 sw=8 noet filetype=sh

Index