Merge pull request #2012 from jjotero/bugfix/use-require-keyword

[bugfix] Restrict use of `required` keyword

Author: jjotero

reframe/core/meta.py

@@ -243,7 +243,7 @@ class was created or even at the instance level (e.g. doing
 
         blacklist = [
             'parameter', 'variable', 'bind', 'run_before', 'run_after',
-            'require_deps'
+            'require_deps', 'required'
         ]
         for b in blacklist:
             namespace.pop(b, None)

reframe/core/variables.py

@@ -493,6 +493,11 @@ def extend(self, cls):
             if key in self.vars:
                 self.vars[key].define(value)
                 _assigned_vars.add(key)
+            elif value is Undefined:
+                # Cannot be set as Undefined if not a variable
+                raise ValueError(
+                    f'{key!r} has not been declared as a variable'
+                )
 
         # Delete the vars from the class __dict__.
         for key in _assigned_vars:

unittests/test_meta.py

@@ -20,6 +20,7 @@ class MyTest(rfm.RegressionTest):
         run_before('run')(ext)
         run_after('run')(ext)
         require_deps(ext)
+        v = required
 
         def __init__(self):
             assert not hasattr(self, 'parameter')
@@ -28,6 +29,7 @@ def __init__(self):
             assert not hasattr(self, 'run_before')
             assert not hasattr(self, 'run_after')
             assert not hasattr(self, 'require_deps')
+            assert not hasattr(self, 'required')
 
     MyTest()
 

unittests/test_variables.py

@@ -170,6 +170,13 @@ def __init__(self):
     MyTest()
 
 
+def test_required_non_var():
+    msg = "'not_a_var' has not been declared as a variable"
+    with pytest.raises(ValueError, match=msg):
+        class Foo(rfm.RegressionTest):
+            not_a_var = required
+
+
 def test_invalid_field():
     class Foo:
         '''An invalid descriptor'''