Merge pull request #16 from henryiii/henryiii/format

format: check and apply

Author: utgwkk

.github/workflows/format.yml

@@ -0,0 +1,16 @@
+name: Format
+
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+
+jobs:
+  pre-commit:
+    name: Pre-commit checks
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.1.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+  - id: requirements-txt-fixer
+  - id: trailing-whitespace
+  - id: fix-encoding-pragma
+
+- repo: https://github.com/mgedmin/check-manifest
+  rev: "0.42"
+  hooks:
+  - id: check-manifest
+
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 3.8.3
+  hooks:
+  - id: flake8
+    additional_dependencies:
+    - flake8-bugbear
+    - flake8-import-order

MANIFEST.in

@@ -0,0 +1,2 @@
+include *.py
+include LICENSE

plugin_test.py

@@ -1,102 +1,114 @@
-pytest_plugins = 'pytester'
-import pytest
+# -*- coding: utf-8 -*-
 import os
+
 from packaging import version
 
+import pytest
+
+
+pytest_plugins = "pytester"
+
+
 # result.stdout.no_fnmatch_line() is added to testdir on pytest 5.3.0
 # https://docs.pytest.org/en/stable/changelog.html#pytest-5-3-0-2019-11-19
 def no_fnmatch_line(result, pattern):
-    if version.parse(pytest.__version__) >= version.parse('5.3.0'):
-        result.stdout.no_fnmatch_line(
-            pattern + '*',
-        )
+    if version.parse(pytest.__version__) >= version.parse("5.3.0"):
+        result.stdout.no_fnmatch_line(pattern + "*",)
     else:
         assert pattern not in result.stdout.str()
 
+
 def test_annotation_succeed_no_output(testdir):
     testdir.makepyfile(
-        '''
+        """
         import pytest
         pytest_plugins = 'pytest_github_actions_annotate_failures'
 
         def test_success():
             assert 1
-        '''
+        """
     )
-    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
     result = testdir.runpytest_subprocess()
 
-    no_fnmatch_line(result, '::error file=test_annotation_succeed_no_output.py')
+    no_fnmatch_line(result, "::error file=test_annotation_succeed_no_output.py")
+
 
 def test_annotation_fail(testdir):
     testdir.makepyfile(
-        '''
+        """
         import pytest
         pytest_plugins = 'pytest_github_actions_annotate_failures'
 
         def test_fail():
             assert 0
-        '''
+        """
     )
-    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
     result = testdir.runpytest_subprocess()
-    result.stdout.fnmatch_lines([
-        '::error file=test_annotation_fail.py,line=5::test_fail*assert 0*',
-    ])
+    result.stdout.fnmatch_lines(
+        ["::error file=test_annotation_fail.py,line=5::test_fail*assert 0*",]
+    )
+
 
 def test_annotation_exception(testdir):
     testdir.makepyfile(
-        '''
+        """
         import pytest
         pytest_plugins = 'pytest_github_actions_annotate_failures'
 
         def test_fail():
             raise Exception('oops')
             assert 1
-        '''
+        """
     )
-    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
     result = testdir.runpytest_subprocess()
