OPENSCAD-TESTRUN(1)

📦 version 2021.01, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

🌸 NAME 🌸

openscad-testrun — bestie, this is the girl that sets up and runs the OpenSCAD test suite 💖

(It lives in the General Commands Manual, section 1, if you were wondering where we're at 🎀)

✨ SYNOPSIS ✨

openscad-testrun [options]

🦋 DESCRIPTION 🦋

Okay so real talk, this manual page is the quick little rundown of the openscad-testrun command. No cap.

Here's the tea: openscad-testrun is a script that sets up a directory — a whole lil home 🏠 — where the OpenSCAD test suite (which is implemented in ctest, fyi) can actually be run. How does it do that? By creating symlinks to the system locations of the input data. Then it runs the suite. Periodt.

Important: the created directory is not removed. She stays. And she'll contain the test results in addition to all those symlinks. So don't be surprised when you go looking and there's extra stuff in there 👀

Why does this script even need to exist? Great question bestie 🫶 Because the test suite in its original form expects all the test input and output data to be in relative locations, and the typical user has no write access to where that data actually lives. So yeah, she's a workaround and she knows it 💅

And lowkey? Future changes to the test suite might make it more flexible, which would remove the need for this script entirely. So this whole vibe might be temporary. We'll see 🤷

💅 OPTIONS 💅

  • -d directory, --directory directory — Set up the tests in a directory called directory. By default, this name gets generated from the current date and time, like openscad-test-2012-02-15_13_37. Iconic auto-naming honestly ✨
  • -j N, --parallel N — Run N test jobs in parallel. You can also set this in the CTEST_PARALLEL_LEVEL environment variable if that's more your thing. The default is to run as many jobs as there are available processing units, as returned by nproc(1). Let her cook 🔥
  • -n, --dry-run — Do not run the test suite, just set it up. It's giving "window shopping" 🛍️
  • --virtual — Use xvfb-run to execute the tests inside a virtual X server. Very main character, very "I have my own little world" energy 🌈

All additional arguments are passed on to ctest. So whatever else you throw at her, she hands straight over to ctest. No gatekeeping 🙈

👑 AUTHOR 👑

The OpenSCAD test suite was written by Clifford Wolf, Marius Kintel, and others. The openscad-testrun script was written by chrysn. Shoutout to the whole squad, fr fr 💜

This manual page was written by chrysn <chrysn@fsfe.org>, for the Debian project (and may be used by others). Love that for us 🫶

And that's a wrap, bestie — this page is from 2012-02-16, and yeah, she's an OPENSCAD-TESTRUN(1) girlie from the General Commands Manual. Old but still slaying 💖✨

📦 where this page comes from