Greatly simplify test-suite driver programs by rouson · Pull Request #86 · BerkeleyLab/julienne

rouson · 2025-08-09T15:57:31Z

This PR

Simplifies the test-suite driver program, test/main.f90, to a form that will facilitate automating the driver creation.
Refactors command_line_test_m using idioms based on a new .expect. unary operator.
Adds .expect. to the table of idioms in the README.md.
Refactors the demo/ subdirectory to demonstrate the new driver structure.
Support older GCC compiler versions by
a. Conditionally gutting the new driver when the preprocessor detects GCC versions below 14.3.0 and
b. Retaining the old driver in test/legacy-main.F90 but conditionally gutting it with GCC 14.3.0 or later versions.

New Features

A unary operator(.expect.) that maps a logical expression to a test_diagnosis_t object.
A test-harness abstraction representing a polymorphic array of tests via
a. A test_harness_t derived type with a test_fixture_t allocatable array component.
b. A test_fixture_t derived type with a polymorphic test_t component.

Driver simplifications

Move the final test results tallying and printing into test_harness_t's type-bound report_results subroutine.
Move the help/usage output into the report_results subroutine.
The new driver consists of only the following elements:
a. Use statements and declarations,
b. One array constructor containing structure constructors and user-defined structure constructor invocations,
c. A single call to report_results on the test harness.

This commit introduces the test_harness_t and test_fixture_t derived types and uses them to refactor and simplify the test-suite driver program: test/main.F90.

This commit reduces the amount of code that end users must write by moving the reporting of the final tally of test passes, test count, and skipped tests to the test_harness_t's "report" type-bound procedure.

This commit the code that checks whether the test suite is running in GitHub CI and checks whether the user requested to run the command_line_t tests. The code is moved from the test-suite driver to the actual test, which further simplifies the test-suite main program.

This commit adds a binary operator that produces a test_diagnosis_t result when applied to a logical operand.

Caveat: The newly refactored test/main.f90 program causes an ICE with gfortran 13.4.

…e into test-harness-feature

move pointer declarations & definitions outside a block construct

also delete redundant example

Also switch file to lower-case .f90 extension because the preprocessor is no longer needed.

bonachea

Looks like a nice improvemen!

I made a few suggestions based on a quick skim.

bonachea · 2025-08-11T16:16:01Z

+  subroutine stop_if_compiler_too_old
+    character(len=:), allocatable :: compiler_identity
+    integer major, minor
+    compiler_identity = compiler_version()
+    if (index(compiler_identity, "GCC")==1) then
+      associate(               final_dot => index(compiler_identity                     ,"." ,back=.true.))
+        associate(       penultimate_dot => index(compiler_identity(:final_dot-1)       ,"." ,back=.true.))
+          associate(space_before_version => index(compiler_identity(:penultimate_dot-1) ," " ,back=.true.))
+            associate( &
+               major_string => compiler_identity(space_before_version+1 : penultimate_dot-1) &
+              ,minor_string => compiler_identity(     penultimate_dot+1 :       final_dot-1) &
+            )
+              read(major_string, '(i2)') major
+              read(minor_string, '(i1)') minor
+              if ((major < 14) .or. (major==14 .and. minor<3)) stop "'"// compiler_identity //"' too old: GCC >= 14.3.0 required"
+            end associate
+          end associate
+        end associate
+      end associate
+    end if
+  end subroutine


This can be written far more concisely using the preprocessor.

You will also need to rename the file back to .F90.

Suggested change

subroutine stop_if_compiler_too_old

character(len=:), allocatable :: compiler_identity

integer major, minor

compiler_identity = compiler_version()

if (index(compiler_identity, "GCC")==1) then

associate( final_dot => index(compiler_identity ,"." ,back=.true.))

associate( penultimate_dot => index(compiler_identity(:final_dot-1) ,"." ,back=.true.))

associate(space_before_version => index(compiler_identity(:penultimate_dot-1) ," " ,back=.true.))

associate( &

major_string => compiler_identity(space_before_version+1 : penultimate_dot-1) &

,minor_string => compiler_identity( penultimate_dot+1 : final_dot-1) &

)

read(major_string, '(i2)') major

read(minor_string, '(i1)') minor

if ((major < 14) .or. (major==14 .and. minor<3)) stop "'"// compiler_identity //"' too old: GCC >= 14.3.0 required"

end associate

end associate

end associate

end associate

end if

end subroutine

#if __GNUC__ && ( __GNUC__ < 14 || (__GNUC__ == 14 && __GNUC_MINOR__ < 3) )

stop "GFortran " // __VERSION__ // " too old: GCC >= 14.3.0 required"

#endif

bonachea · 2025-08-11T16:34:28Z

+program main
+  !! Julienne unit tests driver
+
+#if defined(__GCC__) && (GCC_VERSION < 140300)


I believe it's actually __GNUC__ not __GCC__

Suggested change

#if defined(__GCC__) && (GCC_VERSION < 140300)

#if defined(__GNUC__) && (GCC_VERSION < 140300)

bonachea · 2025-08-11T16:35:12Z


-program main
-  !! Julienne unit tests driver
+#if ! defined(__GCC__) || (GCC_VERSION >= 140300)


Suggested change

#if ! defined(__GCC__) || (GCC_VERSION >= 140300)

#if ! defined(__GNUC__) || (GCC_VERSION >= 140300)

bonachea · 2025-08-11T16:37:31Z

+#ifdef __GNUC__
 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
