development/autotests/ctests-costs-benefits.txt

   1 The ctests are not convenient tests. In this file we can attempt to log the
   2 benefits and costs to using them so we can periodically evaluate which tests we
   3 should keep and which we should get rid of.
   4
   5 Below are some objective costs:
   6
   7 - The time it takes to run the ctests.
   8 - The email discussion back-and-forth.
   9
  10 There are also some non-objective costs. The ctests are annoying and not fun to
  11 maintain, discuss, and fix. Although it's hard to measure this "annoyance"
  12 cost, it should be taken into account when we review.
  13
  14 Below we can try to keep a log of which bugs are found with which ctests. This
  15 way we can see which tests are the most useful. It is difficult to objectively
  16 differentiate between minor bugs and important bugs.
  17
  18 The "Benefit" row gives the amount of days in-between when an issue is found
  19 because of the ctests and when an issue is reported by someone not using the
  20 ctests.
  21
  22 The "ctest" row gives a ctest pattern for the tests that were affected by the
  23 regression.
  24
  25 Examples where convergence tests took time and annoyance to figure out that
  26 they were actually "false positives" (i.e., no bug that is worth the time or
  27 complexity to fix):
  28
  29 https://www.mail-archive.com/search?l=mid&q=20210125200655.e27xaaoy2belyxhw%40tallinn
  30
  31
  32 Examples where bugs were fixed (more quickly) because of ctests:
  33
  34 Report : https://www.mail-archive.com/search?l=mid&q=20210126190837.pwuxhrhrikzszfrh%40tallinn
  35 Fix    : 92f8612a
  36
  37 Report : https://www.mail-archive.com/search?l=mid&q=b0a33192bc5635bd1cb5596e346f9c34615ffeb4.camel%40lyx.org
  38 Fix    : ab1d418f
  39
  40 Fix    : ef2b2827
  41
  42 Fix    : 1ddc1c6b
  43
  44 Report : https://www.mail-archive.com/search?l=mid&q=20210218051838.jbwnemfv5ilhlsls%40tallinn
  45 Fix    : 358e4ace
  46
  47 Fix    : 3df42924
  48
  49 Fix    : 67d0b80f
  50
  51 Fix    : 8ce6c815
  52
  53 Report : https://www.mail-archive.com/search?l=mid&q=20210523014926.xewdr5x62br2okvy%40tallinn
  54 Fix    : 39a9e370
  55
  56 Report : https://www.mail-archive.com/search?l=mid&q=20210528001413.56phju7dvfn4dexs%40tallinn
  57 Fix    : ffa6a724
  58
  59 Report : https://www.mail-archive.com/search?l=mid&q=20210529174524.idnmt5w4tvhuvyy6%40tallinn
  60 Note1  : We are still not sure what to do regarding how to make it more user-friendly
  61          for users to realize that "-dALLOWPSTRANSPARENCY" is needed for the ps2pdf converter.
  62 Benefit: 14 days (https://www.lyx.org/trac/ticket/12303)
  63
  64 Report : https://www.mail-archive.com/search?l=mid&q=20211205190238.edrtqmg3fkdr7gbo%40poole
  65 Fix    : 489bf46a, e3489d54
  66
  67 Report : https://www.mail-archive.com/search?l=mid&q=20220205184128.4clckanaufwmx5z4%40gary
  68 Fix    : d66c27de
  69
  70 Report : https://www.mail-archive.com/search?l=mid&q=20220206142559.rpgwki7wruhtasxp%40gary
  71 Fix    : f71f71d0
  72
  73 Report : https://www.mail-archive.com/search?l=mid&q=20220310131706.qdthdjblfpme2wew%40gary
  74 Fix    : dc502c82
  75 ctests : examples/Welcome_pdf2
  76
  77
  78
  79
  80
  81 Examples where upstream (e.g., LaTeX packages) bugs were fixed (more quickly)
  82 because of ctests:
  83
  84 Fix    : https://github.com/nrnrnr/noweb/pull/12#event-4892099481
  85
  86 Report : (private message to Jürgen: Message-ID:<20211205192054.zbxij5butj3wdyvf@poole>)
  87 Fix    : some of the polyglossia commits in the range 1c36dcdc^...bf69288c
  88 Benefit: Not clear. The regressions were in the development version so they
  89          could have easily been caught before release.
  90
  91 Report : https://www.mail-archive.com/search?l=mid&q=20211207200100.o27ojaftehrjfcza%40poole
  92 Fix    : 2eaf30c5
  93
  94
  95 Report : (private message to Jürgen: LyXMessage-ID:<20220216020703.la2fd5gu7yz7y7dc@gary>)
  96 Fix    : https://github.com/reutenauer/polyglossia/commit/c7489ebaf8c66a7e4fe2529de7068ebb79c68812
  97 Benefit: Not clear. The regressions were in the development version so they
  98          could have easily been caught before release.
  99 ctests : export/export/lyx2lyx/revert-languages-polyglossia-primary_lyx22
 100
 101
 102 Report : https://github.com/latex3/latex2e/issues/836
 103 Fix    : none yet, but confirmed as a bug.
 104 ctests : doc/EmbeddedObjects
 105
 106
 107 Report : https://github.com/gsilano/EuropeCV/issues/29
 108 Fix    : none yet
 109 ctests : Modern_CV
 110