Move clib-demo to samples

[ischoegl]

Changes proposed in this pull request

Detailed tests included in clib_test.c are superseded by the gtest clib suite. Nevertheless, the original file contains a useful example. This PR moves a slightly updated example to samples/clib while retaining the output file comparison.

If applicable, provide an example illustrating new features this pull request is introducing

The behavior of

scons test-clib-demo

is unchanged, but the source code is now compiled from samples/clib/demo.c.

Checklist

• The pull request includes a clear description of this code change
• Commit messages have short titles and reference relevant issues
• Build passes (scons build & scons test) and unit tests address code coverage
• Style & formatting of contributed code follows contributing guidelines
• The pull request is ready for review

[codecov]

Codecov Report

Merging #1454 (549a1b0) into main (5d247d0) will increase coverage by 0.00%.
The diff coverage is 97.67%.

❗ Current head 549a1b0 differs from pull request most recent head 4f519b8. Consider uploading reports for the commit 4f519b8 to get more accurate results

@@           Coverage Diff           @@
##             main    #1454   +/-   ##
=======================================
  Coverage   69.63%   69.64%           
=======================================
  Files         373      374    +1     
  Lines       55769    55812   +43     
  Branches    18295    18298    +3     
=======================================
+ Hits        38833    38868   +35     
- Misses      14480    14487    +7     
- Partials     2456     2457    +1     

Impacted Files	Coverage Δ
samples/clib/demo.c	97.67% <97.67%> (ø)

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[ischoegl]

The updated unit test works, but I'm not sure why the substituted *.in files aren't copied over to build/samples/clib (working on macOS/Apple Silicon).

[speth]

The updated unit test works, but I'm not sure why the substituted *.in files aren't copied over to build/samples/clib (working on macOS/Apple Silicon).

I tested this, and they do get generated when you run the install command. I think it's because the intermediate files aren't added to the build target, but the final installed location is added to the install target. The same is true for the sample build scripts for other interfaces, so I don't think there's anything that needs to be changed here.

[speth]

Thanks, @ischoegl. I think this change generally makes sense, and installing a pure clib example is useful.

One thing that's lost here is what was described at the top of clib_test.c:

// Include all clib headers to make sure all of them are C-compatible, even if
// we don't actually use all of them in this test.
#include "cantera/clib/ct.h"
#include "cantera/clib/ctfunc.h"
#include "cantera/clib/ctmultiphase.h"
#include "cantera/clib/ctonedim.h"
#include "cantera/clib/ctreactor.h"
#include "cantera/clib/ctrpath.h"
#include "cantera/clib/ctsurf.h"

The point was that this is the only file within Cantera that actually gets compiled by the C (rather than C++) compiler, and ensures that these files don't do anything bad like include a C++ header or syntax that isn't valid C (which was in fact the case before I originally added this test). This is why this test was added to the older test_problems test suite rather than the all-C++ gtest test suite, and I think we still need something that ensures this, even if it's not the previous version of the clib test.

[ischoegl]

@speth ... thanks for the feedback and for shedding some light on the *.in files (the cxx substitutions make some noise during the scons build stage, and I made the wrong conclusions).

One thing that's lost here is what was described at the top of clib_test.c:

// Include all clib headers to make sure all of them are C-compatible, even if
// we don't actually use all of them in this test.
#include "cantera/clib/ct.h"
#include "cantera/clib/ctfunc.h"
#include "cantera/clib/ctmultiphase.h"
#include "cantera/clib/ctonedim.h"
#include "cantera/clib/ctreactor.h"
#include "cantera/clib/ctrpath.h"
#include "cantera/clib/ctsurf.h"

Good point. I re-added the 'lost' includes to demo.c, and added a comment explaining why they are there.

[speth]

Looks good to me!