docs icon indicating copy to clipboard operation
docs copied to clipboard

Published 20 hours ago • verified publisher icon nunit

SetUpFixture undocumented in the XML documentation

Open oznetmaster opened this issue 8 years ago • 2 comments

The current documentation for a test-suite element in the xml file states:

type The type of suite represented by this element. Currently supported types are Assembly, TestSuite, TestFixture,

However, "SetUpFixture" apparently is also a valid type. At least, it is appearing in the xml file:

     <test-suite type="SetUpFixture" id="1157" name="Rest" fullname="Twilio.Tests.Rest.TestSetup" classname="Twilio.Tests.Rest.TestSetup" runstate="Runnable" testcasecount="759">

This being undocumented broke my GUI and my result viewer :(

Is it a documentation issue, or is it a framework issue?

oznetmaster avatar Mar 15 '17 04:03 oznetmaster

There are many more types, which should be listed. However, it may be a good idea to clarify the language. My intent was to say that it's an arbitrary string and to list the currently supported values. I was hoping that people would understand from the phrasing that they should not rely on a particular set of types. Anyone is welcome to try re-wording it to serve that purpose.

CharliePoole avatar Mar 15 '17 06:03 CharliePoole

It might be useful to clarify what types can occur at what nesting level in the file.

It is sort of there in the text, but hard to visualize. Perhaps a diagram of some sort?

oznetmaster avatar Mar 15 '17 06:03 oznetmaster