test(instill): improve unit test coverage (#287)

Because

- the unit test coverage was pretty poor and the structure wasn't
organized well

This commit

- improved the unit test coverage

Author: pinglin

.coveragerc

@@ -8,6 +8,7 @@ omit =
     .venv/*
     */tests/*
     */__main__.py
+    instill/protogen/*
 
 [report]
 

.github/CONTRIBUTING.md

@@ -27,10 +27,6 @@ Before delving into the details to come up with your first PR, please familiaris
 
 To confirm these system dependencies are configured correctly:
 
-```shell
-make doctor
-```
-
 #### Installation
 
 Fetch git submodules:

.github/workflows/build.yml

@@ -23,9 +23,6 @@ jobs:
         with:
           poetry-version: 2.1.2
 
-      - name: Check dependencies
-        run: make doctor
-
       - uses: actions/cache@v4
         with:
           path: .venv

.github/workflows/publish.yml

@@ -18,12 +18,11 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
-      - uses: Gr1N/setup-poetry@v8
-
-      - name: Check dependencies
-        run: make doctor
+      - uses: abatilo/actions-poetry@v4
+        with:
+          poetry-version: 2.1.2
 
       - uses: actions/cache@v3
         with:

Makefile

@@ -67,9 +67,6 @@ PYTEST_OPTIONS += --cov-report=xml
 endif
 PYTEST_RERUN_OPTIONS := --last-failed --exitfirst
 
-.PHONY: test
-test: test-all ## Run unit and integration tests
-
 .PHONY: test-unit
 test-unit: install
 	@ ( mv $(FAILURES) $(FAILURES).bak || true ) > /dev/null 2>&1
@@ -79,23 +76,8 @@ ifndef DISABLE_COVERAGE
 	poetry run coveragespace update unit
 endif
 
-.PHONY: test-int
-test-int: install
-	@ if test -e $(FAILURES); then poetry run pytest tests $(PYTEST_RERUN_OPTIONS); fi
-	@ rm -rf $(FAILURES)
-	poetry run pytest tests $(PYTEST_OPTIONS)
-ifndef DISABLE_COVERAGE
-	poetry run coveragespace update integration
-endif
-
-.PHONY: test-all
-test-all: install
-	@ if test -e $(FAILURES); then poetry run pytest $(PACKAGE) tests $(PYTEST_RERUN_OPTIONS); fi
-	@ rm -rf $(FAILURES)
-	poetry run pytest $(PACKAGE) tests $(PYTEST_OPTIONS)
-ifndef DISABLE_COVERAGE
-	poetry run coveragespace update overall
-endif
+.PHONY: test
+test: test-unit
 
 .PHONY: read-coverage
 read-coverage:
@@ -105,18 +87,18 @@ read-coverage:
 
 .PHONY: format
 format: install
-	poetry run isort $(PACKAGE) tests notebooks
-	poetry run black $(PACKAGE) tests notebooks
+	poetry run isort $(PACKAGE) notebooks
+	poetry run black $(PACKAGE) notebooks
 	@ echo
 
 .PHONY: check
 check: install format ## Run formatters, linters, and static analysis
 ifdef CI
 	git diff --exit-code
 endif
-	poetry run mypy $(PACKAGE) tests
-	poetry run pylint $(PACKAGE) tests --rcfile=.pylint.ini
-	poetry run pydocstyle $(PACKAGE) tests
+	poetry run mypy $(PACKAGE)
+	poetry run pylint $(PACKAGE) --rcfile=.pylint.ini
+	poetry run pydocstyle $(PACKAGE)
 
 # DOCUMENTATION ###############################################################
 
@@ -195,7 +177,7 @@ clean-all: clean
 
 .PHONY: .clean-install
 .clean-install:
-	find $(PACKAGE) tests -name '__pycache__' -delete
+	find $(PACKAGE) -name '__pycache__' -delete
 	rm -rf *.egg-info
 
 .PHONY: .clean-test

README.md

@@ -1,6 +1,6 @@
 # Instill Core Python SDK
 
-[![Unix Build Status](https://img.shields.io/github/actions/workflow/status/instill-ai/python-sdk/build.yml?branch=main&label=linux)](https://github.com/instill-ai/python-sdk/actions) [![Coverage Status](https://img.shields.io/codecov/c/gh/instill-ai/python-sdk)](https://codecov.io/gh/instill-ai/python-sdk) [![PyPI License](https://img.shields.io/pypi/l/instill-sdk.svg?color=lightgreen)](https://pypi.org/project/instill-sdk) [![PyPI Version](https://img.shields.io/pypi/v/instill-sdk.svg?color=lightgreen)](https://pypi.org/project/instill-sdk) [![PyPI Downloads](https://img.shields.io/pypi/dm/instill-sdk.svg?color=lightgreen)](https://pypistats.org/packages/instill-sdk)
+[![Unix Build Status](https://img.shields.io/github/actions/workflow/status/instill-ai/python-sdk/build.yml?branch=main&label=linux)](https://github.com/instill-ai/python-sdk/actions) [![Coverage Status](https://img.shields.io/codecov/c/gh/instill-ai/python-sdk)](https://codecov.io/gh/instill-ai/python-sdk) [![PyPI License](https://img.shields.io/pypi/l/instill-sdk.svg?color=blue)](https://pypi.org/project/instill-sdk) [![PyPI Version](https://img.shields.io/pypi/v/instill-sdk.svg?color=blue)](https://pypi.org/project/instill-sdk) [![PyPI Downloads](https://img.shields.io/pypi/dm/instill-sdk.svg?color=blue)](https://pypistats.org/packages/instill-sdk)
 
 > [!IMPORTANT]
 > **This SDK tool is under active development**
@@ -103,7 +103,7 @@ hosts:
 If you do not like the idea of having to create a config file, you can also setup your target instance by doing the following at the very beginning of your script.
 
 ```python
-from instill.configuration import global_config
+from instill.config import global_config
 
 global_config.set_default(
     url="api.instill-ai.com",

instill/clients/constant.py

@@ -48,7 +48,9 @@ def load(self) -> None:
             return
         try:
             with open(path, "r", encoding="utf-8") as c:
-                self._config = _Config.validate(yaml.load(c, Loader=yaml.FullLoader))
+                self._config = _Config.model_validate(
+                    yaml.load(c, Loader=yaml.FullLoader)
+                )
         except Exception as e:
             raise BaseException(f"Invalid configuration file at '{path}'") from e
 
@@ -60,7 +62,7 @@ def save(self) -> None:
         with open(path, "w", encoding="utf-8") as c:
             yaml.dump(
                 json.loads(
-                    self._config.json(
+                    self._config.model_dump_json(
                         exclude_none=True,
                     )
                 ),