[CI] Run pylint as part of Jenkins pipelines (18.04)

The pipeline is failed only when pylint whines about the code actually
touched as part of the pull request.

Ubuntu 16.04 pipelines are not enabled, since they are affected by this
bug, since fixed: https://github.com/PyCQA/pylint/issues/1216.

The `run-pylint` script is provided so it can be reused, maybe in
`.git/hooks/pre-push`.

.ci/prfilter

@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+
+import collections
+import json
+import subprocess
+import sys
+
+DEFAULT_REF = 'origin/master'
+
+def get_diff_ranges(ref=DEFAULT_REF):
+    '''Get chunks affected by a merge request
+
+    Args:
+        ref (str): a reference to diff the HEAD against (default: origin/master)
+
+    Returns:
+        dict: a dict with filenames in keys and list of `(start, end)` ranges in
+            values (start is inclusive, end is not, wrt :py:func:`range`)
+    '''
+    files = collections.defaultdict(list)
+    data = subprocess.check_output(['git', 'diff', '-U0', ref, 'HEAD']).decode()
+    path = None
+
+    for line in data.split('\n'):
+        if line.startswith('+++ '):
+            path = (None if line == '+++ /dev/null'
+                else line.split('/', maxsplit=1)[-1])
+            continue
+        if line.startswith('@@ '):
+            # @@ -8,0 +9 @@ [class name or previous line or whatever]
+            if path is None: # /dev/null
+                continue
+            _, _, plus, *_ = line.split()
+            start, length, *_ = *(int(i) for i in plus[1:].split(',')), 1
+            if not length:
+                # remove-only chunk
+                continue
+            files[path].append((start, start + length))
+
+    return files
+
+class Diff:
+    '''A quick and dirty diff evaluator
+
+    >>> diff = Diff()
+    >>> (message['file'], message['line']) in diff
+    True # or False
+
+    The default diff is to the ``origin/master`` ref.
+    '''
+
+    def __init__(self, ref=DEFAULT_REF):
+        self._files = get_diff_ranges(ref)
+
+    def __contains__(self, pathline):
+        path, line = pathline
+        try:
+            return any(start <= line < end for start, end in self._files[path])
+        except KeyError:
+            return False
+
+def main():
+    diff = Diff()
+    with sys.stdin:
+        pylint = json.load(sys.stdin)
+
+    ret = 0
+    for message in pylint:
+        # shellcheck
+        if 'path' not in message:
+            message['path'] = message['file']
+        if 'symbol' not in message:
+            message['symbol'] = message['code']
+
+        if (message['path'], message['line']) in diff:
+            if not ret:
+                print('MESSAGES AFFECTING THIS PR:')
+            print('{path} +{line}:{column}: {symbol}: {message}'.format(
+                **message))
+            ret += 1
+
+    return min(ret, 255)
+
+if __name__ == '__main__':
+    sys.exit(main())

.ci/run-pylint

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+cd "$(git rev-parse --show-toplevel)"
+
+find . -name \*.py \
+    -and -not -path ./LibOS/shim/test/apps/ltp/src/\* \
+| sed 's/./\\&/g' \
+| xargs pylint3 "$@" \
+    Pal/src/host/Linux-SGX/signer/pal-sgx-get-token \
+    Pal/src/host/Linux-SGX/signer/pal-sgx-sign \
+    Tools/gen_manifest \
+    Tools/gsce \
+    .ci/prfilter

.pylintrc

