Allowing sdists to be packaged with tests (#53)

* Adding tests into sdist
ghandic · Jan 7, 2023 · b48b65c · b48b65c
1 parent 8eef79c
commit b48b65c
Show file tree

Hide file tree

Showing 67 changed files with 27 additions and 26 deletions.
diff --git a/.github/workflows/python-package.yaml b/.github/workflows/python-package.yaml
@@ -48,8 +48,14 @@ jobs:
         run: |
           ls dist
           PACKAGE=`ls dist/jsf-*.tar.gz`
+          # Validate the CLI works
           pip3 install $PACKAGE\[cli\]
           jsf --help
+          # Validate the sdist tests work for conda
+          tar -xvf $PACKAGE
+          cd jsf-*
+          pip install pytest
+          pytest
       - name: Upload coverage
         uses: codecov/codecov-action@v1
         with:

diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,6 @@
 # Application
 *.json
-!src/tests/data/*.json
+!jsf/tests/data/*.json
 TODO.md
 
 # MacOS

diff --git a/LICENSE b/LICENSE
@@ -1 +1 @@
-src/jsf/LICENSE
+jsf/LICENSE
diff --git a/README.md b/README.md
@@ -1 +1 @@
-src/jsf/README.md
+jsf/README.md
diff --git a/docs/index.md b/docs/index.md
@@ -23,12 +23,12 @@ fake_json = faker.generate()
 #### Raw install
 
 ```bash
-jsf --schema src/tests/data/custom.json --instance wow.json
+jsf --schema jsf/tests/data/custom.json --instance wow.json
 ```
 
 #### Docker
 
 ```bash
 docker build . -t challisa/jsf
-docker run -v $PWD:/data challisa/jsf jsf --schema /data/src/tests/data/custom.json --instance /data/wow.json
+docker run -v $PWD:/data challisa/jsf jsf --schema /data/jsf/tests/data/custom.json --instance /data/wow.json
 ```
diff --git a/examples/fastapi/README.md b/examples/fastapi/README.md
@@ -11,6 +11,6 @@
 Using `api.py` and `custom.json` in current example folder
 
 ```bash
-datamodel-codegen --input src/tests/data/custom.json --output model.py
+datamodel-codegen --input jsf/tests/data/custom.json --output model.py
 uvicorn api:app --reload --host 0.0.0.0 --port 8080
 ```
diff --git a/src/jsf/BUILD → jsf/BUILD b/src/jsf/BUILD → jsf/BUILD
@@ -14,7 +14,11 @@ python_distribution(
             "jsf": "jsf.cli:app"
         },
     },
-    dependencies=[":src", ":build_resources"],
+    dependencies=[
+        ":src", 
+        ":build_resources", 
+        "./tests:tests",
+    ],
     long_description_path="README.md",
     provides=python_artifact(
         name="jsf",

diff --git a/src/jsf/LICENSE → jsf/LICENSE b/src/jsf/LICENSE → jsf/LICENSE
diff --git a/src/jsf/README.md → jsf/README.md b/src/jsf/README.md → jsf/README.md
@@ -91,7 +91,7 @@ fake_json = faker.generate()
 
 ```bash
 pip install jsf[cli]
-jsf --schema src/tests/data/custom.json --instance wow.json
+jsf --schema jsf/tests/data/custom.json --instance wow.json
 ```
 
 #### Docker

diff --git a/src/jsf/__init__.py → jsf/__init__.py b/src/jsf/__init__.py → jsf/__init__.py
diff --git a/src/jsf/cli.py → jsf/cli.py b/src/jsf/cli.py → jsf/cli.py
diff --git a/src/jsf/parser.py → jsf/parser.py b/src/jsf/parser.py → jsf/parser.py
diff --git a/src/jsf/requirements.txt → jsf/requirements.txt b/src/jsf/requirements.txt → jsf/requirements.txt
diff --git a/src/jsf/schema_types/BUILD → jsf/schema_types/BUILD b/src/jsf/schema_types/BUILD → jsf/schema_types/BUILD
diff --git a/src/jsf/schema_types/__init__.py → jsf/schema_types/__init__.py b/src/jsf/schema_types/__init__.py → jsf/schema_types/__init__.py
diff --git a/src/jsf/schema_types/_tuple.py → jsf/schema_types/_tuple.py b/src/jsf/schema_types/_tuple.py → jsf/schema_types/_tuple.py
diff --git a/src/jsf/schema_types/anyof.py → jsf/schema_types/anyof.py b/src/jsf/schema_types/anyof.py → jsf/schema_types/anyof.py
diff --git a/src/jsf/schema_types/array.py → jsf/schema_types/array.py b/src/jsf/schema_types/array.py → jsf/schema_types/array.py
diff --git a/src/jsf/schema_types/base.py → jsf/schema_types/base.py b/src/jsf/schema_types/base.py → jsf/schema_types/base.py
diff --git a/src/jsf/schema_types/boolean.py → jsf/schema_types/boolean.py b/src/jsf/schema_types/boolean.py → jsf/schema_types/boolean.py
diff --git a/src/jsf/schema_types/enum.py → jsf/schema_types/enum.py b/src/jsf/schema_types/enum.py → jsf/schema_types/enum.py
diff --git a/src/jsf/schema_types/null.py → jsf/schema_types/null.py b/src/jsf/schema_types/null.py → jsf/schema_types/null.py
diff --git a/src/jsf/schema_types/number.py → jsf/schema_types/number.py b/src/jsf/schema_types/number.py → jsf/schema_types/number.py
diff --git a/src/jsf/schema_types/object.py → jsf/schema_types/object.py b/src/jsf/schema_types/object.py → jsf/schema_types/object.py
diff --git a/src/jsf/schema_types/oneof.py → jsf/schema_types/oneof.py b/src/jsf/schema_types/oneof.py → jsf/schema_types/oneof.py
diff --git a/src/jsf/schema_types/string.py → jsf/schema_types/string.py b/src/jsf/schema_types/string.py → jsf/schema_types/string.py
diff --git a/src/tests/BUILD → jsf/tests/BUILD b/src/tests/BUILD → jsf/tests/BUILD
@@ -3,11 +3,12 @@ python_test_utils(
 )
 
 files(
-    name="test_data", 
-    sources=["data/*.json"]
+    name="tests", 
+    sources=["data/*.json", "*.py"]
 )
 
 python_tests(
-    dependencies=[":test_data"],
+    name="pytest",
+    dependencies=[":tests"],
     interpreter_constraints=parametrize(py3=[">=3.7,<4"]),
 )
diff --git a/src/__init__.py → jsf/tests/__init__.py b/src/__init__.py → jsf/tests/__init__.py
diff --git a/src/tests/conftest.py → jsf/tests/conftest.py b/src/tests/conftest.py → jsf/tests/conftest.py
diff --git a/src/tests/data/anyof.json → jsf/tests/data/anyof.json b/src/tests/data/anyof.json → jsf/tests/data/anyof.json
diff --git a/src/tests/data/anyof_object.json → jsf/tests/data/anyof_object.json b/src/tests/data/anyof_object.json → jsf/tests/data/anyof_object.json
diff --git a/src/tests/data/array-dicts.json → jsf/tests/data/array-dicts.json b/src/tests/data/array-dicts.json → jsf/tests/data/array-dicts.json
diff --git a/src/tests/data/array-fixed-int.json → jsf/tests/data/array-fixed-int.json b/src/tests/data/array-fixed-int.json → jsf/tests/data/array-fixed-int.json
diff --git a/src/tests/data/array-fixed-str.json → jsf/tests/data/array-fixed-str.json b/src/tests/data/array-fixed-str.json → jsf/tests/data/array-fixed-str.json
diff --git a/src/tests/data/array.json → jsf/tests/data/array.json b/src/tests/data/array.json → jsf/tests/data/array.json
diff --git a/src/tests/data/boolean.json → jsf/tests/data/boolean.json b/src/tests/data/boolean.json → jsf/tests/data/boolean.json
diff --git a/src/tests/data/const.json → jsf/tests/data/const.json b/src/tests/data/const.json → jsf/tests/data/const.json
diff --git a/src/tests/data/custom.json → jsf/tests/data/custom.json b/src/tests/data/custom.json → jsf/tests/data/custom.json
diff --git a/src/tests/data/enum.json → jsf/tests/data/enum.json b/src/tests/data/enum.json → jsf/tests/data/enum.json
diff --git a/src/tests/data/external-ref-common.json → jsf/tests/data/external-ref-common.json b/src/tests/data/external-ref-common.json → jsf/tests/data/external-ref-common.json
diff --git a/src/tests/data/external-ref.json → jsf/tests/data/external-ref.json b/src/tests/data/external-ref.json → jsf/tests/data/external-ref.json
@@ -8,7 +8,7 @@
             "$ref": "#/definitions/LocalType"
         },
         "ReferenceToExternalSchema": {
-            "$ref": "file://src/tests/data/external-ref-common.json#/definitions/ExternalType"
+            "$ref": "file://jsf/tests/data/external-ref-common.json#/definitions/ExternalType"
         }
     },
     "definitions": {

diff --git a/src/tests/data/inner-ref.json → jsf/tests/data/inner-ref.json b/src/tests/data/inner-ref.json → jsf/tests/data/inner-ref.json
diff --git a/src/tests/data/integer.json → jsf/tests/data/integer.json b/src/tests/data/integer.json → jsf/tests/data/integer.json
diff --git a/src/tests/data/null.json → jsf/tests/data/null.json b/src/tests/data/null.json → jsf/tests/data/null.json
diff --git a/src/tests/data/number-exclusive-float.json → jsf/tests/data/number-exclusive-float.json b/src/tests/data/number-exclusive-float.json → jsf/tests/data/number-exclusive-float.json
diff --git a/src/tests/data/number-exclusive.json → jsf/tests/data/number-exclusive.json b/src/tests/data/number-exclusive.json → jsf/tests/data/number-exclusive.json
diff --git a/src/tests/data/number.json → jsf/tests/data/number.json b/src/tests/data/number.json → jsf/tests/data/number.json
diff --git a/src/tests/data/object.json → jsf/tests/data/object.json b/src/tests/data/object.json → jsf/tests/data/object.json
diff --git a/src/tests/data/object_no_properties.json → jsf/tests/data/object_no_properties.json b/src/tests/data/object_no_properties.json → jsf/tests/data/object_no_properties.json
diff --git a/src/tests/data/oneof.json → jsf/tests/data/oneof.json b/src/tests/data/oneof.json → jsf/tests/data/oneof.json
diff --git a/src/tests/data/oneof_object.json → jsf/tests/data/oneof_object.json b/src/tests/data/oneof_object.json → jsf/tests/data/oneof_object.json
diff --git a/src/tests/data/recursion.json → jsf/tests/data/recursion.json b/src/tests/data/recursion.json → jsf/tests/data/recursion.json
diff --git a/src/tests/data/string-enum.json → jsf/tests/data/string-enum.json b/src/tests/data/string-enum.json → jsf/tests/data/string-enum.json
diff --git a/src/tests/data/string-format.json → jsf/tests/data/string-format.json b/src/tests/data/string-format.json → jsf/tests/data/string-format.json
diff --git a/src/tests/data/string.json → jsf/tests/data/string.json b/src/tests/data/string.json → jsf/tests/data/string.json
diff --git a/src/tests/data/tuple.json → jsf/tests/data/tuple.json b/src/tests/data/tuple.json → jsf/tests/data/tuple.json
diff --git a/src/tests/data/type-list-null.json → jsf/tests/data/type-list-null.json b/src/tests/data/type-list-null.json → jsf/tests/data/type-list-null.json
diff --git a/src/tests/data/unique-items-array.json → jsf/tests/data/unique-items-array.json b/src/tests/data/unique-items-array.json → jsf/tests/data/unique-items-array.json
diff --git a/src/tests/test_cli.py → jsf/tests/test_cli.py b/src/tests/test_cli.py → jsf/tests/test_cli.py
@@ -1,11 +1,10 @@
 import json
 from pathlib import Path
 
+from jsf.cli import app
 from jsonschema import validate
 from typer.testing import CliRunner
 
-from jsf.cli import app
-
 runner = CliRunner()
 
 

diff --git a/src/tests/test_default_fake.py → jsf/tests/test_default_fake.py b/src/tests/test_default_fake.py → jsf/tests/test_default_fake.py
diff --git a/src/tests/test_model_gen.py → jsf/tests/test_model_gen.py b/src/tests/test_model_gen.py → jsf/tests/test_model_gen.py
@@ -4,9 +4,8 @@
 from typing import List
 
 import pytest  # pants: no-infer-dep
-from pydantic.main import create_model
-
 from jsf.parser import JSF
+from pydantic.main import create_model
 
 Object = create_model("Object")
 

diff --git a/src/tests/test_nullable_types_gen.py → jsf/tests/test_nullable_types_gen.py b/src/tests/test_nullable_types_gen.py → jsf/tests/test_nullable_types_gen.py
diff --git a/src/tests/test_parser.py → jsf/tests/test_parser.py b/src/tests/test_parser.py → jsf/tests/test_parser.py
@@ -1,8 +1,8 @@
 import json
 
 import pytest  # pants: no-infer-dep
-
 from jsf.parser import JSF
+
 from jsf.schema_types import (
     Array,
     Boolean,

diff --git a/src/tests/test_utils.py → jsf/tests/test_utils.py b/src/tests/test_utils.py → jsf/tests/test_utils.py
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -51,14 +51,11 @@ plugins:
       default_handler: python
       handlers:
         python:
-          setup_commands:
-            - import sys
-            - sys.path.append("src")
           rendering:
             show_root_heading: no
             show_if_no_docstring: no
       watch:
-        - src/jsf
+        - jsf
 
 extra:
   social:

diff --git a/pants.toml b/pants.toml
@@ -13,11 +13,6 @@ backend_packages = [
 [python]
 interpreter_constraints = ["CPython>=3.7,<4"]
 
-[source]
-root_patterns = [
-  '/src',
-]
-
 [flake8]
 config = ".flake8"
 

diff --git a/src/tests/__init__.py b/src/tests/__init__.py