From 4919d2892fca7f06462e50baf09cb98734fcd36b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roberto=20Abdelkader=20Mart=C3=ADnez=20P=C3=A9rez?= Date: Mon, 26 Aug 2019 11:25:28 +0200 Subject: [PATCH] Use double backquotes --- spec/test/README.rst | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/spec/test/README.rst b/spec/test/README.rst index b5e2f02..2a05924 100644 --- a/spec/test/README.rst +++ b/spec/test/README.rst @@ -8,7 +8,7 @@ implementation. Prerequisites ------------- -First of all you need a working `kapow server` installed to run the +First of all you need a working ``kapow server`` installed to run the tests against it: Check that your installation is correct by typing this in a shell: @@ -50,16 +50,16 @@ Environment customization You can customize some of the test behavior with the following environment variables: -* `KAPOW_SERVER_CMD`: The full command line to start a non-interactive - listening kapow server. By default: `kapow server` -* `KAPOW_CONTROLAPI_URL`: URL of the Control API. By default: `http://localhost:8081` -* `KAPOW_DATAAPI_URL`: URL of the Data API. By default: `http://localhost:8080` +* ``KAPOW_SERVER_CMD``: The full command line to start a non-interactive + listening kapow server. By default: ``kapow server`` +* ``KAPOW_CONTROLAPI_URL``: URL of the Control API. By default: ``http://localhost:8081`` +* ``KAPOW_DATAAPI_URL``: URL of the Data API. By default: ``http://localhost:8080`` Fixing tests one by one ~~~~~~~~~~~~~~~~~~~~~~~ -If you use `make fix` instead of `make` the first failing test will stop +If you use ``make fix`` instead of ``make`` the first failing test will stop the execution, giving you a chance of inspecting the result. Also the tests will be in DEBUG mode displaying all requests made to the server. @@ -70,27 +70,27 @@ How to develop new tests? Developing new steps -------------------- -First of all execute `make catalog` this will display all the existing +First of all execute ``make catalog`` this will display all the existing steps and associates features. If none of the steps fits your needs -write a new one in your feature and run `make catalog` again. +write a new one in your feature and run ``make catalog`` again. The detected new step will trigger the output of a new section with a template for the step definition to be implemented (you can copy and -paste it removing the `u'` unicode symbol of the strings). +paste it removing the ``u'`` unicode symbol of the strings). Developing new step definitions ------------------------------- To make you life easier, mark the feature or scenario you are working on -with the tag `@wip` and use `make wip` to run only your +with the tag ``@wip`` and use ``make wip`` to run only your scenario/feature. 1. Paste the step definition template you just copied at the end of the - file `steps/steps.py`. -2. Run `make wip` to test that the step is triggered. You should see a - `NotImplementedError` exception. + file ``steps/steps.py``. +2. Run ``make wip`` to test that the step is triggered. You should see a + ``NotImplementedError`` exception. 3. Implement your step. -4. Run `make wip` again. +4. Run ``make wip`` again. -When you finish implementing your step definitions remove the `@wip` of -your feature/scenario and run `make` to test everything together. +When you finish implementing your step definitions remove the ``@wip`` of +your feature/scenario and run ``make`` to test everything together.