diff mbox series

Promote 'tests/runtestslowselfcompare.sh' to 'tests/runtestselfcompare.sh'

Message ID 20211222104936.3998331-1-thomas@codesourcery.com
State Rejected
Headers show
Series Promote 'tests/runtestslowselfcompare.sh' to 'tests/runtestselfcompare.sh' | expand

Commit Message

Thomas Schwinge Dec. 22, 2021, 10:49 a.m. UTC
Per commit cac59a176a0c0d6d6c693cb1cfb475517ec33e97
"Bug 26769 - Fix missing types in abixml output":

| 	* tests/runtestslowselfcompare.sh.in: New test that compares
| 	libabigail.so against its own ABIXML representation.

I consider this to be a pretty important test case -- "eat our own dog
food".

Thus, I find this a bit unfortunate:

| 	* tests/Makefile.am: Add the new test runtestslowselfcompare.sh to
| 	source distribution.  This test is too slow to be run during the
| 	course of 'make check'.  It takes more than 5 minutes on my slow
| 	box here.  Rather, it can be run using 'make check-self-compare'.
| 	I plan to run this before releases now.

..., that is, that 'tests/runtestslowselfcompare.sh' isn't run during
standard 'make check'.

On my eight years old Dell Precision M4700, I see:

    $ \time make check TESTS=runtestslowselfcompare.sh ENABLE_SLOW_TEST=yes

    20.19user 0.64system 0:20.83elapsed 100%CPU (0avgtext+0avgdata 970468maxresident)k
    20.25user 0.51system 0:20.83elapsed 99%CPU (0avgtext+0avgdata 969984maxresident)k
    20.47user 0.53system 0:20.99elapsed 100%CPU (0avgtext+0avgdata 970016maxresident)k

So, ~21 s.

All the other test cases, running in parallel (just '-j5'):

    $ \time make check -j5 # with default 'ENABLE_SLOW_TEST=no'

    364.42user 31.21system 1:02.64elapsed 631%CPU (0avgtext+0avgdata 605568maxresident)k
    359.50user 31.18system 0:59.43elapsed 657%CPU (0avgtext+0avgdata 605720maxresident)k
    359.72user 30.87system 0:59.44elapsed 657%CPU (0avgtext+0avgdata 605292maxresident)k

So, ~61 s.  Additionally running 'tests/runtestslowselfcompare.sh':

    $ \time make check -j5 ENABLE_SLOW_TEST=yes

    389.44user 30.95system 1:06.35elapsed 633%CPU (0avgtext+0avgdata 971036maxresident)k
    387.47user 30.78system 1:05.42elapsed 639%CPU (0avgtext+0avgdata 971000maxresident)k
    388.99user 32.30system 1:04.94elapsed 648%CPU (0avgtext+0avgdata 970356maxresident)k

So, ~66 s, and thus 'tests/runtestslowselfcompare.sh' makes the
'make check -j5' take just ~5 s longer -- acceptable, in my opinion.

Per later commit b56e5aeb409b43fefc01e0397346b66d83e28030
"CONTRIBUTING: Update instructions about regression tests", it was noted
that...

| This is an important regression test.  The
| problem is that it can takes twice as much time as make distcheck.  So
| we've put it into its own separate target.

Given the "5 minutes" number from above, this comment means that a
'make distcheck' (or rather 'make distcheck-fast', I suppose?) would run
~2.5 min?  I've got the following numbers:

    $ \time make distcheck-fast -j5 # with default 'ENABLE_SLOW_TEST=no'

    935.67user 72.00system 4:58.90elapsed 337%CPU (0avgtext+0avgdata 986144maxresident)k
    946.23user 68.60system 4:59.07elapsed 339%CPU (0avgtext+0avgdata 984372maxresident)k
    935.33user 67.69system 5:01.18elapsed 333%CPU (0avgtext+0avgdata 985388maxresident)k

So, ~5 min, and thus for me, 'tests/runtestslowselfcompare.sh' alone
takes just 1/15 the time of that, not "twice as much".

