Initial commit

Author: souvik-deepsource

.deepsource.toml

@@ -0,0 +1,18 @@
+version = 1
+
+[[analyzers]]
+name = 'python'
+enabled = true
+
+  [analyzers.meta]
+  max_line_length = 100
+  skip_doc_coverage = ["module", "magic", "class"]
+  runtime_version = '3.x.x'
+
+[[analyzers]]
+name = "docker"
+enabled = true
+
+[[transformers]]
+name = 'black'
+enabled = true

.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[Makefile]
+indent_style = tab
+
+[*.md]
+trim_trailing_whitespace = false

Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.8.5-slim-buster
+ENV PYTHONPATH /app
+ENV PYTHONUNBUFFERED 1
+ENV PYTHONDONTWRITEBYTECODE 1
+
+ADD . /app
+WORKDIR /app
+
+# install curl
+RUN apt-get update
+RUN apt-get install -y curl git
+
+# download the DeepSource CLI binary
+RUN curl https://deepsource.io/cli | sh
+RUN ["chmod", "777", "/app/main.py"]
+
+CMD ["/app/main.py"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 DeepSource Corp.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,9 @@
+# DeepSource Test Coverage Action
+
+[![DeepSource](https://static.deepsource.io/deepsource-badge-light-mini.svg)](https://deepsource.io/gh/deepsourcelabs/test-coverage-action/?ref=repository-badge)
+
+GitHub Action that enables you to upload your test coverage data to DeepSource easily.
+
+## License
+
+This project is released under the [MIT License](LICENSE).

action.yml

@@ -0,0 +1,22 @@
+name: 'DeepSource Test Coverage Action'
+description: 'GitHub Action that uploads test coverage reports to DeepSource for the Test Coverage analyzer.'
+author: 'Sanket Saurav <[email protected]>'
+inputs:
+  key:
+    description: 'Programming language shortcode for which coverage is reported. Allowed values are — python, go'
+    required: true
+  coverage-file:
+    description: 'Path to the coverage data file. e.g. ./coverage.xml'
+    required: true
+  dsn:
+    description: 'DeepSource DSN of this repository. It is available under Settings → Reporting tab of the repository page on DeepSource.'
+    required: true
+  fail-ci-on-error:
+    description: 'Should the CI build fail if there is an error while uploading the report to DeepSource? Allowed values are — true, false'
+    default: false
+branding:
+  color: 'green'
+  icon: 'umbrella'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'

main.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+import os
+import subprocess
+import sys
+
+# input for the actions are converted to names of a specific format by GitHub
+INPUT_KEYS_MAP = {
+    "key": "INPUT_KEY",
+    "coverage_file": "INPUT_COVERAGE-FILE",
+    "dsn": "INPUT_DSN",
+    "fail_ci_on_error": "INPUT_FAIL-CI-ON-ERROR",
+}
+
+DEEPSOURCE_CLI_PATH = "/app/bin/deepsource"
+
+DEEPSOURCE_TEST_COVERAGE_ANALYZER_SHORTCODE = "test-coverage"
+
+GITHUB_WORKSPACE_PATH = os.environ.get('GITHUB_WORKSPACE')
+
+def main() -> None:
+    """
+    Get the metadata required for invoking DeepSource CLI from the environment
+    and invoke the CLI to report the test coverage.
+    Optionally, fail with a non-zero exit code if the user has configured so.
+    """
+
+    input_data = {key: os.getenv(value) for key, value in INPUT_KEYS_MAP.items()}
+
+    command = [
+        DEEPSOURCE_CLI_PATH,
+        "report",
+        "--analyzer",
+        DEEPSOURCE_TEST_COVERAGE_ANALYZER_SHORTCODE,
+        "--key",
+        input_data["key"],
+        "--value-file",
+        input_data["coverage_file"],
+    ]
+
+    # change the current working directory to the GitHub repository's context
+    os.chdir(GITHUB_WORKSPACE_PATH)
+
+    process = subprocess.run(
+        command,
+        env=dict(os.environ, DEEPSOURCE_DSN=input_data["dsn"]),
+        capture_output=True,
+    )
+
+    if process.returncode != 0:
+        if input_data["fail_ci_on_error"] == "true":
+            print(f"::error file:main.py::{process.stdout}")
+            sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()