fix(junit): could not generate xml if error message has invalid character

cucumber / cucumber-js

Cucumber for JavaScript

https://cucumber.io

MIT License

5.04k stars 1.09k forks source link

fix(junit): could not generate xml if error message has invalid character #2228

Closed zcmgyu closed 1 year ago

zcmgyu commented 1 year ago

🤔 What's changed?

Added invalidCharReplacement option in XML Builder in XML formatter

⚡️ What's your motivation?

I could not generate an XML report file via the JUnit formatter setting if the message of a failed test case contains any invalid character (Eg: \x08). So, in order to prevent these cases I added invalidCharReplacement option for XML builder as this documentation.

🏷️ What kind of change is this?

:bug: Bug fix (non-breaking change which fixes a defect)

♻️ Anything particular you want feedback on?

Feel free to suggest any change or possible improvement.

📋 Checklist:

[x] I agree to respect and uphold the Cucumber Community Code of Conduct
[x] I have added/updated tests to cover my changes.
[x] Users should know about my change

coveralls commented 1 year ago

Coverage: 98.563%. Remained the same when pulling 2a72c0de0f77a3f356f9ca2e83bb59c846c53c9b on zcmgyu:replace-invalid-char-in-junit-xml into 0a2d8dcb6afbe1cc50b45091d8294990952932fb on cucumber:main.

aslakhellesoy commented 1 year ago

Hi @zcmgyu,

Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾

In return for this generous offer we hope you will:

✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team, Aslak Hellesøy Creator of Cucumber

davidjgoss commented 1 year ago

Released in https://github.com/cucumber/cucumber-js/releases/tag/v8.11.0