openbmc/openbmc-test-automation/CONTRIBUTING.md

3 Guide to working on OpenBMC test automation. This document will always be a
33 - Observe a maximum line length of 110 characters.
36 - Robot supports delimiting cells with either two or more spaces or with a pipe
80 - When you define or call a Robot keyword, Robot pays no attention to spaces,
106       # This keyword name is incorrect because of 1) a failure to
107       # separate words with single spaces and 2) a failure to capitalize
119     Punctuate it correctly with the first word capitalized and a period at the
135         # The doc string above is not phrased as a command.
168   - Create a tag for every test suite with a tag name that represents the suite
172     Create a suite Tag name from the test file name
179   - Create a tag for every test case with a tag name that mirrors the test case
191     include a "**Description of argument(s)**" section. This effectively serves
222       "etc.". Separate such values with a slash.
226   When assigning a variable as output from a keyword, do not precede the equal
227   sign with a space.
248   - Words within a variable name should be separated by underscores:
281   - Avoid having the variable's type as a suffix portion of the name:
294     # Use plural name to indicate that it is a list.
305     It creates a lot of confusion for the reader.
328     When a variable is intended to contain **either** an IP address **or** a
329     host name (whether long or short), please give it a suffix of "\_host".
342     For host names (long or short, e.g. "bmc1" or "bmc1.example.com"), use a
356     For short host names (e.g. "bmc1"), use a suffix of \_host_short_name.
369     For IP addresses, use a suffix of \_ip.
384       - If your variable is to contain only the file's name, use a suffix of
393       - If your variable is to contain the path to a file, use a suffix of
394         \_file_path. Bear in mind that a file path can be relative or absolute,
395         so that should not be a consideration in whether to use the
409         are a relative or absolute path (as shown in the examples above). A file
410         path is simply a value with enough information in it for the program to
414         rare case), use a suffix \_abs_file_path.
421       - If your variable is to contain only the directory's name, use a suffix
430       - If your variable is to contain the path to a directory, use a suffix of
431         \_dir_path. Bear in mind that a dir path can be relative or absolute, so
432         that should not be a consideration in whether to use \_dir_path.
445         are a relative or absolute path (as shown in the examples above). A dir
446         path is simply a value with enough information in it for the program to
450         rare case), use a suffix \_abs_dir_path.
451       - IMPORTANT: As a programming convention, do pre- processing on all
452         dir_path variables to ensure that they contain a trailing slash. If we
454         parts of the program, the programmer can count on the value having a
482     - End sentences (or stand-alone phrases) with a period.
516     Note: Normally, a template test case would have many rows of data arguments
520     for these reasons: 1) Template tests are counted as a single test. The user
534   Example as run from a Linux command line:
555                                       the caller does not specify a value,
564 - As shown in the prior example, if your function has any arguments, include a
579 - When you define a python function, observe the following conventions:
598       # This keyword name is incorrect because of 1) a failure to
606     Punctuate it correctly with the first word capitalized and a period at the
626         # The doc string above is not phrased as a command.
629   - Doc strings should begin with a summary line which is one terse, descriptive
662   - Words within a variable name should be separated by underscores:
685     When a variable is intended to contain **either** an IP address **or** a
686     host name (either long or short), please give it a suffix of "\_host".
699     For host names (long or short, e.g. "bmc1" or "bmc1.example.com"), use a
713     For short host names (e.g. "bmc1"), use a suffix of \_host_short_name.
726     For IP addresses, use a suffix of \_ip.
741     - If your variable is to contain only the file's name, use a suffix of
750     - If your variable is to contain the path to a file, use a suffix of
751       \_file_path. Bear in mind that a file path can be relative or absolute, so
752       that should not be a consideration in whether to use the "\_file_path"
766       a relative or absolute path (as shown in the examples above). A file path
767       is simply a value with enough information in it for the program to find
771       rare case), use a suffix \_abs_file_path.
777     - If your variable is to contain only the directory's name, use a suffix of
786     - If your variable is to contain the path to a directory, use a suffix of
787       \_dir_path. Bear in mind that a dir path can be relative or absolute so,
788       that should not be a consideration in whether to use \_dir_path.
801       a relative or absolute path (as shown in the examples above). A dir path
802       is simply a value with enough information in it for the program to find
806       rare case), use a suffix \_abs_dir_path.
807     - IMPORTANT: As a programming convention, do pre- processing on all dir_path
808       variables to ensure that they contain a trailing slash. If we follow that
810       program, the programmer can count on the value having a trailing slash.
829     - End sentences (or stand-alone phrases) with a period.
835 We have several templates in the templates/ sub-directory. If there is a
847 all follow a similar structure.