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

Bug #1732024 reported by Matt Riedemann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Medium
Matt Riedemann

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

Tags: docs
Matt Riedemann (mriedem)
Changed in nova:
status: New → Triaged
Revision history for this message
Matt Riedemann (mriedem) wrote :
Changed in nova:
assignee: nobody → Matt Riedemann (mriedem)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

Fix proposed to branch: master
Review: https://review.openstack.org/519482

Changed in nova:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

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 <email address hidden>
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
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 17.0.0.0b2

This issue was fixed in the openstack/nova 17.0.0.0b2 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.