Cleanup code and tests

Author: saadmk11

.github/workflows/test.yaml

@@ -29,7 +29,7 @@ jobs:
   test:
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
 
     runs-on: ubuntu-latest
 
@@ -41,11 +41,9 @@ jobs:
         python-version: ${{ matrix.python-version }}
 
     - name: Install Dependencies
-      run: python -m pip install --upgrade setuptools pip virtualenv tox coverage
+      run: python -m pip install --upgrade setuptools pip virtualenv tox
     - name: Run Tests
-      run: |
-        tox -e py
-        coverage xml
+      run: tox -e py
 
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v3

github_action_utils.py

@@ -34,7 +34,7 @@
 def _print_command(
     command: CommandTypes,
     command_message: str,
-    property_string: Union[str, None] = None,
+    options_string: Union[str] = "",
 ) -> None:
     """
     Helper function to print GitHub action commands to the shell.
@@ -44,14 +44,11 @@ def _print_command(
     :returns: None
     """
     # https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions
-    if command == "endgroup":
-        echo_message = f"{COMMAND_MARKER}endgroup{COMMAND_MARKER}"
-    else:
-        echo_message = (
-            f"{COMMAND_MARKER}{command} "
-            f"{property_string or ''}"
-            f"{COMMAND_MARKER}{_escape_data(command_message)}"
-        )
+    echo_message = (
+        f"{COMMAND_MARKER}{command} "
+        f"{options_string or ''}"
+        f"{COMMAND_MARKER}{_escape_data(command_message)}"
+    )
 
     print(echo_message)
 
@@ -119,29 +116,12 @@ def _to_camel_case(text: str) -> str:
     return f"{text[:1].lower()}{text.title().replace('_', '')[1:]}"
 
 
