]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
mgr/dashboard: Cleanup HACKING.rst
authorPatrick Nawracay <pnawracay@suse.com>
Mon, 17 Jun 2019 11:01:33 +0000 (13:01 +0200)
committerPatrick Nawracay <pnawracay@suse.com>
Mon, 17 Jun 2019 11:07:01 +0000 (13:07 +0200)
Rephrase explanations on how to write E2E tests with Protractor.

Signed-off-by: Patrick Nawracay <pnawracay@suse.com>
src/pybind/mgr/dashboard/HACKING.rst

index 6c1a2c2289f2642b7674af13b947dde0ca623d6c..ca31aa62156a27107a7c966ffe5ffb429433872a 100644 (file)
@@ -139,13 +139,13 @@ There are a few ways how you can try to resolve this:
 Running End-to-End Tests
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-We use `Protractor <http://www.protractortest.org/>`__ to run our frontend e2e
+We use `Protractor <http://www.protractortest.org/>`__ to run our frontend E2E
 tests.
 
 Our ``run-frontend-e2e-tests.sh`` script will check if Chrome or Docker is
 installed and run the tests if either is found.
 
-Start all frontend e2e tests by running::
+Start all frontend E2E tests by running::
 
   $ ./run-frontend-e2e-tests.sh
 
@@ -173,12 +173,16 @@ Note:
 Writing End-to-End Tests
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-When writing e2e tests you don't want to recompile every time from scratch to
-try out if your test has succeeded. As usual you have your development server
-open (``npm start``) which already has compiled all files. To attach
-`Protractor <http://www.protractortest.org/>`__ to this process, instead of
-spinning up it's own server, you can use ``npm run e2e -- --dev-server-target``
-or just ``npm run e2e:dev`` which is equivalent.
+When writing E2E tests, it is not necessary to compile the frontend code on
+each change of the test files. When your development environment is running
+(``npm start``), you can point Protractor to just use this environment.  To
+attach `Protractor <http://www.protractortest.org/>`__ to this process, run
+``npm run e2e:dev``.
+
+Note::
+
+   In case you have a somewhat particular environment, you might need to adapt
+   `protractor.conf.js` to point to the appropriate destination.
 
 Further Help
 ~~~~~~~~~~~~