检查为 git commit 暂存的任何文件是否与白名单不匹配

Question

由于自动提交和推送的脚本存在一些问题，我想实现一个白名单。

计划是，只允许在路径中使用模式 'foo' 和 'bar' 提交。

#!/bin/sh

WHITELIST="foo bar"
WRKDIR=/home/athur/workwork/test/repo


cd $WRKDIR
git add -A

for file in `git diff --cached -p --name-status | cut -c3-`; do
  if [[ "$file" == *"$WHITELIST"* ]] ; then
    echo "$file is on whitelist"
  else
    echo "$file is not on whitelist. Commit aborted."
    exit 1
  fi
done

问题是，它总是使用“else”子句。 我找不到问题。谢谢

Answer 1

作为最佳实践方法，请考虑：

#!/usr/bin/env bash
#              ^^^^ important: [[ ]] is not guaranteed to work with bin/sh

whitelist_re='(foo|bar)'
workdir=/home/athur/workwork/test/repo

cd -- "$workdir" || exit
git add -A

while IFS= read -r filename; do
  if [[ $file =~ $whitelist ]]; then
    echo "$file is on whitelist" >&2
  else
    echo "$file is not on whitelist; commit aborted." >&2
    exit 1
  fi
done < <(git diff --cached --name-only)

浏览更改：

• shebang 将bash 指定为外壳，这保证了[[ ]] 和<(...) 等扩展可用——/bin/sh 没有保证。
• 使用while read 循环而不是尝试使用for 迭代面向行的数据；请参阅 DontReadLinesWithFor 了解此更改背后的原因。
• 白名单被指定为符合 ERE 的正则表达式，这样=~ 可用于测试值是否匹配。
• 我们不是使用git diff --cached --name-status，然后使用cut 删除事后状态数据，而是使用--name-only 首先只生成名称。
• 使用小写的变量名符合http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html 中给出的约定，指定POSIX 定义的工具将使用全大写的shell 和环境变量名用于它们自己的目的，并且具有至少一个小写字符的名称保留用于应用程序使用。 （请记住，设置 shell 变量会覆盖任何同名环境变量，因此即使export 未使用，这些约定也适用。

---

顺便说一句，如果你只是想知道是否存在任何不匹配的文件，而不知道那些文件是什么，你可以使用：

#!/bin/sh
#      ^^ actually safe here, as no non-POSIX functionality is used

whitelist_re='foo|bar'

if git diff --cached --name-only | grep -qEv "$whitelist_re"; then
  echo "At least one file is not on whitelist; commit aborted" >&2
  exit 1
fi

Answer 2

使用显式列表

== 在这种情况下不是对称的，** 似乎使用不当。

试试"$WHITELIST" == *"$file"*。

（灵感来自How do I check if a variable exists in a list in BASH）

请注意，使用您的 WHITELIST，只有文件 foo 和 bar 会被列入白名单。

检测模式

如果需要检测单个模式，可能需要构造一个函数，例如：

for entry in $WHITELIST ; do 
  if [[ "$file" =~ $entry ]] ; then
    return 0
  fi
done
return 1