LambdaTest Nodejs bindings for Tunnel

Installation

npm i @lambdatest/node-tunnel

Example

var lambdaTunnel = require('@lambdatest/node-tunnel');

//Creates an instance of Tunnel
var tunnelInstance = new lambdaTunnel();

// Replace  with your user and  with your key.
var tunnelArguments = {
  user: process.env.LT_USERNAME || '',
  key: process.env.LT_ACCESS_KEY || ''
};

// Callback Style
// Atarts the Tunnel instance with the required arguments
tunnelInstance.start(tunnelArguments, function(error, status) {
  if (!error) {
    console.log('Tunnel is Running Successfully');
  }
});

// Promise Style
tunnelInstance
  .start(tunnelArguments)
  .then(status => {
    console.log('Tunnel is Running Successfully');
  })
  .catch(error => {
    console.log(error);
  });

// Async/Await Style
(async function() {
  try {
    const istunnelStarted = await tunnelInstance.start(tunnelArguments);
    console.log('Tunnel is Running Successfully');
  } catch (error) {
    console.log(error);
  }
})();

Methods

tunnelInstance.start(tunnelArguments, callback)

Start tunnel Instance.

• tunnelArguments: credentials for secure tunnel connection.
  • user: The username for the LambdaTest account.
  • key: The accessKey for the LambdaTest account.
• callback (function(error, status)): A callback to invoke when the API call is complete.

// Callback Style
tunnelInstance.start(tunnelArguments, function(error, status) {
  if (!error) {
    console.log('Tunnel is Running Successfully');
  }
});

// Promise Style
tunnelInstance
  .start(tunnelArguments)
  .then(status => {
    console.log('Tunnel is Running Successfully');
  })
  .catch(error => {
    console.log(error);
  });

// Async/Await Style
(async function() {
  try {
    const istunnelStarted = await tunnelInstance.start(tunnelArguments);
    console.log('Tunnel is Running Successfully');
  } catch (error) {
    console.log(error);
  }
})();

tunnelInstance.isRunning()

Get Status of tunnel Instance.

// Callback Style
tunnelInstance.start(tunnelArguments, function(error, status) {
  if (!error) {
    console.log('Tunnel is Running Successfully');
    var tunnelRunningStatus = tunnelInstance.isRunning();
    console.log('Tunnel is Running ? ' + tunnelRunningStatus);
  }
});

// Promise Style
tunnelInstance
  .start(tunnelArguments)
  .then(status => {
    console.log('Tunnel is Running Successfully');
    const tunnelRunningStatus = tunnelInstance.isRunning();
    console.log('Tunnel is Running ? ' + tunnelRunningStatus);
  })
  .catch(error => {
    console.log(error);
  });

// Async/Await Style
(async function() {
  try {
    const istunnelStarted = await tunnelInstance.start(tunnelArguments);
    console.log('Tunnel is Running Successfully');
    const tunnelRunningStatus = tunnelInstance.isRunning();
    console.log('Tunnel is Running ? ' + tunnelRunningStatus);
  } catch (error) {
    console.log(error);
  }
})();

tunnelInstance.getTunnelName(callback)

Get name of the Running tunnel Instance.

• callback (function(tunnelName)): A callback to invoke when the API call is complete.

// Callback Style
tunnelInstance.start(tunnelArguments, function(error, status) {
  if (!error) {
    console.log('Tunnel is Running Successfully');
    tunnelInstance.getTunnelName(function(tunnelName) {
      console.log('Tunnel Name : ' + tunnelName);
    });
  }
});

// Promise Style
tunnelInstance
  .start(tunnelArguments)
  .then(status => {
    console.log('Tunnel is Running Successfully');
    tunnelInstance.getTunnelName().then(tunnelName => {
      console.log('Tunnel Name : ' + tunnelName);
    });
  })
  .catch(error => {
    console.log(error);
  });

// Async/Await Style
(async function() {
  try {
    const istunnelStarted = await tunnelInstance.start(tunnelArguments);
    console.log('Tunnel is Running Successfully');
    const tunnelName = await tunnelInstance.getTunnelName();
    console.log('Tunnel Name : ' + tunnelName);
  } catch (error) {
    console.log(error);
  }
})();

tunnelInstance.stop(callback)

Stop the Running tunnel Instance.

• callback (function(error, status)): A callback to invoke when the API call is complete.

// Callback Style
tunnelInstance.start(tunnelArguments, function(error, status) {
  if (!error) {
    console.log('Tunnel is Running Successfully');
    tunnelInstance.stop(function(error, status) {
      console.log('Tunnel is Stopped ? ' + status);
    });
  }
});

// Promise Style
tunnelInstance
  .start(tunnelArguments)
  .then(status => {
    console.log('Tunnel is Running Successfully');
    tunnelInstance.stop().then(status => {
      console.log('Tunnel is Stopped ? ' + status);
    });
  })
  .catch(error => {
    console.log(error);
  });

// Async/Await Style
(async function() {
  try {
    const istunnelStarted = await tunnelInstance.start(tunnelArguments);
    console.log('Tunnel is Running Successfully');
    const status = await tunnelInstance.stop();
    console.log('Tunnel is Stopped ? ' + status);
  } catch (error) {
    console.log(error);
  }
})();

Arguments

Every modifier except user and key is optional. Visit LambdaTest tunnel modifiers for an entire list of modifiers. Below are demonstration of some modifiers for your reference.

LambdaTest Basic Credentials

Below credentials will be used to perform basic authentication of your LambdaTest account.

• user (Username of your LambdaTest account)
• key (Access Key of your LambdaTest account)

Port

If you wish to connect tunnel on a specific port.

• port : (optional) Local port to connect tunnel.

tunnelArguments = {
  user: process.env.LT_USERNAME || '',
  key: process.env.LT_ACCESS_KEY || '',
  port: ''
};

Proxy

If you wish to perform tunnel testing using a proxy.

• proxyhost: Hostname/IP of proxy, this is a mandatory value.
• proxyport: Port for the proxy, by default it would consider 3128 if proxyhost is used For Basic Authentication, we use the below proxy options:
• proxyuser: Username for connecting to proxy, mandatory value for using 'proxypass'
• proxypass: Password for the USERNAME option.

tunnelArguments = {
  user: process.env.LT_USERNAME || '',
  key: process.env.LT_ACCESS_KEY || '',
  proxyHost: '127.0.0.1',
  proxyPort: '8000',
  proxyUser: 'user',
  proxyPass: 'password'
};

Tunnel Name

Human readable tunnel identifier

• tunnelName: (Name of the tunnel)

tunnelArguments = {
  user: process.env.LT_USERNAME || '',
  key: process.env.LT_ACCESS_KEY || '',
  tunnelName: ''
};

Testing Local Folder

Populate the path of the local folder you want to test in your internal server as a value in the below modifier.

• dir/localdir/localdirectory : Path of the local folder you want to test

tunnelArguments = {
  user: process.env.LT_USERNAME || '',
  key: process.env.LT_ACCESS_KEY || '',
  dir: '