cmake: add ctest support to setup hook #50323

jtojnar · 2018-11-13T19:07:02Z

Motivation for this change

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Determined the impact on package closure size (by running nix path-info -S before and after)
Fits CONTRIBUTING.md.

matthewbauer · 2018-11-13T19:35:45Z

Is there any way to get CMake to generate Makefiles with a check target? That would be nice if possible.

jtojnar · 2018-11-13T19:58:22Z

Using ctest is probably a better idea, since it works across backends.

GrahamcOfBorg · 2018-11-13T20:24:33Z

Timed out, unknown build status on x86_64-linux (full log)

Attempted: cmake

Partial log (click to expand)

cannot build derivation '/nix/store/a1x4lyy63m2cli86w14kmrdi4rkn8mv2-flex-2.6.4.drv': 7 dependencies couldn't be built
cannot build derivation '/nix/store/vpwinnpnkvja99gcnc933dz70hgyxrqv-intltool-0.51.0.drv': 5 dependencies couldn't be built
cannot build derivation '/nix/store/a67wph067lb2vjphhlk70v4b0210vkfm-gnome-doc-utils-0.20.10.drv': 10 dependencies couldn't be built
cannot build derivation '/nix/store/vzqvj33z84fq2va84sgx5kr7qmfhj405-linux-pam-1.3.0.drv': 6 dependencies couldn't be built
cannot build derivation '/nix/store/0kqkmaja6aa75vf16gsdfnvv5kj0vqrq-shadow-4.6.drv': 11 dependencies couldn't be built
cannot build derivation '/nix/store/zhyq10n8lav4955n1q4qxq9axh9zqxwr-util-linux-2.32.1.drv': 5 dependencies couldn't be built
cannot build derivation '/nix/store/7skcr05xb68jfamcq6s8xy62mhc6412y-e2fsprogs-1.44.4.drv': 7 dependencies couldn't be built
cannot build derivation '/nix/store/h0qazb06wz1bjfsyc2xr9wv11l87xmxw-libarchive-3.3.2.drv': 12 dependencies couldn't be built
cannot build derivation '/nix/store/dqv1pwsbzh21bip96px6ax4wc4qdqhfx-cmake-3.12.1.drv': 11 dependencies couldn't be built
error: build of '/nix/store/dqv1pwsbzh21bip96px6ax4wc4qdqhfx-cmake-3.12.1.drv' failed

GrahamcOfBorg · 2018-11-13T20:32:28Z

Success on aarch64-linux (full log)

Attempted: cmake

Partial log (click to expand)

shrinking /nix/store/w7dn07m9g6rihpa6xkwkv573q3r4pq6c-cmake-3.12.1/bin/cpack
shrinking /nix/store/w7dn07m9g6rihpa6xkwkv573q3r4pq6c-cmake-3.12.1/bin/ctest
shrinking /nix/store/w7dn07m9g6rihpa6xkwkv573q3r4pq6c-cmake-3.12.1/bin/cmake
strip is /nix/store/a6cc0wimnbsrhbgy5axg7lq81akfy32y-binutils-2.30/bin/strip
stripping (with command strip and flags -S) in /nix/store/w7dn07m9g6rihpa6xkwkv573q3r4pq6c-cmake-3.12.1/bin
patching script interpreter paths in /nix/store/w7dn07m9g6rihpa6xkwkv573q3r4pq6c-cmake-3.12.1
/nix/store/w7dn07m9g6rihpa6xkwkv573q3r4pq6c-cmake-3.12.1/share/cmake-3.12/Modules/CPack.STGZ_Header.sh.in: interpreter directive changed from "/bin/sh" to "/nix/store/qvjs7hccx24r8cwhvm3h243jq0zw97r5-bash-4.4-p23/bin/sh"
/nix/store/w7dn07m9g6rihpa6xkwkv573q3r4pq6c-cmake-3.12.1/share/cmake-3.12/Modules/Squish4RunTestCase.sh: interpreter directive changed from "/bin/sh" to "/nix/store/qvjs7hccx24r8cwhvm3h243jq0zw97r5-bash-4.4-p23/bin/sh"
/nix/store/w7dn07m9g6rihpa6xkwkv573q3r4pq6c-cmake-3.12.1/share/cmake-3.12/Modules/SquishRunTestCase.sh: interpreter directive changed from "/bin/sh" to "/nix/store/qvjs7hccx24r8cwhvm3h243jq0zw97r5-bash-4.4-p23/bin/sh"
checking for references to /build in /nix/store/w7dn07m9g6rihpa6xkwkv573q3r4pq6c-cmake-3.12.1...

