##############################################################################
"""Script to check a git repository for commits missing DCO."""
-import subprocess
import sys
import click
+from lftools.shell import dco as dco_checker
+
@click.group()
@click.pass_context
"""
if not repo_path:
repo_path = "."
- status = subprocess.call(['dco', 'check', repo_path])
+ status = dco_checker.check(repo_path)
sys.exit(status)
@click.argument('repo-path', required=False)
@click.pass_context
def match(ctx, repo_path):
- """Check repository for commits whose DCO does not match the commit author's email.
+ """Check for commits whose DCO does not match the commit author's email.
This check will exclude merge commits and empty commits.
It operates in your current working directory which has to
"""
if not repo_path:
repo_path = "."
- status = subprocess.call(['dco', 'match', repo_path])
+ status = dco_checker.match(repo_path)
sys.exit(status)
--- /dev/null
+# -*- code: utf-8 -*-
+# SPDX-License-Identifier: EPL-1.0
+##############################################################################
+# Copyright (c) 2019 The Linux Foundation and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+##############################################################################
+"""Placeholder docstring for PyDocStyleBear."""
--- /dev/null
+# -*- code: utf-8 -*-
+# SPDX-License-Identifier: EPL-1.0
+##############################################################################
+# Copyright (c) 2019 The Linux Foundation and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+##############################################################################
+"""Functions for DCO check tasks."""
+
+import logging
+from os import chdir
+from os import getcwd
+import re
+import subprocess # nosec
+
+log = logging.getLogger(__name__)
+
+
+def get_branches(path=getcwd(), invert=False):
+ """Get a list of branches."""
+ if invert:
+ invert = '--invert-grep'
+ else:
+ invert = ''
+ chdir(path)
+ try:
+ branches = subprocess.check_output( # nosec
+ "git branch -r | grep -v origin/HEAD", shell=True)\
+ .decode(encoding="UTF-8") \
+ .splitlines()
+ hashlist = []
+ for branch in branches:
+ branch = branch.strip()
+ hashes = subprocess.check_output( # nosec
+ 'git log {} --no-merges --pretty="%H %ae" --grep "Signed-off-by" {}' # noqa
+ .format(branch, invert), shell=True)\
+ .decode(encoding="UTF-8")\
+ .split('\n')
+ hashlist = hashlist + hashes
+ if hashlist:
+ # remove a trailing blank list entry
+ hashlist.pop()
+ return hashlist
+ else:
+ return False
+ except subprocess.CalledProcessError as e:
+ log.error(e)
+ exit(1)
+
+
+def check(path=getcwd()):
+ """Check repository for commits missing DCO."""
+ chdir(path)
+ try:
+ hashes = get_branches(path, invert=True)
+ if not hashes:
+ exit(0)
+ else:
+ missing = []
+ for commit in hashes:
+ if commit:
+ missing.append(commit.split(' ')[0])
+
+ if missing:
+ # de-dupe the commit list
+ missing_list = list(dict.fromkeys(missing))
+ for commit in missing_list:
+ log.info("{}".format(commit))
+ exit(1)
+ except subprocess.CalledProcessError as e:
+ log.error(e)
+ exit(1)
+
+
+def match(path=getcwd()):
+ """Check for commits where DCO does not match the commit author's email."""
+ chdir(path)
+ try:
+ hashes = get_branches(path)
+ exit_code = 0
+ if not hashes:
+ exit(exit_code)
+ else:
+ for commit in hashes:
+ commit_id = commit.split(' ')[0]
+ if commit_id:
+ commit_log_message = subprocess.check_output( # nosec
+ "git log --format=%B -n 1 {}"
+ .format(commit_id), shell=True)\
+ .decode(encoding="UTF-8")
+ commit_author_email = subprocess.check_output( # nosec
+ "git log --format='%ae' {}^!"
+ .format(commit_id), shell=True)\
+ .decode(encoding="UTF-8").strip()
+ sob_email_regex = '(?=Signed\-off\-by: )*[\<](.*)[\>]' # noqa
+ sob_results = re.findall(sob_email_regex,
+ commit_log_message)
+
+ if commit_author_email in sob_results:
+ continue
+ else:
+ log.info("For commit ID {}: \n\tCommitter is {}"
+ "\n\tbut commit is signed off by {}\n"
+ .format(commit_id,
+ commit_author_email,
+ sob_results))
+ exit_code = 1
+ exit(exit_code)
+ except subprocess.CalledProcessError as e:
+ log.error(e)
+ exit(1)
[files]
packages = lftools
scripts =
- shell/dco
shell/deploy
shell/gerrit_create
shell/inactivecommitters
+++ /dev/null
-#!/bin/bash
-# SPDX-License-Identifier: EPL-1.0
-##############################################################################
-# Copyright (c) 2018 The Linux Foundation and others.
-#
-# All rights reserved. This program and the accompanying materials
-# are made available under the terms of the Eclipse Public License v1.0
-# which accompanies this distribution, and is available at
-# http://www.eclipse.org/legal/epl-v10.html
-##############################################################################
-
-# This script determines if a git repo contains commits missing DCO.
-# It operates in your current working directory which must be a git repo.
-# Alternatively you can pass it a path to a git repo.
-
-function dcocheck {
- REPO_PATH="$1"
- cd "$REPO_PATH" || exit 1
-
- status=0
- while IFS= read -r -a line; do
- # shellcheck disable=SC2128
- my_array+=( "$line" )
- done < <( git branch -r | grep -v origin/HEAD )
- for branch in "${my_array[@]}"
- do
- status=1
- branch=$(echo "$branch" | xargs)
- echo "Checking commits in branch $branch for commits missing DCO..."
- git log "$branch" --no-merges --pretty="%H %ae" --grep 'Signed-off-by' --invert-grep -- | \
- while read -r results; do
- commit_hash="$(echo "$results" | cut -d' ' -f1)"
- >&2 echo "$commit_hash is missing Signed-off-by line."
- done
- done
- exit $status
-}
-
-function dcomatch {
- REPO_PATH="$1"
- cd "$REPO_PATH" || exit 1
-
- status=0
- while IFS= read -r -a line; do
- # shellcheck disable=SC2128
- my_array+=( "$line" )
- done < <( git branch -r | grep -v origin/HEAD )
- for branch in "${my_array[@]}"
- do
- status=1
- branch=$(echo "$branch" | xargs)
- git log "$branch" --no-merges --pretty="%H %ae" --grep 'Signed-off-by' -- | \
- while read -r results; do
- commit_hash="$(echo "$results" | cut -d' ' -f1)"
- author_email="$(echo "$results" | cut -d' ' -f2)"
- sob="$(git show --quiet "$commit_hash" | grep -oP '(?=Signed\-off\-by: )[\s\S]*[\<](.*)[\>]')"
- if [[ "$sob" != *"$author_email"* ]] ; then
- >&2 echo "$commit_hash author is $author_email and DCO is $sob"
- if [ "$sob" = "" ] ; then
- >&2 echo "NOTE: If DCO is empty, then the commit is likely signed with a name but no email address"
- fi
- fi
- done
- done
- exit $status
-}
-
-case "$1" in
- match) dcomatch "$2" ;;
- check) dcocheck "$2" ;;
-esac
Code Review / releng / lftools.git / commitdiff