-    result.stdout.fnmatch_lines([
-        '::error file=test_annotation_exception.py,line=5::test_fail*oops*',
-    ])
+    result.stdout.fnmatch_lines(
+        ["::error file=test_annotation_exception.py,line=5::test_fail*oops*",]
+    )
+
 
 def test_annotation_fail_disabled_outside_workflow(testdir):
     testdir.makepyfile(
-        '''
+        """
         import pytest
         pytest_plugins = 'pytest_github_actions_annotate_failures'
 
         def test_fail():
             assert 0
-        '''
+        """
     )
-    testdir.monkeypatch.setenv('GITHUB_ACTIONS', '')
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "")
     result = testdir.runpytest_subprocess()
-    no_fnmatch_line(result, '::error file=test_annotation_fail_disabled_outside_workflow.py*')
+    no_fnmatch_line(
+        result, "::error file=test_annotation_fail_disabled_outside_workflow.py*"
+    )
+
 
 def test_annotation_fail_cwd(testdir):
     testdir.makepyfile(
-        '''
+        """
         import pytest
         pytest_plugins = 'pytest_github_actions_annotate_failures'
 
         def test_fail():
             assert 0
-        '''
+        """
     )
-    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
-    testdir.monkeypatch.setenv('GITHUB_WORKSPACE', os.path.dirname(str(testdir.tmpdir)))
-    testdir.mkdir('foo')
-    testdir.makefile('.ini', pytest='[pytest]\ntestpaths=..')
-    result = testdir.runpytest_subprocess('--rootdir=foo')
-    result.stdout.fnmatch_lines([
-        '::error file=test_annotation_fail_cwd.py,line=5::test_fail*assert 0*',
-    ])
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
+    testdir.monkeypatch.setenv("GITHUB_WORKSPACE", os.path.dirname(str(testdir.tmpdir)))
+    testdir.mkdir("foo")
+    testdir.makefile(".ini", pytest="[pytest]\ntestpaths=..")
+    result = testdir.runpytest_subprocess("--rootdir=foo")
+    result.stdout.fnmatch_lines(
+        ["::error file=test_annotation_fail_cwd.py,line=5::test_fail*assert 0*",]
+    )
+
 
 def test_annotation_long(testdir):
     testdir.makepyfile(
-        '''
+        """
         import pytest
         pytest_plugins = 'pytest_github_actions_annotate_failures'
 
@@ -114,40 +126,43 @@ def test_fail():
             x += 1
 
             assert f(x) == 3
-        '''
+        """
     )
-    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
     result = testdir.runpytest_subprocess()