Additionally enabling 'tests/runtestslowselfcompare.sh' here:

    $ \time make distcheck-fast -j5 ENABLE_SLOW_TEST=yes

    965.52user 67.06system 5:04.04elapsed 339%CPU (0avgtext+0avgdata 984760maxresident)k
    981.54user 67.57system 4:57.65elapsed 352%CPU (0avgtext+0avgdata 985836maxresident)k
    972.32user 68.58system 5:09.81elapsed 335%CPU (0avgtext+0avgdata 985224maxresident)k

..., again 'tests/runtestslowselfcompare.sh' makes that just take ~5 s
longer -- acceptable, in my opinion.

	* tests/runtestslowselfcompare.sh.in: Rename to...
	* tests/runtestselfcompare.sh.in: ... this, and assume
	'ENABLE_SLOW_TEST' set.
	* tests/Makefile.am: Adjust.
	(check-self-compare): Remove target.
	* Makefile.am: Likewise.
	* configure.ac: Adjust.
	* CONTRIBUTING: Likewise.
---
 CONTRIBUTING                                   | 18 ++++++++----------
 Makefile.am                                    |  9 +--------
 configure.ac                                   |  4 ++--
 tests/Makefile.am                              | 14 ++++----------
 ...fcompare.sh.in => runtestselfcompare.sh.in} |  7 +------
 5 files changed, 16 insertions(+), 36 deletions(-)
 rename tests/{runtestslowselfcompare.sh.in => runtestselfcompare.sh.in} (61%)

Comments

Dodji Seketeli Jan. 4, 2022, 2:53 p.m. UTC | #1
Hello Thomas,

Thomas Schwinge <thomas@codesourcery.com> a écrit:

> Per commit cac59a176a0c0d6d6c693cb1cfb475517ec33e97
> "Bug 26769 - Fix missing types in abixml output":
>
> | 	* tests/runtestslowselfcompare.sh.in: New test that compares
> | 	libabigail.so against its own ABIXML representation.
>
> I consider this to be a pretty important test case -- "eat our own dog
> food".
>
> Thus, I find this a bit unfortunate:
>
> | 	* tests/Makefile.am: Add the new test runtestslowselfcompare.sh to
> | 	source distribution.  This test is too slow to be run during the
> | 	course of 'make check'.  It takes more than 5 minutes on my slow
> | 	box here.  Rather, it can be run using 'make check-self-compare'.
> | 	I plan to run this before releases now.
>
> ..., that is, that 'tests/runtestslowselfcompare.sh' isn't run during
> standard 'make check'.
>
> On my eight years old Dell Precision M4700, I see:
>
>     $ \time make check TESTS=runtestslowselfcompare.sh ENABLE_SLOW_TEST=yes
>
>     20.19user 0.64system 0:20.83elapsed 100%CPU (0avgtext+0avgdata 970468maxresident)k
>     20.25user 0.51system 0:20.83elapsed 99%CPU (0avgtext+0avgdata 969984maxresident)k
>     20.47user 0.53system 0:20.99elapsed 100%CPU (0avgtext+0avgdata 970016maxresident)k
>
> So, ~21 s.

On my machine (AMD FX8350 box) it's really still much longer than that, as
you pointed above.  And I know users who are in the same case, still.
Yeah, surprising, I know.  Your box is more than 10 times faster than
mine, it seems.

> All the other test cases, running in parallel (just '-j5'):
>
>     $ \time make check -j5 # with default 'ENABLE_SLOW_TEST=no'
>
>     364.42user 31.21system 1:02.64elapsed 631%CPU (0avgtext+0avgdata 605568maxresident)k
>     359.50user 31.18system 0:59.43elapsed 657%CPU (0avgtext+0avgdata 605720maxresident)k
>     359.72user 30.87system 0:59.44elapsed 657%CPU (0avgtext+0avgdata 605292maxresident)k
>
> So, ~61 s.  Additionally running 'tests/runtestslowselfcompare.sh':
>
>     $ \time make check -j5 ENABLE_SLOW_TEST=yes
>
>     389.44user 30.95system 1:06.35elapsed 633%CPU (0avgtext+0avgdata 971036maxresident)k
>     387.47user 30.78system 1:05.42elapsed 639%CPU (0avgtext+0avgdata 971000maxresident)k
>     388.99user 32.30system 1:04.94elapsed 648%CPU (0avgtext+0avgdata 970356maxresident)k
>
> So, ~66 s, and thus 'tests/runtestslowselfcompare.sh' makes the
> 'make check -j5' take just ~5 s longer -- acceptable, in my opinion.
>
> Per later commit b56e5aeb409b43fefc01e0397346b66d83e28030
> "CONTRIBUTING: Update instructions about regression tests", it was noted
> that...
>
> | This is an important regression test.  The
> | problem is that it can takes twice as much time as make distcheck.  So
> | we've put it into its own separate target.
>
> Given the "5 minutes" number from above, this comment means that a
> 'make distcheck' (or rather 'make distcheck-fast', I suppose?)

