[flang][driver] Refine tests for module search directories

[awarzynski]

Summary

This patch refactors include-module.f90:

• rename the test file as use-module.f90 to better highlight which driver feature is being tested
• move tests for diagnostics to use-module-error.f90 (it tests that -J/-module-dir can only be used once)
• make sure that f18 is tested when FLANG_BUILD_NEW_DRIVER is set to Off
• add tests for when all module files are successfully discovered and loaded

With this patch, there should be a clear separation into 3 scenarios in
use-module.f90:

• Everything is OK
• One module file wasn't found (missing include path for basictestingmoduletwo.mod)
• Two module files are found, but the test requires basictestingmoduleone.mod from both Inputs and Inputs/module-dir. Only the latter is found.

Depends on: D97164

[tskeith]

make sure that f18 is tested when FLANG_BUILD_NEW_DRIVER is set to Off

I don't think any of the tests in flang/test/Flang-Driver are run when that flag is Off, due to the configuration in flang/test/lit.cfg.py. That's why I added flang/test/Driver/write-module.f90 in D97164. Those tests are run in either configuration.

flang/test/Flang-Driver/Inputs/module-dir/basictestmoduleone.mod

3

Rather than check in the .mod files (whose format can change at any time) it would be better to check in the Fortran source and compile it for tests that need it. It would make the tests less fragile.

flang/test/Flang-Driver/use-module-error.f90

8

For tests like this that require the new driver, it would be better to use %flang rather than %flang-new. Otherwise in ten years it will still say %flang-new and people will wonder what's new about it.

15

Same here: use %flang_fc1.

[awarzynski]

Use %flang and %flang_fc1 instead of %flang-new.

[awarzynski]

In D97197#2579141, @tskeith wrote:

make sure that f18 is tested when FLANG_BUILD_NEW_DRIVER is set to Off

I don't think any of the tests in flang/test/Flang-Driver are run when that flag is Off, due to the configuration in flang/test/lit.cfg.py. That's why I added flang/test/Driver/write-module.f90 in D97164. Those tests are run in either configuration.

I assumed that the reason for a separate file in D97164 was -module and -fparse-only (which are not available in the new driver). I should've asked. I think this is all fine and is a good indicator that it's time to update flang/test/lit.cfg.py: https://reviews.llvm.org/D97207.

flang/test/Flang-Driver/Inputs/module-dir/basictestmoduleone.mod

3

I agree that we should aim for something more reliable/stable. Could that be a separate patch though?

flang/test/Flang-Driver/use-module-error.f90

8

Old habits. Updated.

[tskeith]

flang/test/Flang-Driver/Inputs/module-dir/basictestmoduleone.mod

3

Yes, that's fine.

[awarzynski]

Rebase on top of main

[awarzynski]

Ping

[tskeith]

This is more a comment for D97207, but it's related to -module-dir: We probably don't need flang/test/Driver/write-module.f90 any more if it's tested in flang/test/Flang-Driver. In fact, I think we should get rid of all of the tests in flang/test/Driver and rename flang/test/Flang-Driver to flang/test/Driver.

[awarzynski]

In D97197#2611673, @tskeith wrote:

This is more a comment for D97207, but it's related to -module-dir: We probably don't need flang/test/Driver/write-module.f90 any more if it's tested in flang/test/Flang-Driver. In fact, I think we should get rid of all of the tests in flang/test/Driver and rename flang/test/Flang-Driver to flang/test/Driver.

I agree, please see https://reviews.llvm.org/D98257.

flang/test/Flang-Driver/Inputs/module-dir/basictestmoduleone.mod

-!mod$ v1 sum:449b70509dd4bce3
+!mod$ v1 sum:d380ce014c8955d8
 module basictestmoduleone
-type::t2
-end type
 end

flang/test/Flang-Driver/Inputs/module-dir/basictestmoduletwo.mod

-!mod$ v1 sum:563b9a1f049282d2
+!mod$ v1 sum:6c4101164527e745
 module basictestmoduletwo
+type::t2
+end type
 end

flang/test/Flang-Driver/include-module.f90

