Summary

Add new support for easily testing Review Board extensions.

Review Request #8295 — Created July 19, 2016 and submitted Aug. 12, 2016, 3:27 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

Commit

3b58b9f...

Reviewers

Groups

reviewboard

People

Description

This introduces a new TestCase class and a command line tool for easily

unit testing Review Board extensions.
The new ExtensionTestCase can be used by extension authors to create

unit tests that make use of an enabled instance of the extension. This

makes use of Djblets's new testing support, and also allows for the

usage of the handy object creation methods we have in Review Board's

main TestCase class.
A new rbext test command is now provided, which makes it easy to run

an extension's test suite. This works similarly to other test runners

like nosetests, but sets up a suitable Review Board environment in which

to run the tests.
To make that work well, and to consolidate code, the main Review Board

test runner now makes use of Djblets's new TestRunner class. This means

that both Review Board and any extensions will be running in the same

kind of environment.
Documentation has been added describing how to make use of all this to

write and run test suites.

Testing Done

Ran the Review Board test suite.

Updated an extension to use ExtensionTestCase, and then ran the
test suite using rbext test. I also tried a variety of other
options (built-in and through nosetests), and tried running
subsets of tests. All worked.

Read through the new docs and verified that the formatting and
linking was all correct.

Issues

Description	From	Last Updated
A "test" snuck into your description.	david	Aug. 5, 2016, 7:06 p.m.
'six' imported but unused	reviewbot	July 19, 2016, 3:26 a.m.
Col: 1 E402 module level import not at top of file	reviewbot	July 19, 2016, 3:26 a.m.
Col: 1 W391 blank line at end of file	reviewbot	July 19, 2016, 3:26 a.m.
This is a comma splice.	brennie	July 26, 2016, 6:11 p.m.
"handles"	brennie	July 26, 2016, 6:11 p.m.
"light"	brennie	July 26, 2016, 6:11 p.m.
This is sheet	MP mpietryga	Aug. 9, 2016, 5:12 a.m.

Tool: Pyflakes
Processed Files:
    reviewboard/extensions/testing/__init__.py
    reviewboard/extensions/tests.py
    reviewboard/test.py
    reviewboard/extensions/testing/testcases.py
    reviewboard/cmdline/rbext.py
    setup.py

Ignored Files:
    docs/manual/extending/extensions/testing.rst
    docs/manual/extending/coderef/index.rst
    docs/manual/extending/extensions/index.rst



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/extensions/testing/__init__.py
    reviewboard/extensions/tests.py
    reviewboard/test.py
    reviewboard/extensions/testing/testcases.py
    reviewboard/cmdline/rbext.py
    setup.py

Ignored Files:
    docs/manual/extending/extensions/testing.rst
    docs/manual/extending/coderef/index.rst
    docs/manual/extending/extensions/index.rst

reviewboard/cmdline/rbext.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'six' imported but unused
```
reviewboard/cmdline/rbext.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
reviewboard/extensions/testing/testcases.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 1
 W391 blank line at end of file
```

Change Summary:

Fixed Review Bot complaints.

Commit:

162b5fc578f09e22c501a688742bd3e76c8d0417

9f788678c2de436584e0dcd9380ad82d55c7edf4

Diff:

Revision 2 (+671 -147)

Show changes

	setup.py
	docs/manual/extending/coderef/index.rst
	docs/manual/extending/extensions/index.rst
	docs/manual/extending/extensions/testing.rst
	reviewboard/test.py
	reviewboard/cmdline/rbext.py
	reviewboard/extensions/tests.py
	reviewboard/extensions/testing/__init__.py
	1 more

Tool: Pyflakes
Processed Files:
    reviewboard/extensions/testing/__init__.py
    reviewboard/extensions/tests.py
    reviewboard/test.py
    reviewboard/extensions/testing/testcases.py
    reviewboard/cmdline/rbext.py
    setup.py

Ignored Files:
    docs/manual/extending/extensions/testing.rst
    docs/manual/extending/coderef/index.rst
    docs/manual/extending/extensions/index.rst



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/extensions/testing/__init__.py
    reviewboard/extensions/tests.py
    reviewboard/test.py
    reviewboard/extensions/testing/testcases.py
    reviewboard/cmdline/rbext.py
    setup.py