Well, you are maybe reading too much into that sentence :-)  Since that time,
make distcheck grew slower.  So I guess the test now takes roughly the
same time as make distcheck or make distcheck-fast.

> would run
> ~2.5 min?  I've got the following numbers:
>
>     $ \time make distcheck-fast -j5 # with default 'ENABLE_SLOW_TEST=no'
>
>     935.67user 72.00system 4:58.90elapsed 337%CPU (0avgtext+0avgdata 986144maxresident)k
>     946.23user 68.60system 4:59.07elapsed 339%CPU (0avgtext+0avgdata 984372maxresident)k
>     935.33user 67.69system 5:01.18elapsed 333%CPU (0avgtext+0avgdata 985388maxresident)k
>
> So, ~5 min, and thus for me, 'tests/runtestslowselfcompare.sh' alone
> takes just 1/15 the time of that, not "twice as much".
>
> Additionally enabling 'tests/runtestslowselfcompare.sh' here:
>
>     $ \time make distcheck-fast -j5 ENABLE_SLOW_TEST=yes
>
>     965.52user 67.06system 5:04.04elapsed 339%CPU (0avgtext+0avgdata 984760maxresident)k
>     981.54user 67.57system 4:57.65elapsed 352%CPU (0avgtext+0avgdata 985836maxresident)k
>     972.32user 68.58system 5:09.81elapsed 335%CPU (0avgtext+0avgdata 985224maxresident)k
>
> ..., again 'tests/runtestslowselfcompare.sh' makes that just take ~5 s
> longer -- acceptable, in my opinion.

On my machine, your patch "make check" takes 5 minutes longer than
without.  So I am reluctant to apply it.

In practise, it's not a big deal, I think, as I run 'make
check-self-compare' very regularly.

As bizarre as it seems, the tendency I'd like us to move towards is less
tests "by default".  That is, split out the binaries that we have in the
tarball today and keep a very minimal set of tests.  The tarball is too
big as it is, and yet, there are tons of tests that I'd like to run that
are not present there.

That is why I'd like us to progress towards having much more tests that
are in a separated "test project", somehow.  In that project, we'd
either have binaries locally present or references to binaries (like
distros packages over the interweb) to grab and run comparisons on.

So I would not spent to much time on these tests that are locally
present in the tarball.  Rather, if you are interested in this super
important testing strategy project, we could discuss it a bit more in
depth.


I hope this makes sense.

Thank you for showing interesting in this area.

[...]

Cheers,
Thomas Schwinge Jan. 5, 2022, 4:10 p.m. UTC | #2
Hi Dodji!

Happy New Year to y'all, too!