-! Ensure argument -I works as expected with module files.
-
-! REQUIRES: new-flang-driver
-
-!--------------------------
-! FLANG DRIVER (flang-new)
-!--------------------------
-! RUN: not %flang-new -fsyntax-only -I %S/Inputs -I %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=INCLUDED
-! RUN: not %flang-new -fsyntax-only -I %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
-! RUN: not %flang-new -fsyntax-only -I %S/Inputs -J %S/Inputs/module-dir %s 2>&1 | FileCheck %s --check-prefix=INCLUDED
-! RUN: not %flang-new -fsyntax-only -J %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
-! RUN: not %flang-new -fsyntax-only -I %S/Inputs -module-dir %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=INCLUDED
-! RUN: not %flang-new -fsyntax-only -module-dir %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
-! RUN: not %flang-new -fsyntax-only -J %S/Inputs/module-dir -J %S/Inputs/ %s  2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
-! RUN: not %flang-new -fsyntax-only -J %S/Inputs/module-dir -module-dir %S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
-! RUN: not %flang-new -fsyntax-only -module-dir %S/Inputs/module-dir -J%S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
-
-!-----------------------------------------
-! FRONTEND FLANG DRIVER (flang-new -fc1)
-!-----------------------------------------
-! RUN: not %flang-new -fc1 -fsyntax-only -I %S/Inputs -I %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=INCLUDED
-! RUN: not %flang-new -fc1 -fsyntax-only -I %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
-! RUN: not %flang-new -fc1 -fsyntax-only -I %S/Inputs -J %S/Inputs/module-dir %s 2>&1 | FileCheck %s --check-prefix=INCLUDED
-! RUN: not %flang-new -fc1 -fsyntax-only -J %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
-! RUN: not %flang-new -fc1 -fsyntax-only -I %S/Inputs -module-dir %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=INCLUDED
-! RUN: not %flang-new -fc1 -fsyntax-only -module-dir %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
-! RUN: not %flang-new -fc1 -fsyntax-only -J %S/Inputs/module-dir -J %S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
-! RUN: not %flang-new -fc1 -fsyntax-only -J %S/Inputs/module-dir -module-dir %S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
-! RUN: not %flang-new -fc1 -fsyntax-only -module-dir %S/Inputs/module-dir -J%S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
-
-!-----------------------------------------
-! EXPECTED OUTPUT FOR MISSING MODULE FILE
-!-----------------------------------------
-! SINGLEINCLUDE:error: Cannot read module file for module 'basictestmoduletwo'
-! SINGLEINCLUDE-NOT:error: Cannot read module file for module 'basictestmoduletwo'
-! SINGLEINCLUDE-NOT:error: Derived type 't1' not found
-! SINGLEINCLUDE:error: Derived type 't2' not found
-
-!-----------------------------------------
-! EXPECTED OUTPUT FOR MISSING MODULE FILE
-!-----------------------------------------
-! DOUBLEINCLUDE:error: Only one '-module-dir/-J' option allowed
-
-!---------------------------------------
-! EXPECTED OUTPUT FOR ALL MODULES FOUND
-!---------------------------------------
-! INCLUDED-NOT:error: Cannot read module file
-! INCLUDED-NOT:error: Derived type 't1' not found
-! INCLUDED:error: Derived type 't2' not found
-
-program test_dash_I_with_mod_files
-    USE basictestmoduleone
-    USE basictestmoduletwo
-    type(t1) :: x1 ! t1 defined in Inputs/basictestmoduleone.mod
-    type(t2) :: x2 ! t2 defined in Inputs/module-dir/basictestmoduleone.mod
-end

flang/test/Flang-Driver/use-module-error.f90

+! Ensure that multiple module directories are not allowed
+
+! REQUIRES: new-flang-driver
+
+!--------------------------
+! FLANG DRIVER (flang-new)
+!--------------------------
+! RUN: not %flang-new -fsyntax-only -J %S/Inputs/module-dir -J %S/Inputs/ %s  2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
+! RUN: not %flang-new -fsyntax-only -J %S/Inputs/module-dir -module-dir %S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
+! RUN: not %flang-new -fsyntax-only -module-dir %S/Inputs/module-dir -J%S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
+
+!-----------------------------------------
+! FRONTEND FLANG DRIVER (flang-new -fc1)
+!-----------------------------------------
+! RUN: not %flang-new -fc1 -fsyntax-only -J %S/Inputs/module-dir -J %S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
+! RUN: not %flang-new -fc1 -fsyntax-only -J %S/Inputs/module-dir -module-dir %S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
+! RUN: not %flang-new -fc1 -fsyntax-only -module-dir %S/Inputs/module-dir -J%S/Inputs/ %s 2>&1 | FileCheck %s --check-prefix=DOUBLEINCLUDE
+
+!-----------------------------------------
+! EXPECTED OUTPUT FOR MISSING MODULE FILE
+!-----------------------------------------
+! DOUBLEINCLUDE:error: Only one '-module-dir/-J' option allowed
+
+program too_many_module_dirs
+end

