Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/testingbot/testingbot-tunnel

Tunnel to run Cloud Selenium tests on your local computer
https://github.com/testingbot/testingbot-tunnel

proxy selenium tunnel vpn webdriver

Last synced: 24 days ago
JSON representation

Tunnel to run Cloud Selenium tests on your local computer

Host: GitHub
URL: https://github.com/testingbot/testingbot-tunnel
Owner: testingbot
License: other
Created: 2012-04-05T08:18:44.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2023-09-14T16:59:27.000Z (about 1 year ago)
Last Synced: 2024-08-05T09:14:52.784Z (4 months ago)
Topics: proxy, selenium, tunnel, vpn, webdriver
Language: Java
Homepage: https://testingbot.com
Size: 2.9 MB
Stars: 13
Watchers: 6
Forks: 12
Open Issues: 2
Metadata Files:
- Readme: README.markdown
- Changelog: CHANGELOG
- License: LICENSE.txt

Awesome Lists containing this project

awesome-network-stuff - **14**星

README

# TestingBot Tunnel

This is a Java-based application to test websites on your local computer or staging environment with the TestingBot.com browser cloud.
A secure connection is established between your machine and the TestingBot.com cloud.
You can find more information on https://testingbot.com/support/other/tunnel

About
-------

Whether you want to test on your local computer (localhost), on a staging server inside your LAN, or on a computer across VPN, TestingBot Tunnel makes all of this possible in a secure and reliable way.

You will no longer need to open up ports on your firewall or whitelist our IP range to run tests on your staging environment.
Below are some of the features of the TestingBot Tunnel:

* Fast: at TestingBot's end of the tunnel we keep a cache of static content, to reduce traffic inside the tunnel.
* Secure: based on an SSH Tunnel.
* Robust: full HTTP(S) support, coded in Java
* Easy to set up and use, supported on all operating systems.

Prerequisites
-------

This version of the tunnel requires Java 8 or higher. If you'd like to run on Java < 8, please use [TestingBot Tunnel 1.21](https://github.com/testingbot/Testingbot-Tunnel/tree/TestingBotTunnel-1.21) (no longer maintained)

**NOTE:** If you use the containerized tunnel, Java is not needed. See below under the *Docker*-header.

Install
-------

To start the tunnel, enter the following command:
`java -jar testingbot-tunnel.jar key secret`

You can obtain a free key and secret from https://testingbot.com/members/user/edit

**Hint:** Instead of passing the key and secret to the command, you can have them as environment variables `${TESTINGBOT_KEY}` and `${TESTINGBOT_SECRET}`.

Options
-------

The tunnel comes with various options:

|Command|Description|
|---------|-------------|
|-a,--auth |Performs Basic Authentication for specific hosts.|
|-d,--debug|Enables debug messages. Will output request/response headers.|
|-dns,--dns|Use a custom DNS server. For example: 8.8.8.8|
|--doctor|Perform sanity/health checks to detect possible misconfiguration or problems.|
|--extra-headers |Inject extra headers in the requests the tunnel makes.|
|-f,--readyfile |This file will be touched when the tunnel is ready for usage|
|-F,--fast-fail-regexps |Specify domains you don't want to proxy, comma separated.|
|-h,--help|Displays help text|
|-i,--tunnel-identifier |Add an identifier to this tunnel connection. In case of multiple tunnels, specify this identifier in your desired capabilities to use this specific tunnel.|
|-j,--localproxy |The port to launch the local proxy on (default 8087).|
|-l,--logfile |Write logging to a file.|
|--metrics-port |Use the specified port to access metrics. Default port 8003|
|-P,--se-port |The local port your Selenium test should connect to. Default port is 4445|
|-p,--hubport |Use this if you want to connect to port 80 on our hub instead of the default port 4444|
|--pac |Proxy autoconfiguration. Should be a http(s) URL|
|-q,--nocache|Bypass our Caching Proxy running on our tunnel VM.|
|-v,--version|Displays the current version of the Tunnel|
|-w,--web |Point to a directory for testing. Creates a local webserver.|
|-x,--noproxy|Do not start a local proxy (requires user provided proxy server on port 8087)|
|-Y,--proxy |Specify an upstream proxy.|
|-z,--proxy-userpwd |Username and password required to access the proxy configured with --proxy.|

Example
-------
To use the tunnel, simply start it:

```
$ java -jar testingbot-tunnel.jar
```

Now point your tests to use the tunnel's IP (localhost if the .jar is running on your local computer) and port 4445
```ruby
require "rubygems"
require 'testingbot'
gem "selenium-client"
gem "selenium-webdriver"
require "selenium-webdriver"
require "selenium/client"

caps = {
:browserName => "internet explorer",
:version => "latest",
:platform => "WINDOWS"
}

urlhub = "http://key:secret@localhost:4445/wd/hub"
client = Selenium::WebDriver::Remote::Http::Default.new
client.timeout = 120

webdriver = Selenium::WebDriver.for :remote, :url => urlhub,
:desired_capabilities => caps, :http_client => client
webdriver.navigate.to "http://staging.local"
puts webdriver.title
webdriver.quit
```

Node
-------
We have created a NodeJS based launcher which you can use in your NodeJS tests and projects:
[testingbot-tunnel-launcher](https://github.com/testingbot/testingbot-tunnel-launcher)

More documentation about this tunnel is available on https://testingbot.com/support/other/tunnel

Docker
------
For those who don't want to deal with Java, we also provide a containerized version of the tunnel.

To start the tunnel, run:
```
$ docker run -p 4445:4445 --net=host testingbot/tunnel:2.9
```

Alternatively:
```
$ docker run -p 4445:4445 --net=host -e TESTINGBOT_KEY= -e TESTINGBOT_SECRET= testingbot/tunnel:2.9
```

Compile from Source
-------------------

To compile and test the Jar yourself you can use the following command:

mvn assembly:assembly