Ignored Files:
    docs/manual/extending/extensions/testing.rst
    docs/manual/extending/coderef/index.rst
    docs/manual/extending/extensions/index.rst

reviewboard/cmdline/rbext.py (Diff revision 2)
The issue has been resolved. Show all issues
```
This is a comma splice.
```
reviewboard/cmdline/rbext.py (Diff revision 2)
The issue has been resolved. Show all issues
```
"handles"
```
reviewboard/test.py (Diff revision 2)
The issue has been resolved. Show all issues
```
"light"
```

Change Summary:

Fixed documentation issues.

Description:

		This introduces a new TestCase class and a command line tool for easily
		unit testing Review Board extensions.

		The new `ExtensionTestCase` can be used by extension authors to create
		unit tests that make use of an enabled instance of the extension. This
		makes use of Djblets's new testing support, and also allows for the
		usage of the handy object creation methods we have in Review Board's
~		main `TestCase` class.
	~	main `TestCase` class.
	+	test

		A new `rbext test` command is now provided, which makes it easy to run
		an extension's test suite. This works similarly to other test runners
		like `nosetests`, but sets up a suitable Review Board environment in which
		to run the tests.

		To make that work well, and to consolidate code, the main Review Board
		test runner now makes use of Djblets's new `TestRunner` class. This means
		that both Review Board and any extensions will be running in the same
		kind of environment.

		Documentation has been added describing how to make use of all this to
		write and run test suites.

Commit:

9f788678c2de436584e0dcd9380ad82d55c7edf4

3b58b9f35b381962fb99661a02300a8fce962fe6

Diff:

Revision 3 (+671 -147)

Show changes

	setup.py
	docs/manual/extending/coderef/index.rst
	docs/manual/extending/extensions/index.rst
	docs/manual/extending/extensions/testing.rst
	reviewboard/test.py
	reviewboard/cmdline/rbext.py
	reviewboard/extensions/tests.py
	reviewboard/extensions/testing/__init__.py
	1 more

Tool: Pyflakes
Processed Files:
    reviewboard/extensions/testing/__init__.py
    reviewboard/extensions/tests.py
    reviewboard/test.py
    reviewboard/extensions/testing/testcases.py
    reviewboard/cmdline/rbext.py
    setup.py

Ignored Files:
    docs/manual/extending/extensions/testing.rst
    docs/manual/extending/coderef/index.rst
    docs/manual/extending/extensions/index.rst



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/extensions/testing/__init__.py
    reviewboard/extensions/tests.py
    reviewboard/test.py
    reviewboard/extensions/testing/testcases.py
    reviewboard/cmdline/rbext.py
    setup.py

Ignored Files:
    docs/manual/extending/extensions/testing.rst
    docs/manual/extending/coderef/index.rst
    docs/manual/extending/extensions/index.rst

The issue has been resolved. Show all issues
```
A "test" snuck into your description.
```

Change Summary:: test
Description:: This introduces a new TestCase class and a command line tool for easily
unit testing Review Board extensions.

The new ExtensionTestCase can be used by extension authors to create
unit tests that make use of an enabled instance of the extension. This
makes use of Djblets's new testing support, and also allows for the
usage of the handy object creation methods we have in Review Board's
~ main TestCase class.
~ main TestCase class.
- test

A new rbext test command is now provided, which makes it easy to run
an extension's test suite. This works similarly to other test runners
like nosetests, but sets up a suitable Review Board environment in which
to run the tests.

To make that work well, and to consolidate code, the main Review Board
test runner now makes use of Djblets's new TestRunner class. This means
that both Review Board and any extensions will be running in the same
kind of environment.

Documentation has been added describing how to make use of all this to
write and run test suites.

Ship it!

```
Ship It!
```

setup.py (Diff revision 3)

The issue has been dropped. Show all issues

This is sheet

mike_conley Aug. 9, 2016, 5:41 a.m.

Hey Mateusz,

This is a production instance of Review Board. Please don't use it for testing. If you'd like to play with a demo instance of Review Board, you can find one here: http://demo.reviewboard.org/dashboard/

Status:: Completed
Change Summary:: Pushed to release-3.0.x (de85920)