On 2022-01-04T15:53:57+0100, Dodji Seketeli <dodji@redhat.com> wrote:
> Thomas Schwinge <thomas@codesourcery.com> a écrit:
>
>> Per commit cac59a176a0c0d6d6c693cb1cfb475517ec33e97
>> "Bug 26769 - Fix missing types in abixml output":
>>
>> |    * tests/runtestslowselfcompare.sh.in: New test that compares
>> |    libabigail.so against its own ABIXML representation.
>>
>> I consider this to be a pretty important test case -- "eat our own dog
>> food".
>>
>> Thus, I find this a bit unfortunate:
>>
>> |    * tests/Makefile.am: Add the new test runtestslowselfcompare.sh to
>> |    source distribution.  This test is too slow to be run during the
>> |    course of 'make check'.  It takes more than 5 minutes on my slow
>> |    box here.  Rather, it can be run using 'make check-self-compare'.
>> |    I plan to run this before releases now.
>>
>> ..., that is, that 'tests/runtestslowselfcompare.sh' isn't run during
>> standard 'make check'.
>>
>> On my eight years old Dell Precision M4700, I see:
>>
>>     $ \time make check TESTS=runtestslowselfcompare.sh ENABLE_SLOW_TEST=yes
>>
>>     20.19user 0.64system 0:20.83elapsed 100%CPU (0avgtext+0avgdata 970468maxresident)k
>>     20.25user 0.51system 0:20.83elapsed 99%CPU (0avgtext+0avgdata 969984maxresident)k
>>     20.47user 0.53system 0:20.99elapsed 100%CPU (0avgtext+0avgdata 970016maxresident)k
>>
>> So, ~21 s.
>
> On my machine (AMD FX8350 box) it's really still much longer than that, as
> you pointed above.  And I know users who are in the same case, still.
> Yeah, surprising, I know.  Your box is more than 10 times faster than
> mine, it seems.

"Interesting" ;-) -- thanks for confirming your numbers.

Per a quick web search, your AMD FX8350 would be just a little older than
my Dell Precision M4700 with "Intel(R) Core(TM) i7-3740QM CPU @ 2.70GHz",
so I wonder where the rather big difference is coming from.  Mine has
24 GiB of RAM, and I'm caching the "WDC WD7500BPKT-7" HDD with a
"KINGSTON SA400S3" SSD; maybe that's it.

>> All the other test cases, running in parallel (just '-j5'):
>>
>>     $ \time make check -j5 # with default 'ENABLE_SLOW_TEST=no'
>>
>>     364.42user 31.21system 1:02.64elapsed 631%CPU (0avgtext+0avgdata 605568maxresident)k
>>     359.50user 31.18system 0:59.43elapsed 657%CPU (0avgtext+0avgdata 605720maxresident)k
>>     359.72user 30.87system 0:59.44elapsed 657%CPU (0avgtext+0avgdata 605292maxresident)k
>>
>> So, ~61 s.  Additionally running 'tests/runtestslowselfcompare.sh':
>>
>>     $ \time make check -j5 ENABLE_SLOW_TEST=yes
>>
>>     389.44user 30.95system 1:06.35elapsed 633%CPU (0avgtext+0avgdata 971036maxresident)k
>>     387.47user 30.78system 1:05.42elapsed 639%CPU (0avgtext+0avgdata 971000maxresident)k
>>     388.99user 32.30system 1:04.94elapsed 648%CPU (0avgtext+0avgdata 970356maxresident)k
>>
>> So, ~66 s, and thus 'tests/runtestslowselfcompare.sh' makes the
>> 'make check -j5' take just ~5 s longer -- acceptable, in my opinion.
>>
>> Per later commit b56e5aeb409b43fefc01e0397346b66d83e28030
>> "CONTRIBUTING: Update instructions about regression tests", it was noted
>> that...
>>
>> | This is an important regression test.  The
>> | problem is that it can takes twice as much time as make distcheck.  So
>> | we've put it into its own separate target.
>>
>> Given the "5 minutes" number from above, this comment means that a
>> 'make distcheck' (or rather 'make distcheck-fast', I suppose?)
>
> Well, you are maybe reading too much into that sentence :-)  Since that time,
> make distcheck grew slower.  So I guess the test now takes roughly the
> same time as make distcheck or make distcheck-fast.
>
>> would run
>> ~2.5 min?  I've got the following numbers:
>>
>>     $ \time make distcheck-fast -j5 # with default 'ENABLE_SLOW_TEST=no'
>>
>>     935.67user 72.00system 4:58.90elapsed 337%CPU (0avgtext+0avgdata 986144maxresident)k
>>     946.23user 68.60system 4:59.07elapsed 339%CPU (0avgtext+0avgdata 984372maxresident)k
>>     935.33user 67.69system 5:01.18elapsed 333%CPU (0avgtext+0avgdata 985388maxresident)k
>>
>> So, ~5 min, and thus for me, 'tests/runtestslowselfcompare.sh' alone
>> takes just 1/15 the time of that, not "twice as much".
>>
>> Additionally enabling 'tests/runtestslowselfcompare.sh' here:
>>
>>     $ \time make distcheck-fast -j5 ENABLE_SLOW_TEST=yes
>>
>>     965.52user 67.06system 5:04.04elapsed 339%CPU (0avgtext+0avgdata 984760maxresident)k
>>     981.54user 67.57system 4:57.65elapsed 352%CPU (0avgtext+0avgdata 985836maxresident)k
>>     972.32user 68.58system 5:09.81elapsed 335%CPU (0avgtext+0avgdata 985224maxresident)k
>>
>> ..., again 'tests/runtestslowselfcompare.sh' makes that just take ~5 s
>> longer -- acceptable, in my opinion.
>
> On my machine, your patch "make check" takes 5 minutes longer than
> without.  So I am reluctant to apply it.

