tests: Add command line tests with random prefixes

Author: ZoeLeibowitz

devito/petsc/iet/routines.py

@@ -149,7 +149,12 @@ def _make_options_callback(self):
 
         for k, v in params.items():
             option = f'-{prefix}{k}'
-            if option in sys.argv:
+            # if option in sys.argv:
+            # TODO: Pre-build the KSPGetArgs operator and run it here
+            # to drop the global _petsc_clargs
+            # tmp = petsc_get_args_op.apply()
+            import devito.petsc.initialize
+            if option in devito.petsc.initialize._petsc_clargs:
                 # Ensures that the command line args take priority
                 continue
             option_name = String(option)

devito/petsc/initialize.py

@@ -12,9 +12,17 @@
 _petsc_initialized = False
 
 
+global _petsc_clargs
+
 def PetscInitialize(clargs=sys.argv):
     global _petsc_initialized
+    global _petsc_clargs
+
     if not _petsc_initialized:
+        if clargs is not sys.argv:
+            clargs = [sys.argv[0], *clargs]
+        # TODO: drop this
+        _petsc_clargs = clargs
         dummy = Symbol(name='d')
         # TODO: Potentially just use cgen + the compiler machinery in Devito
         # to generate these "dummy_ops" instead of using the Operator class.
@@ -37,7 +45,6 @@ def PetscInitialize(clargs=sys.argv):
         argv_pointer = (POINTER(c_char)*len(clargs))(
             *map(lambda s: cast(s, POINTER(c_char)), argv_bytes)
         )
-
         op_init.apply(argc=len(clargs), argv=argv_pointer)
 
         atexit.register(op_finalize.apply)

devito/petsc/logging.py

@@ -203,7 +203,8 @@ class PetscReturnVariable:
         name='KSPGetTolerances',
         variable_type=(PetscScalar, PetscScalar, PetscScalar, PetscInt),
         input_params='ksp',
-        output_param=('rtol', 'abstol', 'dtol', 'maxits'),
+        # TODO: check if maxits is max_its in command line
+        output_param=('rtol', 'atol', 'dtol', 'maxits'),
     ),
     'kspgetconvergedreason': PetscReturnVariable(
         name='KSPGetConvergedReason',

tests/test_petsc.py

@@ -3,6 +3,7 @@
 import numpy as np
 import os
 import re
+import sys
 from collections import OrderedDict
 
 from conftest import skipif
@@ -23,15 +24,37 @@
 from devito.petsc.logging import PetscSummary
 from devito.petsc.solver_parameters import linear_solve_defaults
 
+@pytest.fixture(scope='session')
+def command_line():
+    # one prefix per test
+    prefix = ('d17weqroegn', 'riabfodkj')
+
+    petsc_option = (
+        ('ksp_rtol',),
+        ('ksp_rtol','ksp_atol')
+    )
+    value = (
+        ('1e-8',),
+        ('1e-11','1e-15'),
+    )
+    argv = []
+
+    expected = {}
+    for p, opt, val in zip(prefix, petsc_option, value, strict=True):
+        for o, v in zip(opt, val, strict=True):
+            argv.extend([f'-{p}_{o}', v])
+        expected[p] = zip(opt,val)
+    return argv, expected
+
 
 @pytest.fixture(scope='session', autouse=True)
-def petsc_initialization():
+def petsc_initialization(command_line):
+    argv, _ = command_line
     # TODO: Temporary workaround until PETSc is automatically
     # initialized
     configuration['compiler'] = 'custom'
     os.environ['CC'] = 'mpicc'
-    # PetscInitialize(argv)
-    PetscInitialize()
+    PetscInitialize(argv)
 
 
 @skipif('petsc')
@@ -1710,26 +1733,48 @@ def test_multiple_operators(self, log_level):
     # TODO: Add test to check that the command line args override anything set
     # in the solver_parameters dictionary
 
-    # @skipif('petsc')
-    # def test_command_line_priority(self):
-    #     """
-    #     Test solver parameters specifed via the command line
-    #     take precedence over those set in the solver_parameters
-    #     dictionary.
-    #     """
-    #     prefix = 'd17weqroegn'
-
-    #     solver1 = PETScSolve(
-    #         self.eq1, target=self.e, solver_parameters={
-    #             'ksp_rtol': '1e-9',
-    #             'snes_view': None}
-    #     )
-    #     with switchconfig(language='petsc'):
-    #         op = Operator(solver1)
-    #         op.apply()
-
-    #     # Check that the command line option specifying the ksp_rtol took
-    #     # priorty over the solver
+    @skipif('petsc')
+    def test_command_line_priority_1(self, command_line):
+        """
+        Test solver parameters specifed via the command line
+        take precedence over those set in the solver_parameters
+        dictionary.
+        """
+        prefix = 'd17weqroegn'
+        _, expected = command_line
+
+        solver1 = PETScSolve(
+            self.eq1, target=self.e,
+            options_prefix=prefix
+        )
+        with switchconfig(language='petsc', log_level='DEBUG'):
+            op = Operator(solver1)
+            summary = op.apply()
+
+        petsc_summary = summary.petsc
+        entry = petsc_summary.get_entry('section0', prefix)
+        for opt, val in expected[prefix]:
+            assert str(entry.KSPGetTolerances[opt.removeprefix('ksp_')]) == val
+
+    @skipif('petsc')
+    def test_command_line_priority_2(self, command_line):
+        """
+        """
+        prefix = 'riabfodkj'
+        _, expected = command_line
+
+        solver1 = PETScSolve(
+            self.eq1, target=self.e,
+            options_prefix=prefix
+        )
+        with switchconfig(language='petsc', log_level='DEBUG'):
+            op = Operator(solver1)
+            summary = op.apply()
+
+        petsc_summary = summary.petsc
+        entry = petsc_summary.get_entry('section0', prefix)
+        for opt, val in expected[prefix]:
+            assert str(entry.KSPGetTolerances[opt.removeprefix('ksp_')]) == val
 
 
 class TestHashing: