aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/developer/devguide
AgeCommit message (Collapse)AuthorFilesLines
2018-11-09Merge "[docs] Resolve "nested numbering in toctree?" warning"Rex Lee1-1/+0
2018-11-06[docs] Update mailing list to use #yardstickEmma Foley1-3/+3
The mailing list is on a new system that lets you use #topics instead of [topics]. The contact information has been updated to reflect this. JIRA: YARDSTICK-1335 Change-Id: Ida9af98f00761a3bff8903165fd2806163787ccd Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-11-06Merge changes from topic 'doc/nsb-qsg'Rex Lee1-132/+201
* changes: [docs][userguide] Update formatting for Influx instructions in ch04 [userguide] Update the directory structure listing [docs][devguide] Fix line lengths in devguide_nsb_prox.rst
2018-11-05[docs] Resolve "nested numbering in toctree?" warningEmma Foley1-1/+0
Signed-off-by: Emma Foley <emma.l.foley@intel.com> Change-Id: Id31c0484db2dc28c2237455b863d2eac9fcbc66a
2018-10-30[docs][devguide] Fix line lengths in devguide_nsb_prox.rstEmma Foley1-132/+201
JIRA: YARDSTICK-1335 Change-Id: I863da3318a71dbcf2dc3f2b43fda6a92feed2089 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Update broken and redirected linksEmma Foley2-6/+6
A number of links were broken, or permenently redirected. Some literal include directives pointed to the wrong location. These have been updated, so the links are valid. JIRA: YARDSTICK-1416 Change-Id: Icd20113e0ab099850fa58fa41bb27a00670f57ca Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30Merge "[docs] Add developer guidelines for contribution"Rex Lee1-0/+89
2018-10-30[docs] Add conventions for writing unit tests.Emma Foley1-0/+51
Added details of conventions used when writing unit tests. JIRA: YARDSTICK-1335 Change-Id: I7bb141126968c88c8a2d7e0dce4f33ed6f79cee4 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Add developer guidelines for contributionEmma Foley1-0/+89
A new section was added to the devguide, stating expectations for code contributions. * What to include in a change * Code style guidelines * How to run tests JIRA: YARDSTICK-1335 Change-Id: Idfe7790042a3a3fe6cd8763374b10f2268bd63cd Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-07-16Propose the backporting processEmma Foley1-0/+26
Change-Id: I0b0fddf8dfdd68fa144b28dba911352e9a4974fd JIRA: YARDSTICK-1253 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-07-04Merge "Fix up formatting on devguide"Rodolfo Alonso Hernandez1-77/+151
2018-06-29Update PROX_NSB_DEVGUIDE for F ReleaseDanielMartinBuckley10-25/+119
Contains Updates :- New Description of Grafana output New Description of ProxDuration Runner Update Description of Openstack Network Change-Id: I861bb7eab4aeed207c0151be6766c48c5f10c6ef Signed-off-by: Daniel Martin Buckley <daniel.m.buckley@intel.com>
2018-06-29Fix up formatting on devguideEmma Foley1-77/+151
* Change the notation used for heading levels and add a key at the top of the file. * Wrap lines at 80 characters. * Highlight keywords Change-Id: Ic6e7194270bbffb3ddaf688c774b632287b0c201 JIRA: YARDSTICK-1253 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-05-11[docs] Add info on gerrit groups to the devguide.Emma Foley1-1/+2
Added the yardstick-reviewers and yardstick-committers groups as an alternative to adding individual developers to a code review. Change-Id: I1ebba56ba27dac00f7e7af7858b3c599a0f1eae8 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-03-09Do NOT hardcode interface speed for PROX testsDanielMartinBuckley1-1/+9
JIRA: YARDSTICK-1035 Do not hardcode NIC/interface speed in PROX test. Test assumes NIC used is 10Gbps. This is incorrect. It could support 1Gbps, 10Gbps, 25Gbps, 40Gbps or something else. This is used to calculate pps (Packets Per Second) In Baremetal the NIC speed could be extracted. however when run on a virtual machine this is not possible. Solution: Add in options section of test file. eg. Options: interface_speed_gbps: 10 Where 10 refers to a 10Gbps. In a setup where multiple interfaces are used. This will refer to the speed of the slowest connection. Change-Id: I89ab16479a2cdd1d79e52cbcc5a972762c60d057 Signed-off-by: Daniel Martin Buckley <daniel.m.buckley@intel.com>
2018-02-27Addition of NSB Prox developer guide.DanielMartinBuckley16-0/+1226
JIRA: YARDSTICK-840 This provides a developer guide to enable the reader to add NSB PROX tests based on existing PROX functionality. This allows the user to configure, run and debug NSB Prox tests for Baremetal and Openstack (both 2 and 4 ports) Change-Id: I2cb9eb6064e501dd9abe0d2cc4ed8ce4b369f174 Signed-off-by: Daniel Martin Buckley <daniel.m.buckley@intel.com>
2017-12-22Merge "Remove "flake8" and "pep8" from test-requirements"Ross Brattain1-1/+1
2017-12-14Change testcases 'cirros' image to 'yardstick-image'Rodolfo Alonso Hernandez1-2/+2
The default OpenStack 'cirros-0.3.5' image doesn't exist anymore. The image included by default in any testing OpenStack deployment is now called 'cirros-0.3.5-x86_64-disk', but this name can change. Because Yardstick, during the installation, deploys a customized image, 'yardstick-image', it makes sense to use it as the default image. JIRA: YARDSTICK-873 Change-Id: I8fd7cbc01d4fa52e9107f2fac7d2d9ff5d1091c7 Signed-off-by: Rodolfo Alonso Hernandez <rodolfo.alonso.hernandez@intel.com>
2017-12-13Remove "flake8" and "pep8" from test-requirementsRodolfo Alonso Hernandez1-1/+1
Removed "flake8" and "pep8" from test-requirements. Since 44070670c798d2cde2824f3150b2b11bf35c6319, "pylint" is the code style checker, instead of "flake8" or "pep8". JIRA: YARDSTICK-832 Change-Id: Iee598b0b1793d71dc74be36fa1875387b17d1e25 Signed-off-by: Rodolfo Alonso Hernandez <rodolfo.alonso.hernandez@intel.com>
2017-11-17Tox: add a pep8 targetEmma Foley1-1/+1
Adds a pep8, pep8-full targets to tox: * pep8 target: runs pylint on the changed files * pep8-full target: runs pylint on whole repo Adds scripts to run pylint: * stored in tools/ Documentation: changeed the command for running tests (run_tests.sh -> tox). This runs the same set of tests as before. JIRA: YARDSTICK-832 Change-Id: I652da87723682d958f3fcbc2eb4cd88422636a3b Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2017-10-25Removing trailing whitespaceJingLu51-3/+3
Change-Id: I0380deec3e41a6dc02571ed9c4fa16e304f7f85e Signed-off-by: JingLu5 <lvjing5@huawei.com>
2017-10-25Add "How to work with test case" into devguidekubi1-0/+250
JIRA: YARDSTICK-73 add a new chapter about how to work with test case, now just add three sub chapter, sample test case, release test case, test case description file, will update more for how to write a new test case. Change-Id: I44906917e76ad6d4890f345c963b9e4440f6be39 Signed-off-by: kubi <jean.gaoliang@huawei.com>
2017-10-18Hamonization of the titles of the documents (Testing group)Morgan Richomme1-3/+3
Change-Id: I6065fb416a90544539316666aac92735ee84177a Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>
2017-03-30Refine documentationJingLu53-0/+240
Change-Id: I0d3387a520e3decf51bb0f7db53996f148a611d0 Signed-off-by: JingLu5 <lvjing5@huawei.com>