Make test_target less strict with git

.pylintrc

@@ -11,7 +11,7 @@
 # R0801: Similar lines in files
 # I0011: Informational: locally disabled pylint
 # I0013: Informational: Ignoring entire file
-disable=C0111,W0511,W0142,W0622,W0223,W0212,R0901,R0801,I0011,I0013,anomalous-backslash-in-string
+disable=bad-option-value,C0111,W0511,W0142,W0622,W0223,W0212,R0901,R0801,I0011,I0013,anomalous-backslash-in-string,useless-object-inheritance
 
 [Format]
 max-line-length=120

.travis.yml

@@ -9,43 +9,17 @@ matrix:
       os: linux
     - python: "3.3"
       os: linux
-      script:
-      # Skip integration tests in Travis for Python 3.3, need to look into this
-      # Error example: https://travis-ci.org/jorisroovers/gitlint/jobs/310861373
-        - "./run_tests.sh"
-        - "./run_tests.sh --build"
-        - "./run_tests.sh --pep8"
-        - "./run_tests.sh --lint"
-        - "./run_tests.sh --git"
     - python: "3.4"
       os: linux
-      script:
-      # Skip integration tests in Travis for Python 3.4, need to look into this
-      # Error example: https://travis-ci.org/jorisroovers/gitlint/jobs/310861374
-        - "./run_tests.sh"
-        - "./run_tests.sh --build"
-        - "./run_tests.sh --pep8"
-        - "./run_tests.sh --lint"
-        - "./run_tests.sh --git"
     - python: "3.5"
       os: linux
-      script:
-      # Skip integration tests in Travis for Python 3.5, need to look into this
-      # Error example: https://travis-ci.org/jorisroovers/gitlint/jobs/310861375
-        - "./run_tests.sh"
-        - "./run_tests.sh --build"
-        - "./run_tests.sh --pep8"
-        - "./run_tests.sh --lint"
-        - "./run_tests.sh --git"
     - python: "3.6"
       os: linux
-      script:
-      # Skip lint tests for python 3.6 (see https://github.com/PyCQA/pylint/issues/1072)
-        - "./run_tests.sh"
-        - "./run_tests.sh --integration"
-        - "./run_tests.sh --build"
-        - "./run_tests.sh --pep8"
-        - "./run_tests.sh --git"
+    - python: "3.7"
+      os: linux
+      # See https://github.com/travis-ci/travis-ci/issues/9815
+      dist: xenial
+      sudo: true
     - python: "pypy"
       os: linux
 install:

gitlint/cli.py

@@ -120,7 +120,7 @@ def get_stdin_data():
         input_data = sys.stdin.read()
         # Only return the input data if there's actually something passed
         # i.e. don't consider empty piped data
-        if len(input_data) != 0:
+        if input_data:
             return ustr(input_data)
     return False
 
@@ -295,4 +295,5 @@ def generate_config(ctx):
 # Let's Party!
 setup_logging()
 if __name__ == "__main__":
-    cli()  # pragma: no cover, # pylint: disable=no-value-for-parameter
+    # pylint: disable=no-value-for-parameter
+    cli()  # pragma: no cover

gitlint/git.py

@@ -24,7 +24,7 @@ def _git(*command_parts, **kwargs):
     git_kwargs = {'_tty_out': False}
     git_kwargs.update(kwargs)
     try:
-        result = sh.git(*command_parts, **git_kwargs)
+        result = sh.git(*command_parts, **git_kwargs)  # pylint: disable=unexpected-keyword-arg
         # If we reach this point and the result has an exit_code that is larger than 0, this means that we didn't
         # get an exception (which is the default sh behavior for non-zero exit codes) and so the user is expecting
         # a non-zero exit code -> just return the entire result
@@ -82,7 +82,7 @@ def from_full_message(commit_msg_str):
             cutline_index = None
         lines = [line for line in all_lines[:cutline_index] if not line.startswith(GitCommitMessage.COMMENT_CHAR)]
         full = "\n".join(lines)
-        title = lines[0] if len(lines) > 0 else ""
+        title = lines[0] if lines else ""
         body = lines[1:] if len(lines) > 1 else []
         return GitCommitMessage(original=commit_msg_str, full=full, title=title, body=body)
 

gitlint/lint.py

@@ -1,3 +1,4 @@
+# pylint: disable=logging-not-lazy
 import logging
 from gitlint import rules as gitlint_rules
 from gitlint import display

gitlint/rules.py

@@ -1,3 +1,4 @@
+# pylint: disable=inconsistent-return-statements
 import copy
 import logging
 import re
@@ -262,7 +263,7 @@ def validate(self, commit):
         min_length = self.options['min-length'].value
         body_message_no_newline = "".join([line for line in commit.message.body if line is not None])
         actual_length = len(body_message_no_newline)
-        if actual_length > 0 and actual_length < min_length:
+        if 0 < actual_length < min_length:
             violation_message = "Body message is too short ({0}<{1})".format(actual_length, min_length)
             return [RuleViolation(self.id, violation_message, body_message_no_newline, 3)]
 

gitlint/tests/test_cli.py

