Wait Service

Wait Service is a pure rust program to test and wait on the availability of multiple services.

Help

This is the help output from a Unix build with the json feature enabled.

EXAMPLES:
wait-service --tcp localhost:27017 --tcp localhost:27018   -t 5 -- npm start   # Wait for localhost:27017 and localhost:27018 (max 5 seconds) and then run `npm start`
wait-service --tcp localhost:27017 --uds /var/run/app.sock -t 0 -- npm start   # Wait for localhost:27017 and /var/run/app.sock (forever) and then run `npm start`
wait-service --json /path/to/json                              -- npm start   # Wait for services defined in the JSON file (max 60 seconds) and then run `npm start`

Usage: wait-service [OPTIONS] -- <COMMAND>...

Arguments:
  <COMMAND>...  Command to execute after service is available

Options:
  -t, --timeout <TIMEOUT>  Set the timeout in seconds, zero for no timeout [default: 60]
      --tcp <TCP>...       Test and wait on the availability of TCP services
      --uds <UDS>...       Test and wait on the availability of UDS services [aliases: unix]
      --json <JSON>...     Test and wait on the availability of TCP or UDS services
  -h, --help               Print help information
  -V, --version            Print version information

Services

Each --tcp service is a host:port pair. An IPv6 literal has to be bracketed.

wait-service --tcp 127.0.0.1:8080 --tcp '[::1]:8080' -- npm start

--tcp, --uds and --json all accept multiple values after a single flag, so these two are equivalent.

wait-service --tcp localhost:27017 --tcp localhost:27018 -- npm start
wait-service --tcp localhost:27017 localhost:27018       -- npm start

A host name is resolved with the system resolver first, so /etc/hosts entries are honored, and a direct DNS query is only used as a fallback. A service that cannot be resolved or connected to yet is retried every 500 milliseconds until the timeout expires.

--uds is available only on Unix platforms.

The Config File

The --json option is available only when building with the json feature, for example cargo install wait-service --features json. It imports TCP services and, on Unix platforms, UDS services from one or more JSON files. The content of each file needs to be a JSON array of objects and may contain only the fields shown below.

For a TCP service, the object format is

{
    "host": "example.com",
    "port": 443
}

For a UDS service, the object format is

{
    "uds": "/path/to/socket_file"
}

UDS objects are supported only on Unix platforms.

License

MIT