0506379572
It is an initial seed of hacking rules based on neutron and nova projects. For ceilometer it prevents bug 1508442 and closes/prevents bug 1529836. All the requirements about the hacking rules were corrected on this propose review. To be clear about the requirements, the only alarmed was about import[1], in specific H306 [H306] "Alphabetically order your imports by the full module path. Organize your imports" [1] http://docs.openstack.org/developer/hacking/ Change-Id: Ia530873078c97925bfb91fde87b38131426a74c2 Closes-Bug: 1529836
28 lines
1.0 KiB
ReStructuredText
28 lines
1.0 KiB
ReStructuredText
Ceilometer Style Commandments
|
|
=============================
|
|
|
|
- Step 1: Read the OpenStack Style Commandments
|
|
http://docs.openstack.org/developer/hacking/
|
|
- Step 2: Read on
|
|
|
|
Ceilometer Specific Commandments
|
|
--------------------------------
|
|
|
|
- [C301] LOG.warn() is not allowed. Use LOG.warning()
|
|
- [C302] Deprecated library function os.popen()
|
|
|
|
Creating Unit Tests
|
|
-------------------
|
|
For every new feature, unit tests should be created that both test and
|
|
(implicitly) document the usage of said feature. If submitting a patch for a
|
|
bug that had no unit test, a new passing unit test should be added. If a
|
|
submitted bug fix does have a unit test, be sure to add a new one that fails
|
|
without the patch and passes with the patch.
|
|
|
|
All unittest classes must ultimately inherit from testtools.TestCase.
|
|
|
|
All setUp and tearDown methods must upcall using the super() method.
|
|
tearDown methods should be avoided and addCleanup calls should be preferred.
|
|
Never manually create tempfiles. Always use the tempfile fixtures from
|
|
the fixture library to ensure that they are cleaned up.
|