Skip to content

DEBUGGING.md

Latest commit

 

History

History
42 lines (33 loc) · 2.14 KB

DEBUGGING.md

File metadata and controls

42 lines (33 loc) · 2.14 KB
Raw

Layer 1 Driver Debugging

This guide is a short review of Python Layer 1 (L1) driver debugging process.

  • Run PyCharms as SYSTEM

To attach PyCharms debugger to the driver process called by CloudShell it should be run as SYSTEM. An easy way to get a CMD prompt as SYSTEM is to grab PSEXEC from Microsoft Sysinternals:

  1. Download PSEXEC and unzip to some folder.
  2. Open an elevated CMD prompt as an administrator.
  3. Navigate to the folder where you unzipped PSEXEC.EXE
  4. Run:
     PSEXEC -i -s -d CMD

You will have a new CMD prompt open, as SYSTEM

  1. Run PyCharm in the opened CMD:
C:\Program Files (x86)\JetBrains\PyCharm Community Edition 2016.1.4\bin\pycharm.exe

  • Open the driver as a Project in PyCharm and configure the interpreter

  1. Press Open and select the driver folder, like C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers\cloudshell-L1-driver_example
  2. Specify Project interpreter from the driver virtualenv. Set python executable from the driver folder, like C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers\cloudshell-L1-driver_example\Scripts\python.exe

  • Run driver in a debug mode

  1. Edit Runtime Configuration of the driver C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers\cloudshell-L1-driver_example\driver_example_RuntimeConfig.yml
  2. Specify DEBUG_ENABLED option to TRUE
DEBUG_ENABLED: TRUE
  1. Kill the python process of the driver. Find the PID (process id) of the driver process in the commands log and kill it in the Task Manager.

  • Attach PyCharm's debugger to the driver process

  1. Specify breakpoints in the driver project's source files.
  2. Use CloudShell to call a driver commands. For example, call Autoload in ResourceManager.
  3. Find in the commands log of the driver the PID of the driver process.
  4. Attach PyCharms debugger to the driver process. In PyCharm press Run>Attach to LocalProcess and choose the process with the same PID you found in the commands log.
  5. Wait until it stops on the breakpoint.