waitForIt

SYNOPSIS:
    Wait for host:port to be available.

USAGE: waitForIt [OPTIONS] [ARGUMENTS]
USAGE: waitForIt [--timeout|-t <timeout>] [--exec-command-on-timeout|--lax|-l]
  [--help|-h] [--config] [--bash-framework-config <bash-framework-config>]
  [--verbose|-v] [-vv] [-vvv] [--log-level <log-level>] [--log-file <log-file>]
  [--display-level <display-level>] [--no-color] [--theme <theme>] [--version]
  [--quiet|-q] [--algorithm|--algo <algorithm>] [--user-nc]

ARGUMENTS:
  hostOrIp {single} (mandatory)    Host or IP under test.
  port {single} (mandatory)    TCP port under test.
  [commandArgs {list} (optional)]    Execute command with args after the test finishes or exit with status co
    de if no command provided.

TIMEOUT OPTIONS:
  --timeout, -t <timeout> {single}
    Timeout in seconds, zero for no timeout.
    Default value: 15
  --exec-command-on-timeout, --lax, -l {single}
    Execute sub-command even if timeout is reached.

GLOBAL OPTIONS:
  --help, -h {single}
    Displays this command help
  --config {single}
    Displays configuration
  --bash-framework-config <bash-framework-config> {single}
    Use alternate bash framework configuration.
  --verbose, -v {single}
    Info level verbose mode (alias of --display-level INFO)
  -vv {single}
    Debug level verbose mode (alias of --display-level DEBUG)
  -vvv {single}
    Trace level verbose mode (alias of --display-level TRACE)
  --log-level <log-level> {single}
    Set log level
    Possible values: 
      - OFF
      - ERR
      - ERROR
      - WARN
      - WARNING
      - INFO
      - DEBUG
      - TRACE
    Default value: OFF
  --log-file <log-file> {single}
    Set log file
    Default value: /logs/bash.log
  --display-level <display-level> {single}
    Set display level
    Possible values: 
      - OFF
      - ERR
      - ERROR
      - WARN
      - WARNING
      - INFO
      - DEBUG
      - TRACE
    Default value: INFO
  --no-color {single}
    Produce monochrome output. alias of --theme noColor.
  --theme <theme> {single}
    Choose color theme - default-force means colors will be produced even if
    command is piped.
    Possible values: 
      - default
      - default-force
      - noColor
    Default value: default
  --version {single}
    Print version information and quit.
  --quiet, -q {single}
    Quiet mode, doesn't display any output.

SPECIFIC OPTIONS:
  --algorithm, --algo <algorithm> {single}
    Algorithm to use Check algorithms list below.
    Default: automatic selection based on commands availability and timeout option value.
  --user-nc {single}
    Legacy mode using nc command or while loop (uses timeout command by defa
    ult).


DESCRIPTION:
  EXIT STATUS CODES:
    0: the host/port is available
    1: indicates host/port is not available or argument error
    2: timeout reached

  AVAILABLE ALGORITHMS:
    timeoutV1WithNc: previous version of timeout command with --timeout option, base command nc
    timeoutV2WithNc: newer version of timeout command using timeout as argument, base command nc
    whileLoopWithNc: timeout command simulated using while loop, base command nc
    timeoutV1WithTcp: previous version of timeout command with --timeout option
    timeoutV2WithTcp: newer version of timeout command using timeout as argument
    whileLoopWithTcp: timeout command simulated using while loop, base command tcp

VERSION: 3.0

AUTHOR: [François Chastanet](https://github.com/fchastanet)

SOURCE FILE: https://github.com/fchastanet/bash-tools-framework/tree/master/src/_binaries/Utils/waitForIt/waitForIt-binary.yaml

LICENSE: MIT License
Copyright (c) 2020-now François Chastanet