Merge pull request #6 from utgwkk/enable-only-in-workflow

Enable only in workflow

Author: utgwkk

plugin_test.py

@@ -11,7 +11,8 @@ def test_success():
             assert 1
         '''
     )
-    result = testdir.runpytest()
+    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
+    result = testdir.runpytest_subprocess()
     result.stdout.no_fnmatch_line(
         '::error file=test_annotation_succeed_no_output.py*',
     )
@@ -26,7 +27,8 @@ def test_fail():
             assert 0
         '''
     )
-    result = testdir.runpytest()
+    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
+    result = testdir.runpytest_subprocess()
     result.stdout.fnmatch_lines([
         '::error file=test_annotation_fail.py,line=4::def test_fail():*',
     ])
@@ -42,7 +44,24 @@ def test_fail():
             assert 1
         '''
     )
-    result = testdir.runpytest()
+    testdir.monkeypatch.setenv('GITHUB_ACTIONS', 'true')
+    result = testdir.runpytest_subprocess()
     result.stdout.fnmatch_lines([
         '::error file=test_annotation_exception.py,line=4::def test_fail():*',
     ])
+
+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', '')
+    result = testdir.runpytest_subprocess()
+    result.stdout.no_fnmatch_line(
+        '::error file=test_annotation_fail_disabled_outside_workflow.py*',
+    )

pytest_github_actions_annotate_failures/plugin.py

@@ -1,6 +1,11 @@
 import os
 
 def pytest_runtest_logreport(report):
+    # 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':
+        return
+
     if report.outcome != 'failed':
         return