Await Service Port

await-service-port.sh, contains a function that returns listening ports for a given service, even if it has to wait a few seconds, and even if the listening ports are not known in advance; such as in the case with librespot service.

The following covers how to install this branch as a submodule within your own project, and parameters that await-service-port.sh currently responds to.

Quick Start

Bash Variables

_module_https_url='https://github.com/network-utilities/await-service-port.git'
_module_relative_path='modules/await-service-port'

Git Commands

cd "<your-git-project-path>"

git checkout gh-pages
git submodule add -b master --name await-service-port "${_module_https_url}" "${_module_relative_path}"

git submodule update
cd "${_module_relative_path}"
git checkout master
git pull

Version Locking; recommended for those that audit every dependency...

git checkout tags/<tag_name> -b <branch_name>

... replace <tag_name> with the tag to checkout and <branch_name> with a custom name, eg...

git checkout tags/v0.0.1 -b loc-v0.0.1

Edit Your ReadMe File

Suggested additions so everyone has a good time with submodules

Clone with the following to avoid incomplete downloads


    git clone --recurse-submodules <url-for-your-project>


Update/upgrade submodules via


    git submodule update --init --recursive
    git submodule update --merge

Example Usage

Example of sourcing and utilize await_service_port features

example_usage.sh

#!/usr/bin/env bash


## Find true directory this script resides in
__SOURCE__="${BASH_SOURCE[0]}"
while [[ -h "${__SOURCE__}" ]]; do
    __SOURCE__="$(find "${__SOURCE__}" -type l -ls | sed -n 's@^.* -> \(.*\)@\1@p')"
done
__DIR__="$(cd -P "$(dirname "${__SOURCE__}")" && pwd)"


## Source module code within this script
source "${__DIR__}/modules/await-service-port/await-service-port.sh"


#
# Two examples of waiting for SSHD listening ports
#
_sshd_ports_list=($(await_service_port 'sshd' 'tcp'))
if [ "${#_sshd_ports_list[@]}" -gt '0' ]; then
    printf 'SSHD Port: %s\n' "${_sshd_ports_list[@]}"
else
    printf 'No ports found this time\n' >&2
fi

_sshd_ports_string="$(await_service_port 'sshd' 'tcp')"
if [ -n "${_sshd_ports_string}" ]; then
    printf 'SSHD Port(s): %s\n' "${_sshd_ports_string[@]}"
else
    printf 'No ports found this time\n' >&2
fi

Test that things work!

Commit and Push

git add .gitmodules
git add modules/await-service-port
git add README.md


git commit -F- <<'EOF'
:heavy_plus_sign: Adds network-utilities/await-service-port dependency


**Edits**


- `README.md` file, documentation updates for submodules


**Additions**

- `.gitmodules` file, tracks other Git repository code utilized by this project

- `modules/await-service-port` submodule, Git tracked dependency
EOF


git push origin master

🎉 Excellent 🎉 your project is now ready to begin unitizing code from this one!