![Matthew Treinish](/assets/img/avatar_default.png)
This commit updates the hacking rules to add a strict format for bug skips. Previously, there was no defined rules for skip formatting which caused a number of test skips to be added without consistent formatting. These skips then failed to get picked up by tools/skip_tracker.py. This commit adds a new hacking test to ensure that any skips added conform to a format that the skip_tracker will pick up. HACKING.rst was also updated to explain the new rules being enforced. Change-Id: I95f3ec7de2ee5e2039d53ad9565b5cec936a7672
6.6 KiB
Test Data/Configuration
- Assume nothing about existing test data
- Tests should be self contained (provide their own data)
- Clean up test data at the completion of each test
- Use configuration files for values that will vary by environment
General
Put two newlines between top-level code (funcs, classes, etc)
Put one newline between methods in classes and anywhere else
Long lines should be wrapped in parentheses in preference to using a backslash for line continuation.
Do not write "except:", use "except Exception:" at the very least
Include your name with TODOs as in "#TODO(termie)"
Do not name anything the same name as a built-in or reserved word Example:
def list(): return [1, 2, 3] mylist = list() # BAD, shadows `list` built-in class Foo(object): def list(self): return [1, 2, 3] mylist = Foo().list() # OKAY, does not shadow built-in
Imports
- Do not import objects, only modules (*)
- Do not import more than one module per line (*)
- Do not make relative imports
- Order your imports by the full module path
- Organize your imports according to the following template
Example:
# vim: tabstop=4 shiftwidth=4 softtabstop=4
{{stdlib imports in human alphabetical order}}
\n
{{third-party lib imports in human alphabetical order}}
\n
{{tempest imports in human alphabetical order}}
\n
\n
{{begin your code}}
Human Alphabetical Order Examples
Example:
import httplib
import logging
import random
import StringIO
import testtools
import time
import eventlet
import webob.exc
import tempest.config
from tempest.services.compute.json.limits_client import LimitsClientJSON
from tempest.services.compute.xml.limits_client import LimitsClientXML
from tempest.services.volume.volumes_client import VolumesClientJSON
import tempest.test
Docstrings
Example:
"""A one line docstring looks like this and ends in a period."""
"""A multi line docstring has a one-line summary, less than 80 characters.
Then a new paragraph after a newline that explains in more detail any
general information about the function, class or method. Example usages
are also great to have here if it is a complex class for function.
When writing the docstring for a class, an extra line should be placed
after the closing quotations. For more in-depth explanations for these
decisions see http://www.python.org/dev/peps/pep-0257/
If you are going to describe parameters and return values, use Sphinx, the
appropriate syntax is as follows.
:param foo: the foo parameter
:param bar: the bar parameter
:returns: return_type -- description of the return value
:returns: description of the return value
:raises: AttributeError, KeyError
"""
Dictionaries/Lists
If a dictionary (dict) or list object is longer than 80 characters, its items should be split with newlines. Embedded iterables should have their items indented. Additionally, the last item in the dictionary should have a trailing comma. This increases readability and simplifies future diffs.
Example:
my_dictionary = {
"image": {
"name": "Just a Snapshot",
"size": 2749573,
"properties": {
"user_id": 12,
"arch": "x86_64",
},
"things": [
"thing_one",
"thing_two",
],
"status": "ACTIVE",
},
}
Calling Methods
Calls to methods 80 characters or longer should format each argument with newlines. This is not a requirement, but a guideline:
unnecessarily_long_function_name('string one',
'string two',
kwarg1=constants.ACTIVE,
kwarg2=['a', 'b', 'c'])
Rather than constructing parameters inline, it is better to break things up:
list_of_strings = [
'what_a_long_string',
'not as long',
]
dict_of_numbers = {
'one': 1,
'two': 2,
'twenty four': 24,
}
object_one.call_a_method('string three',
'string four',
kwarg1=list_of_strings,
kwarg2=dict_of_numbers)
Test Skips
If a test is broken because of a bug it is appropriate to skip the test until bug has been fixed. However, the skip message should be formatted so that Tempest's skip tracking tool can watch the bug status. The skip message should contain the string 'Bug' immediately followed by a space. Then the bug number should be included in the message '#' in front of the number.
Example:
@testtools.skip("Skipped until the Bug #980688 is resolved")
openstack-common
A number of modules from openstack-common are imported into the project.
These modules are "incubating" in openstack-common and are kept in sync with the help of openstack-common's update.py script. See:
The copy of the code should never be directly modified here. Please always update openstack-common first and then run the script to copy the changes across.
OpenStack Trademark
OpenStack is a registered trademark of the OpenStack Foundation, and uses the following capitalization:
OpenStack
Commit Messages
Using a common format for commit messages will help keep our git history readable. Follow these guidelines:
First, provide a brief summary (it is recommended to keep the commit title under 50 chars).
The first line of the commit message should provide an accurate description of the change, not just a reference to a bug or blueprint. It must be followed by a single blank line.
If the change relates to a specific driver (libvirt, xenapi, qpid, etc...), begin the first line of the commit message with the driver name, lowercased, followed by a colon.
Following your brief summary, provide a more detailed description of the patch, manually wrapping the text at 72 characters. This description should provide enough detail that one does not have to refer to external resources to determine its high-level functionality.
Once you use 'git review', two lines will be appended to the commit message: a blank line followed by a 'Change-Id'. This is important to correlate this commit with a specific review in Gerrit, and it should not be modified.
For further information on constructing high quality commit messages, and how to split up commits into a series of changes, consult the project wiki: