Debug your Restbird test script from VS Code.
Restbird Debugger extension allows you to debug test scripts (written in GoLang, Python and Javascript) for Restbird project in vscode directly.
By simply right click and choose "Restbird: Debug Restbird script"
-
Example of debugging as Restful request
-
Example of debugging as Mock Server
You also get the side befefit of Syntax check VSCode offered
- GoLang (go version go1.10.2 linux/amd64)
- Python (python3)
- Javascript
- Python (python3)
- Javascript
-
First, pull the restbird docker image from the docker hub.
docker pull restbird/rest
-
Second, start a restbird container
docker run -ti --user
$(id -u):$ (id -g) --net host -v {path-to-project}:/data/restbird restbird/restThis will use port 8080 of host machine
-
Or second, start a restbird container (Alternative way to start Restbird docker, if you want to run multiple dockers in the same machine)
docker run -ti --user
$(id -u):$ (id -g) -p {host-port}:8080 -v {path-to-project}:/data/restbird restbird/restAlternatively, if you want to use mock server, a range of ports need to be reserved when starting restbird in 2nd step.
docker run -ti --user
$(id -u):$ (id -g) -p {host-port}:8080 -p 8000-8010:8000-8010 -v {path-to-project}:/data/restbird restbird/rest
Note: You don't need to install all envinronment, just the specific language you used to develop your test script
-
Install Golang version 1.10.2
For the reason that Restbird is compiled with Go version 1.10.2, so in the initial release we'll only support debugging with the same Golang version.
We will support other Go versions later
Download the archieve and extract it into /usr/local, creating a Go tree in /usr/local/go. For example:
tar -C /usr/local -xzf go1.10.2.linux-amd64.tar.gz
-
Setup GoPath in VSCode
After run debug, Restbird will generate debug files (main.go and related libs in Restbird project directory (a "sanbox" directory will be created) of your local filesystem)
{ "go.gopath" : "[Your Restbird project directory]/sandbox/tmp:[Your Restbird project directory]/sandbox/tmp/src/restbirdlib", }
-
Install Delve debugger for Debugging GoLang
And ensure it is in your "GOPATH/bin" or "PATH".
-
Configure debug in VSCode: Sample Debug Configuration (launch.json)
{ "name": "Launch Go", "type": "go", "request": "launch", "mode": "auto", "program": "${fileDirname}", "host": "127.0.0.1", "port": 2345, "env": {}, "args": [] }
-
Open the Go file you want to debug and right click then chooe "Restbird: Debug Restbird script"
main.go will be generated under [your Restbird project directory]/sandbox/tmp/src/restbird-[rest/mock/task]
click Debug to start debugging
-
Ensure Python 3 has been installed in your system.
-
Install Request lib
Below command has been tested in ubuntu 16.04
apt-get install python3
apt-get install python3-pip
pip3 install --user pipenv
pip3 install requests
- Setup pythonPath in VSCode to use python3
{
"python.pythonPath": "Path to your python3, e.g. /usr/bin/python3"
}
- Configure debug in VSCode: Sample Debug Configuration (launch.json)
{
"name": "Python: Current File",
"type": "python",
"request": "launch",
"program": "${file}",
}
Restbird also support to use pipenv, Pipfile is shiped with debug package inside [Your path to Restbird project]/sandbox/tmp/ directory when you Run debug of Python script
- pipenv install
- pipenv --venv
To get the virtal env path - Setup pythonPath in VSCode to use python3
{
"python.pythonPath": "Path to your virtaul env, e.g. /User/restbird/.local/share/virtualenvs/restbird-BKBCD7Kk"
}
-
Ensure Node.js has been installed in your system
-
Configure debug in VSCode: Sample Debug Configuration (launch.json)
{
"type": "node",
"request": "launch",
"name": "Launch JS",
"program": "${fileDirname}/restbird-mock.js",
"runtimeExecutable": "/usr/local/node-v8.9.4-linux-x64/bin//node",
},
Restbird only support using Javasript in mock server
global.serverPort: The port Restbird docker server listens to.credential.username: The username of Restbird usercredential.password: The password of Restbird user
If VS code didn't promt any useful message when debugger failed to start,
- Check the owner of this folder {path-to-project}/sandbox/, make sure this is under your current login user (use chown in Linux).
When you launch docker container, if you didn’t map the user, the default user will be root. So you can’t edit {path-to-project}/sandbox/xxxx. This will make debugger failed. So suggest to always use :
docker run -ti --user
$(id -u):$ (id -g) --net host -v {path-to-project}:/data/restbird restbird/rest
- For Golang script, check if there's any syntax error In VS code, if your installed Go extension, it will compile and show build errors automaticly when saving. Or just simple "Run" through Restbird WebUI, it will also check for syntax error.
If you used the 2nd way to start docker
docker run -ti --user
$(id -u):$ (id -g) -p {host-port}:8080 -p 8000-8010:8000-8010 -v {path-to-project}:/data/restbird restbird/rest
For Debbuging mockserver, it is required to set the mock server port to use the port that hasn’t been mapped into docker, or mock server will not be able to start due to port already been used.
Or use the 1st command
docker run -ti --user
$(id -u):$ (id -g) --net host -v {path-to-project}:/data/restbird restbird/rest
Make sure node and npm has been installed in your system, run whereis node to get the node path, and add it to runtimeExecutable in launch.json, e.g.
{
"type": "node",
"request": "launch",
"name": "Launch JS",
"program": "${fileDirname}/restbird-mock.js",
"runtimeExecutable": "/usr/local/node-v8.9.4-linux-x64/bin//node",
},
How to install node and npm in ubuntu
Please download our Demo Restbird project for test drive.
Initial release of Restbird Debugger
Enjoy!