Merge lp:~wallyworld/launchpad/reassign-reviewer-cancel-option into lp:launchpad

[Ian Booth]

Add Cancel URL to the merge proposal Reassign Reviewer page

Bug 640193 requires that a Cancel link be on the merge proposal Reassign Reviewer page.

Implementation

    Simple fix - assign cancel_url in CodeReviewVoteReassign initialize() method. Also a few drive-by lint fixes.

Tests

    test -vvt test_codereviewvote

    Add new test_view_attributes() test to test_codereviewvote.py

= Launchpad lint =

Checking for conflicts and issues in changed files.

Linting changed files:
  lib/lp/code/browser/codereviewvote.py
  lib/lp/code/browser/tests/test_codereviewvote.py

[Steve Kowalik (stevenk)]

This change looks good to me.

review: Approve (code*)

[Tim Penhey (thumper)]

Steve, when reviewing browser we try to avoid overriding initialize unless it
is really necessary (I don't entirely recall why), and provide as much as we
can using properties.

Also when writing tests for views there is a very useful test method called:
    create_initialized_view

So... with these two thoughts in mind I have the following suggestions:

    @property
    def next_url(self):
        return canonical_url(self.context.branch_merge_proposal)

    cancel_url = next_url

This means that you don't have to override the initialize method.

Also in the test, you should never have any database IDs, like +merge/1.

Better to assert that the cancel_url matches the canonical_url of the merge
proposal.

    self.assertEqual(canonical_url(bmp), view.cancel_url)

Also... use create_initialized_view rather than manually creating the review.

    view = create_initialized_view(vote, '+reassign')

I also find the flow of the test a little harder to follow with the multiple
login commands. I think it would read slightly better to use
with_person_logged_in (don't forget the future import if it isn't there
already).

    def test_view_cancel_url(self):
        # Check that the cancel url exists.
        bmp = self.factory.makeBranchMergeProposal()
        reviewer = self.factory.makePerson()
        with person_logged_in(bmp.registrant):
            vote = bmp.nominateReviewer(
                reviewer=reviewer, registrant=bmp.registrant)
        with person_logged_in(reviewer):
            view = create_initialized_view(vote, '+reassign')
            self.assertEqual(canonical_url(bmp), view.cancel_url)

A side note: we often use comments instead of docstrings for the test methods
because it isn't always easy to get a single line to describe the test.

review: Needs Fixing

[Ian Booth (wallyworld)]

Thanks for the tips. I'll address the issues raised. The approach taken
was based on looking at what had been done previously for say
MergeProposalEditView. However, I see now that case is in the minority
and most other implementations use properties :-) Trust me to find as a
template to copy from the "wrong" one :-)

The structure of the test itself, with the multiple logins and use of
docstring etc, was based on the test case just above it, the only other
one in that test class. I thought it best to maintain implementation
consistency between the two test cases. What I'll look to do then is
refactor the existing test case as well so that they are both a)
implemented as per crrent best practice, and b) consistent.

