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 Report :https://www.mail-archive.com/search?l=mid&q=20210125200655.e27xaaoy2belyxhw%40tallinn
  30
  31
  32 Examples where an upstream issue was reported and ended up wasting time:
  33
  34 Report : https://github.com/latex3/latex2e/issues/836#issuecomment-1159826566
  35 ctests : export/templates/Obsolete/.*American_Geophysical_Union.*_(lyx22|lyx23|pdf|dvi).*
  36
  37
  38
  39 Examples where bugs were fixed (more quickly) because of ctests:
  40
  41 Report : https://www.mail-archive.com/search?l=mid&q=20210126190837.pwuxhrhrikzszfrh%40tallinn
  42 Fix    : 92f8612a
  43
  44 Report : https://www.mail-archive.com/search?l=mid&q=b0a33192bc5635bd1cb5596e346f9c34615ffeb4.camel%40lyx.org
  45 Fix    : ab1d418f
  46
  47 Fix    : ef2b2827
  48
  49 Fix    : 1ddc1c6b
  50
  51 Report : https://www.mail-archive.com/search?l=mid&q=20210218051838.jbwnemfv5ilhlsls%40tallinn
  52 Fix    : 358e4ace
  53
  54 Fix    : 3df42924
  55
  56 Fix    : 67d0b80f
  57
  58 Fix    : 8ce6c815
  59
  60 Report : https://www.mail-archive.com/search?l=mid&q=20210523014926.xewdr5x62br2okvy%40tallinn
  61 Fix    : 39a9e370
  62
  63 Report : https://www.mail-archive.com/search?l=mid&q=20210528001413.56phju7dvfn4dexs%40tallinn
  64 Fix    : ffa6a724
  65
  66 Report : https://www.mail-archive.com/search?l=mid&q=20210529174524.idnmt5w4tvhuvyy6%40tallinn
  67 Note1  : We are still not sure what to do regarding how to make it more user-friendly
  68          for users to realize that "-dALLOWPSTRANSPARENCY" is needed for the ps2pdf converter.
  69 Benefit: 14 days (https://www.lyx.org/trac/ticket/12303)
  70
  71 Report : https://www.mail-archive.com/search?l=mid&q=20211205190238.edrtqmg3fkdr7gbo%40poole
  72 Fix    : 489bf46a, e3489d54
  73
  74 Report : https://www.mail-archive.com/search?l=mid&q=20220205184128.4clckanaufwmx5z4%40gary
  75 Fix    : d66c27de
  76 Report : https://www.mail-archive.com/search?l=mid&q=20220206142559.rpgwki7wruhtasxp%40gary
  77 Fix    : f71f71d0
  78
  79 Report : https://www.mail-archive.com/search?l=mid&q=20220310131706.qdthdjblfpme2wew%40gary
  80 Fix    : dc502c82
  81 ctests : examples/Welcome_pdf2
  82
  83
  84
  85
  86
  87 Examples where upstream (e.g., LaTeX packages) bugs were fixed (more quickly)
  88 because of ctests:
  89
  90 Fix    : https://github.com/nrnrnr/noweb/pull/12#event-4892099481
  91
  92 Report : (private message to Jürgen: Message-ID:<20211205192054.zbxij5butj3wdyvf@poole>)
  93 Fix    : some of the polyglossia commits in the range 1c36dcdc^...bf69288c
  94 Benefit: Not clear. The regressions were in the development version so they
  95          could have easily been caught before release.
  96
  97 Report : https://www.mail-archive.com/search?l=mid&q=20211207200100.o27ojaftehrjfcza%40poole
  98 Fix    : 2eaf30c5
  99
 100
 101 Report : (private message to Jürgen: LyXMessage-ID:<20220216020703.la2fd5gu7yz7y7dc@gary>)
 102 Fix    : https://github.com/reutenauer/polyglossia/commit/c7489ebaf8c66a7e4fe2529de7068ebb79c68812
 103 Benefit: Not clear. The regressions were in the development version so they
 104          could have easily been caught before release.
 105 ctests : export/export/lyx2lyx/revert-languages-polyglossia-primary_lyx22
 106
 107
 108 Report : https://github.com/latex3/latex2e/issues/836
 109 Fix    : https://github.com/latex3/latex2e/commit/878a4715df024fc3425d2bfd5d3d138b9395c178
 110 ctests : doc/EmbeddedObjects
 111
 112
 113 Report : https://github.com/gsilano/EuropeCV/issues/29
 114 Fix    : none yet
 115 ctests : Modern_CV
 116
 117
 118 Report : https://github.com/schlcht/microtype/issues/21
 119          upstream: https://github.com/latex3/latex2e/issues/880
 120 Fix    : none yet
 121 ctests : export/templates/Articles/Hebrew_Article_.*(dvi|pdf|pdf2|pdf3)