Sure, understood, and no worries.

> In practise, it's not a big deal, I think, as I run 'make
> check-self-compare' very regularly.
>
> As bizarre as it seems, the tendency I'd like us to move towards is less
> tests "by default".  That is, split out the binaries that we have in the
> tarball today and keep a very minimal set of tests.

My goal is just to establish a testing baseline, so that I can be
reasonably sure that changes I may be doing don't regress anything.
For the time being, I might just locally set 'ENABLE_SLOW_TEST=yes'; and
at least we've now got some numbers (confirmed/new) in the archives.

> The tarball is too
> big as it is, and yet, there are tons of tests that I'd like to run that
> are not present there.
>
> That is why I'd like us to progress towards having much more tests that
> are in a separated "test project", somehow.  In that project, we'd
> either have binaries locally present or references to binaries (like
> distros packages over the interweb) to grab and run comparisons on.

Yes, that makes sense.  (I did wonder about the Git repository/checkout
size as well as the fact that huge binary blobs are stored there without
sources reference.)

> So I would not spent to much time on these tests that are locally
> present in the tarball.  Rather, if you are interested in this super
> important testing strategy project, we could discuss it a bit more in
> depth.

Heh, not at this time, sorry.  ;-)


Grüße
 Thomas
-----------------
Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, 80634 München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: Thomas Heurung, Frank Thürauf; Sitz der Gesellschaft: München; Registergericht München, HRB 106955
diff mbox series

Patch

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 5ab7bcce..588f87dd 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -58,6 +58,9 @@  tests in parallel to make whole thing go faster by doing:
 
   make -jN -lN check
 
+distcheck
+---------
+
 If you want to test the fabrication of the distribution tarball (this
 is important, because that is how we do to actually release the
 tarball of the project that you can download from the internet) then
@@ -85,19 +88,14 @@  Please make sure you always launch "make distcheck-fast" before sending a
 patch, so that you are sure that we can always build a tarball after
 your patch is applied to the source tree.
 
-A complementary regression checking target is "check-self-compare".
-You invoke it by doing "make check-self-compare".  That target
-analyzes the ABI of the libabigail.so shared object, serializes it
+tests/runtestselfcompare.sh
+---------------------------
+
+This one analyzes the ABI of the libabigail.so shared object, serializes it
 into the ABIXML format and then compares the ABI internal
 representation gathered from the libabigail.so binary against the one
 gathered from the ABIXML format.  The two should be equal if
-everything goes right.  This is an important regression test.  The
-problem is that it can take a considerable amount of time.
-So we've put it into its own separate target.
-
-So, to be complete the regression checking command to run against your
-patch should be: "make check-self-compare distcheck-fast -j16", if you have
-a machine with a 16 threads processors, for instance.
+everything goes right.  This is an important regression test.
 
 Launching regression tests in Valgrind
 --------------------------------------
diff --git a/Makefile.am b/Makefile.am
index 65a1b121..99353e82 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -80,17 +80,10 @@  tarball-and-tag-and-upload: tarball-and-all
 tarball-and-all: tag-and-all
 	$(MAKE) tarball
 