@@ -0,0 +1,480 @@
+[MASTER]
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code.
+extension-pkg-whitelist=
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=CVS
+
+# Add files or directories matching the regex patterns to the blacklist. The
+# regex matches against base names, not paths.
+ignore-patterns=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
+# number of processors available to use.
+jobs=0
+
+# Control the amount of potential inferred values when inferring a single
+# object. This can help the performance when dealing with large functions or
+# complex, nested conditions.
+limit-inference-results=100
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# Specify a configuration file.
+#rcfile=
+
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages.
+suggestion-mode=yes
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
+confidence=
+
+enable=*
+disable=
+    bad-continuation,
+    missing-docstring,
+
+
+[REPORTS]
+
+# Python expression which should return a note less than 10 (10 is the highest
+# note). You have access to the variables errors warning, statement which
+# respectively contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation report
+# (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details.
+#msg-template=
+
+# Set the output format. Available formats are text, parseable, colorized, json
+# and msvs (visual studio). You can also give a reporter class, e.g.
+# mypackage.mymodule.MyReporterClass.
+output-format=colorized
+
+# Tells whether to display a full report or only the messages.
+reports=yes
+
+# Activate the evaluation score.
+score=no
+
+
+[REFACTORING]
+
+# Maximum number of nested blocks for function / method body
+max-nested-blocks=5
+
+# Complete name of functions that never returns. When checking for
+# inconsistent-return-statements if a never returning function is called then
+# it will be considered as an explicit return statement and no message will be
+# printed.
+never-returning-functions=sys.exit
+
+
+[SIMILARITIES]
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# Tells whether to warn about missing members when the owner of the attribute
+# is inferred to be None.
+ignore-none=yes
+
+# This flag controls whether pylint should warn about no-member and similar
+# checks whenever an opaque object is returned when inferring. The inference
+# can return multiple potential results while evaluating a Python object, but
+# some branches might not be evaluated, which results in partial inference. In
+# that case, it might be useful to still emit no-member and other checks for
+# the rest of the inferred objects.
+ignore-on-opaque-inference=yes
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local
+
+# List of module names for which member attributes should not be checked
+# (useful for modules/projects where namespaces are manipulated during runtime
+# and thus existing member attributes cannot be deduced by static analysis. It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# Show a hint with possible names when a member name was not found. The aspect
+# of finding the hint is based on edit distance.
+missing-member-hint=yes
+
+# The minimum edit distance a name should have in order to be considered a
+# similar match for a missing member name.
+missing-member-hint-distance=1
+
+# The total number of similar names that should be taken in consideration when
+# showing a hint for a missing member.
+missing-member-max-choices=1
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=
+    FIXME,
+    XXX,
+    TODO,
+    BUG,
+
+[LOGGING]
+
+# Format style used to check logging format string. `old` means using %
+# formatting, while `new` is for `{}` formatting.
+logging-format-style=old
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format.
+logging-modules=logging
+
+
+[SPELLING]
+
+# Limits count of emitted suggestions for spelling mistakes.
+max-spelling-suggestions=4
+
+# Spelling dictionary name. Available dictionaries: none. To make it working
+# install python-enchant package..
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to indicated private dictionary in
+# --spelling-private-dict-file option instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[FORMAT]
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=LF
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=^\s*(# )?<?https?://\S+>?$
+
+# Number of spaces of indent required inside a hanging or continued line.
+indent-after-paren=4
+
+# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+# Maximum number of characters on a single line.
+max-line-length=100
+
+# Maximum number of lines in a module.
+max-module-lines=1000
+
+# List of optional constructs for which whitespace checking is disabled. `dict-
+# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
+# `trailing-comma` allows a space between comma and closing bracket: (a, ).
+# `empty-line` allows space-only lines.
+no-space-check=
+    trailing-comma,
+    dict-separator
+
+# Allow the body of a class to be on the same line as the declaration if body
+# contains single statement.
+single-line-class-stmt=no
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=no
+
+
+[BASIC]
+
+# Naming style matching correct argument names.
+argument-naming-style=snake_case
+
+# Regular expression matching correct argument names. Overrides argument-
+# naming-style.
+#argument-rgx=
+
+# Naming style matching correct attribute names.
+attr-naming-style=snake_case
+
+# Regular expression matching correct attribute names. Overrides attr-naming-
+# style.
+#attr-rgx=
+
+# Bad variable names which should always be refused, separated by a comma.
+bad-names=
+    foo,
+    bar,
+    baz,
+    toto,
+    tutu,
+    tata,
+    spam,
+    eggs,
+
+# Naming style matching correct class attribute names.
+class-attribute-naming-style=any
+
+# Regular expression matching correct class attribute names. Overrides class-
+# attribute-naming-style.
+#class-attribute-rgx=
+
+# Naming style matching correct class names.
+class-naming-style=PascalCase
+
+# Regular expression matching correct class names. Overrides class-naming-
+# style.
+#class-rgx=
+
+# Naming style matching correct constant names.
+const-naming-style=UPPER_CASE
+
+# Regular expression matching correct constant names. Overrides const-naming-
+# style.
+#const-rgx=
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+# Naming style matching correct function names.
+function-naming-style=snake_case
+
+# Regular expression matching correct function names. Overrides function-
+# naming-style.
+#function-rgx=
+
+# Good variable names which should always be accepted, separated by a comma.
+good-names=
+    i,
+    j,
+    k,
+    ex,
+    Run,
+    _
+
+# Include a hint for the correct naming format with invalid-name.
+include-naming-hint=no
+
+# Naming style matching correct inline iteration names.
+inlinevar-naming-style=any
+
+# Regular expression matching correct inline iteration names. Overrides
+# inlinevar-naming-style.
+#inlinevar-rgx=
+
+# Naming style matching correct method names.
+method-naming-style=snake_case
+
+# Regular expression matching correct method names. Overrides method-naming-
+# style.
+#method-rgx=
+
+# Naming style matching correct module names.
+module-naming-style=snake_case
+
+# Regular expression matching correct module names. Overrides module-naming-
+# style.
+#module-rgx=
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=^_
+
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+# These decorators are taken in consideration only for invalid-name.
+property-classes=abc.abstractproperty
+
+# Naming style matching correct variable names.
+variable-naming-style=snake_case
+
+# Regular expression matching correct variable names. Overrides variable-
+# naming-style.
+#variable-rgx=
+
+
+[VARIABLES]
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid defining new builtins when possible.
+additional-builtins=
+
+# Tells whether unused global variables should be treated as a violation.
+allow-global-unused-variables=yes
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=
+    cb_,
+    _cb
+
+# A regular expression matching the name of dummy variables (i.e. expected to
+# not be used).
+dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore.
+ignored-argument-names=_.*|^ignored_|^unused_
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
+
+
+[IMPORTS]
+
+# Allow wildcard imports from modules that define __all__.
+allow-wildcard-with-all=no
+
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
+
+# Deprecated modules which should not be used, separated by a comma.
+deprecated-modules=optparse,tkinter.tix
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled).
+ext-import-graph=
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled).
+import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled).
+int-import-graph=
+
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
+
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant
+
+
+[CLASSES]
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=
+    __init__,
+    __new__,
+    setUp
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=
+    _asdict,
+    _fields,
+    _replace,
+    _source,
+    _make
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=cls
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method.
+max-args=5
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Maximum number of boolean expressions in an if statement.
+max-bool-expr=5
+
+# Maximum number of branch for function / method body.
+max-branches=12
+
+# Maximum number of locals for function / method body.
+max-locals=15
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+# Maximum number of return / yield for function / method body.
+max-returns=6
+
+# Maximum number of statements in function / method body.
+max-statements=50
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception".
+overgeneral-exceptions=Exception