GrahamcOfBorg · 2018-11-13T21:23:10Z

Timed out, unknown build status on x86_64-darwin (full log)

Attempted: cmake

Partial log (click to expand)

cannot build derivation '/nix/store/3xmsnhizm25664h8klhz7bsj55i8pkjb-ps-1003.1-2008.drv': 2 dependencies couldn't be built
cannot build derivation '/nix/store/ix8db15d4h8zc4v4gdlk104cjqpbzg5k-xnu-osx-10.11.6.drv': 8 dependencies couldn't be built
cannot build derivation '/nix/store/i5bsx5zvy0s4vzf20lkgrzrmih7ihlir-IOKit-osx-10.11.6.drv': 2 dependencies couldn't be built
cannot build derivation '/nix/store/3mpq2g37f62gb2d3gi0fmnznz7qdvg1v-curl-7.62.0.drv': 7 dependencies couldn't be built
cannot build derivation '/nix/store/y6l9l1m90pqzxcfk390icp1bz8yw4kxi-configd-osx-10.8.5.drv': 8 dependencies couldn't be built
cannot build derivation '/nix/store/svc7m7gvdigj4xn7s7h8cn86aj56a6lz-python-2.7.15.drv': 8 dependencies couldn't be built
cannot build derivation '/nix/store/yfgd8gisn0jmqcp1fvwm72bsidjlh52v-libxml2-2.9.8.drv': 3 dependencies couldn't be built
cannot build derivation '/nix/store/7919r7n2qr6zvlvb1zhm5wdmy3lbdarw-libarchive-3.3.2.drv': 6 dependencies couldn't be built
cannot build derivation '/nix/store/rz86a4mpbf1kjdbrkjs459z56iz9dhck-cmake-3.12.1.drv': 9 dependencies couldn't be built
error: build of '/nix/store/rz86a4mpbf1kjdbrkjs459z56iz9dhck-cmake-3.12.1.drv' failed

matthewbauer · 2018-11-15T20:54:06Z

We really only support one backend in makefile, right now. According to this doc, "make test" should already work:

https://gitlab.kitware.com/cmake/community/wikis/doc/ctest/Testing-With-CTest#simple-testing

Do you have any specific packages where tests are not being run right now when they should be?

matthewbauer · 2018-11-15T21:30:07Z

I think it’s a mistake to use Ninja + CMake in Nixpkgs. At least we shouldn’t do it in the per-package basis that happens right now in a few places. It’s definitely okay to use Ninja when the package has a hand-written ninja file (or in Meson’s case where the developers stubbornly /refuse/ to write a Make backend). But in the CMake case we should do the same thing everywhere. I do think it would be a good idea to add a check phase for Ninja when we are forced to use it, though.

Mic92 · 2018-11-15T21:42:58Z

Can you elaborate why ninja is a problem? Make was not really designed as a backend for generated Makefiles. On the other hand ninja is not supposed to be handwritten.

matthewbauer · 2018-11-16T00:54:24Z

Mostly for legacy reasons - Make has been around for long enough that it seems worth supporting. Ninja depends on the Python runtime without really offering any clear advantages to Make. The time difference appears to be almost negligible:

http://david.rothlis.net/ninja-benchmark/

Of course, it's still worth supporting Ninja as a setup hook. I just think we should use Makefiles when they're available to us for consistency.

Mic92 · 2018-11-16T01:42:22Z

Ninja does not depend on python. I have seen projects that ship a single static executable of it to bootstrap their project
this benchmark looks rather synthetic to me, when I add ninja to neovim the build takes 22.943 instead of 26.484, this is a 15 % percent speedup over the whole build.

matthewbauer · 2018-11-17T22:05:09Z

I suppose it's not hurting anything too much. My main rationale is that you should use as few dependencies as possible. Make is an implicit dependency on anything that use stdenv. Might as well use that when it is available.

It would definitely be nice if we could do some bootstrapping and avoid the build-time python dependency. Basic shell scripts could probably work? A static executable doesn't seem very cross platform though.

Anyway, I've opened a separate PR that adds the checPhase in the ninja setup hook:

#50527

