aboutsummaryrefslogtreecommitdiff
path: root/containers/check-dco/check-dco.py
blob: 402b8e03feb5e62869a0cc0a985679e27622ab27 (plain)
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
#!/usr/bin/env python3
#
# check-dco.py: validate all commits are signed off
#
# Copyright (C) 2020 Red Hat, Inc.
#
# SPDX-License-Identifier: GPL-2.0-or-later

import os
import os.path
import sys
import subprocess

namespace = "libvirt"
if len(sys.argv) >= 2:
    namespace = sys.argv[1]


def get_default_branch(remote):
    info = subprocess.check_output(["git", "remote", "show", remote],
                                   universal_newlines=True)
    head = "HEAD branch: "
    for line in info.split("\n"):
        offset = line.find(head)
        if offset != -1:
            offset += len(head)
            return line[offset:]

    raise Exception("Cannot find default branch")


def get_branch_commits():
    cwd = os.getcwd()
    reponame = os.path.basename(cwd)
    repourl = "https://gitlab.com/%s/%s.git" % (namespace, reponame)

    subprocess.check_call(["git", "remote", "add", "check-dco", repourl])
    try:
        main = get_default_branch("check-dco")
        subprocess.check_call(["git", "fetch", "check-dco", main],
                              stdout=subprocess.DEVNULL,
                              stderr=subprocess.DEVNULL)

        ancestor = subprocess.check_output(["git", "merge-base", "check-dco/" + main, "HEAD"],
                                           universal_newlines=True)
        ancestor = ancestor.strip()

        return (ancestor, "HEAD")
    finally:
        subprocess.check_call(["git", "remote", "rm", "check-dco"])


def get_mergereq_commits():
    return (os.environ["CI_MERGE_REQUEST_DIFF_BASE_SHA"],
            os.environ["CI_MERGE_REQUEST_SOURCE_BRANCH_SHA"])


if os.environ.get("CI_PIPELINE_SOURCE", "") == "merge_request_event":
    ancestor, head = get_mergereq_commits()
else:
    ancestor, head = get_branch_commits()

errors = False

print("\nChecking for 'Signed-off-by: NAME <EMAIL>' on all commits since %s...\n" % ancestor)

log = subprocess.check_output(["git", "log", "--format=%H %s", ancestor + "..." + head],
                              universal_newlines=True)

if log == "":
    commits = []
else:
    commits = [[c[0:40], c[41:]] for c in log.strip().split("\n")]

for sha, subject in commits:

    msg = subprocess.check_output(["git", "show", "-s", sha],
                                  universal_newlines=True)
    lines = msg.strip().split("\n")

    print("🔍 %s %s" % (sha, subject))
    sob = False
    for line in lines:
        if "Signed-off-by:" in line:
            sob = True
            if "localhost" in line:
                print("    ❌ FAIL: bad email in %s" % line)
                errors = True

    if not sob:
        print("    ❌ FAIL missing Signed-off-by tag")
        errors = True

if errors:
    print("""

❌ ERROR: One or more commits are missing a valid Signed-off-By tag.


This project requires all contributors to assert that their contributions
are provided in compliance with the terms of the Developer's Certificate
of Origin 1.1 (DCO):

  https://developercertificate.org/

To indicate acceptance of the DCO every commit must have a tag

  Signed-off-by: REAL NAME <EMAIL>

This can be achieved by passing the "-s" flag to the "git commit" command.

To bulk update all commits on current branch "git rebase" can be used:

  git rebase -i master -x 'git commit --amend --no-edit -s'

""")

    sys.exit(1)

sys.exit(0)