FalconEye Extension for Visual Studio Code

A Visual Studio Code extension which helps FalconEye automation script developers to create, modify & debug test scripts in Python language. The extension features an integrated DUT View, a real-time test execution log view, real-time videos of DUTs, soft touch control for android devices and toolbar buttons for running scripts under the FalconEye framework.Supported VSCode version v1.55.2.

Important

This extension will only work if you have access to a FalconEye test automation system. For the features in this extension to work, you must login using your FalconEye credentials from this extension. For more information on video test automation & QoE measurement using FalconEye, contact falcon@tataelxsi.com

How to configure the extension for first use

• Click on the settings icon on the bottom left hand side of the Visual Studio Code window.

  

• Expand 'Extensions' category and select FalconEye

  

• There are three values you need to configure there.

  • FE_Ext_Logger_Server_Port: this extension needs to talk to a specific port on the FalconEye execution servers to fetch the logs in real-time. This port need to be specified in this field, after consulting with your respective FalconEye support team. Default value is 9010.

  • FE_Ext_RTSP_Server: this extension accesses the video streams from a new service running on one of the execution servers. The IP address and the port of this service is to be given in this field. The default port is 7010. Please contact your respective FalconEye support team for the IP address.

  • FEFramework_API_Gateway: The IP address and the port at which FalconEye Framework APIs are hosted.For version greater the v0.2.0 , update host name instead of IP address (example: hostname:port)

  • Disable Proxy: From Visual studio settings ,search for "http" and set configuration as shown below.

Login to FalconEye

• Step 1. Click on the FalconEye icon on the sidebar of Visual Studio Code. This will show a FalconEye login page.
• Step 2. Login using your FalconEye credentials.
• Step 3. After logging in, you should be able to see a DUT view on the UI pane to the left.

Main UI Components of the Extension

DUT View

The DUT view will show all the DUTs that are locked under your user log-in. If you need a DUT to appear here, you should lock it in FalconEye client application.

Upon clicking on a DUT, you will be able to see a Play icon on that item. Click on this icon to open up a video page that will show the real-time video from that DUT. You may rearrange The video page to suit your layout preferences within the Visual Studio Code's window.

FalconEye Log View

To open FalconEye execution logs view, click on "View" menu of Visual Studio Code, and select "Output" (Or press Ctrl + Shift + U). This will open up the output pane at the bottom. On the dropdown at the top right on this pane, select FalconEye Log. The output pane is now ready to start showing real-time log of the test execution.

FalconEye Run/Debug Option

These Options will appear along with the usual Run icon that appears on the top toolbar when you open up a Python file in Visual Studio Code editor. These are the options a user should use to start running or debugging a FalconEye test script. The regular "Run Python File in Terminal" option should not be used, as it will start the Python script without the necessary command-line arguments for the test script.

Android Mobile Device Soft Touch Control

User is now capable of remotly accessing android mobile device from DUT video panel.User can control actions such as swipe,tap,home,volume up,volume down,power,orientation change and rebooting device.Change in orientation functionality works according to the behaiour of device or application.

How to run or debug a FalconEye test script in Visual Studio Code

• Pre-requisite: You should open Visual Studio Code in a folder which is you working directory for FalconEye scripting. This can be done in three ways.
  • If you have already opened up Visual Studio Code, click on File->Open Folder on the main menu, and select the folder.
  • Using a command prompt, navigate to the folder where you want to work, then type in "code ." (code followed by a space and then a dot) and hit enter.
  • Using windows explorer, go to the scripts folder and right click, then select "Open with Code" option.

Open a test script. Select the device from the DUT view , and then click on "Run with FalconEye" toolbar button. This will start the script after passing all the required command line arguments automatically. This involves the DUT identifiers and other data required by the FalconEye framework to properly run a test script.

Follow the same process to start debugging a script, however you should click on "Debug with FalconEye" instead of "Run with FalconEye" button.

While a script is under the debugger, you will be able to use breakpoints and other standard debugger features such as step through, step inside, step outside and so on. Read python extension's readme section for getting yourself familiarized on how to use debugging features in Visual Studio Code.

FalconEye supports python versions -python 2.7 and python 3.7. Appropriate python environment can be selected from the " Select Interpreter" option as shown below. You can either select an environment required for execution shown in list or manually provide the python executable path by selecting "Enter interpreter path..."

Code Snippets for FalconEye Test APIs

• When you want to start a new test script, create a new python file and simply type in the platform name (iOS/Android/STB) in the empty editor and it will auto-generate all the lines of code required for the test script.

  

• Test API snippets can be added by just typing the API name in the text editor. For example, if you need to add QuickCapture API snippet, just start typing 'quickcapture'. As you type, the matching API names will be listed in an intellisense popup, and the selected API's calling structure will also be displayed as a sub-menu to the Intellisense popup. You can select the required API and press Enter - this will add the code snippet for that API into your test script.

  

Limitations

• At present, this extension doesn't allow users to execute or debug FalconEye test scripts from environments other than Windows.

• Currently, video streams from TBS Encoders are not supported.

Happy scripting!