Actionlint 项目中发现 pyflakes 语法错误处理问题

在 GitHub Actions 工作流静态分析工具 Actionlint 中，我们发现了一个关于 Python 脚本语法错误处理的缺陷。当用户在 run: 步骤中使用 Python 脚本并包含语法错误时，Actionlint 未能正确报告问题，而是抛出了内部错误。

问题背景

Actionlint 是一个用于静态分析 GitHub Actions 工作流的工具，它可以检查工作流文件中的各种问题，包括脚本语法错误。对于 Python 脚本，Actionlint 通过调用 pyflakes 工具来进行检查。

正常情况下，当 Python 脚本存在逻辑问题时，pyflakes 会将错误信息输出到标准输出(stdout)。然而，当遇到语法错误时，pyflakes 的行为有所不同——它会将错误信息输出到标准错误(stderr)，并且错误信息可能包含多行内容。

问题表现

当工作流中包含如下代码时：

on: push
jobs:
  step-level:
    runs-on: ubuntu-latest
    steps:
      - run: print(
        shell: python

Actionlint 本应报告类似以下的友好错误信息：

test.yaml:6:9: pyflakes reported issue in this script: 1:7: unexpected EOF while parsing [pyflakes]
   |
10 |       - run: print(
   |         ^~~~

但实际上却抛出了内部错误：

`/path/to/pyflakes` did not run successfully while checking script at line:6,col:9: /path/to/pyflakes.exe exited with status 1 but stdout was empty. stderr: "<stdin>:1:7: unexpected EOF while parsing\r\nprint(\r\n      ^\r\n"

技术分析

这个问题的根源在于 Actionlint 对 pyflakes 输出的处理假设不全面：

1. 输出通道假设：Actionlint 假设 pyflakes 的所有输出都会发送到 stdout，但实际上语法错误会发送到 stderr
2. 输出格式假设：Actionlint 假设 pyflakes 的错误信息都是单行的，但实际上语法错误信息可能包含多行内容
3. 错误分类假设：Actionlint 没有区分 pyflakes 的逻辑错误和语法错误，导致对语法错误的处理不当

解决方案

要解决这个问题，需要对 Actionlint 的 pyflakes 输出处理逻辑进行以下改进：

1. 同时检查 stdout 和 stderr 的输出
2. 支持解析多行错误信息
3. 统一处理 pyflakes 的各种错误类型，提供一致的用户体验

这种改进不仅修复了当前的问题，还增强了工具的健壮性，能够更好地处理各种边缘情况。

对用户的影响

修复后，用户将获得以下好处：

1. 更清晰的错误信息：语法错误会像其他错误一样被清晰地展示出来
2. 更一致的体验：无论是什么类型的 Python 错误，都会以相同的方式呈现
3. 更少的干扰：不会再看到工具内部的错误信息，只看到真正需要关注的脚本问题

总结

这个案例展示了静态分析工具在处理外部工具输出时需要特别注意的边界情况。作为工具开发者，我们需要全面考虑各种可能的输出形式，而不仅仅是"快乐路径"。对于 Actionlint 这样的工具来说，正确处理各种错误情况对于提供良好的用户体验至关重要。

通过这次修复，Actionlint 在 Python 脚本检查方面的能力得到了提升，能够更好地服务于需要在 GitHub Actions 中使用 Python 的开发团队。