Merge pull request #19 from intergral/coverage

chore(tests): add more tests and enforce test coverage

Author: Umaaz

.flake8

@@ -12,16 +12,14 @@ per-file-ignores =
     # ignore unused imports in __init__ files
     */__init__.py: F401
     # supress some docstring requirements in tests
-    test/__init__.py: D104
-    test/test_deep/__init__.py: D104
-    test/test_deep/*/__init__.py: D104,D107
-    test/test_deep/*/test_*.py: D101,D102,D107,D100,D105
-    test/test_deep/test_*.py: D101,D102,D107,D100,D105
-    test/test_deep/test_target.py: D102,D107,D103
+    tests/unit_tests/*.py: D
+    tests/unit_tests/**/*.py: D
     # these files are from OTEL so should use OTEL license.
     */deep/api/types.py: NCF102
     */deep/api/resource/__init__.py: NCF102
     */deep/api/attributes/__init__.py: NCF102
+    tests/unit_tests/api/attributes/*.py: NCF102,D
+    tests/unit_tests/api/resource/*.py: NCF102,D
 
 detailed-output = True
 copyright-regex =

.github/workflows/on_push.yaml

@@ -22,8 +22,26 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements.txt
           pip install -r dev-requirements.txt
+
       - name: Flake8
-        run: flake8
+        run: make lint
+
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Python # Set Python version
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+      # Install pip and pytest
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r dev-requirements.txt
+      - run: |
+          make coverage
 
   tests:
 
@@ -46,7 +64,7 @@ jobs:
           pip install -r dev-requirements.txt
           pip install .
       - name: Test with pytest
-        run: pytest test --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml
+        run: pytest tests/unit_tests --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml
       - name: Upload pytest test results
         uses: actions/upload-artifact@v3
         with:

.idea/misc.xml

@@ -16,7 +16,11 @@ endif
 
 .PHONY: test
 test:
-	pytest test
+	pytest tests/unit_tests
+
+.PHONY: coverage
+coverage:
+	pytest tests/unit_tests --cov=deep  --cov-report term --cov-fail-under=77 --cov-report html --cov-branch
 
 .PHONY: lint
 lint:

Makefile

@@ -7,10 +7,13 @@
       <sourceFolder url="file://$MODULE_DIR$/deep-extractor/src" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/examples/simple-app/src" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
-      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/tests" isTestSource="true" />
       <excludeFolder url="file://$MODULE_DIR$/venv/lib/python3.10/site-packages/deep" />
     </content>
-    <orderEntry type="jdk" jdkName="Python 3.10 (deep-python-client)" jdkType="Python SDK" />
+    <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>
+  <component name="PackageRequirementsSettings">
+    <option name="requirementsPath" value="requirements.txt, dev-requirments.txt" />
+  </component>
 </module>

deep-python-client.iml

@@ -10,3 +10,7 @@ flake8-docstrings
 certifi>=2023.7.22 # not directly required, pinned by Snyk to avoid a vulnerability
 flake8-header-validator>=0.0.3
 setuptools>=65.5.1 # not directly required, pinned by Snyk to avoid a vulnerability
+pytest-cov
+mockito
+opentelemetry-api
+opentelemetry-sdk

dev-requirements.txt

@@ -47,3 +47,15 @@ path = "src/deep/version.py"
 # read dependencies from reuirements.txt
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements.txt"]}
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "./src",
+    "./tests"
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "if TYPE_CHECKING:",
+    "@abc.abstractmethod"
+]

pyproject.toml

@@ -43,7 +43,7 @@ def _clean_attribute_value(
 
 
 def _clean_attribute(
-        key: str, value: types.AttributeValue, max_len: Optional[int]
+        key: str, value: Union[types.AttributeValue, Sequence[types.AttributeValue]], max_len: Optional[int]
 ) -> Optional[types.AttributeValue]:
     """
     Check if attribute value is valid and cleans it if required.

src/deep/api/attributes/__init__.py

@@ -68,6 +68,7 @@ def shutdown(self):
         if not self.started:
             return
         self.task_handler.flush()
+        self.poll.shutdown()
         self.started = False
 
     def register_tracepoint(self, path: str, line: int, args: Dict[str, str] = None,

src/deep/api/deep.py

@@ -38,24 +38,26 @@ def __plugin_generator(configured):
         try:
             module, cls = plugin.rsplit(".", 1)
             yield getattr(import_module(module), cls)
-            logging.debug('Did import default integration %s', plugin)
-        except (DidNotEnable, SyntaxError) as e:
+            logging.debug('Did import integration %s', plugin)
+        except (DidNotEnable, Exception) as e:
             logging.debug(
-                "Did not import default integration %s: %s", plugin, e
+                "Did not import integration %s: %s", plugin, e
             )
 
 
-def load_plugins() -> 'Tuple[list[Plugin], BoundedAttributes]':
+def load_plugins(custom=None) -> 'Tuple[list[Plugin], BoundedAttributes]':
     """
     Load all the deep plugins.
 
     Attempt to load each plugin, if successful merge a attributes list of each plugin.
 
     :return: the loaded plugins and attributes.
     """
+    if custom is None:
+        custom = []
     bounded_attributes = BoundedAttributes(immutable=False)
     loaded = []
-    for plugin in __plugin_generator(DEEP_PLUGINS):
+    for plugin in __plugin_generator(DEEP_PLUGINS + custom):
         try:
             plugin_instance = plugin()
             if not plugin_instance.is_active():