@@ -355,8 +355,7 @@ def test_target(self, _):
         # We expect gitlint to tell us that /tmp is not a git repo (this proves that it takes the target parameter
         # into account).
         self.assertEqual(result.exit_code, self.GIT_CONTEXT_ERROR_CODE)
-        expected_path = os.path.realpath("/tmp")
-        self.assertEqual(result.output, "%s is not a git repository.\n" % expected_path)
+        self.assertTrue("not a git repository" in result.output)
 
     def test_target_negative(self):
         """ Negative test for the --target option """

gitlint/user_rules.py

@@ -41,7 +41,7 @@ def find_rule_classes(extra_path):
             modules.append(os.path.splitext(filename)[0])
 
     # No need to continue if there are no modules specified
-    if len(modules) == 0:
+    if not modules:
         return []
 
     # Append the extra rules path to python path so that we can import them
@@ -93,7 +93,7 @@ def assert_valid_rule_class(clazz):
                                        rules.LineRule.__name__, rules.CommitRule.__name__))
 
     # Rules must have an id attribute
-    if not hasattr(clazz, 'id') or clazz.id is None or len(clazz.id) == 0:
+    if not hasattr(clazz, 'id') or clazz.id is None or not clazz.id:
         raise UserRuleError(u"User-defined rule class '{0}' must have an 'id' attribute".format(clazz.__name__))
 
     # Rule id's cannot start with gitlint reserved letters
@@ -102,7 +102,7 @@ def assert_valid_rule_class(clazz):
         raise UserRuleError(msg.format(clazz.__name__, clazz.id[0]))
 
     # Rules must have a name attribute
-    if not hasattr(clazz, 'name') or clazz.name is None or len(clazz.name) == 0:
+    if not hasattr(clazz, 'name') or clazz.name is None or not clazz.name:
         raise UserRuleError(u"User-defined rule class '{0}' must have a 'name' attribute".format(clazz.__name__))
 
     # if set, options_spec must be a list of RuleOption

gitlint/utils.py

@@ -1,4 +1,4 @@
-# pylint: disable=bad-option-value,unidiomatic-typecheck,undefined-variable
+# pylint: disable=bad-option-value,unidiomatic-typecheck,undefined-variable,no-else-return
 import sys
 
 from locale import getpreferredencoding

qa/base.py

@@ -1,14 +1,21 @@
 # -*- coding: utf-8 -*-
-# pylint: disable=bad-option-value,unidiomatic-typecheck,undefined-variable
+# pylint: disable=bad-option-value,unidiomatic-typecheck,undefined-variable,no-else-return,
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
 
 import os
 import sys
 import tempfile
 from datetime import datetime
 from uuid import uuid4
 
-from unittest2 import TestCase
-from sh import git, rm, touch, DEFAULT_ENCODING  # pylint: disable=no-name-in-module
+try:
+    # python 2.x
+    from unittest2 import TestCase
+except ImportError:
+    # python 3.x
+    from unittest import TestCase
+
+from sh import git, rm, touch, DEFAULT_ENCODING, RunningCommand  # pylint: disable=no-name-in-module
 
 
 def ustr(obj):
@@ -42,6 +49,12 @@ def tearDown(self):
         for tmpfile in self.tmpfiles:
             os.remove(tmpfile)
 
+    def assertEqualStdout(self, output, expected):  # pylint: disable=invalid-name
+        self.assertIsInstance(output, RunningCommand)
+        output = output.stdout.decode(DEFAULT_ENCODING)
+        output = output.replace('\r\n', '\n')
+        self.assertMultiLineEqual(output, expected)
+
     @classmethod
     def setUpClass(cls):
         """ Sets up the integration tests by creating a new temporary git repository """
@@ -57,7 +70,8 @@ def tearDownClass(cls):
     @classmethod
     def create_tmp_git_repo(cls):
         """ Creates a temporary git repository and returns its directory path """
-        tmp_git_repo = os.path.realpath("/tmp/gitlint-test-%s" % datetime.now().strftime("%Y%m%d-%H%M%S"))
+        tmp_git_repo = os.path.realpath("/tmp/gitlint-test-{0}".format(
+            datetime.now().strftime("%Y%m%d-%H%M%S-%f")))
         git("init", tmp_git_repo)
         # configuring name and email is required in every git repot
         git("config", "user.name", "gitlint-test-user", _cwd=tmp_git_repo)
@@ -138,11 +152,3 @@ def get_expected(filename="", variable_dict=None):
         if variable_dict:
             expected = expected.format(**variable_dict)
         return expected
-
-    @staticmethod
-    def mock_stdin():
-        """ Convenience method to create a Mock stdin object to deal with https://github.com/amoffat/sh/issues/427 """
-        class MockInput(object):
-            def read(self, _size):  # pylint: disable=no-self-use
-                return
-        return MockInput()

qa/requirements.txt

@@ -1,5 +1,6 @@
-unittest2==1.1.0 # support for python 2.6
-sh==1.11
-pytest==3.0.4
+unittest2==1.1.0; python_version <= '2.7'
+sh==1.12.14
+pytest==3.2.5; python_version == '2.6' or python_version == '3.3'
+pytest==3.10.0; python_version != '2.6' and python_version != '3.3'
 arrow==0.10.0
