Merge lp:~bgh/neutron/testing2 into lp:neutron/diablo

[Brad Hall]

Add TESTING document :)

[dan wendlandt (danwent)]

Cool. A couple minor comments:

- Might be good to point to Salvatore's wiki page which actually describes the tests: http://wiki.openstack.org/QuantumUnitTestStatus, as it is not obvious how to get to this list from the branch that is linked in the doc.

- Also, is Salvatore planning on keeping that branch around for a while, or it will go away once that set of tests are merged?

- It would be great somewhere state that before someone proposes for code to be merged, they have run the tests and they are clean. Not sure if this doc is the right place, but it just came to mind.

- Maybe state that for functional tests, quantum should be running on the same local machine (i'm guessing)

[Salvatore Orlando (salvatore-orlando)]

Thanks for providing a guide to testing in the source code tree!

I'm ok with merging it in trunk now, altough we have to keep in mind that the current source code tree does not have any unit test, as there are only a few functional tests. I would consider merging this document into the unit test branch, and then merge everything into trunk. What's your opinion?

Also, as suggested by Dan it will be good to point out that quantum should be running on the same machine where the test are being executed, on port 9696. This at least until we enable functional tests to load/stop the service.

I also agree with Dan that contributors should make sure that all unit tests pass before proposing for merge: I would also add that whenever new functionalities are added, they should provide unit tests for them.

@Dan: Plan is to propose my branch for merge as soon as all unit tests for API are ready. I just need to find a couple of hours to finish them! I will then keep the branch around while unit tests for other components are completed.

review: Needs Information

[dan wendlandt (danwent)]

Good points salvatore. Merging into the testing branch makes sense to me.
 Also agree with the comment about telling people to add new unit tests
before new functionality comes in. This is something that we'll want to
enforce as part of code reviews.

dan

On Wed, Jul 13, 2011 at 3:44 PM, Salvatore Orlando <
<email address hidden>> wrote:

> Review: Needs Information
> Thanks for providing a guide to testing in the source code tree!
>
> I'm ok with merging it in trunk now, altough we have to keep in mind that
> the current source code tree does not have any unit test, as there are only
> a few functional tests. I would consider merging this document into the unit
> test branch, and then merge everything into trunk. What's your opinion?
>
> Also, as suggested by Dan it will be good to point out that quantum should
> be running on the same machine where the test are being executed, on port
> 9696. This at least until we enable functional tests to load/stop the
> service.
>
> I also agree with Dan that contributors should make sure that all unit
> tests pass before proposing for merge: I would also add that whenever new
> functionalities are added, they should provide unit tests for them.
>
>
> @Dan: Plan is to propose my branch for merge as soon as all unit tests for
> API are ready. I just need to find a couple of hours to finish them! I will
> then keep the branch around while unit tests for other components are
> completed.
>
> --
> https://code.launchpad.net/~bgh/quantum/testing2/+merge/67789
> You are requested to review the proposed merge of lp:~bgh/quantum/testing2
> into lp:quantum.
>

--
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Dan Wendlandt
Nicira Networks, Inc.
www.nicira.com | www.openvswitch.org
Sr. Product Manager
cell: 650-906-2650
~~~~~~~~~~~~~~~~~~~~~~~~~~~

[Brad Hall (bgh)]

Thanks for all the feedback. I'm going to put this into the unit tests branch for now and we can merge it along with the tests.

[Salvatore Orlando (salvatore-orlando)]

Setting state for this merge proposal to Rejected as the branch has been merged into lp:~netstack/quantum/quantum-unit-tests.

Not deleting the merge proposal itself just in case we want to keep the discussion history.

Unmerged revisions

20. By Brad Hall on 2011-07-13

add TESTING file

=== added file 'TESTING'
--- TESTING	1970-01-01 00:00:00 +0000
+++ TESTING	2011-07-13 04:59:22 +0000
@@ -0,0 +1,33 @@
+Testing Quantum
+=============================================================
+
+Overview
+
+    There are two types of tests in quantum: functional and unit.  Their
+    respective directories are located in the tests/ directory.
+
+    The functional tests are intended to be used when the service is running.
+    Their goal is to make sure the service is working end to end and also to
+    test any plugin for conformance and functionality.
+
+    The unit tests can be run without the service running.  They are designed
+    to test the various pieces of the quantum tree to make sure any new
+    changes don't break existing functionality.
+
+Running tests
+
+    All tests can be run via the run_tests.sh script, which will allow you to
+    run them in the standard environment or create a virtual environment to
+    run them in.  All of the functional tests will fail if the service isn't
+    running.  One current TODO item is to be able to specify whether you want
+    to run the functional or unit tests via run_tests.sh.
+
+    After running all of the tests, run_test.sh will report any pep8 errors
+    found in the tree.
+
+Adding more tests
+
+    Quantum is a pretty new code base at this point and there is plenty of
+    areas that need tests.  The current blueprint and branch for adding tests
+    is located at:
+    https://code.launchpad.net/~netstack/quantum/quantum-unit-tests