Enable doc tests with new test infra #391
Conversation
tests/Doc/Bf_tutorial.cs
Outdated
| public class Bf_tutorial : AbstractNRedisStackTest, IDisposable | ||
| { | ||
|
|
||
| public void run() | ||
| public Bf_tutorial(EndpointsFixture fixture) : base(fixture) { } | ||
|
|
||
| [SkippableTheory] | ||
| [MemberData(nameof(EndpointsFixture.Env.StandaloneOnly), MemberType = typeof(EndpointsFixture.Env))] | ||
| public void run(string endpointId) | ||
| { | ||
| var muxer = ConnectionMultiplexer.Connect("localhost:6379"); | ||
| var db = muxer.GetDatabase(); | ||
| var db = GetCleanDatabase(endpointId); |
There was a problem hiding this comment.
My main concern is that the user can see this part of the code when they view the whole file (eg, if you go here and click the little eye widget on any code tab).
It looks like some of this isn't code that we can recommend to users as part of the example. We can filter out [SkippableTheory] and the other attributes when we pull the example into the docs. We might also be able to remove the inherited test classes, etc. However, I'm not sure about the GetCleanDatabase(). If this is the best/only way to handle the tests, then we might have to add something to the docs processing, a bit like:
// REMOVE_START
var db = GetCleanDatabase(endpointId); // <-- Code that actually gets tested.
// REMOVE_END
/* ADD_START <-- New processing command
var muxer = ConnectionMultiplexer.Connect("localhost:6379"); <-- Code the user sees.
var db = muxer.GetDatabase();
ADD_END */
I guess I could implement this fairly easily in the Python script that processes the docs, but it would mean that the code the user sees isn't exactly the same as the code that gets tested in the NRedisStack repo. Maybe that wouldn't be a problem since most of the real code is the same?
I'm not sure about the best way to handle this, but there are probably other options. Aside from this, it's great to see improvements to the docs testing :-)
There was a problem hiding this comment.
@andy-stark-redis i am at the same spot with you on your concern.
i guess i just jumped in to enable doc tests with new infra but looks like it was too quick to catch what you've shown.
running and displaying different code is not the ideal, i believe.
then how do we handle it in other client libs? let me see.
No description provided.