kiwicom/loopbind

🛠️️ CLI tool to easily bind localhost network interface with additional IP and ensure matching record in /etc/hosts.

v1.3 2023-08-11 13:57 UTC

Requires

• php: >=8.0
• ext-iconv: *
• ext-json: *
• ext-mbstring: *
• contributte/console: ^0.9.0
• nette/schema: ^1.2
• nette/utils: ^4.0

Requires (Dev)

• pepakriz/phpstan-exception-rules: ^0.12.0
• phpstan/extension-installer: ^1.2
• phpstan/phpstan: ^1.9
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-strict-rules: ^1.4
• phpunit/phpunit: ^10.0
• spaze/phpstan-disallowed-calls: ^2.11
• spaze/phpstan-disallowed-calls-nette: ^2.0
• symplify/easy-coding-standard: ^12.0

MIT

• Jan Drábek
• Transactional Messaging Team

README

🛠️️ CLI tool to easily bind localhost network interface with additional IP and ensure matching record in /etc/hosts.

This is a helper tool to be installed via composer global to machines where the localhost deployment process of Docker composition (via docker-compose.yaml) is prepared in a way that it binds the ports on IP from localhost subnet block and multiple of such compositions should be allowed to run in parallel (differentiated by the IP).

Practically speaking this tool ensures that the localhost network interface (lo0 on OS X) will also have another IP from localhost subnet block (for example 127.0.0.2) and there will entry in /etc/hosts for particular domain routing to that IP (for example 127.0.0.2 example.test).

Supported platforms:

Platform	Support
OS X	✅
Linux	✅
Windows	❌

Required underlying utilities:

• sudo
• ifconfig
• sed

Installation

Run

composer global require kiwicom/loopbind

Then if you have composer bin directory on the PATH you can use it by calling loopbind in the CLI. So you can initialize the configuration with a CLI wizard:

$ loopbind init
> ENV variable name to extract IP address from (leave empty if you want to provide manually or want random one):
> 
> Do you want to generate random free local IP:
>
>  [0] yes
>  [1] no
> > no
> IPv4 address from local block:
> 127.0.0.1
> Hostname (leave empty to continue):
> hostname
> Hostname (leave empty to continue):
> 
> New config file `.loopbind.json` was created.
> Do you want to create .env file with variable IP:
>
>  [0] yes
>  [1] no
> > yes
> File `.env` was created with variable `IP` set to `127.0.0.2`.
> You appear to have .docker-compose.yml file in your directory. Run `docker compose stop`, replace port binding from `"80:80"` to `"$IP:80:80"` and then `docker copmose up`.

Usage

In the project root define a file named .loopbind.json with following content:

{
    "localIPAlias": "127.11.23.1",
    "hostname": "foobar.test"
}

Or when you need to bind multiple hostnames:

{
    "localIPAlias": "127.11.23.1",
    "hostname": ["www.foobar.test","foobar.test"]
}

Then in this directory you can run loopbind apply to run commands to ensure the binding. Also, you can run loopbind unapply to remove it and loopbind show to show the configuration and its status.

The commands are idempotent so repeated apply/unapply does nothing (and the apply command does not even need to run the command again).

Please note, that the config is expected to be in the current working directory.

Development

This projects uses following coding standard:

• PHPCS
• PHPStan analysis (composer stan)
• PHPUnit tests. (composer unit)

However, due to the expected side effects (changing the computer configuration after run) and application of KISS only a subset of functionality is tested automatically. Hence, testing of:

• ApplyCommand
• UnapplyCommand

should be done manually.