Merge pull request #108 from olehermanse/str

cfengine lint: Added support for deprecated str attribute in vars promises

Author: olehermanse

src/cfengine_cli/lint.py

@@ -50,6 +50,7 @@
     "rlist",
     "slist",
     "string",
+    "str",  # deprecated shorthand for string
 }
 PROMISE_BLOCK_ATTRIBUTES = ("path", "interpreter")
 
@@ -775,29 +776,35 @@ def _lint_attribute_name(
     """Check an attribute name for deprecations and validity according to the
     surrounding promise type."""
     assert node.type == "attribute_name"
-    if state.strict and _text(node) == "ifvarclass":
+    attribute_name = _text(node)
+    assert attribute_name == state.attribute_name
+    if state.strict and state.promise_type == "vars" and attribute_name == "str":
+        raise ValidationError(
+            f"Deprecation: Use 'string' instead of 'str' {location}", node
+        )
+    if state.strict and attribute_name == "ifvarclass":
         raise ValidationError(
             f"Deprecation: Use 'if' instead of 'ifvarclass' {location}", node
         )
-    if state.promise_type and state.attribute_name:
+    if state.promise_type and attribute_name:
         promise_type_data = syntax_data.BUILTIN_PROMISE_TYPES.get(
             state.promise_type, {}
         )
         if not promise_type_data:
             # Custom promise type - we cannot validate attribute name here.
             return
         promise_type_attrs = promise_type_data.get("attributes", {})
-        if state.attribute_name not in promise_type_attrs:
+        if attribute_name not in promise_type_attrs:
             raise ValidationError(
-                f"Error: Invalid attribute '{state.attribute_name}' for promise type '{state.promise_type}' {location}",
+                f"Error: Invalid attribute '{attribute_name}' for promise type '{state.promise_type}' {location}",
                 node,
             )
-    if state.block_keyword == "promise" and state.attribute_name not in (
+    if state.block_keyword == "promise" and attribute_name not in (
         None,
         *PROMISE_BLOCK_ATTRIBUTES,
     ):
         raise ValidationError(
-            f"Error: Invalid attribute name '{state.attribute_name}' in '{state.block_name}' custom promise type definition {location}",
+            f"Error: Invalid attribute name '{attribute_name}' in '{state.block_name}' custom promise type definition {location}",
             node,
         )
 

tests/lint/002_deprecations.expected.txt

@@ -0,0 +1,17 @@
+
+{
+  defaults:
+  ^-------^
+Deprecation: Promise type 'defaults' is deprecated at tests/lint/002_deprecations.x.cf:3:3
+
+  vars:
+    "x" str => "value";
+        ^-^
+Deprecation: Use 'string' instead of 'str' at tests/lint/002_deprecations.x.cf:6:9
+
+    "Hello, CFEngine"
+      ifvarclass => "cfengine";
+      ^--------^
+Deprecation: Use 'if' instead of 'ifvarclass' at tests/lint/002_deprecations.x.cf:9:7
+FAIL: tests/lint/002_deprecations.x.cf (3 errors)
+Failure, 3 errors in total.

tests/lint/002_ifvarclass.x.cf tests/lint/002_deprecations.x.cftests/lint/002_ifvarclass.x.cf renamed to tests/lint/002_deprecations.x.cf

@@ -1,5 +1,9 @@
 bundle agent main
 {
+  defaults:
+    "x" string => "value";
+  vars:
+    "x" str => "value";
   reports:
     "Hello, CFEngine"
       ifvarclass => "cfengine";

tests/lint/002_ifvarclass.expected.txt

@@ -0,0 +1,16 @@
+bundle agent my_bundle
+{
+  reports:
+    "Hello";
+}
+
+body perms my_body
+{
+  owners => { "root" };
+}
+
+promise agent my_promise_type
+{
+  path => "/bin/true";
+  interpreter => "/bin/bash";
+}

tests/lint/003_deprecated_promise_type.cf

@@ -0,0 +1,16 @@
+
+bundle agent MyBundle
+             ^------^
+Convention: Bundle name should be lowercase at tests/lint/003_name_lowercase.x.cf:1:14
+
+
+body perms MyBody
+           ^----^
+Convention: Body name should be lowercase at tests/lint/003_name_lowercase.x.cf:7:12
+
+
+promise agent MyPromiseType
+              ^-----------^
+Convention: Promise type should be lowercase at tests/lint/003_name_lowercase.x.cf:12:15
+FAIL: tests/lint/003_name_lowercase.x.cf (3 errors)
+Failure, 3 errors in total.

tests/lint/003_deprecated_promise_type.expected.txt

@@ -0,0 +1,16 @@
+bundle agent MyBundle
+{
+  reports:
+    "Hello";
+}
+
+body perms MyBody
+{
+  owners => { "root" };
+}
+
+promise agent MyPromiseType
+{
+  path => "/bin/true";
+  interpreter => "/bin/bash";
+}