{"id":84,"date":"2012-07-16T20:44:40","date_gmt":"2012-07-16T20:44:40","guid":{"rendered":"http:\/\/blog.mozilla.org\/webqa\/?p=84"},"modified":"2012-07-16T20:44:40","modified_gmt":"2012-07-16T20:44:40","slug":"setting-up-pycharm-to-run-mozwebqa-tests","status":"publish","type":"post","link":"https:\/\/blog.mozilla.org\/fxtesteng\/2012\/07\/16\/setting-up-pycharm-to-run-mozwebqa-tests\/","title":{"rendered":"Setting Up PyCharm to Run MozWebQA Tests"},"content":{"rendered":"

(The following is a guest post by Bob Silverberg<\/a>, one of our awesome contributors in Web QA.)<\/em><\/strong><\/p>\n

PyCharm<\/a> is a Python IDE, released by JetBrains<\/a>. I quite enjoy using it and, as I've recently started contributing some tests to Mozilla's Web QA<\/a> department (mozwebqa), I wanted to use it to interactively debug some mozwebqa tests. This turned out to be a lot trickier than I had imagined, so I am documenting the steps to do so via this post.<\/p>\n

This post assumes you have a project open in PyCharm for one of the mozwebqa projects. I am going to use marketplace-tests<\/a> for this example. As I am on a Mac, the instructions and screen shots will be OS X-specific, but I imagine they will translate pretty closely to Windows.<\/p>\n

Step 1 – Configure py.test as your default test runner<\/h3>\n
    \n
  1. Open up the Preferences…<\/em> dialog and choose Python Integrated Tools<\/em> under Project Settings<\/em>.<\/li>\n
  2. Choose py.test<\/strong> as the Default test runner.<\/em><\/li>\n
  3. Click OK<\/em>.<\/li>\n<\/ol>\n

    Step 2 – Set default run configuration parameters for your project<\/h3>\n
      \n
    1. Type ctrl + alt + R<\/strong> to open the Run<\/em> configuration selector.<\/li>\n
    2. Type 0<\/strong>, or choose the first option (Edit configurations…<\/em>) from the select list.<\/li>\n
    3. In the Run<\/em> dialog, expand Defaults > Python's test<\/em> and click onpy.test<\/em>.<\/li>\n
    4. Make sure the Python interpreter that you want to use for this project is selected for Python interpreter<\/em>. If you are using virtualenv you may have to configure a new Python interpreter for your virtualenv. More on that in a separate post.<\/li>\n
    5. Choose the root of your project for Working directory<\/em>.<\/li>\n
    6. Click Apply<\/em>, then Close<\/em>.<\/li>\n<\/ol>\n

      Step 3 – Create a pytest.ini file in the root of your project<\/h3>\n

      This is necessary to pass command line options to py.test. It would be nice if there were a way to do this via the IDE, but I was not able to do it. If anyone knows how, or can figure out how, to do that I'd love to know. I was<\/em> able to pass a single option to the command line from PyCharm, but could not get it to work with multiple options.<\/p>\n

        \n
      1. Create a file called pytest.ini<\/em> in the root of your project.<\/li>\n
      2. Add the command line options you need into that file under the [pytest]<\/em> section. See below for an example from marketplace-tests.<\/em><\/li>\n
      3. Click OK<\/em>.<\/li>\n<\/ol>\n

        [pytest]
        \naddopts = --driver=firefox --credentials=mine\/credentials.yaml --destructive<\/code>\n<\/p>\n

        Step 4 – Create a copy of credentials.yaml in a personal folder<\/h3>\n

        You are going to have to edit credentials.yaml<\/em> to place some actual credentials in it, so in order to not have it overwitten each time you do a pull, you should put a copy that you are going to use somewhere else. I tend to create a \/mine<\/em> folder under the project root and place it there, but you can put it anywhere you like. You will notice that the command line option above uses that \/mine<\/em> folder to locate the credentials file.<\/p>\n

        Step 5 – Run your tests<\/h3>\n

        With a file that contains tests open in an editor window, type ctrl + shift + R<\/strong> and PyCharm will run all of the tests in the file. If you wish to run just one test, type ctrl + alt + R<\/strong>, followed by 0<\/strong> to open the Edit configurations…<\/em> dialog and then place the name of your test in the Keywords<\/em> input. Click Run<\/strong>.<\/p>\n","protected":false},"excerpt":{"rendered":"

        (The following is a guest post by Bob Silverberg, one of our awesome contributors in Web QA.) PyCharm is a Python IDE, released by JetBrains. I quite enjoy using it … Read more<\/a><\/p>\n","protected":false},"author":512,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[25202,25193],"tags":[25209,25208,19632],"_links":{"self":[{"href":"https:\/\/blog.mozilla.org\/fxtesteng\/wp-json\/wp\/v2\/posts\/84"}],"collection":[{"href":"https:\/\/blog.mozilla.org\/fxtesteng\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.mozilla.org\/fxtesteng\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.mozilla.org\/fxtesteng\/wp-json\/wp\/v2\/users\/512"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.mozilla.org\/fxtesteng\/wp-json\/wp\/v2\/comments?post=84"}],"version-history":[{"count":0,"href":"https:\/\/blog.mozilla.org\/fxtesteng\/wp-json\/wp\/v2\/posts\/84\/revisions"}],"wp:attachment":[{"href":"https:\/\/blog.mozilla.org\/fxtesteng\/wp-json\/wp\/v2\/media?parent=84"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.mozilla.org\/fxtesteng\/wp-json\/wp\/v2\/categories?post=84"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.mozilla.org\/fxtesteng\/wp-json\/wp\/v2\/tags?post=84"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}