flang/test/Flang-Driver/use-module.f90

+! Checks that module search directories specified with `-J/-module-dir` and `-I` are handled correctly
+
+!--------------------------
+! FLANG DRIVER (flang-new)
+!--------------------------
+! RUN: %flang -fsyntax-only -I %S/Inputs -I %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=INCLUDED --allow-empty
+! RUN: %flang -fsyntax-only -I %S/Inputs -J %S/Inputs/module-dir %s 2>&1 | FileCheck %s --check-prefix=INCLUDED --allow-empty
+! RUN: %flang -fsyntax-only -I %S/Inputs -module-dir %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=INCLUDED --allow-empty
+
+! RUN: not %flang -fsyntax-only -I %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=MISSING_MOD2
+! RUN: not %flang -fsyntax-only -J %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=MISSING_MOD2
+! RUN: not %flang -fsyntax-only -module-dir %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=MISSING_MOD2
+
+! RUN: not %flang -fsyntax-only -I %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
+! RUN: not %flang -fsyntax-only -J %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
+! RUN: not %flang -fsyntax-only -module-dir %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
+
+!-----------------------------------------
+! FRONTEND FLANG DRIVER (flang-new -fc1)
+!-----------------------------------------
+! RUN: %flang_fc1 -fsyntax-only -I %S/Inputs -I %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=INCLUDED --allow-empty
+! RUN: %flang_fc1 -fsyntax-only -I %S/Inputs -J %S/Inputs/module-dir %s 2>&1 | FileCheck %s --check-prefix=INCLUDED --allow-empty
+! RUN: %flang_fc1 -fsyntax-only -I %S/Inputs -module-dir %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=INCLUDED --allow-empty
+
+! RUN: not %flang_fc1 -fsyntax-only -I %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=MISSING_MOD2
+! RUN: not %flang_fc1 -fsyntax-only -J %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=MISSING_MOD2
+! RUN: not %flang_fc1 -fsyntax-only -module-dir %S/Inputs %s  2>&1 | FileCheck %s --check-prefix=MISSING_MOD2
+
+! RUN: not %flang_fc1 -fsyntax-only -I %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
+! RUN: not %flang_fc1 -fsyntax-only -J %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
+! RUN: not %flang_fc1 -fsyntax-only -module-dir %S/Inputs/module-dir %s  2>&1 | FileCheck %s --check-prefix=SINGLEINCLUDE
+
+!------------------------------------
+! EXPECTED OUTPUT: all modules found
+!------------------------------------
+! INCLUDED-NOT: error
+
+!------------------------------------------------------------------
+! EXPECTED OUTPUT: include dir for `basictestingmoduletwo` is missing
+!------------------------------------------------------------------
+! MISSING_MOD2-NOT:error: Cannot read module file for module 'basictestmoduleone''
+! MISSING_MOD2-NOT:error: Derived type 't1' not found
+! MISSING_MOD2:error: Cannot read module file for module 'basictestmoduletwo'
+! MISSING_MOD2:error: Derived type 't2' not found
+
+!----------------------------------------------------------------------
+! EXPECTED OUTPUT: `Inputs` is not included, and hence `t1` is undefined
+!---------------------------------------------------------------------
+! SINGLEINCLUDE-NOT:error: Cannot read module file for module 'basictestmoduleone'
+! SINGLEINCLUDE:error: Derived type 't1' not found
+! SINGLEINCLUDE-NOT:error: Cannot read module file for module 'basictestmoduletwo'
+! SINGLEINCLUDE-NOT:error: Derived type 't2' not found
+
+
+program test_search_dirs_for_mod_files
+    USE basictestmoduleone
+    USE basictestmoduletwo
+    type(t1) :: x1 ! t1 defined in Inputs/basictestmoduleone.mod
+    type(t2) :: x2 ! t2 defined in Inputs/module-dir/basictestmoduleone.mod
+end