-gitlint # no version as you want to test the currently installed version
+gitlint # no version as you want to test the currently installed version

qa/test_commits.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
 from sh import git, gitlint  # pylint: disable=no-name-in-module
 from qa.base import BaseTestCase
 
@@ -17,7 +17,7 @@ def test_successful(self):
         self._create_simple_commit(u"Sïmple title3\n\nSimple bödy describing the commit3")
         output = gitlint("--commits", "test-branch-commits-base...test-branch-commits",
                          _cwd=self.tmp_git_repo, _tty_in=True)
-        self.assertEqual(output, "")
+        self.assertEqualStdout(output, "")
 
     def test_violations(self):
         """ Test linting multiple commits with violations """
@@ -40,7 +40,7 @@ def test_violations(self):
                     u"3: B6 Body message is missing\n")
 
         self.assertEqual(output.exit_code, 4)
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
     def test_lint_single_commit(self):
         self._create_simple_commit(u"Sïmple title.\n")
@@ -52,7 +52,7 @@ def test_lint_single_commit(self):
         expected = (u"1: T3 Title has trailing punctuation (.): \"Sïmple title2.\"\n" +
                     u"3: B6 Body message is missing\n")
         self.assertEqual(output.exit_code, 2)
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
     def test_lint_head(self):
         """ Testing whether we can also recognize special refs like 'HEAD' """
@@ -72,7 +72,7 @@ def test_lint_head(self):
             u"1: T3 Title has trailing punctuation (.): \"Sïmple title.\"\n"
         )
 
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
     def test_ignore_commits(self):
         """ Tests multiple commits of which some rules get igonored because of ignore-* rules """
@@ -102,4 +102,4 @@ def test_ignore_commits(self):
             u"1: T3 Title has trailing punctuation (.): \"Sïmple title.\"\n"
         )
 
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)

qa/test_config.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
 import platform
 import sys
 
@@ -16,44 +16,44 @@ def test_ignore_by_id(self):
         self._create_simple_commit(u"WIP: Thïs is a title.\nContënt on the second line")
         output = gitlint("--ignore", "T5,B4", _tty_in=True, _cwd=self.tmp_git_repo, _ok_code=[1])
         expected = u"1: T3 Title has trailing punctuation (.): \"WIP: Thïs is a title.\"\n"
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
     def test_ignore_by_name(self):
         self._create_simple_commit(u"WIP: Thïs is a title.\nContënt on the second line")
         output = gitlint("--ignore", "title-must-not-contain-word,body-first-line-empty",
                          _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[1])
         expected = u"1: T3 Title has trailing punctuation (.): \"WIP: Thïs is a title.\"\n"
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
     def test_verbosity(self):
         self._create_simple_commit(u"WIP: Thïs is a title.\nContënt on the second line")
         output = gitlint("-v", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3])
         expected = u"1: T3\n1: T5\n2: B4\n"
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
         output = gitlint("-vv", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3])
         expected = u"1: T3 Title has trailing punctuation (.)\n" + \
                    u"1: T5 Title contains the word 'WIP' (case-insensitive)\n" + \
                    u"2: B4 Second line is not empty\n"
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
         output = gitlint("-vvv", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3])
         expected = u"1: T3 Title has trailing punctuation (.): \"WIP: Thïs is a title.\"\n" + \
                    u"1: T5 Title contains the word 'WIP' (case-insensitive): \"WIP: Thïs is a title.\"\n" + \
                    u"2: B4 Second line is not empty: \"Contënt on the second line\"\n"
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
         # test silent mode
         output = gitlint("--silent", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3])
-        self.assertEqual(output, "")
+        self.assertEqualStdout(output, "")
 
     def test_set_rule_option(self):
         self._create_simple_commit(u"This ïs a title.")
         output = gitlint("-c", "title-max-length.line-length=5", _tty_in=True, _cwd=self.tmp_git_repo, _ok_code=[3])
         expected = u"1: T1 Title exceeds max length (16>5): \"This ïs a title.\"\n" + \
                    u"1: T3 Title has trailing punctuation (.): \"This ïs a title.\"\n" + \
                    "3: B6 Body message is missing\n"
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
     def test_config_from_file(self):
         commit_msg = u"WIP: Thïs is a title thåt is a bit longer.\nContent on the second line\n" + \
@@ -68,7 +68,7 @@ def test_config_from_file(self):
                    "2: B4 Second line is not empty\n" + \
                    "3: B1 Line exceeds max length (48>30)\n"
 
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)
 
     def test_config_from_file_debug(self):
         commit_msg = u"WIP: Thïs is a title thåt is a bit longer.\nContent on the second line\n" + \
@@ -89,4 +89,4 @@ def test_config_from_file_debug(self):
                                                        'config_path': config_path, 'target': self.tmp_git_repo,
                                                        'commit_sha': commit_sha, 'commit_date': expected_date})
 
-        self.assertEqual(output, expected)
+        self.assertEqualStdout(output, expected)