-def _print_log_message(
-    command: LogCommandTypes,
-    message: str,
-    **kwargs: Any,
-) -> None:
-    """
-    prints a log message to the GitHub action shell.
-
-    :param message: Message to display
-    :param title: Custom title
-    :param file: Filename in the repository
-    :param col: Column number, starting at 1
-    :param end_column: End column number
-    :param line: Line number, starting at 1
-    :param end_line: End line number
-    :returns: None
-    """
-    property_sting = ",".join(
+def _build_options_string(**kwargs: Any) -> str:
+    return ",".join(
         f"{_to_camel_case(key)}={_escape_property(value)}"
         for key, value in kwargs.items()
-        if value
+        if value is not None
     )
-    _print_command(command, message, property_string=property_sting)
 
 
 def set_output(name: str, value: Any) -> None:
@@ -155,8 +135,7 @@ def set_output(name: str, value: Any) -> None:
     :param value: value of the output
     :returns: None
     """
-    property_string = f"name={_escape_property(name)}"
-    _print_command("set-output", value, property_string=property_string)
+    _print_command("set-output", value, options_string=_build_options_string(name=name))
 
 
 def echo(message: Any) -> None:
@@ -182,7 +161,10 @@ def debug(message: str) -> None:
     :param message: message string
     :returns: None
     """
-    _print_log_message("debug", message)
+    _print_command(
+        "debug",
+        message,
+    )
 
 
 def notice(
@@ -209,15 +191,17 @@ def notice(
     :param end_line: End line number
     :returns: None
     """
-    _print_log_message(
+    _print_command(
         "notice",
         message,
-        title=title,
-        file=file,
-        col=col,
-        end_column=end_column,
-        line=line,
-        end_line=end_line,
+        options_string=_build_options_string(
+            title=title,
+            file=file,
+            col=col,
+            end_column=end_column,
+            line=line,
+            end_line=end_line,
+        ),
     )
 
 
@@ -245,15 +229,17 @@ def warning(
     :param end_line: End line number
     :returns: None
     """
-    _print_log_message(
+    _print_command(
         "warning",
         message,
-        title=title,
-        file=file,
-        col=col,
-        end_column=end_column,
-        line=line,
-        end_line=end_line,
+        options_string=_build_options_string(
+            title=title,
+            file=file,
+            col=col,
+            end_column=end_column,
+            line=line,
+            end_line=end_line,
+        ),
     )
 
 
@@ -281,15 +267,17 @@ def error(
     :param end_line: End line number
     :returns: None
     """
-    _print_log_message(
+    _print_command(
         "error",
         message,
-        title=title,
-        file=file,
-        col=col,
-        end_column=end_column,
-        line=line,
-        end_line=end_line,
+        options_string=_build_options_string(
+            title=title,
+            file=file,
+            col=col,
+            end_column=end_column,
+            line=line,
+            end_line=end_line,
+        ),
     )
 
 
@@ -304,8 +292,7 @@ def save_state(name: str, value: Any) -> None:
     :param value: value of the state environment variable
     :returns: None
     """
-    property_string = f"name={_escape_property(name)}"
-    _print_command("save-state", value, property_string=property_string)
+    _print_command("save-state", value, options_string=_build_options_string(name=name))
 
 
 def get_state(name: str) -> Union[str, None]:
@@ -350,7 +337,7 @@ def end_group() -> None:
 
     :returns: None
     """
-    _print_command("endgroup", "")
+    print(f"{COMMAND_MARKER}endgroup{COMMAND_MARKER}")
 
 
 @contextmanager

requirements-dev.txt

@@ -1,2 +1,3 @@
 coverage
 pytest
+pytest-cov

tests/test_github_action_utils.py

@@ -11,7 +11,6 @@
 @pytest.mark.parametrize(
     "test_input,expected",
     [
-        (["endgroup", ""], "::endgroup::\n"),
         (
             ["debug", "test debug", "test=1,test2=2"],
             "::debug test=1,test2=2::test debug\n",
@@ -97,10 +96,9 @@ def test__to_camel_case(test_input: str, expected: str) -> None:
 
 
 @pytest.mark.parametrize(
-    "input_args,input_kwargs,expected",
+    "input_kwargs,expected",
     [
         (
-            ["error", "test error"],
             {
                 "title": "test  \ntitle",
                 "file": "abc.py",
@@ -109,21 +107,14 @@ def test__to_camel_case(test_input: str, expected: str) -> None:
                 "line": 4,
                 "end_line": 5,
             },
-            "::error title=test  %0Atitle,file=abc.py,col=1,endColumn=2,line=4,endLine=5::test error\n",
+            "title=test  %0Atitle,file=abc.py,col=1,endColumn=2,line=4,endLine=5",
         ),
-        (["error", "test debug"], {}, "::error ::test debug\n"),
-        (["debug", "test debug"], {}, "::debug ::test debug\n"),
+        ({"name": "test-name"}, "name=test-name"),
+        ({}, ""),
     ],
 )
-def test__print_log_message(
-    capfd: Any,
-    input_args: Any,
-    input_kwargs: Any,
-    expected: str,
-) -> None:
-    gha_utils._print_log_message(*input_args, **input_kwargs)
-    out, err = capfd.readouterr()
-    assert out == expected
+def test__build_options_string(input_kwargs: Any, expected: str) -> None:
+    assert gha_utils._build_options_string(**input_kwargs) == expected
 
 
 @pytest.mark.parametrize(

tox.ini

@@ -1,18 +1,21 @@
 [tox]
-envlist = py37,py38,py39,py310,black-formatter,isort,mypy
+envlist = py36,py37,py38,py39,py310,black-formatter,isort,mypy
 
 [testenv]
-commands = coverage run --source . -m pytest {posargs}
+commands = pytest --cov=. --cov-report xml {posargs}
 deps = -rrequirements-dev.txt
 
 [testenv:black-formatter]
+basepython = python3.10
 commands = black --check --diff .
 deps = black
 
 [testenv:isort]
+basepython = python3.10
 commands = isort --profile black --check-only --diff .
 deps = isort
 
 [testenv:mypy]
+basepython = python3.10
 commands = mypy --strict --install-types --non-interactive github_action_utils.py
 deps = mypy