On 28/09/10 08:24, Tim Penhey wrote:
> Review: Needs Fixing
> Steve, when reviewing browser we try to avoid overriding initialize unless it
> is really necessary (I don't entirely recall why), and provide as much as we
> can using properties.
>
> Also when writing tests for views there is a very useful test method called:
> create_initialized_view
>
> So... with these two thoughts in mind I have the following suggestions:
>
> @property
> def next_url(self):
> return canonical_url(self.context.branch_merge_proposal)
>
> cancel_url = next_url
>
> This means that you don't have to override the initialize method.
>
> Also in the test, you should never have any database IDs, like +merge/1.
>
> Better to assert that the cancel_url matches the canonical_url of the merge
> proposal.
>
> self.assertEqual(canonical_url(bmp), view.cancel_url)
>
> Also... use create_initialized_view rather than manually creating the review.
>
> view = create_initialized_view(vote, '+reassign')
>
> I also find the flow of the test a little harder to follow with the multiple
> login commands. I think it would read slightly better to use
> with_person_logged_in (don't forget the future import if it isn't there
> already).
>
> def test_view_cancel_url(self):
> # Check that the cancel url exists.
> bmp = self.factory.makeBranchMergeProposal()
> reviewer = self.factory.makePerson()
> with person_logged_in(bmp.registrant):
> vote = bmp.nominateReviewer(
> reviewer=reviewer, registrant=bmp.registrant)
> with person_logged_in(reviewer):
> view = create_initialized_view(vote, '+reassign')
> self.assertEqual(canonical_url(bmp), view.cancel_url)
>
> A side note: we often use comments instead of docstrings for the test methods
> because it isn't always easy to get a single line to describe the test.
>

[Tim Penhey (thumper)]

review: Approve

=== modified file 'lib/lp/code/browser/codereviewvote.py'
--- lib/lp/code/browser/codereviewvote.py	2010-08-20 20:31:18 +0000
+++ lib/lp/code/browser/codereviewvote.py	2010-09-27 23:15:58 +0000
@@ -24,7 +24,7 @@
 class ReassignSchema(Interface):
     """Schema to use when reassigning the reviewer for a requested review."""
 
-    reviewer = PublicPersonChoice( title=_('Reviewer'), required=True,
+    reviewer = PublicPersonChoice(title=_('Reviewer'), required=True,
             description=_('A person who you want to review this.'),
             vocabulary='ValidPersonOrTeam')
 
@@ -36,11 +36,16 @@
 
     page_title = label = 'Reassign review request'
 
+    @property
+    def next_url(self):
+        return canonical_url(self.context.branch_merge_proposal)
+
+    cancel_url = next_url
+
     @action('Reassign', name='reassign')
     def reassign_action(self, action, data):
         """Use the form data to change the review request reviewer."""
         self.context.reassignReview(data['reviewer'])
-        self.next_url = canonical_url(self.context.branch_merge_proposal)
 
     def validate(self, data):
         """Make sure that the reassignment can happen."""

=== modified file 'lib/lp/code/browser/tests/test_codereviewvote.py'
--- lib/lp/code/browser/tests/test_codereviewvote.py	2010-08-20 20:31:18 +0000
+++ lib/lp/code/browser/tests/test_codereviewvote.py	2010-09-27 23:15:58 +0000
@@ -1,22 +1,22 @@
 # Copyright 2009 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
-
 """Unit tests for CodeReviewVoteReferences."""
 
+from __future__ import with_statement
 
 __metaclass__ = type
 
 
 import unittest
 
-from canonical.launchpad.webapp.servers import LaunchpadTestRequest
+from canonical.launchpad.webapp import canonical_url
 from canonical.testing import DatabaseFunctionalLayer
-from lp.code.browser.codereviewvote import CodeReviewVoteReassign
 from lp.testing import (
-    login_person,
+    person_logged_in,
     TestCaseWithFactory,
     )
+from lp.testing.views import create_initialized_view
 
 
 class TestReassignReviewer(TestCaseWithFactory):
@@ -25,18 +25,30 @@
     layer = DatabaseFunctionalLayer
 
     def test_reassign(self):
-        """A reviewer can reassign their vote to someone else."""
+        # A reviewer can reassign their vote to someone else.
         bmp = self.factory.makeBranchMergeProposal()
         reviewer = self.factory.makePerson()
-        login_person(bmp.registrant)
-        vote = bmp.nominateReviewer(
-            reviewer=reviewer, registrant=bmp.registrant)
+        with person_logged_in(bmp.registrant):
+            vote = bmp.nominateReviewer(
+                reviewer=reviewer, registrant=bmp.registrant)
         new_reviewer = self.factory.makePerson()
-        login_person(reviewer)
-        view = CodeReviewVoteReassign(vote, LaunchpadTestRequest())
-        view.reassign_action.success({'reviewer': new_reviewer})
+        with person_logged_in(reviewer):
+            view = create_initialized_view(vote, '+reassign')
+            view.reassign_action.success({'reviewer': new_reviewer})
         self.assertEqual(vote.reviewer, new_reviewer)
 
+    def test_view_attributes(self):
+        # Check various urls etc on view are correct.
+        # At the moment, there's just the one: cancel_url
+        bmp = self.factory.makeBranchMergeProposal()
+        reviewer = self.factory.makePerson()
+        with person_logged_in(bmp.registrant):
+            vote = bmp.nominateReviewer(
+                reviewer=reviewer, registrant=bmp.registrant)
+        with person_logged_in(reviewer):
+            view = create_initialized_view(vote, '+reassign')
+        self.assertEqual(canonical_url(bmp), view.cancel_url)
+
 
 def test_suite():
     return unittest.TestLoader().loadTestsFromName(__name__)