Add more queries

[mpkorstanje]

🤔 What's changed?

• Added several new methods to find pickles, testcases, test cast started and test steps by TestStepStarted events.
• Made lineage API public.

⚡️ What's your motivation?

Convert the TeamCity plugin to the message protocol (cucumber/cucumber-jvm#3007). Unlike the JUnit XML formatter this plugin also responds to test steps and so needs queries that involve test steps.

The plugin also needs to transform the elements in the pickle tree to something more complex then a name so the lineage api is made public.

🏷️ What kind of change is this?

• ⚡ New feature (non-breaking change which adds new behaviour)

♻️ Anything particular you want feedback on?

Updating the API section in the README is getting quite cumbersome. Do we want to keep doing that?

📋 Checklist:

• I agree to respect and uphold the Cucumber Community Code of Conduct
• I've changed the behaviour of the code
  • I have added/updated tests to cover my changes.
• My change requires a change to the documentation.
  • I have updated the documentation accordingly.
• Users should know about my change
  • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

[davidjgoss]

re the subject being TestStepStarted in most of these, by contrast in the few cases on existing methods where a test step at execution time is involved, it's TestStepFinished. Those make sense as they're generally in the area of results or attachments where it only makes sense once the step has finished. Are the use cases for these new methods particular to the step starting i.e. finishing is too late?

(I don't think it's a problem, I'm more curious than anything.)

[davidjgoss]

Updating the API section in the README is getting quite cumbersome. Do we want to keep doing that?

I think we should stop, and provide nice readable/searchable documentation instead. The commonality across platforms is important for us, but for end users? "Give me docs for the one I need." We can add e.g. typedoc for the JS package.

[mpkorstanje]

re the subject being TestStepStarted in most of these, by contrast in the few cases on existing methods where a test step at execution time is involved, it's TestStepFinished. Those make sense as they're generally in the area of results or attachments where it only makes sense once the step has finished. Are the use cases for these new methods particular to the step starting i.e. finishing is too late?

The TeamCityPlugin interleaves Service Messages into standard output and then builds a hierarchy about that:

Each step node of the tree is started by writing a testStarted message and ended by writing a testFinished message. Hence the need to find things when step starts.

[mpkorstanje]

I think we should stop, and provide nice readable/searchable documentation instead. The commonality across platforms is important for us, but for end users? "Give me docs for the one I need." We can add e.g. typedoc for the JS package.

I'll do that for the Java implementation.