-    result.stdout.fnmatch_lines([
-        '::error file=test_annotation_long.py,line=17::test_fail*assert 8 == 3*where 8 = f(8)*',
-    ])
-    no_fnmatch_line(result, '::*assert x += 1*')
+    result.stdout.fnmatch_lines(
+        [
+            "::error file=test_annotation_long.py,line=17::test_fail*assert 8 == 3*where 8 = f(8)*",
+        ]
+    )
+    no_fnmatch_line(result, "::*assert x += 1*")
+
 
 def test_class_method(testdir):
     testdir.makepyfile(
-        '''
+        """
         import pytest
         pytest_plugins = 'pytest_github_actions_annotate_failures'
 
         class TestClass(object):
             def test_method(self):
                 x = 1
                 assert x == 2
-        '''
+        """
     )
-    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
     result = testdir.runpytest_subprocess()
-    result.stdout.fnmatch_lines([
-        '::error file=test_class_method.py,line=7::TestClass.test_method*assert 1 == 2*',
-    ])
-    no_fnmatch_line(result, '::*x = 1*')
-
-
+    result.stdout.fnmatch_lines(
+        [
+            "::error file=test_class_method.py,line=7::TestClass.test_method*assert 1 == 2*",
+        ]
+    )
+    no_fnmatch_line(result, "::*x = 1*")
 
 
 def test_annotation_param(testdir):
     testdir.makepyfile(
-        '''
+        """
         import pytest
         pytest_plugins = 'pytest_github_actions_annotate_failures'
 
@@ -159,13 +174,16 @@ def test_param(a, b):
             b += 1
 
             assert a == b
-        '''
+        """
     )
-    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
+    testdir.monkeypatch.setenv("GITHUB_ACTIONS", "true")
     result = testdir.runpytest_subprocess()
-    result.stdout.fnmatch_lines([
-        '::error file=test_annotation_param.py,line=11::test_param?other?1*assert 2 == 3*',
-    ])
+    result.stdout.fnmatch_lines(
+        [
+            "::error file=test_annotation_param.py,line=11::test_param?other?1*assert 2 == 3*",
+        ]
+    )
+
 
 # Debugging / development tip:
 # Add a breakpoint() to the place you are going to check,

pytest_github_actions_annotate_failures/plugin.py

@@ -1,8 +1,11 @@
+# -*- coding: utf-8 -*-
 from __future__ import print_function
+
 import os
-import pytest
 from collections import OrderedDict
 
+import pytest
+
 # Reference:
 # https://docs.pytest.org/en/latest/writing_plugins.html#hookwrapper-executing-around-other-hooks
 # https://docs.pytest.org/en/latest/writing_plugins.html#hook-function-ordering-call-example
@@ -11,6 +14,7 @@
 # Inspired by:
 # https://github.com/pytest-dev/pytest/blob/master/src/_pytest/terminal.py
 
+
 @pytest.hookimpl(tryfirst=True, hookwrapper=True)
 def pytest_runtest_makereport(item, call):
     # execute all other hooks to obtain the report object
@@ -19,25 +23,24 @@ def pytest_runtest_makereport(item, call):
 
     # enable only in a workflow of GitHub Actions
     # ref: https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
-    if os.environ.get('GITHUB_ACTIONS') != 'true':
+    if os.environ.get("GITHUB_ACTIONS") != "true":
         return
 
     if report.when == "call" and report.failed:
         # collect information to be annotated
         filesystempath, lineno, _ = report.location
 
         # try to convert to absolute path in GitHub Actions
-        workspace = os.environ.get('GITHUB_WORKSPACE')
+        workspace = os.environ.get("GITHUB_WORKSPACE")
         if workspace:
             full_path = os.path.abspath(filesystempath)
             rel_path = os.path.relpath(full_path, workspace)
-            if not rel_path.startswith('..'):
+            if not rel_path.startswith(".."):
                 filesystempath = rel_path
 
         # 0-index to 1-index
         lineno += 1
 
-
         # get the name of the current failed test, with parametrize info
         longrepr = report.head_line or item.name
 
@@ -59,13 +62,14 @@ def _error_workflow_command(filesystempath, lineno, longrepr):
     if lineno is not None:
         details_dict["line"] = lineno
 
-    details = ",".join("{}={}".format(k,v) for k,v in details_dict.items())
+    details = ",".join("{}={}".format(k, v) for k, v in details_dict.items())
 
     if longrepr is None:
-        return '\n::error {}'.format(details)
+        return "\n::error {}".format(details)
     else:
         longrepr = _escape(longrepr)
-        return '\n::error {}::{}'.format(details, longrepr)
+        return "\n::error {}::{}".format(details, longrepr)
+
 
 def _escape(s):
-    return s.replace('%', '%25').replace('\r', '%0D').replace('\n', '%0A')
+    return s.replace("%", "%25").replace("\r", "%0D").replace("\n", "%0A")

setup.cfg

@@ -0,0 +1,12 @@
+[flake8]
+ignore = E203, E231, E501, E722, W503, B950
+select = C,E,F,W,B,B9,I
+
+[bdist_wheel]
+universal = 1
+
+[check-manifest]
+ignore =
+  .github
+  .pre-commit-config.yaml
+  requirements.txt

setup.py

@@ -1,4 +1,6 @@
-from setuptools import setup, find_packages
+# -*- coding: utf-8 -*-
+from setuptools import find_packages, setup
+
 
 with open("./README.md") as f:
     long_description = f.read()
@@ -13,16 +15,12 @@
     author_email="[email protected]",
     url="https://github.com/utgwkk/pytest-github-actions-annotate-failures",
     license="MIT",
-    classifiers=[
-        "Framework :: Pytest",
-    ],
+    classifiers=["Framework :: Pytest",],
     packages=find_packages(),
     entry_points={
         "pytest11": [
             "pytest_github_actions_annotate_failures = pytest_github_actions_annotate_failures.plugin",
         ],
     },
-    install_requires=[
-        "pytest>=4.0.0",
-    ],
+    install_requires=["pytest>=4.0.0",],
 )