Opened 4 years ago

Closed 3 years ago

#17283 closed defect (implemented)

Stem could use a (tested) document for writing new tests for Tor

Reported by: nickm Owned by: Sebastian
Priority: Medium Milestone:
Component: Core Tor/Tor Version:
Severity: Normal Keywords: TorCoreTeam201603
Cc: Actual Points:
Parent ID: Points: medium/large
Reviewer: atagar Sponsor: SponsorS-must

Description

(Please pardon me if this already exists, and send me a link)

In order to continue to improve Tor test coverage, I'd like there to be a document for "how to write a test for a new controller feature in Stem". And I'd like the document to be beta-tested by having somebody unfamiliar with stem try to do it. This way, we could ask for a stem test as part of any new controller feature.

Due April 2016.

Child Tickets

Change History (10)

comment:1 Changed 4 years ago by nickm

Keywords: TorCoreTeam201603 added
Severity: Normal

comment:2 Changed 4 years ago by Sebastian

Owner: changed from atagar to Sebastian
Status: newassigned

comment:3 Changed 4 years ago by atagar

Thanks Sebastian! For what it's worth I was imagining this would be a FAQ entry ("Q: How do I write a test for my new Tor feature?"). This could use a new event type for an example. Maybe something that's automatically emitted like a 'CIRCUIT_BW' event to keep it simple.

Anyway, just food for thought. The above would probably only take a few minutes.

comment:4 Changed 3 years ago by isabela

Sponsor: SponsorSSponsorS-must

comment:5 Changed 3 years ago by Sebastian

Component: StemTor
Status: assignedneeds_review

see branch stemtest in my Tor repository. This is for the "guide" part of the ticket, the actual implementation is blocked on a couple of bugs that we have to sort through first.

comment:6 Changed 3 years ago by nickm

Reviewer: atagar

Damian, do you have time to review this? If not please just remove yourself as reviewer.

comment:7 Changed 3 years ago by atagar

Status: needs_reviewneeds_information

Hi Sebastian, per chance did you forget to push this to your remote? Not spotting a branch with that name...

https://gitweb.torproject.org/user/sebastian/stem.git/

comment:8 Changed 3 years ago by Sebastian

Status: needs_informationneeds_review

Mentioned to atagar that I made a Tor patch, not stem. He mentioned on irc that this looks good to him.

comment:9 Changed 3 years ago by Sebastian

to make it clear, this is ready to merge I think.

comment:10 Changed 3 years ago by nickm

Resolution: implemented
Status: needs_reviewclosed

Applied; thanks!

Note: See TracTickets for help on using tickets.