Jenkinsfiles/Linux-18.04

@@ -3,6 +3,14 @@ pipeline {
               dockerfile { filename 'Jenkinsfiles/ubuntu-18.04.dockerfile' }
         }
         stages {
+                stage('Lint') {
+                    steps {
+                        sh '''
+                            ./.ci/run-pylint -f text || :
+                            ./.ci/run-pylint -f json | ./.ci/prfilter
+                        '''
+                    }
+                }
                 stage('Build') {
                     steps {
                         sh '''

Jenkinsfiles/Linux-Debug-18.04

@@ -3,6 +3,14 @@ pipeline {
               dockerfile { filename 'Jenkinsfiles/ubuntu-18.04.dockerfile' }
         }
         stages {
+                stage('Lint') {
+                    steps {
+                        sh '''
+                            ./.ci/run-pylint -f text || :
+                            ./.ci/run-pylint -f json | ./.ci/prfilter
+                        '''
+                    }
+                }
                 stage('Build') {
                     steps {
                         sh '''

Jenkinsfiles/Linux-SGX-18.04

@@ -6,6 +6,14 @@ pipeline {
                        }
         }
         stages {
+                stage('Lint') {
+                    steps {
+                        sh '''
+                            ./.ci/run-pylint -f text || :
+                            ./.ci/run-pylint -f json | ./.ci/prfilter
+                        '''
+                    }
+                }
                 stage('Build') {
                     steps {
                         sh '''

Jenkinsfiles/ubuntu-18.04.dockerfile

@@ -26,6 +26,7 @@ RUN apt-get update && env DEBIAN_FRONTEND=noninteractive apt-get install -y \
     linux-headers-4.15.0-20-generic \
     net-tools \
     protobuf-c-compiler \
+    pylint3 \
     python \
     python3-apport \
     python3-apt \