feat: add linting (#11)

* feat: add linting

* test: add test w/ more than one recipe

* test: missed some changes

Author: beckermr

.github/workflows/tests.yml

@@ -65,6 +65,8 @@ jobs:
       - name: run tests
         run: |
           pytest -vvs tests
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: ensure cli runs
         run: |

conda_forge_feedstock_ops/__main__.py

@@ -259,6 +259,31 @@ def _parse_package_and_feedstock_names():
         }
 
 
+def _lint():
+    from conda_forge_feedstock_ops.lint import lint
+    from conda_forge_feedstock_ops.os_utils import sync_dirs
+
+    logger = logging.getLogger("conda_forge_feedstock_ops.container")
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+        input_fs_dir = "/cf_feedstock_ops_dir"
+        logger.debug(
+            "input container feedstock dir %s: %s",
+            input_fs_dir,
+            os.listdir(input_fs_dir),
+        )
+
+        fs_dir = os.path.join(tmpdir, os.path.basename(input_fs_dir))
+        sync_dirs(input_fs_dir, fs_dir, ignore_dot_git=True, update_git=False)
+        logger.debug(
+            "copied container feedstock dir %s: %s", fs_dir, os.listdir(fs_dir)
+        )
+
+        lints, hints = lint(fs_dir, use_container=False)
+
+        return {"lints": lints, "hints": hints}
+
+
 @click.group()
 def main_container():
     pass
@@ -284,3 +309,13 @@ def main_parse_package_and_feedstock_names(log_level):
         log_level=log_level,
         existing_feedstock_node_attrs=None,
     )
+
+
+@main_container.command(name="lint")
+@log_level_option
+def main_lint(log_level):
+    return _run_bot_task(
+        _lint,
+        log_level=log_level,
+        existing_feedstock_node_attrs=None,
+    )

conda_forge_feedstock_ops/container_utils.py

@@ -103,6 +103,7 @@ def run_container_operation(
     input: Optional[str] = None,
     mount_dir: Optional[str] = None,
     mount_readonly: bool = True,
+    extra_container_args: Optional[Iterable[str]] = None,
 ):
     """Run a feedstock operation in a container.
 
@@ -120,6 +121,8 @@ def run_container_operation(
         The directory to mount to the container at `/cf_feedstock_ops_dir`, by default None.
     mount_readonly
         Whether to mount the directory as read-only, by default True.
+    extra_container_args
+        Extra arguments to pass to the container, by default None.
 
     Returns
     -------
@@ -137,9 +140,12 @@ def run_container_operation(
     else:
         mnt_args = []
 
+    extra_container_args = extra_container_args or []
+
     cmd = [
         *get_default_container_run_args(tmpfs_size_mb=tmpfs_size_mb),
         *mnt_args,
+        *extra_container_args,
         get_default_container_name(),
         *args,
     ]

conda_forge_feedstock_ops/lint.py

@@ -0,0 +1,121 @@
+import logging
+import os
+import shutil
+import tempfile
+from collections import defaultdict
+from pathlib import Path
+
+import conda_smithy.lint_recipe
+
+from conda_forge_feedstock_ops.container_utils import (
+    get_default_log_level_args,
+    run_container_operation,
+    should_use_container,
+)
+from conda_forge_feedstock_ops.json import loads
+from conda_forge_feedstock_ops.os_utils import chmod_plus_rwX, sync_dirs
+
+logger = logging.getLogger(__name__)
+
+
+def lint(feedstock_dir, use_container=None):
+    """Lint all of the recipes in a feedstock.
+
+    **WARNING: This function will inject the GH_TOKEN env var into
+    the container in order to run conda-forge-specific linting.
+    Make sure that token is read-only.**
+
+    Parameters
+    ----------
+    feedstock_dir : str
+        The path to the feedstock directory.
+    use_container
+        Whether to use a container to run the parse.
+        If None, the function will use a container if the environment
+        variable `CF_FEEDSTOCK_OPS_IN_CONTAINER` is 'false'. This feature can be
+        used to avoid container in container calls.
+
+    Returns
+    -------
+    lints : dict
+        Dictionary mapping relative recipe path to its lints.
+    hints : dict
+        Dictionary mapping relative recipe path to its hints.
+    """
+    if should_use_container(use_container=use_container):
+        return _lint_containerized(feedstock_dir)
+    else:
+        return _lint_local(feedstock_dir)
+
+
+def _lint_containerized(feedstock_dir):
+    args = [
+        "conda-forge-feedstock-ops-container",
+        "lint",
+    ] + get_default_log_level_args(logger)
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+        sync_dirs(feedstock_dir, tmpdir, ignore_dot_git=True, update_git=False)
+        chmod_plus_rwX(tmpdir, recursive=True)
+
+        logger.debug(
+            "host feedstock dir %s: %r",
+            feedstock_dir,
+            os.listdir(feedstock_dir),
+        )
+        logger.debug(
+            "copied host feedstock dir %s: %r",
+            tmpdir,
+            os.listdir(tmpdir),
+        )
+
+        data = run_container_operation(
+            args,
+            mount_readonly=True,
+            mount_dir=tmpdir,
+            json_loads=loads,
+            extra_container_args=["-e", "GH_TOKEN"],
+        )
+
+        # When tempfile removes tempdir, it tries to reset permissions on subdirs.
+        # This causes a permission error since the subdirs were made by the user
+        # in the container. So we remove the subdir we made before cleaning up.
+        shutil.rmtree(tmpdir)
+
+    return data["lints"], data["hints"]
+
+
+#############################################################
+# This code is from conda-forge-webservices w/ modifications
+
+
+def _find_recipes(path: Path) -> list[Path]:
+    """Returns all `meta.yaml` and `recipe.yaml` files in the given path."""
+    meta_yamls = path.rglob("meta.yaml")
+    recipe_yamls = path.rglob("recipe.yaml")
+
+    return sorted(set([x for x in (list(meta_yamls) + list(recipe_yamls))]))
+
+
+def _lint_local(feedstock_dir):
+    recipes = _find_recipes(Path(feedstock_dir))
+
+    lints = defaultdict(list)
+    hints = defaultdict(list)
+
+    for recipe in recipes:
+        recipe_dir = recipe.parent
+        rel_path = str(recipe.relative_to(feedstock_dir))
+
+        _lints, _hints = conda_smithy.lint_recipe.main(
+            str(recipe_dir), conda_forge=True, return_hints=True
+        )
+
+        lints[rel_path] = _lints
+        hints[rel_path] = _hints
+
+    return dict(lints), dict(hints)
+
+
+# end of code from conda-forge-webservices w/ modifications
+#############################################################

tests/conftest.py

@@ -42,6 +42,10 @@
     not (HAVE_CONTAINERS and HAVE_TEST_IMAGE), reason="containers not available"
 )
 
+skipif_no_github_token = pytest.mark.skipif(
+    "GH_TOKEN" not in os.environ, reason="no GH_TOKEN in environment"
+)
+
 
 @pytest.fixture(autouse=True, scope="session")
 def set_cf_feedstock_ops_container_tag_to_test():