-tag-and-all: distcheck check-self-compare
+tag-and-all: distcheck
 	$(MAKE) tag-release-only
 
 # the default for GZIP_ENV is --best, which is pretty slow for check runs
 # distcheck-fast therefore compresses with --fast instead
 distcheck-fast:
 	$(MAKE) distcheck GZIP_ENV="--fast"
-
-# This makes us compare libabigail.so against its own ABIXML
-# representation.  It's super slow (more than 5 minutes on one of my
-# old boxes) so I do this only before releases.
-check-self-compare:
-	$(MAKE) -C tests check-self-compare
-
diff --git a/configure.ac b/configure.ac
index 29130175..1172a9fe 100644
--- a/configure.ac
+++ b/configure.ac
@@ -969,8 +969,8 @@  libabigail.pc
 dnl Some test scripts are generated by autofoo.
 AC_CONFIG_FILES([tests/runtestcanonicalizetypes.sh],
 		[chmod +x tests/runtestcanonicalizetypes.sh])
-		AC_CONFIG_FILES([tests/runtestslowselfcompare.sh],
-		[chmod +x tests/runtestslowselfcompare.sh])
+AC_CONFIG_FILES([tests/runtestselfcompare.sh],
+		[chmod +x tests/runtestselfcompare.sh])
 AC_CONFIG_FILES([tests/mockfedabipkgdiff],
 		[chmod +x tests/mockfedabipkgdiff])
 AC_CONFIG_FILES([tests/runtestfedabipkgdiff.py],
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 17e2d4b4..27ecb623 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -12,11 +12,9 @@  FEDABIPKGDIFF_TEST += runtestfedabipkgdiff.py
 endif
 endif
 
-RUN_TEST_SLOW_SELF_COMPARE=runtestslowselfcompare.sh
-
 # rather expensive tests (keep in this order), > 1s runtime
 TESTS=				\
-$(RUN_TEST_SLOW_SELF_COMPARE)   \
+runtestselfcompare.sh		\
 runtestdiffsuppr		\
 runtesttypesstability		\
 runtestdiffpkg			\
@@ -60,7 +58,7 @@  endif
 EXTRA_DIST = \
 runtestcanonicalizetypes.sh.in \
 runtestfedabipkgdiff.py.in \
-runtestslowselfcompare.sh.in \
+runtestselfcompare.sh.in \
 mockfedabipkgdiff.in \
 test-valgrind-suppressions.supp
 
@@ -183,8 +181,8 @@  testdiff2_LDADD=$(top_builddir)/src/libabigail.la
 printdifftree_SOURCES = print-diff-tree.cc
 printdifftree_LDADD = $(top_builddir)/src/libabigail.la
 
-runtestslowselfcompare_sh_SOURCES =
-runtestslowselfcompare.sh$(EXEEXT):
+runtestselfcompare_sh_SOURCES =
+runtestselfcompare.sh$(EXEEXT):
 
 runtestcanonicalizetypes_sh_SOURCES =
 runtestcanonicalizetypes.sh$(EXEEXT):
@@ -242,7 +240,3 @@  check-valgrind-memcheck-recursive:
 
 check-valgrind-helgrind-recursive:
 	$(MAKE) check-valgrind-helgrind VALGRIND_FLAGS="${RECURSIVE_VALGRIND_FLAGS}"
-
-check-self-compare:
-	$(MAKE) check TESTS=runtestslowselfcompare.sh ENABLE_SLOW_TEST=yes
-
diff --git a/tests/runtestslowselfcompare.sh.in b/tests/runtestselfcompare.sh.in
similarity index 61%
rename from tests/runtestslowselfcompare.sh.in
rename to tests/runtestselfcompare.sh.in
index 3d0ef123..a6f16009 100644
--- a/tests/runtestslowselfcompare.sh.in
+++ b/tests/runtestselfcompare.sh.in
@@ -5,9 +5,4 @@ 
 abidw=@top_builddir@/tools/abidw
 objdir=@top_builddir@/src/.libs
 
-echo "ENABLE_SLOW_TEST="$ENABLE_SLOW_TEST
-
-if test x$ENABLE_SLOW_TEST != x; then
-    `$abidw --abidiff $objdir/libabigail.so`
-fi
-
+`$abidw --abidiff $objdir/libabigail.so`