Merge pull request #20 from phillipdupuis/cicd-tweaks

CICD updates for linting with black, code coverage, and cleaning up naming conventions

Author: phillipdupuis

.coveragerc

@@ -1,12 +1,17 @@
-name: "Tests"
-
+name: CI/CD
 on:
   push:
   pull_request:
-
 jobs:
+  lint:
+    name: Lint code with black
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: psf/black@stable
   test:
-    name: Test pyglotaran stable
+    name: Run unit tests
+    needs: lint
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -21,7 +26,6 @@ jobs:
             python-version: "3.9"
           - os: ubuntu-latest
             python-version: "3.10"
-
     steps:
       - name: Check out repo
         uses: actions/checkout@v3
@@ -38,12 +42,21 @@ jobs:
           npm i -g json-schema-to-typescript
       - name: Install python dependencies
         run: |
-          python -m pip install -U pip wheel pytest pytest-cov
+          python -m pip install -U pip wheel pytest pytest-cov coverage
           python -m pip install -U .
       - name: Run tests
         run: |
           python -m pytest --cov=pydantic2ts
-
+      - name: Generate LCOV File
+        if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8' }}
+        run: |
+          coverage lcov
+      - name: Coveralls
+        if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8' }}
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: coverage.lcov
   deploy:
     name: Deploy to PyPi
     runs-on: ubuntu-latest
@@ -61,9 +74,8 @@ jobs:
       - name: Build dist
         run: |
           python setup.py sdist bdist_wheel
-
       - name: Publish package
         uses: pypa/gh-action-pypi-publish@v1.5.0
         with:
           user: __token__
-          password: ${{ secrets.pypi_password }}
+          password: ${{ secrets.pypi_password }}

.github/workflows/tests.yml renamed to .github/workflows/cicd.yml

@@ -2,6 +2,7 @@
 
 [![PyPI version](https://badge.fury.io/py/pydantic-to-typescript.svg)](https://badge.fury.io/py/pydantic-to-typescript)
 [![Tests](https://github.com/phillipdupuis/pydantic-to-typescript/actions/workflows/tests.yml/badge.svg)](https://github.com/phillipdupuis/pydantic-to-typescript/actions/workflows/tests.yml)
+[![Coverage Status](https://coveralls.io/repos/github/phillipdupuis/pydantic-to-typescript/badge.svg?branch=master)](https://coveralls.io/github/phillipdupuis/pydantic-to-typescript?branch=master)
 
 A simple CLI tool for converting pydantic models into typescript interfaces. Useful for any scenario in which python and javascript applications are interacting, since it allows you to have a single source of truth for type definitions.
 

README.md

@@ -116,6 +116,7 @@ def remove_master_model_from_output(output: str) -> None:
     ]
 
     new_lines = banner_comment_lines + lines[:start] + lines[(end + 1) :]
+
     with open(output, "w") as f:
         f.writelines(new_lines)
 
@@ -209,9 +210,7 @@ def generate_typescript_defs(
 
     logger.info("Converting JSON schema to typescript definitions...")
 
-    os.system(
-        f'{json2ts_cmd} -i {schema_file_path} -o {output} --bannerComment ""'
-    )
+    os.system(f'{json2ts_cmd} -i {schema_file_path} -o {output} --bannerComment ""')
     shutil.rmtree(schema_dir)
     remove_master_model_from_output(output)
 

pydantic2ts/cli/script.py

@@ -35,8 +35,11 @@ def readme():
     author="Phillip Dupuis",
     author_email="phillip_dupuis@alumni.brown.edu",
     url="https://github.com/phillipdupuis/pydantic-to-typescript",
-    packages=find_packages(),
+    packages=find_packages(exclude=["tests*"]),
     install_requires=install_requires,
+    extras_require={
+        "dev": ["pytest", "pytest-cov", "coverage"],
+    },
     entry_points={"console_scripts": ["pydantic2ts = pydantic2ts.cli.script:main"]},
     classifiers=classifiers,
 )

setup.py

@@ -1,6 +1,7 @@
 import os
 import sys
 import subprocess
+import pytest
 from pydantic2ts import generate_typescript_defs
 
 
@@ -25,13 +26,6 @@ def run_test(
     Execute pydantic2ts logic for converting pydantic models into tyepscript definitions.
     Compare the output with the expected output, verifying it is identical.
     """
-    # Literal was only introduced in python 3.8 (Ref.: PEP 586) so tests break
-    if sys.version_info < (3, 8) and test_name == "submodules":
-        return
-    # GenericModel is only supported for python>=3.7
-    # (Ref.: https://pydantic-docs.helpmanual.io/usage/models/#generic-models)
-    if sys.version_info < (3, 7) and test_name == "generics":
-        return
     module_path = module_path or get_input_module(test_name)
     output_path = tmpdir.join(f"cli_{test_name}.ts").strpath
 
@@ -52,10 +46,21 @@ def test_single_module(tmpdir):
     run_test(tmpdir, "single_module")
 
 
+@pytest.mark.skipif(
+    sys.version_info < (3, 8),
+    reason="Literal requires python 3.8 or higher (Ref.: PEP 586)",
+)
 def test_submodules(tmpdir):
     run_test(tmpdir, "submodules")
 
 
+@pytest.mark.skipif(
+    sys.version_info < (3, 7),
+    reason=(
+        "GenericModel is only supported for python>=3.7 "
+        "(Ref.: https://pydantic-docs.helpmanual.io/usage/models/#generic-models)"
+    ),
+)
 def test_generics(tmpdir):
     run_test(tmpdir, "generics")
 
@@ -68,16 +73,22 @@ def test_excluding_models(tmpdir):
 
 def test_relative_filepath(tmpdir):
     test_name = "single_module"
-    relative_path = os.path.join(".", "tests", "expected_results", test_name, "input.py")
+    relative_path = os.path.join(
+        ".", "tests", "expected_results", test_name, "input.py"
+    )
     run_test(
-        tmpdir, "single_module", module_path=relative_path,
+        tmpdir,
+        "single_module",
+        module_path=relative_path,
     )
 
 
 def test_calling_from_python(tmpdir):
     run_test(tmpdir, "single_module", call_from_python=True)
-    run_test(tmpdir, "submodules", call_from_python=True)
-    run_test(tmpdir, "generics", call_from_python=True)
+    if sys.version_info >= (3, 8):
+        run_test(tmpdir, "submodules", call_from_python=True)
+    if sys.version_info >= (3, 7):
+        run_test(tmpdir, "generics", call_from_python=True)
     run_test(
         tmpdir,
         "excluding_models",