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
|
#!/bin/bash
# Copyright: 2017, Loic Esteve
# License: BSD 3 clause
# This script is used in Travis to check that PRs do not add obvious
# flake8 violations. It relies on two things:
# - computing a similar diff to what github is showing in a PR. The
# diff is done between:
# 1. the common ancestor of the local branch and the
# joblib/joblib remote
# 2. the local branch
# - run flake8 --diff on the computed diff
#
# Additional features:
# - the line numbers in Travis match the local branch on the PR
# author machine.
# - bash continuous_integration/azure/flake8_diff.sh can be run
# locally for quick turn-around
set -e
# pipefail is necessary to propagate exit codes
set -o pipefail
PROJECT=joblib/joblib
PROJECT_URL=https://github.com/$PROJECT.git
# Find the remote with the project name (upstream in most cases)
REMOTE=$(git remote -v | grep $PROJECT | cut -f1 | head -1 || echo '')
# Add a temporary remote if needed. For example this is necessary when
# Travis is configured to run in a fork. In this case 'origin' is the
# fork and not the reference repo we want to diff against.
if [[ -z "$REMOTE" ]]; then
TMP_REMOTE=tmp_reference_upstream
REMOTE=$TMP_REMOTE
git remote add $REMOTE $PROJECT_URL
fi
echo "Remotes:"
git remote --verbose
# Travis does the git clone with a limited depth (50 at the time of
# writing). This may not be enough to find the common ancestor with
# $REMOTE/master so we unshallow the git checkout
if [[ -a .git/shallow ]]; then
echo 'Unshallowing the repo.'
git fetch --unshallow
fi
# Try to find the common ancestor between $LOCAL_BRANCH_REF and
# $REMOTE/master
if [[ -z "$LOCAL_BRANCH_REF" ]]; then
LOCAL_BRANCH_REF=$(git rev-parse --abbrev-ref HEAD)
fi
REMOTE_MASTER_REF="$REMOTE/master"
# Make sure that $REMOTE_MASTER_REF is a valid reference
echo -e "Fetching $REMOTE_MASTER_REF"
git fetch $REMOTE master:refs/remotes/$REMOTE_MASTER_REF
LOCAL_BRANCH_SHORT_HASH=$(git rev-parse --short $LOCAL_BRANCH_REF)
REMOTE_MASTER_SHORT_HASH=$(git rev-parse --short $REMOTE_MASTER_REF)
# Very confusing: need to use '..' i.e. two dots for 'git
# rev-list' but '...' i.e. three dots for 'git diff'
DIFF_RANGE="$REMOTE_MASTER_SHORT_HASH...$LOCAL_BRANCH_SHORT_HASH"
REV_RANGE="$REMOTE_MASTER_SHORT_HASH..$LOCAL_BRANCH_SHORT_HASH"
echo -e "Running flake8 on the diff in the range" \
"from $LOCAL_BRANCH_REF to $REMOTE_MASTER_REF ($DIFF_RANGE)\n" \
"$(git rev-list $REV_RANGE | wc -l) commit(s)"
# Remove temporary remote only if it was previously added.
if [[ -n "$TMP_REMOTE" ]]; then
git remote remove $TMP_REMOTE
fi
# We ignore files from doc/sphintext. Unfortunately there is no
# way to do it with flake8 directly (the --exclude does not seem to
# work with --diff). We could use the exclude magic in the git pathspec
# ':!doc/sphintext' but it is only available on git 1.9 and Travis
# uses git 1.8.
# We need the following command to exit with 0 hence the echo in case
# there is no match
MODIFIED_FILES=$(git diff --name-only $DIFF_RANGE | \
grep -v 'doc/sphinxext' || echo "no_match")
if [[ "$MODIFIED_FILES" == "no_match" ]]; then
echo "No file outside doc/sphinxext has been modified"
else
# Conservative approach: diff without context so that code that
# was not changed does not create failures
git diff --unified=0 $DIFF_RANGE -- $MODIFIED_FILES | flake8 --diff --show-source
fi
echo -e "No problem detected by flake8\n"
|