+#else
+#define GCC_VERSION 0
+#endif


Minor nitpick:

For the "not Gfortran" case, you might instead consider leaving GCC_VERSION undefined:

Suggested change

#ifdef __GNUC__

#define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)

#else

#define GCC_VERSION 0

#endif

#ifdef __GNUC__

# define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)

#else

# undef GCC_VERSION

#endif

Then later your tests become more readable and slightly less error-prone:

#if ! defined(GCC_VERSION) || (GCC_VERSION >= 140300)

rouson · 2025-08-13T22:34:53Z

This PR is superseded by PR #91.

rouson added 7 commits August 9, 2025 07:16

feat(test): define/use test harness, test fixtures

ddd1aa9

This commit introduces the test_harness_t and test_fixture_t derived types and uses them to refactor and simplify the test-suite driver program: test/main.F90.

refac(test_harness): mv help I/O to harness report

c2f951c

feat(test):don't run intentional fail if --help/-h

a738cac

fix(intentional-fail): mv 'implicit none'

b0c034b

feat(test_harness): automatically report tally

162628d

This commit reduces the amount of code that end users must write by moving the reporting of the final tally of test passes, test count, and skipped tests to the test_harness_t's "report" type-bound procedure.

feat: default preprocessing of test main

d40d334

rouson requested a review from ktras August 9, 2025 15:57

rouson and others added 14 commits August 9, 2025 10:28

feat(test_diagnosis): add .expect. operator

5820af7

This commit adds a binary operator that produces a test_diagnosis_t result when applied to a logical operand.

fix(include): use GCC minor and patch versions

559c1ed

fix: work around gfortran 14 builds

f110cbc

Caveat: The newly refactored test/main.f90 program causes an ICE with gfortran 13.4.

fix(command_line_test): mv code

ebc5be1

chore(CI): use more descriptive names

fe2f192

chore(CI): print versions, set env vars

f4c44d1

fix(include/language-support): add compilers

56e126f

chore(test_fixture): priv component, non-alloc arg

5ea38ec

chore(test_harness): priv component, non-alloc arg

9e75285

doc(test/main,harness): add/edit comments

932edcc

chore(test_harness): mk component array non-poly

db2981e

refac(test_harness): disambiguate binding name

6120c8f

refac(test_harness): rm dummy args

4df3368

refac(test_harness): collapse print statements

7ed8437

rouson force-pushed the test-harness-feature branch from 56e126f to 7ed8437 Compare August 10, 2025 18:36

rouson and others added 6 commits August 10, 2025 11:40

chore(CI): fix compiler names

664578e

fix(CI): only run command-line tests if not in CI

a928d8f

Merge branch 'test-harness-feature' of github.com:berkeleylab/julienn…

b757a10

…e into test-harness-feature

fix(CI): fix logic to skip command_line_t tests

cff34b6

fix(command_line_test_t): fix output statements

03a05c8

fix(CI): use legacy-main with GCC version < 14.3.0

06ca107

rouson force-pushed the test-harness-feature branch from bfa2155 to 06ca107 Compare August 11, 2025 02:37

rouson added 7 commits August 10, 2025 19:43

fix(CI): ensure non-empty test-suite main programs

5a5ab9c

fix(command_line_test): separate ptr decl/def

e049da7

fix(command_line_test): gfoetran 12 workaround

0c9dd15

move pointer declarations & definitions outside a block construct

doc(README): add example of operator(.expect.)

c94c0cf

also delete redundant example

doc(demo): refactor driver using test harness

d268f93

doc(demo): update README.md

f49a117

Also switch file to lower-case .f90 extension because the preprocessor is no longer needed.

chore: use .f90 file extension

0d34d8c

This was referenced Aug 11, 2025

Move --contains test filtering logic into Julienne #67

Closed

Automate the creation of the test-suite driver #87

Closed

bonachea linked an issue Aug 11, 2025 that may be closed by this pull request

Move --contains test filtering logic into Julienne #67

Closed

bonachea requested changes Aug 11, 2025

View reviewed changes

bonachea mentioned this pull request Aug 12, 2025

Centralize the test filtering logic to test_description_m #91

Merged

rouson closed this Aug 13, 2025

rouson deleted the test-harness-feature branch August 23, 2025 22:18

Navigation Menu

Uh oh!

Greatly simplify test-suite driver programs - #86

Greatly simplify test-suite driver programs#86
rouson wants to merge 34 commits into
mainfrom
test-harness-feature

rouson commented Aug 9, 2025 •

edited

Loading

Uh oh!

bonachea left a comment

Uh oh!

bonachea Aug 11, 2025

Uh oh!

bonachea Aug 11, 2025

Uh oh!

bonachea Aug 11, 2025

Uh oh!

bonachea Aug 11, 2025

Uh oh!

Uh oh!

rouson commented Aug 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	#if defined(__GCC__) && (GCC_VERSION < 140300)
	#if defined(__GNUC__) && (GCC_VERSION < 140300)

	#if ! defined(__GCC__) \|\| (GCC_VERSION >= 140300)
	#if ! defined(__GNUC__) \|\| (GCC_VERSION >= 140300)

Uh oh!

Conversation

rouson commented Aug 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Features

Driver simplifications

Uh oh!

bonachea left a comment

Choose a reason for hiding this comment

Uh oh!

bonachea Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

bonachea Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

bonachea Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

bonachea Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rouson commented Aug 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rouson commented Aug 9, 2025 •

edited

Loading