tests: address review points from @utgwkk

Author: henryiii

plugin_test.py

@@ -119,7 +119,7 @@ def test_fail():
     testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
     result = testdir.runpytest_subprocess()
     result.stdout.fnmatch_lines([
-        '::error file=test_annotation_long.py,line=17::test_annotation_fail*assert 8 == 3*where 8 = f(8)*',
+        '::error file=test_annotation_long.py,line=17::test_fail*assert 8 == 3*where 8 = f(8)*',
     ])
     no_fnmatch_line(result, '::*assert x += 1*')
 
@@ -145,7 +145,7 @@ def test_method(self):
 
 
 
-def test_annotation_long(testdir):
+def test_annotation_param(testdir):
     testdir.makepyfile(
         '''
         import pytest
@@ -164,7 +164,7 @@ def test_param(a, b):
     testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
     result = testdir.runpytest_subprocess()
     result.stdout.fnmatch_lines([
-        '::error file=test_annotation_long.py,line=11::test_param?other?1*assert 2 == 3*',
+        '::error file=test_annotation_param.py,line=11::test_param?other?1*assert 2 == 3*',
     ])
 
 # Debugging / development tip:

pytest_github_actions_annotate_failures/plugin.py

@@ -3,6 +3,14 @@
 import pytest
 from collections import OrderedDict
 
+# 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
+# https://docs.pytest.org/en/stable/reference.html#pytest.hookspec.pytest_runtest_makereport
+#
+# 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