Help writing a CMakeLists

[VictorEijkhout]

As a regression test I want to compile & run one of the sources in the unit_tests directory. Unforunately the CMakeLists there is not usable since it can only be used when called from the main build.

Here is my attempt at a CMakeLists.txt:

cmake_minimum_required(VERSION 3.31.5)

project( ${PROJECTNAME}
  DESCRIPTION "C++ programs for Aspect testing"
  VERSION 1.0 )

add_executable( ${PROJECTNAME} ${PROJECTNAME}.cpp )

find_package( MPI )
# nope find_package( deal.II REQUIRED )
find_package( Aspect REQUIRED )

find_package( PkgConfig REQUIRED )
pkg_check_modules( CATCH2 REQUIRED catch2-with-main )
target_include_directories(
        ${PROJECTNAME} PUBLIC
        ${CATCH2_INCLUDE_DIRS}
        )
target_link_directories(
        ${PROJECTNAME} PUBLIC
        ${CATCH2_LIBRARY_DIRS}
        )
target_link_libraries(
        ${PROJECTNAME} PUBLIC
        ${CATCH2_LIBRARIES}
        )

DEAL_II_INITIALIZE_CACHED_VARIABLES()

ASPECT_SETUP_PLUGIN(${PROJECTNAME})

install( TARGETS ${PROJECTNAME} DESTINATION . )

This leads to an error:

-- Found PkgConfig: /usr/bin/pkg-config (found version "1.7.3")
-- Checking for module 'catch2-with-main'
--   Found catch2-with-main, version 3.8.1
###
#
#  WARNING:
#
#  CMAKE_BUILD_TYPE "" unsupported by current installation!
#  deal.II was configured with "DebugRelease".
#
#  CMAKE_BUILD_TYPE was forced to "Debug".
#
###
-- Setting up plugin:
--   name <first>
--   using ASPECT_DIR /home1/apps/gcc13/impi21/aspect/3.0.0/bin
--   setting up RELEASE variant
CMake Error at /home1/apps/gcc13/impi21/dealii/9.6.2/share/deal.II/macros/macro_deal_ii_setup_target.cmake:103 (target_link_libraries):
  The keyword signature for target_link_libraries has already been used with
  the target "first".  All uses of target_link_libraries with a target must
  be either all-keyword or all-plain.

  The uses of the keyword signature are here:

   * CMakeLists.txt:23 (target_link_libraries)

Call Stack (most recent call first):
  /home1/apps/gcc13/impi21/aspect/3.0.0/lib/cmake/Aspect/AspectConfig.cmake:73 (deal_ii_setup_target)
  CMakeLists.txt:30 (ASPECT_SETUP_PLUGIN)


-- Configuring incomplete, errors occurred!

Can I get a hint?

[tjhei]

As a regression test

I would suggest that you run the normal test suite. You can achieve this by running ctest in your build directory. This will run one "quick" test and the unit tests. You can enable all tests by setting the cmake option ASPECT_RUN_ALL_TESTS=ON.

Note, the unit tests are baked into the ASPECT binary and can be manually invoked using ./aspect-debug --test. No need to set up an extra target.

[VictorEijkhout]

1. I don't have a build directory: those get thrown away after I install.
2. Besides I want to be able to run tests at any time, not just when installing. And I'm installing in a very strange environment, so I couldn't even test there.
3. Will check out testing through the built-in tests.

But really, how do I write an aspect cmakelists? I want to write my own tests, and I'm only starting with yours.

[VictorEijkhout]

Oh, I don't have aspect-debug: I only have the release build. Does that one have the tests too?

Oh joy:

aspect-release --test
aspect-release: error while loading shared libraries: libWorldBuilderRelease.so: cannot open shared object file: No such file or directory

Why do you put libraries in the bin dir rather than lib?

[tjhei]

Does that one have the tests too?

Yes, it should work.

libWorldBuilderRelease.so

How are you configuring ASPECT? We only statically link the world builder as far as I know and this is a shared library you are missing.

[tjhei]

Are you specifying BUILD_SHARED_LIBS=ON by any chance?

[VictorEijkhout]

Yes, I have shared libs as a default option for cmake.

[VictorEijkhout]

But really, how do I write an aspect cmakelists? I want to write my own tests, and I'm only starting with yours.

[bangerth]

@VictorEijkhout It's not quite clear to me what you want to do. The test suite is part of ASPECT, so it makes sense that the CMakelists.txt file in that directory isn't written to be used as a stand-alone cmake script. Is your goal to copy the test suite somewhere else and run it against an installed copy of ASPECT?

[VictorEijkhout]

I'd like to write a cmake setup for my own programs. My attempt above contains lines

DEAL_II_INITIALIZE_CACHED_VARIABLES()
ASPECT_SETUP_PLUGIN(${PROJECTNAME})

which I copied from one of your cmake lists, but that gives an error as reported.

So I'm looking for an as-vanilla-looking-as-possible cmake way to build an aspect program, test or otherwise.

[bangerth]

I guess I don't quite understand what "build an aspect program" actually means. The ASPECT cmake files build the ASPECT executable. The way people extend ASPECT is not to build a different executable, but to build a shared library that the ASPECT executable can then load.

[tjhei]

But really, how do I write an aspect cmakelists? I want to write my own tests, and I'm only starting with yours.

Running and writing your own tests using the ctest testing framework is described here:
https://aspect-documentation.readthedocs.io/en/latest/user/extending/testing/running-tests.html

How to write/compile/use a plugin is described here:
https://aspect-documentation.readthedocs.io/en/latest/user/extending/write-a-plugin.html

Many cookbooks and benchmarks make use of this.

[VictorEijkhout]

I guess I misunderstand the usage model. And I now notice that the lib directory doesn't seem to contain libraries.

Ok, I'll do aspect-release --test. Does that need an mpiexec? can I select what tests to run? I need only the minimum to convince me that the executable is functional.

[bangerth]

I don't think any of the tests check the parallel execution. So no need for mpirun/mpiexec. If you run ./aspect --test you should get something like

/aspect-debug --test
===============================================================================
All tests passed (2098 assertions in 31 test cases)

[VictorEijkhout]

I get a message from my MPI:

MPI startup(): PMI server not found. Please set I_MPI_PMI_LIBRARY variable if it is not a singleton case.

so MPI is involved somewhere. that message goes away if I prepend mpiexec or local variant thereof.

And can I select what tests to run?