codecov-cli 0.5.2__tar.gz → 0.6.0__tar.gz

{codecov-cli-0.5.2/codecov_cli.egg-info → codecov-cli-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codecov-cli
-Version: 0.5.2
+Version: 0.6.0
 Summary: Codecov Command Line Interface
 Author: Codecov
 Author-email: support@codecov.io

codecov-cli-0.6.0/codecov_cli/commands/process_test_results.py

@@ -0,0 +1,175 @@
+import logging
+import os
+import pathlib
+from dataclasses import dataclass
+from typing import List
+
+import click
+from test_results_parser import (
+    Outcome,
+    ParserError,
+    Testrun,
+    build_message,
+    parse_junit_xml,
+)
+
+from codecov_cli.helpers.request import (
+    log_warnings_and_errors_if_any,
+    send_post_request,
+)
+from codecov_cli.services.upload.file_finder import select_file_finder
+
+logger = logging.getLogger("codecovcli")
+
+
+_process_test_results_options = [
+    click.option(
+        "-s",
+        "--dir",
+        "--files-search-root-folder",
+        "dir",
+        help="Folder where to search for test results files",
+        type=click.Path(path_type=pathlib.Path),
+        default=pathlib.Path.cwd,
+        show_default="Current Working Directory",
+    ),
+    click.option(
+        "-f",
+        "--file",
+        "--files-search-direct-file",
+        "files",
+        help="Explicit files to upload. These will be added to the test results files to be processed. If you wish to only process the specified files, please consider using --disable-search to disable processing other files.",
+        type=click.Path(path_type=pathlib.Path),
+        multiple=True,
+        default=[],
+    ),
+    click.option(
+        "--exclude",
+        "--files-search-exclude-folder",
+        "exclude_folders",
+        help="Folders to exclude from search",
+        type=click.Path(path_type=pathlib.Path),
+        multiple=True,
+        default=[],
+    ),
+    click.option(
+        "--disable-search",
+        help="Disable search for coverage files. This is helpful when specifying what files you want to upload with the --file option.",
+        is_flag=True,
+        default=False,
+    ),
+    click.option(
+        "--provider-token",
+        help="Token used to make calls to Repo provider API",
+        type=str,
+        default=None,
+    ),
+]
+
+
+def process_test_results_options(func):
+    for option in reversed(_process_test_results_options):
+        func = option(func)
+    return func
+
+
+@dataclass
+class TestResultsNotificationPayload:
+    failures: List[Testrun]
+    failed: int = 0
+    passed: int = 0
+    skipped: int = 0
+
+
+@click.command()
+@process_test_results_options
+def process_test_results(
+    dir=None, files=None, exclude_folders=None, disable_search=None, provider_token=None
+):
+    if provider_token is None:
+        raise click.ClickException(
+            "Provider token was not provided. Make sure to pass --provider-token option with the contents of the GITHUB_TOKEN secret, so we can make a comment."
+        )
+
+    summary_file_path = os.getenv("GITHUB_STEP_SUMMARY")
+    if summary_file_path is None:
+        raise click.ClickException(
+            "Error getting step summary file path from environment. Can't find GITHUB_STEP_SUMMARY environment variable."
+        )
+
+    slug = os.getenv("GITHUB_REPOSITORY")
+    if slug is None:
+        raise click.ClickException(
+            "Error getting repo slug from environment. Can't find GITHUB_REPOSITORY environment variable."
+        )
+
+    ref = os.getenv("GITHUB_REF")
+    if ref is None or "pull" not in ref:
+        raise click.ClickException(
+            "Error getting PR number from environment. Can't find GITHUB_REF environment variable."
+        )
+
+    file_finder = select_file_finder(
+        dir, exclude_folders, files, disable_search, report_type="test_results"
+    )
+
+    upload_collection_results = file_finder.find_files()
+    if len(upload_collection_results) == 0:
+        raise click.ClickException(
+            "No JUnit XML files were found. Make sure to specify them using the --file option."
+        )
+
+    payload = generate_message_payload(upload_collection_results)
+
+    message = build_message(payload)
+
+    # write to step summary file
+    with open(summary_file_path, "w") as f:
+        f.write(message)
+
+    # GITHUB_REF is documented here: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
+    pr_number = ref.split("/")[2]
+
+    create_github_comment(provider_token, slug, pr_number, message)
+
+
+def create_github_comment(token, repo_slug, pr_number, message):
+    url = f"https://api.github.com/repos/{repo_slug}/issues/{pr_number}/comments"
+
+    headers = {
+        "Accept": "application/vnd.github+json",
+        "Authorization": f"Bearer {token}",
+        "X-GitHub-Api-Version": "2022-11-28",
+    }
+    logger.info("Posting github comment")
+
+    log_warnings_and_errors_if_any(
+        send_post_request(url=url, data={"body": message}, headers=headers),
+        "Posting test results comment",
+    )
+
+
+def generate_message_payload(upload_collection_results):
+    payload = TestResultsNotificationPayload(failures=[])
+
+    for result in upload_collection_results:
+        testruns = []
+        try:
+            logger.info(f"Parsing {result.get_filename()}")
+            testruns = parse_junit_xml(result.get_content())
+            for testrun in testruns:
+                if (
+                    testrun.outcome == Outcome.Failure
+                    or testrun.outcome == Outcome.Error
+                ):
+                    payload.failed += 1
+                    payload.failures.append(testrun)
+                elif testrun.outcome == Outcome.Skip:
+                    payload.skipped += 1
+                else:
+                    payload.passed += 1
+        except ParserError as err:
+            raise click.ClickException(
+                f"Error parsing {str(result.get_filename(), 'utf8')} with error: {err}"
+            )
+    return payload

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli/helpers/folder_searcher.py

@@ -58,7 +58,7 @@ def search_files(
     this_is_excluded = functools.partial(
         _is_excluded, filename_exclude_regex, multipart_exclude_regex
     )
-    for (dirpath, dirnames, filenames) in os.walk(folder_to_search):
+    for dirpath, dirnames, filenames in os.walk(folder_to_search):
         dirs_to_remove = set(d for d in dirnames if d in folders_to_ignore)
 
         if multipart_exclude_regex is not None:

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli/helpers/git.py

@@ -61,13 +61,16 @@ def parse_git_service(remote_repo_url: str):
     Possible cases we're considering:
     - https://github.com/codecov/codecov-cli.git returns github
     - git@github.com:codecov/codecov-cli.git returns github
+    - ssh://git@github.com/gitcodecov/codecov-cli returns github
+    - ssh://git@github.com:gitcodecov/codecov-cli returns github
     - https://user-name@bitbucket.org/namespace-codecov/first_repo.git returns bitbucket
     """
     services = [service.value for service in GitService]
     parsed_url = urlparse(remote_repo_url)
     service = None
 
-    if remote_repo_url.startswith("https://"):
+    scheme = parsed_url.scheme
+    if scheme in ("https", "ssh"):
         netloc = parsed_url.netloc
         if "@" in netloc:
             netloc = netloc.split("@", 1)[1]

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli/helpers/git_services/github.py

@@ -24,9 +24,11 @@ class Github:
                     "ref": res["head"]["ref"],
                     # Through empiric test data it seems that the "repo" key in "head" is set to None
                     # If the PR is from the same repo (e.g. not from a fork)
-                    "slug": res["head"]["repo"]["full_name"]
-                    if res["head"]["repo"]
-                    else res["base"]["repo"]["full_name"],
+                    "slug": (
+                        res["head"]["repo"]["full_name"]
+                        if res["head"]["repo"]
+                        else res["base"]["repo"]["full_name"]
+                    ),
                 },
                 "base": {
                     "sha": res["base"]["sha"],

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli/helpers/versioning_systems.py

@@ -135,9 +135,11 @@ class GitVersioningSystem(VersioningSystemInterface):
         )
 
         return [
-            filename[1:-1]
-            if filename.startswith('"') and filename.endswith('"')
-            else filename
+            (
+                filename[1:-1]
+                if filename.startswith('"') and filename.endswith('"')
+                else filename
+            )
             for filename in res.stdout.decode("unicode_escape").strip().split("\n")
         ]
 

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli/main.py

@@ -11,6 +11,7 @@ from codecov_cli.commands.create_report_result import create_report_results
 from codecov_cli.commands.empty_upload import empty_upload
 from codecov_cli.commands.get_report_results import get_report_results
 from codecov_cli.commands.labelanalysis import label_analysis
+from codecov_cli.commands.process_test_results import process_test_results
 from codecov_cli.commands.report import create_report
 from codecov_cli.commands.send_notifications import send_notifications
 from codecov_cli.commands.staticanalysis import static_analysis
@@ -71,6 +72,7 @@ cli.add_command(static_analysis)
 cli.add_command(empty_upload)
 cli.add_command(upload_process)
 cli.add_command(send_notifications)
+cli.add_command(process_test_results)
 
 
 def run():

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli/services/staticanalysis/analyzers/general.py

@@ -85,13 +85,13 @@ class BaseAnalyzer(object):
 
     def get_import_lines(self, root_node, imports_query):
         import_lines = set()
-        for (a, _) in imports_query.captures(root_node):
+        for a, _ in imports_query.captures(root_node):
             import_lines.add((a.start_point[0] + 1, a.end_point[0] - a.start_point[0]))
         return import_lines
 
     def get_definition_lines(self, root_node, definitions_query):
         definition_lines = set()
-        for (a, _) in definitions_query.captures(root_node):
+        for a, _ in definitions_query.captures(root_node):
             definition_lines.add(
                 (a.start_point[0] + 1, a.end_point[0] - a.start_point[0])
             )

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli/services/upload/file_finder.py

@@ -253,7 +253,11 @@ class FileFinder(object):
         user_files_paths_resolved = [path.resolve() for path in user_files_paths]
         for filepath in self.explicitly_listed_files:
             if filepath.resolve() not in user_files_paths_resolved:
-                not_found_files.append(filepath)
+                ## The file given might be linked or in a parent dir, check to see if it exists
+                if filepath.exists():
+                    user_files_paths.append(filepath)
+                else:
+                    not_found_files.append(filepath)
 
         if not_found_files:
             logger.warning(

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli/services/upload/upload_collector.py

@@ -46,6 +46,7 @@ class UploadCollector(object):
         comment_regex = re.compile(r"^\s*\/\/.*$")
         bracket_regex = re.compile(r"^\s*[\{\}]\s*(\/\/.*)?$")
         list_regex = re.compile(r"^\s*[\]\[]\s*(\/\/.*)?$")
+        parenthesis_regex = re.compile(r"^\s*[\(\)]\s*(\/\/.*)?$")
         go_function_regex = re.compile(r"^\s*func\s*[\{]\s*(\/\/.*)?$")
         php_end_bracket_regex = re.compile(r"^\s*\);\s*(\/\/.*)?$")
 
@@ -54,7 +55,7 @@ class UploadCollector(object):
         lcov_excel_regex = re.compile(r"\/\/ LCOV_EXCL")
 
         kt_patterns_to_apply = fix_patterns_to_apply(
-            [bracket_regex], [comment_block_regex], True
+            [bracket_regex, parenthesis_regex], [comment_block_regex], True
         )
         go_patterns_to_apply = fix_patterns_to_apply(
             [empty_line_regex, comment_regex, bracket_regex, go_function_regex],
@@ -71,7 +72,6 @@ class UploadCollector(object):
             [],
             False,
         )
-
         cpp_swift_vala_patterns_to_apply = fix_patterns_to_apply(
             [empty_line_regex, bracket_regex],
             [lcov_excel_regex],
@@ -139,6 +139,8 @@ class UploadCollector(object):
                     reason=err.reason,
                 ),
             )
+        except IsADirectoryError as err:
+            logger.info(f"Skipping {filename}, found a directory not a file")
 
         return UploadCollectionResultFileFixer(
             path, fixed_lines_without_reason, fixed_lines_with_reason, eof

{codecov-cli-0.5.2 → codecov-cli-0.6.0/codecov_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codecov-cli
-Version: 0.5.2
+Version: 0.6.0
 Summary: Codecov Command Line Interface
 Author: Codecov
 Author-email: support@codecov.io

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ codecov_cli/commands/create_report_result.py
 codecov_cli/commands/empty_upload.py
 codecov_cli/commands/get_report_results.py
 codecov_cli/commands/labelanalysis.py
+codecov_cli/commands/process_test_results.py
 codecov_cli/commands/report.py
 codecov_cli/commands/send_notifications.py
 codecov_cli/commands/staticanalysis.py

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/codecov_cli.egg-info/requires.txt

@@ -4,3 +4,5 @@ ijson==3.*
 pyyaml==6.*
 responses==0.21.*
 tree-sitter==0.20.*
+test-results-parser==0.1.*
+regex

{codecov-cli-0.5.2 → codecov-cli-0.6.0}/setup.py

@@ -10,7 +10,7 @@ with open(path.join(here, "README.md"), encoding="utf-8") as f:
 
 setup(
     name="codecov-cli",
-    version="0.5.2",
+    version="0.6.0",
     packages=find_packages(exclude=["contrib", "docs", "tests*"]),
     description="Codecov Command Line Interface",
     long_description=long_description,
@@ -24,6 +24,8 @@ setup(
         "pyyaml==6.*",
         "responses==0.21.*",
         "tree-sitter==0.20.*",
+        "test-results-parser==0.1.*",
+        "regex",
     ],
     entry_points={
         "console_scripts": [