jtojnar · 2018-11-18T01:18:40Z

We could also set checkTarget to test in cmake setup hook, but ctest looks cleaner to me and is analogous to what meson does.

matthewbauer · 2018-11-18T19:47:49Z

We could also set checkTarget to test in cmake setup hook, but ctest looks cleaner to me and is analogous to what meson does.

I didn't realize that meson already had a check phase! That does change things but I am still partial to doing this all in Ninja. In setup.sh, build, install, & check are all handled by the same program (make). Ninja is supposed to be a make replacement so it should also handle the same phases. CMake, Meson, gyp, configure, etc. are all "generators" so they should only override the configure phase. This should hopefully lead to less phases in total and a clearer separation between build "generators" like CMake & Meson from "runners" like Make & Ninja.

orivej · 2018-11-19T01:00:03Z

pkgs/development/tools/build-managers/cmake/setup-hook.sh

+cmakeCheckPhase() {
+    runHook preCheck
+
+    ctest --extra-verbose


Maybe ctest --output-on-failure, without --extra-verbose?

jtojnar · 2018-11-20T22:40:55Z

Closing in favour of #50527

cmake: add ctest support to setup hook

Verified

This commit was signed with the committer’s verified signature. The key has expired.

NeQuissimus Tim Steinbach

GPG key ID: C5629893DE283C96
Expired

Verified
Learn about vigilant mode

3b7a51b

GrahamcOfBorg added 10.rebuild-darwin-stdenv 10.rebuild-darwin: 501+ 10.rebuild-linux: 501+ labels Nov 13, 2018

matthewbauer mentioned this pull request Nov 17, 2018

Add check phase to ninja setup hook #50527

Merged

orivej reviewed Nov 19, 2018

View reviewed changes

jtojnar closed this Nov 20, 2018

jtojnar deleted the cmake-ctest branch November 20, 2018 22:41

jtojnar mentioned this pull request Apr 17, 2020

meson: Consider switching builder to backend-agnostic compile command #85441

Open

knedlsepp mentioned this pull request Jul 27, 2021

doc/manual/stdenv: improve cmake documentation #126032

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cmake: add ctest support to setup hook #50323

cmake: add ctest support to setup hook #50323

jtojnar commented Nov 13, 2018

matthewbauer commented Nov 13, 2018

jtojnar commented Nov 13, 2018

GrahamcOfBorg commented Nov 13, 2018

GrahamcOfBorg commented Nov 13, 2018

GrahamcOfBorg commented Nov 13, 2018

matthewbauer commented Nov 15, 2018 •

edited

Loading

matthewbauer commented Nov 15, 2018 via email •

edited

Loading

Mic92 commented Nov 15, 2018 •

edited

Loading

matthewbauer commented Nov 16, 2018 •

edited

Loading

Mic92 commented Nov 16, 2018 •

edited

Loading

matthewbauer commented Nov 17, 2018

jtojnar commented Nov 18, 2018

matthewbauer commented Nov 18, 2018

orivej Nov 19, 2018

jtojnar commented Nov 20, 2018

cmake: add ctest support to setup hook #50323

cmake: add ctest support to setup hook #50323

Conversation

jtojnar commented Nov 13, 2018

Motivation for this change

Things done

matthewbauer commented Nov 13, 2018

jtojnar commented Nov 13, 2018

GrahamcOfBorg commented Nov 13, 2018

GrahamcOfBorg commented Nov 13, 2018

GrahamcOfBorg commented Nov 13, 2018

matthewbauer commented Nov 15, 2018 • edited Loading

matthewbauer commented Nov 15, 2018 via email • edited Loading

Mic92 commented Nov 15, 2018 • edited Loading

matthewbauer commented Nov 16, 2018 • edited Loading

Mic92 commented Nov 16, 2018 • edited Loading

matthewbauer commented Nov 17, 2018

jtojnar commented Nov 18, 2018

matthewbauer commented Nov 18, 2018

orivej Nov 19, 2018

Choose a reason for hiding this comment

jtojnar commented Nov 20, 2018

matthewbauer commented Nov 15, 2018 •

edited

Loading

matthewbauer commented Nov 15, 2018 via email •

edited

Loading

Mic92 commented Nov 15, 2018 •

edited

Loading

matthewbauer commented Nov 16, 2018 •

edited

Loading

Mic92 commented Nov 16, 2018 •

edited

Loading