• Icon: Improvement Improvement
    • Resolution: Unresolved
    • Icon: Minor Minor
    • tap-plugin
    • None

      Could the TAP Plugin (optionally?) have a table of contents on the page? We have some jobs with thousands of tests in a dozen .tap files; finding the file you want on the page is pretty tedious, so a table of contents at the top of the page (with hyperlinks to anchors on the page) would be super-useful.

          [JENKINS-18703] TAP Plugin Table of Contents

          Hi Ralph,

          That's doable :o) I'm planning to cut a new release soon.

          Do you think perhaps you could send me a screen shot, maybe a simple powerpoint, or anything with more details. Something that I could use as spec for writing this TOC, please?

          Thanks!
          /Bruno

          Bruno P. Kinoshita added a comment - Hi Ralph, That's doable :o) I'm planning to cut a new release soon. Do you think perhaps you could send me a screen shot, maybe a simple powerpoint, or anything with more details. Something that I could use as spec for writing this TOC, please? Thanks! /Bruno

          Ralph Bolton added a comment -

          Hi Bruno,

          That's great news - thanks for looking at this!

          I've attached a mock-up (sorry, I attached an old one and a newer, more correct one, but can't delete the old one).

          In short, I'd like some sort of "table of contents" (TOC) at the top of the page (before any TAP tables) that lists the various files that have been processed. Even just a bullet-list would be sufficient (as shown in my mock-up). I propose that the names of the files be hyperlinks to the tables below (eg. "part1.tap" in the TOC hyperlinks to an anchor tag on the "File: part1.tap" text ahead of the table of TAP output for that file).

          In my mock-up, each entry in the table of contents has summary information about the number of tests that have passed/failed etc. This information is optional, but adds some value to the table (and invites the TOC becoming an actual table, although this also is optional).

          It's up to you, but I'd suggest maybe making the display of table of contents a "tick box" option. The reason I say this is that we have a number of builds which only have one TAP file in them - a table of contents for such a build is confusing and unnecessary, so I imagine we'd want to turn off the TOC for such a build. Another possibility would be to suppress the TOC if it only has one entry in it, although again, this is optional.

          Honestly, anything you want to do would be great - we have a build with nearly 4000 tests over 20 files - making that page a bit easier to use would be super-cool.

          Thanks again - really appreciate it.

          ...Ralph

          Ralph Bolton added a comment - Hi Bruno, That's great news - thanks for looking at this! I've attached a mock-up (sorry, I attached an old one and a newer, more correct one, but can't delete the old one). In short, I'd like some sort of "table of contents" (TOC) at the top of the page (before any TAP tables) that lists the various files that have been processed. Even just a bullet-list would be sufficient (as shown in my mock-up). I propose that the names of the files be hyperlinks to the tables below (eg. "part1.tap" in the TOC hyperlinks to an anchor tag on the "File: part1.tap" text ahead of the table of TAP output for that file). In my mock-up, each entry in the table of contents has summary information about the number of tests that have passed/failed etc. This information is optional, but adds some value to the table (and invites the TOC becoming an actual table, although this also is optional). It's up to you, but I'd suggest maybe making the display of table of contents a "tick box" option. The reason I say this is that we have a number of builds which only have one TAP file in them - a table of contents for such a build is confusing and unnecessary, so I imagine we'd want to turn off the TOC for such a build. Another possibility would be to suppress the TOC if it only has one entry in it, although again, this is optional. Honestly, anything you want to do would be great - we have a build with nearly 4000 tests over 20 files - making that page a bit easier to use would be super-cool. Thanks again - really appreciate it. ...Ralph

          Thanks for the mock up Ralph! 4000 tests? Wow, there's another issue regarding performance/scalability of the plug-in. I'll try to include that one in this release too :o) Probably your job/builds will load faster after that is fixed.

          Will take a look with calm on your mock up during the weekend. Thanks again!

          /B

          Bruno P. Kinoshita added a comment - Thanks for the mock up Ralph! 4000 tests? Wow, there's another issue regarding performance/scalability of the plug-in. I'll try to include that one in this release too :o) Probably your job/builds will load faster after that is fixed. Will take a look with calm on your mock up during the weekend. Thanks again! /B

          Ralph Bolton added a comment -

          Hi Bruno,

          Yeah, we're running tests against our DNS domains; for each domain there's probably a dozen tests or more, and we've got quite a few domains, especially when you include the subdomains we care about too. I've sent you a tar file with some example .tap files in it (to your Yahoo email address). That may help you see what we're seeing in this particular Jenkins build

          Cheers,

          ...Ralph

          Ralph Bolton added a comment - Hi Bruno, Yeah, we're running tests against our DNS domains; for each domain there's probably a dozen tests or more, and we've got quite a few domains, especially when you include the subdomains we care about too. I've sent you a tar file with some example .tap files in it (to your Yahoo email address). That may help you see what we're seeing in this particular Jenkins build Cheers, ...Ralph

          Interesting!

          > Yeah, we're running tests against our DNS domains;

          Do you have any literature about it? I've never heard about testing DNS domains :o)

          Thanks!

          Bruno P. Kinoshita added a comment - Interesting! > Yeah, we're running tests against our DNS domains; Do you have any literature about it? I've never heard about testing DNS domains :o) Thanks!

          Ralph Bolton added a comment -

          > Do you have any literature about it? I've never heard about testing DNS domains :o)

          This is something we're trialling - the idea is to make sure that all of our domains are the same as a 'template'. For example, we make sure that certain fields in our Whois, SOA, NS and MX records have the right information in them. To do this, we give Jenkins a list of our domain names, it then runs a job that generates a series of tests for each domain, performs those tests (generating TAP output) and then reports all of that for us (and sends emails if things are wrong, etc).

          Ralph Bolton added a comment - > Do you have any literature about it? I've never heard about testing DNS domains :o) This is something we're trialling - the idea is to make sure that all of our domains are the same as a 'template'. For example, we make sure that certain fields in our Whois, SOA, NS and MX records have the right information in them. To do this, we give Jenkins a list of our domain names, it then runs a job that generates a series of tests for each domain, performs those tests (generating TAP output) and then reports all of that for us (and sends emails if things are wrong, etc).

          Ralph Bolton added a comment -

          In another project, we use the TAP plugin for reporting on some machine-generated tests. We've now hit 8000 or so, and Jenkins is struggling with it. It's possible it's nothing to do with TAP, but I did an strace on the Jenkins Java process and it seemed to be reading TAP files at the time (which was quite a long time, to read 8000 tests + meta!). The weird thing is that it affects all of Jenkins - even just clicking around in other projects or the home page or whatever.

          I need to do some more looking into this to figure out what's causing what, but any thoughts on the TAP plugin's performance would be most welcome

          Ralph Bolton added a comment - In another project, we use the TAP plugin for reporting on some machine-generated tests. We've now hit 8000 or so, and Jenkins is struggling with it. It's possible it's nothing to do with TAP, but I did an strace on the Jenkins Java process and it seemed to be reading TAP files at the time (which was quite a long time, to read 8000 tests + meta!). The weird thing is that it affects all of Jenkins - even just clicking around in other projects or the home page or whatever. I need to do some more looking into this to figure out what's causing what, but any thoughts on the TAP plugin's performance would be most welcome

            kinow Bruno P. Kinoshita
            coofercat Ralph Bolton
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: