{"id":11572,"date":"2019-12-23T05:18:12","date_gmt":"2019-12-23T10:18:12","guid":{"rendered":"https:\/\/qxf2.com\/blog\/?p=11572"},"modified":"2019-12-23T05:27:19","modified_gmt":"2019-12-23T10:27:19","slug":"run-python-behave-from-visual-studio-code","status":"publish","type":"post","link":"https:\/\/qxf2.com\/blog\/run-python-behave-from-visual-studio-code\/","title":{"rendered":"Run python behave from Visual Studio Code"},"content":{"rendered":"

I was working at a client that uses behave and was primarily designed to work on Linux systems. It has several configuration variables stored as environmental variables. I tried running the behave tests on Windows using Visual Studio Code since I wanted debugging functionality. I documented the steps so that it will help anyone who wants to try the same.<\/p>\n

Prerequisite<\/h4>\n

Before getting started, please install the required packages needed for an automation environment. The primary ones would be Selenium,<\/a> Python,<\/a> pip,<\/a>\u00a0behave,<\/a>\u00a0chromedriver\u00a0<\/a>(or any browser) on your Windows machine.<\/p>\n


\n<\/strong>Setting up configuration in Visual Studio Code<\/h4>\n
    \n
  1. In Visual Studio Code, open the folder you want to work on.<\/span><\/span><\/li>\n
  2. Click on Debug Icon\u00a0<\/span>and then on ‘Configure or Fix launch.json’ icon.\u00a0The Select Environment dropdown gets opened.\u00a0Select Node.js.<\/span><\/span><\/span> \n

    \"Select_environment\"<\/a> <\/li>\n

  3. The launch.json will be displayed. This file is used to configure the debugger in Visual Studio Code.<\/li>\n
  4. Add the following configuration details to the launch.json<\/span>\n
    {\r\n\u00a0\u00a0\u00a0\u00a0\/\/\u00a0Use\u00a0IntelliSense\u00a0to\u00a0learn\u00a0about\u00a0possible\u00a0attributes.\r\n\u00a0\u00a0\u00a0\u00a0\/\/\u00a0Hover\u00a0to\u00a0view\u00a0descriptions\u00a0of\u00a0existing\u00a0attributes.\r\n\u00a0\u00a0\u00a0\u00a0\/\/\u00a0For\u00a0more\u00a0information,\u00a0visit:\u00a0https:\/\/go.microsoft.com\/fwlink\/?linkid=830387<\/a>\r\n\u00a0\u00a0\u00a0\u00a0\"version\":\u00a0\"0.2.0\",\r\n\u00a0\u00a0\u00a0\u00a0\"configurations\":\u00a0[\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0{\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"name\":\u00a0\"Python:\u00a0Behave\u00a0current\u00a0file\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"type\":\u00a0\"python\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"request\":\u00a0\"launch\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"module\":\u00a0\"behave\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"console\":\u00a0\"integratedTerminal\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"env\":\u00a0{\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"BASE_DIR\":\u00a0\"<your_automation_repository>\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0},\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"args\":[\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"--no-capture\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"--no-capture-stderr\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"${file}\"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\r\n\u00a0\u00a0\u00a0\u00a0]\r\n}<\/pre>\n
    <\/span>Note<\/strong>: In BASE_DIR we have set the path to automation repository. So, we will have the flexibility to change it to the directory we are working on.
    \n<\/span><\/li>\n
  5. The final file should look like this:
    \n    \"Final<\/a>
    \n<\/span><\/li>\n
  6. Set the integrated terminal as gitbash so that tests will be run through it.
    \nDo Ctrl + Shift + P to open the settings editor. Type settings and clicking on the JSON option.<\/span>
    \n    \"Settings<\/a>
    \nProvide the path to the git bash in the “terminal.integrated.shell.windows” option<\/p>\n
    \"\"<\/a><\/li>\n
  7. Set bashrc.
    \n<\/span><\/span><\/p>\n
    if [ -z $BASE_DIR ]; then\r\n BASE_DIR=<path of your automation repository>\r\nfi\r\ncd $BASE_DIR<\/pre>\n
    The BASE_DIR specified here is a default directory which will be used in case the directory is not set in VSCode and prevent the script from failing.<\/li>\n
  8. If you are using a virtual environment, set the path to it in\u00a0settings.json.
    \nDo Ctrl + Shift + P to open the settings editor. Type settings and clicking on the JSON option.<\/span>
    \n    \"Settings<\/a>
    \nSet the path of the virtual environment under “python.pythonPath”<\/span>
    \n    \"\"<\/a><\/li>\n<\/ol>\n
    That is it. Open the feature file you want to run and click on\u00a0the Run icon\u00a0<\/span>to start running your test in debug mode.\u00a0There are various option such as Pause, Step Over, Step Into etc. while running the test.\u00a0\u00a0\"Debug<\/a>
    \n<\/span>
    \n<\/span><\/p>\n
    References<\/h4>\n
      \n
    1. https:\/\/code.visualstudio.com\/docs\/editor\/variables-reference<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
      I was working at a client that uses behave and was primarily designed to work on Linux systems. It has several configuration variables stored as environmental variables. I tried running the behave tests on Windows using Visual Studio Code since I wanted debugging functionality. I documented the steps so that it will help anyone who wants to try the same. […]<\/p>\n","protected":false},"author":27,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-11572","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/11572","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/users\/27"}],"replies":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/comments?post=11572"}],"version-history":[{"count":27,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/11572\/revisions"}],"predecessor-version":[{"id":12000,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/11572\/revisions\/12000"}],"wp:attachment":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/media?parent=11572"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/categories?post=11572"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/tags?post=11572"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}