← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1732024] Re: docs: unit tests doc links to hacking repo docs which isn't particularly helpful

 

Reviewed:  https://review.openstack.org/519482
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=85235d229be7ee77640a68ffd8619518478d0805
Submitter: Zuul
Branch:    master

commit 85235d229be7ee77640a68ffd8619518478d0805
Author: Matt Riedemann <mriedem.os@xxxxxxxxx>
Date:   Mon Nov 13 17:13:18 2017 -0500

    doc: fix link to creating unit tests in contributor guide
    
    The testing strategy doc was linking to the hacking repo docs
    on creating unit tests, which are very specific to creating
    unit tests for hacking rules.
    
    This changes the link to the 'creating unit tests' section in
    the HACKING.rst file, which has more information on testing
    within nova.
    
    Along with that change, the HACKING.rst testing section is
    updated a bit to point out that we use stestr now instead of
    testr and adds a proper link to the development environment
    quickstart docs.
    
    The nova/tests/unit/README.rst actually needs a lot of work,
    but that's left for another day.
    
    Change-Id: Ie5106d87d632286162b31ce132e947c306d21abd
    Closes-Bug: #1732024


** Changed in: nova
       Status: In Progress => Fix Released

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1732024

Title:
  docs: unit tests doc links to hacking repo docs which isn't
  particularly helpful

Status in OpenStack Compute (nova):
  Fix Released

Bug description:
  This page:

  https://docs.openstack.org/nova/latest/contributor/testing.html#unit-
  tests

  Links to:

  https://docs.openstack.org/hacking/latest/user/hacking.html#creating-
  unit-tests

  Which is specific to writing unit tests for the hacking repo, not
  nova. The nova docs should probably point at the nova hacking docs
  instead:

  https://github.com/openstack/nova/blob/master/HACKING.rst#creating-
  unit-tests

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1732024/+subscriptions


References