Functionize CLI Tunnel

If your application under test is only accessible with a special connection or runs locally, you may use the Functionize CLI to connect to non-public sites. The Functionize CLI supports a simple tunneling option to connect to a private site. This is much easier than setting up a white list for all our servers.

The Functionize CLI tunnel is a secure reverse tunnel over secure websockets protocol (wss). The connection leverages the same token oauth authentication as the rest of the Functionize CLI. The tunnel should require no changes to your firewall settings. DNS resolution takes place on the machine where the tunnel is started. You can also have more than one tunnel running in parallel.

NOTE: One limitation of the of tunnel is the connection will sever if the computer goes to sleep. The authentication token generated for your Functionize connection will expire after an hour if the tunnel is not open. The token will remain active if the tunnel itself remains open. In other words, don't let your tunnel machine sleep!

See below for a visual representation of the tunnel and how it communicates.

 

Prerequisites:

Setting up the Functionize CLI tunnel requires a Proxy set for you by our team. Message Support with your IP address and they'll provide you with the endpoint required to start the tunnel as well as the IP address and port to be used in your Test or Project Settings within Functionize (See below).

 

Commands for the Tunnel with the Functionize CLI

Init: Initialize the tunnel connection

Start: Open the tunnel connection to your proxy domain 

Stop: Close the tunnel connection

 

Flags for Tunnel commands with the Functionize CLI

-e, --endPoint string: Set your remote endpoint with this flag. Your Proxy domain is the string.

-h, --help: The list of Tunnel commands and flags.

--noConnections int: The number of parallel connections you wish to open. By default, one connection opens. You have the option of setting a maximum of 12 parallel connections.

 

Starting and Stopping the Tunnel

Within the Functionize CLI, run the following commands:

  1. Initialize the tunnel connection: fze tunnel init
  2. You should see "Initializing tunnel. Tunnel has been successfully initialized."
  3. Start the tunnel connection: fze tunnel start --endPoint string (The string is your Proxy endpoint provided to you from Support.) 
    During the Start command you also have the option of setting the number of parallel connections with the flag --noConnections int (The int is the number of connections you wish to open with a maximum of 12. By default, including not using this flag, one connection will open.)
    Screen_Shot_2021-07-20_at_7.32.11_PM.png
  4. Stop the tunnel connection: fze tunnel stop (As noted above, the tunnel will remain open and active as long as the computer does not go to sleep.)
    Screen_Shot_2021-07-20_at_7.34.15_PM.png

 

Set the Proxy within your Project or Test

Proxy IP address and port are added to the Project Advanced Settings on the Basic Tab.Screen_Shot_2021-07-20_at_6.41.54_PM.png

Proxy IP address and port are added to the Test Settings on the Advanced Tab.Screen_Shot_2021-07-20_at_6.39.17_PM.png

 

Visual Representation of tunneling with the Functionize CLI

Connectivity_Options__-_Tunnel.jpeg