teragrep / pth_10

Data Processing Language (DPL) translator for Apache Spark
GNU Affero General Public License v3.0
0 stars 2 forks source link

Use descriptive test names instead of generic test_n #226

Open StrongestNumber9 opened 6 months ago

StrongestNumber9 commented 6 months ago

Description

A test fails. It is called syslogStream_test_1. What does it do compared to syslogStream_test_2?

Use case or motivation behind the feature request

All tests should have descriptive names so you can know what it is testing just by looking at the name alone. syslogStream_test_1 and syslogStream_test_2 should be called more like testSyslogStreamSending and testSyslogStreamSendingFailure

Related issues

https://github.com/teragrep/pth_10/blob/57586b4575bf084e3cc4a34bd39bca6c2166fa9a/src/test/java/com/teragrep/pth10/SyslogStreamTest.java#L165-L167

https://github.com/teragrep/pth_10/blob/57586b4575bf084e3cc4a34bd39bca6c2166fa9a/src/test/java/com/teragrep/pth10/SyslogStreamTest.java#L207-L209

Additional context

Haven't gone through most of the tests, this is just something I noticed when test got stuck and I went to check what it was supposed to be doing.