Base test case classes with helper methods

[Ryan J Ollos]

I've been considering ways to reduce the code duplication of helper methods in the test code. For example, there are at least a half-dozen instances of _insert_ticket and _create_request. One possibility would be to create a mixin-like base class with the helper methods.

[Ryan J Ollos]

Example of changes I have in mind can be found in log:rjollos.git:t12211_base_test_classes. I'm very interested to know if someone sees a better way to do this.

[Ryan J Ollos]

Replying to Ryan J Ollos:

I'm very interested to know if someone sees a better way to do this.

I've considered a few alternative approaches:

1. Create helper functions in trac.test.
2. Create helper class(es) in trac.test. The classes could be instantiated as needed in test cases. This would minimize the number of methods relative to approach (1).
3. Attach the helper functions to trac.test.EnvironmentStub. One downside is that the number of methods on the class could grow large very quickly.

My main aim for this ticket is to find an approach that avoids defining _create_request on numerous TestCases.

[Ryan J Ollos]

Replaced uses of _insert_user with EnvironmentStub.insert_known_users in [14524]. Additional proposed changes in log:rjollos.git:t12211_known_users. insert_known_users was added in 1.1.x, so it wouldn't be a breaking API change to rename the method.

Continuing the thought in comment:2, it might make sense to define insert_users on a class other than EnvironmentStub.

[Ryan J Ollos]

comment:3 changes committed in [14535].

[Ryan J Ollos]

Proposed changes in log:rjollos.git:t12211_mock_request. I'll add class documentation before committing.

[Christian Boos]

Very nice indeed (both TicketTestCase and MockRequest).

[Ryan J Ollos]

Thanks, I added TicketTestCase to the changes ([9763655/rjollos.git]) and I'll spend more time reviewing the code in trac.ticket.tests to see what other methods can be added to the class.

[Ryan J Ollos]

I modified MockRequest to use Request as a base class and populate the callbacks: log:rjollos.git:t12211_mock_request.1.