Status: Closed (View Workflow)
Resolution: Not A Defect
If the file type is considered as binary by Jenkins webserver then the TAP plugin doesn't consider this file for inclusion in TAP reports. This can be quite confusing and if you're not aware of this issue it can easily hide problems.
Note: I'm not talking about file permissions but what the Jenkins webserver (Stapler?) considers the file as. If the file extension isn't something which Jenkins serves as plain text then this file is ignored by the TAP plugin.
To reproduce this issue use the following shell execution step:
rm -rf reports
cat > reports/demo << EOF
ok 1 demo OK
cat > reports/demo.pl << EOF
ok 1 demo.pl OK
cat > reports/demo.txt << EOF
ok 1 demo.txt OK
and enable "reports/*" for TAP results.
Then the following report looks like:
whereas there are 3 TAP result files available and considered for inclusion:
When clicking on the "demo" file name (not "view"!) in your browser it's considered as BIN file and download gets enforced. When clicking on demo.pl and demo.txt instead they are provided as plain-text files without forcing download to view them.
It would be nice if such "binary files" could be also considered for TAP reports or if not at least warn in the TAP execution run and mention in the documentation that files should be preferably have suffix .tap.
thanks for your answer. I just added the according information at https://wiki.jenkins-ci.org/display/JENKINS/TAP+Plugin (see 2nd bullet under "Known Limitations"). Feel free to close this issue.
thanks for your work on the TAP plugin,
Thanks a ton Michael! I've also updated the Wiki. The other limitation had already been implemented in a past version. Will close this issue once the next version is released (scheduled to this next Saturday).
Fixed in 1.8. This version will be available from update manager within few hours.
First of all, thanks for detailed report, with steps to reproduce, images and very clear description.
>When clicking on the "demo" file name (not "view"!) in your browser it's considered as BIN file and download gets
>enforced. When clicking on demo.pl and demo.txt instead they are provided as plain-text files without forcing
>download to view them.
I think this is the correct behaviour in this case.
>It would be nice if such "binary files" could be also considered for TAP reports or if not at least warn in the
>TAP execution run and mention in the documentation that files should be preferably have suffix .tap.
In order to warn during the plug-in execution that a file being parsed is binary (or to skip it) the plug-in would have to use the same mime-types as Jenkins (the plug-in today uses none, it simply ignores the mime-types).
This can cause more bugs, and would be much more complicated to maintain.
However, I do agree that we could add/mention something in the documentation. Would you be willing to write something about it in the plug-in Wiki? If you already have the login in wiki.jenkins-ci.org, go to https://wiki.jenkins-ci.org/display/JENKINS/TAP+Plugin and feel free to add information that would help other users
Thanks a lot!