(conan-io#11162) [linter] Transform ConanFile class to match actual…

… one

* [linter] Add member validation

* linter - transform ConanFile to match actual class

* install matching conan version

* add more dynamics

* no settings

* these are failing

* mock settings

* user_info_build

* add fatals to matcher (conan-io#11)

* increase threshold

* touch

Co-authored-by: ericLemanissier <ericLemanissier@users.noreply.github.com>

.github/workflows/linter-conan-v2.yml

@@ -6,7 +6,7 @@ on:
 env:
   PYTHONPATH: ${{github.workspace}}
   PYVER: "3.8"
-  SCORE_THRESHOLD: "9.0"
+  SCORE_THRESHOLD: "9.5"
   REQUIREMENTS: "pylint==2.14"
 
 jobs:
@@ -23,14 +23,20 @@ jobs:
         with:
           files: |
             linter/**
+      - name: Get Conan v1 version
+        id: parse_conan_v1_version
+        if: steps.changed_files.outputs.any_changed == 'true'
+        uses: mikefarah/yq@master
+        with:
+          cmd: yq '.conan.version' '.c3i/c3i.yml'
       - uses: actions/setup-python@v3
         if: steps.changed_files.outputs.any_changed == 'true'
         with:
           python-version: ${{ env.PYVER }}
       - name: Install requirements
         if: steps.changed_files.outputs.any_changed == 'true'
         run: |
-          pip install ${{ env.REQUIREMENTS }}
+          pip install ${{ env.REQUIREMENTS }} conan==${{ steps.parse_conan_v1_version.outputs.result }}
       - name: Execute linter over all recipes in the repository
         if: steps.changed_files.outputs.any_changed == 'true'
         run: |
@@ -63,14 +69,20 @@ jobs:
         with:
           files: |
             recipes/*/*/conanfile.py
+      - name: Get Conan v1 version
+        id: parse_conan_v1_version
+        if: steps.changed-files.outputs.any_changed == 'true'
+        uses: mikefarah/yq@master
+        with:
+          cmd: yq '.conan.version' '.c3i/c3i.yml'
       - uses: actions/setup-python@v3
         if: steps.changed-files.outputs.any_changed == 'true'
         with:
           python-version: ${{ env.PYVER }}
       - name: Install dependencies
         if: steps.changed-files.outputs.any_changed == 'true'
         run: |
-          pip install ${{ env.REQUIREMENTS }}
+          pip install ${{ env.REQUIREMENTS }} conan==${{ steps.parse_conan_v1_version.outputs.result }}
       - name: Run linter
         if: steps.changed-files.outputs.any_changed == 'true'
         run: |

linter/.pylintrc

@@ -1,12 +1,21 @@
 [MASTER]
-load-plugins=linter.conanv2_transition
+load-plugins=linter.conanv2_transition,
+             linter.conanfile_transform
 py-version=3.6
 recursive=no
 suggestion-mode=yes
 unsafe-load-any-extension=no
 
 [MESSAGES CONTROL]
-disable=all
+disable=fixme,
+        line-too-long,
+        missing-module-docstring,
+        missing-function-docstring,
+        missing-class-docstring,
+        invalid-name,
+        wrong-import-order,  # TODO: Remove
+        import-outside-toplevel  # TODO: Remove
+
 enable=conan-bad-name,
        conan-missing-name
 

linter/conanfile_transform.py

@@ -0,0 +1,74 @@
+
+# Class ConanFile doesn't declare all the valid members and functions,
+#   some are injected by Conan dynamically to the class.
+
+import textwrap
+import astroid
+from astroid.builder import AstroidBuilder
+from astroid.manager import AstroidManager
+
+
+def _settings_transform():
+    module = AstroidBuilder(AstroidManager()).string_build(
+        textwrap.dedent("""
+            class Settings(object):
+                os = None
+                arch = None
+                compiler = None
+                build_type = None
+            """)
+    )
+    return module['Settings']
+
+def _user_info_build_transform():
+    module = AstroidBuilder(AstroidManager()).string_build(
+        textwrap.dedent("""
+            class UserInfoBuild(defaultdict):
+                pass
+            """)
+    )
+    return module['UserInfoBuild']
+
+
+def register(_):
+    pass
+
+def transform_conanfile(node):
+    """Transform definition of ConanFile class so dynamic fields are visible to pylint"""
+
+    str_class = astroid.builtin_lookup("str")
+    dict_class = astroid.builtin_lookup("dict")
+    info_class = astroid.MANAGER.ast_from_module_name("conans.model.info").lookup(
+        "ConanInfo")
+    build_requires_class = astroid.MANAGER.ast_from_module_name(
+        "conans.client.graph.graph_manager").lookup("_RecipeBuildRequires")
+    file_copier_class = astroid.MANAGER.ast_from_module_name(
+        "conans.client.file_copier").lookup("FileCopier")
+    file_importer_class = astroid.MANAGER.ast_from_module_name(
+        "conans.client.importer").lookup("_FileImporter")
+    python_requires_class = astroid.MANAGER.ast_from_module_name(
+        "conans.client.graph.python_requires").lookup("PyRequires")
+
+    dynamic_fields = {
+        "conan_data": str_class,
+        "build_requires": build_requires_class,
+        "tool_requires": build_requires_class,
+        "info_build": info_class,
+        "user_info_build": [_user_info_build_transform()],
+        "info": info_class,
+        "copy": file_copier_class,
+        "copy_deps": file_importer_class,
+        "python_requires": [str_class, python_requires_class],
+        "recipe_folder": str_class,
+        "settings_build": [_settings_transform()],
+        "settings_target": [_settings_transform()],
+        "conf": dict_class,
+    }
+
+    for f, t in dynamic_fields.items():
+        node.locals[f] = [i for i in t]
+
+
+astroid.MANAGER.register_transform(
+    astroid.ClassDef, transform_conanfile,
+    lambda node: node.qname() == "conans.model.conan_file.ConanFile")

linter/recipe_linter.json

@@ -1,5 +1,18 @@
 {
     "problemMatcher": [
+        {
+            "owner": "recipe_linter_fatals",
+            "severity": "error",
+            "pattern": [
+                {
+                    "regexp": "(\\S+):(\\d+): \\[(F\\d+\\(\\S+\\)),\\s(.+?)\\](.+)",
+                    "file": 1,
+                    "line": 2,
+                    "message": 5,
+                    "code": 3
+                }
+            ]
+        },
         {
             "owner": "recipe_linter_errors",
             "severity": "error",