@wdio/junit-reporter: testcase names have a different naming format than the one specified in the docs

[sandupetrasco]

I'd like to report

• Unclear documentation
• A typo
• Missing documentation
• Other

Description of the report
affected package: @wdio/junit-reporter

One specific example is the following one:
The docs:

The use-case:

It can be seen that the naming format from the docs does not correspond with the one that is used in > 6.* versions (it is the same in older < 5.* versions of @wdio/junit-reporter).

Another issue related to naming format:
Test:

Current output in the reporter:

Conclusion: All the symbols or none should be allowed in the tests names.

These issues come as a problem for our solutions and we would appreciate it if you fix them ASAP.
Thanks!

[AutomationReddy]

@sandupetrasco I will provide a PR soon to update the doc and _ will be removed from test names. Can you also please let us know what is the issue that you are facing with special chars. The reason for allowing @ is; few reporters take tags from test case names which starts with @ symbol like @foo @bar.

[sandupetrasco]

@AutomationReddy The older versions of @wdio/junit-reporter (e.g. 5.18.*) were removing all the special chars from the test names. We were using some string matches after formatting the test name in junit format, and a specific edge-case with the @ symbol is kinda' extra :).
However, is there a specific reason you do not allow special chars (those on the keyboard) and remove (some of) them from the test names?

[christian-bromann]

These issues come as a problem for our solutions and we would appreciate it if you fix them ASAP.

@sandupetrasco if this is a problem for you please consider contributing to the project to get it resolved, thanks!

[christian-bromann]

@lthurr did your fix recently also fixed this?

[lthurr]

@christian-bromann Nope! My fix was about appending all the parent suite names to classname

Regarding this issue:
The documentation says you'll get

... name="a_nested_test_suite_a_test_case" ...

And you actually get

... name="a nested test suite a test case" ...

I think documentation could be updated.

[christian-bromann]

@lthurr yes thanks for clarifying. Updated docs.