# tcpw
`tcpw` (TCP Wait) is a tool that waits until TCP endpoints are open.
It is useful for synchronizing the spin-up of interdependent services, such as linked docker containers.
That is yet another alternative to `wait-for-it.sh`.
## Rationale
- available as a binary executable without any dependencies (file size <1M).
- Optimized with: `-ldflags="-s -w" -trimpath` and `upx`
- Pre-built binaries:
- [tcpw-linux-x86_64](https://raw.githubusercontent.com/jackcvr/tcpw/main/bin/x86_64/tcpw)
- [tcpw-linux-aarch64](https://raw.githubusercontent.com/jackcvr/tcpw/main/bin/aarch64/tcpw)
- [tcpw-linux-armv7l](https://raw.githubusercontent.com/jackcvr/tcpw/main/bin/armv7l/tcpw)
- available on `PyPI` (x86_64 only)
- additionally, you can set:
- more than one endpoint: `-a google.com:80 -a booble.gum:8080 ...`
- command, which can be executed only after success, failure or any result: `-on f -a google.com:9999 echo "Endpoint is down"`
- polling interval: `-i 500ms`
- `timeout/interval` in different time units: `ns,ms,s,m,h`
## Installation
Download executable file:
`sh -c "wget -O tcpw https://raw.githubusercontent.com/jackcvr/tcpw/main/bin/$(uname -m)/tcpw && chmod +x tcpw"`
or:
`pip install tcpw`
[](https://pypi.org/project/tcpw)
[](https://pypi.org/project/tcpw)
## Usage
```text
Usage: tcpw [-t timeout] [-i interval] [-on (s|f|any)] [-q] [-v] [-a host:port ...] [command [args]]
-a value
Endpoint to await, in the form 'host:port'
-i duration
Interval between retries in format N{ns,ms,s,m,h} (default 1s)
-on string
Condition for command execution. Possible values: 's' - after success, 'f' - after failure, 'any' - always (default "s")
-q Do not print anything (default false)
-t duration
Timeout in format N{ns,ms,s,m,h}, e.g. '5s' == 5 seconds. Zero for no timeout (default 0)
-v Verbose mode (default false)
command args
Execute command with arguments after the test finishes (default: if connection succeeded)
```
## Examples
Wait 5 seconds for port 80 on `www.google.com`, and if it is available, echo the message `Google is up`:
```bash
$ tcpw -t 5s -a www.google.com:80 echo "Google is up"
2024/08/26 20:06:47.209012 successfully connected to www.google.com:80
Google is up
```
Next command waits 2 seconds for www.google.com:80 and localhost:5000, checking them every 500 milliseconds
with enabled verbose mode and executes `echo` regardless of the result:
```bash
$ tcpw -t 2s -i 500ms -v -on any -a www.google.com:80 -a localhost:5000 echo "Printed anyway"
2024/08/26 20:08:24.153240 connecting to localhost:5000...
2024/08/26 20:08:24.153327 connecting to www.google.com:80...
2024/08/26 20:08:24.153541 dial tcp 127.0.0.1:5000: connect: connection refused
2024/08/26 20:08:24.179927 successfully connected to www.google.com:80
2024/08/26 20:08:24.654984 dial tcp 127.0.0.1:5000: connect: connection refused
2024/08/26 20:08:25.155997 dial tcp 127.0.0.1:5000: connect: connection refused
2024/08/26 20:08:25.661397 dial tcp 127.0.0.1:5000: connect: connection refused
2024/08/26 20:08:26.161613 dial tcp: lookup localhost: i/o timeout
timeout error
Printed anyway
```
## License
[MIT](https://spdx.org/licenses/MIT.html)
Raw data
{
"_id": null,
"home_page": null,
"name": "tcpw",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "wait-for-it, waitforit, tcp, expect, docker, containers",
"author": null,
"author_email": "Andrii Kuzmin <jack.cvr@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8b/e5/87997d1bf130767160bdf940a9c986ebafce08721a295e7ffeead9ffbf24/tcpw-0.1.10.tar.gz",
"platform": null,
"description": "# tcpw\n\n`tcpw` (TCP Wait) is a tool that waits until TCP endpoints are open.\n\nIt is useful for synchronizing the spin-up of interdependent services, such as linked docker containers.\n\nThat is yet another alternative to `wait-for-it.sh`.\n\n## Rationale\n\n- available as a binary executable without any dependencies (file size <1M).\n - Optimized with: `-ldflags=\"-s -w\" -trimpath` and `upx`\n - Pre-built binaries:\n - [tcpw-linux-x86_64](https://raw.githubusercontent.com/jackcvr/tcpw/main/bin/x86_64/tcpw)\n - [tcpw-linux-aarch64](https://raw.githubusercontent.com/jackcvr/tcpw/main/bin/aarch64/tcpw)\n - [tcpw-linux-armv7l](https://raw.githubusercontent.com/jackcvr/tcpw/main/bin/armv7l/tcpw)\n- available on `PyPI` (x86_64 only)\n- additionally, you can set:\n - more than one endpoint: `-a google.com:80 -a booble.gum:8080 ...`\n - command, which can be executed only after success, failure or any result: `-on f -a google.com:9999 echo \"Endpoint is down\"`\n - polling interval: `-i 500ms`\n - `timeout/interval` in different time units: `ns,ms,s,m,h`\n\n\n## Installation\n\nDownload executable file:\n\n`sh -c \"wget -O tcpw https://raw.githubusercontent.com/jackcvr/tcpw/main/bin/$(uname -m)/tcpw && chmod +x tcpw\"`\n\nor:\n\n`pip install tcpw`\n\n[](https://pypi.org/project/tcpw)\n[](https://pypi.org/project/tcpw)\n\n## Usage\n\n```text\nUsage: tcpw [-t timeout] [-i interval] [-on (s|f|any)] [-q] [-v] [-a host:port ...] [command [args]]\n\n -a value\n \tEndpoint to await, in the form 'host:port'\n -i duration\n \tInterval between retries in format N{ns,ms,s,m,h} (default 1s)\n -on string\n \tCondition for command execution. Possible values: 's' - after success, 'f' - after failure, 'any' - always (default \"s\")\n -q\tDo not print anything (default false)\n -t duration\n \tTimeout in format N{ns,ms,s,m,h}, e.g. '5s' == 5 seconds. Zero for no timeout (default 0)\n -v\tVerbose mode (default false)\n command args\n \tExecute command with arguments after the test finishes (default: if connection succeeded)\n```\n\n## Examples\n\nWait 5 seconds for port 80 on `www.google.com`, and if it is available, echo the message `Google is up`:\n\n```bash\n$ tcpw -t 5s -a www.google.com:80 echo \"Google is up\"\n2024/08/26 20:06:47.209012 successfully connected to www.google.com:80\nGoogle is up\n```\n\nNext command waits 2 seconds for www.google.com:80 and localhost:5000, checking them every 500 milliseconds\nwith enabled verbose mode and executes `echo` regardless of the result:\n\n```bash\n$ tcpw -t 2s -i 500ms -v -on any -a www.google.com:80 -a localhost:5000 echo \"Printed anyway\"\n2024/08/26 20:08:24.153240 connecting to localhost:5000...\n2024/08/26 20:08:24.153327 connecting to www.google.com:80...\n2024/08/26 20:08:24.153541 dial tcp 127.0.0.1:5000: connect: connection refused\n2024/08/26 20:08:24.179927 successfully connected to www.google.com:80\n2024/08/26 20:08:24.654984 dial tcp 127.0.0.1:5000: connect: connection refused\n2024/08/26 20:08:25.155997 dial tcp 127.0.0.1:5000: connect: connection refused\n2024/08/26 20:08:25.661397 dial tcp 127.0.0.1:5000: connect: connection refused\n2024/08/26 20:08:26.161613 dial tcp: lookup localhost: i/o timeout\ntimeout error\nPrinted anyway\n```\n\n## License\n\n[MIT](https://spdx.org/licenses/MIT.html) \n",
"bugtrack_url": null,
"license": null,
"summary": "Wait until TCP endpoints are open",
"version": "0.1.10",
"project_urls": {
"Documentation": "https://github.com/jackcvr/tcpw#readme",
"Issues": "https://github.com/jackcvr/tcpw/issues",
"Source": "https://github.com/jackcvr/tcpw"
},
"split_keywords": [
"wait-for-it",
" waitforit",
" tcp",
" expect",
" docker",
" containers"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1de176d92b60a4b1aae6734858c1918158dc3cdc628c25717fe886c2001b8f57",
"md5": "a9de8ae54ca8f1d643631496fc40f0cf",
"sha256": "f61ff6701809442ff1e79cf9d6d256a5d8434fff2bfa96de9d6bc2291bb2388e"
},
"downloads": -1,
"filename": "tcpw-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9de8ae54ca8f1d643631496fc40f0cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 893849,
"upload_time": "2024-09-07T21:40:15",
"upload_time_iso_8601": "2024-09-07T21:40:15.022880Z",
"url": "https://files.pythonhosted.org/packages/1d/e1/76d92b60a4b1aae6734858c1918158dc3cdc628c25717fe886c2001b8f57/tcpw-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8be587997d1bf130767160bdf940a9c986ebafce08721a295e7ffeead9ffbf24",
"md5": "20fe59920421405fb99313863ad4f1fa",
"sha256": "2ea2f6950fc9bad26a022918c6aa9b1918ea4dd7b85a7e6da0e988a490c1f448"
},
"downloads": -1,
"filename": "tcpw-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "20fe59920421405fb99313863ad4f1fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 896476,
"upload_time": "2024-09-07T21:40:17",
"upload_time_iso_8601": "2024-09-07T21:40:17.879141Z",
"url": "https://files.pythonhosted.org/packages/8b/e5/87997d1bf130767160bdf940a9c986ebafce08721a295e7ffeead9ffbf24/tcpw-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-07 21:40:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jackcvr",
"github_project": "tcpw#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tcpw"
}
JSON
