coreutils 0.8.0

coreutils ~ GNU coreutils (updated); implemented as universal (cross-platform) utils, written in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
# spell-checker:ignore pcoreutils
"""Run cargo clippy with appropriate flags and emit GitHub Actions annotations."""

from __future__ import annotations

import argparse
import json
import os
import re
import subprocess
import sys


def run_cmd(
    cmd: list[str],
    *,
    check: bool = False,
) -> subprocess.CompletedProcess[str]:
    """Run a command with UTF-8 encoding (avoids cp1252 issues on Windows)."""
    env = {**os.environ, "PYTHONUTF8": "1"}
    return subprocess.run(
        cmd,
        capture_output=True,
        text=True,
        encoding="utf-8",
        errors="replace",
        check=check,
        env=env,
    )


def get_utility_list(features: str) -> list[str]:
    """Get list of utilities from cargo metadata."""
    if features == "all":
        cmd = ["cargo", "metadata", "--all-features", "--format-version", "1"]
    else:
        cmd = ["cargo", "metadata", "--features", features, "--format-version", "1"]
    result = run_cmd(cmd, check=True)
    metadata = json.loads(result.stdout)
    # Find the coreutils root node and collect uu_ dependencies
    utilities = []
    for node in metadata["resolve"]["nodes"]:
        if re.search(r"coreutils[ @#]\d+\.\d+\.\d+", node["id"]):
            for dep in node["deps"]:
                # The pkg field contains the crate name (uu_<util>),
                # while name is the renamed dependency alias
                pkg = dep["pkg"]
                match = re.search(r"uu_(\w+)[@#]", pkg)
                if match:
                    utilities.append(match.group(1))
            break
    return sorted(utilities)


def build_clippy_command(
    features: str,
    *,
    workspace: bool,
    target: str | None,
) -> list[str]:
    """Build the cargo clippy command line."""
    cmd = ["cargo", "clippy"]

    extra = []
    if features == "all":
        extra.append("--all-features")
    else:
        extra.extend(["--features", features])

    if workspace:
        extra.append("--workspace")

    if target:
        extra.extend(["--no-default-features", "--target", target])
        # For cross-compilation targets, just check -pcoreutils
        # (show-utils.sh over-resolves due to default features)
        extra.append("-pcoreutils")
    else:
        extra.extend(["--all-targets", "--tests", "--benches", "-pcoreutils"])
        utilities = get_utility_list(features)
        extra.extend(f"-puu_{u}" for u in utilities)

    cmd.extend(extra)
    cmd.extend(["--", "-D", "warnings"])
    return cmd


# Pattern to match clippy/rustc errors for GHA annotations
ERROR_PATTERN = re.compile(
    r"^error:\s+(.*)\n\s+-->\s+(.*):(\d+):(\d+)",
    re.MULTILINE,
)


def emit_annotations(output: str, fault_type: str) -> None:
    """Emit GitHub Actions annotations from cargo clippy errors."""
    fault_prefix = fault_type.upper()
    for m in ERROR_PATTERN.finditer(output):
        message, file, line, col = m.groups()
        print(
            f"::{fault_type} file={file},line={line},col={col}"
            f"::{fault_prefix}: `cargo clippy`: {message} (file:'{file}', line:{line})",
        )


def main() -> int:
    """Run cargo clippy and emit GHA annotations on failure."""
    parser = argparse.ArgumentParser(description="Run cargo clippy for CI")
    parser.add_argument("--features", required=True, help="Feature set to use")
    parser.add_argument(
        "--workspace",
        action="store_true",
        help="Include --workspace flag",
    )
    parser.add_argument("--target", default=None, help="Cross-compilation target")
    parser.add_argument(
        "--fault-type",
        default="warning",
        choices=["warning", "error"],
        help="GHA annotation type",
    )
    parser.add_argument(
        "--fail-on-fault",
        action="store_true",
        help="Exit with error code on clippy failures",
    )
    args = parser.parse_args()

    cmd = build_clippy_command(
        args.features,
        workspace=args.workspace,
        target=args.target,
    )
    print(f"Running: {' '.join(cmd)}", file=sys.stderr)

    result = run_cmd(cmd)
    output = result.stdout + result.stderr

    # Always print the full output
    print(output)

    if result.returncode != 0:
        emit_annotations(output, args.fault_type)
        if args.fail_on_fault:
            return 1

    return 0


if __name__ == "__main__":
    sys.exit(main())