Merge pull request #315 from smokestacklightnin/ci/testing/use-pytest

Add testing workflow and use `pytest`

Author: peytondmurray

.github/workflows/ci-test.yml

@@ -0,0 +1,39 @@
+# Github action definitions for unit-tests with PRs.
+
+name: tft-unit-tests
+on:
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+  workflow_dispatch:
+
+jobs:
+  unit-tests:
+    if: github.actor != 'copybara-service[bot]'
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+        cache-dependency-path: |
+          setup.py
+
+    - name: Install dependencies
+      run: |
+        pip install .[test]
+
+    - name: Run unit tests
+      shell: bash
+      run: |
+        pytest 

README.md

@@ -42,23 +42,28 @@ pip install tensorflow-transform
 To build from source follow the following steps:
 Create a virtual environment by running the commands
 
-```
-python3 -m venv <virtualenv_name>
+```bash
+python -m venv <virtualenv_name>
 source <virtualenv_name>/bin/activate
-pip3 install setuptools wheel
 git clone https://github.com/tensorflow/transform.git
 cd transform
-python3 setup.py bdist_wheel
+pip install .
 ```
 
-This will build the TFT wheel in the dist directory. To install the wheel from
-dist directory run the commands
+If you are doing development on the TFT repo, replace
 
+```bash
+pip install .
 ```
-cd dist
-pip3 install tensorflow_transform-<version>-py3-none-any.whl
+
+with
+
+```bash
+pip install -e .
 ```
 
+The `-e` flag causes TFT to be installed in [development mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html).
+
 ### Nightly Packages
 
 TFT also hosts nightly packages at https://pypi-nightly.tensorflow.org on
@@ -72,6 +77,14 @@ pip install --extra-index-url https://pypi-nightly.tensorflow.org/simple tensorf
 This will install the nightly packages for the major dependencies of TFT such
 as TensorFlow Metadata (TFMD), TFX Basic Shared Libraries (TFX-BSL).
 
+### Running Tests
+
+To run TFT tests, run the following command from the root of the repository:
+
+```bash
+pytest
+```
+
 ### Notable Dependencies
 
 TensorFlow is required.

pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+addopts = --import-mode=importlib
+testpaths = tensorflow_transform
+python_files = *_test.py
+norecursedirs = .* *.egg

setup.py

@@ -111,6 +111,7 @@ def _make_docs_packages():
     namespace_packages=[],
     install_requires=_make_required_install_packages(),
     extras_require= {
+      'test': ['pytest>=8.0'],
       'docs': _make_docs_packages(),
     },
     python_requires='>=3.9,<4',

tensorflow_transform/analyzers_test.py

@@ -624,5 +624,3 @@ def testMinDiffFromAvg(self):
         analyzers.calculate_recommended_min_diff_from_avg(100000000), 25)
 
 
-if __name__ == '__main__':
-  test_case.main()

tensorflow_transform/annotators_test.py

@@ -65,5 +65,3 @@ def preprocessing_fn():
     self.assertEqual(trackable_object, object_tracker.trackable_objects[0])
 
 
-if __name__ == '__main__':
-  test_case.main()

tensorflow_transform/beam/analysis_graph_builder_test.py

@@ -16,6 +16,7 @@
 import os
 import sys
 
+import pytest
 import tensorflow as tf
 import tensorflow_transform as tft
 from tensorflow_transform import analyzer_nodes
@@ -412,6 +413,8 @@ class AnalysisGraphBuilderTest(tft_unit.TransformTestCase):
           ],
       )
   )
+  @pytest.mark.xfail(run=False, reason="PR 315 This class contains tests that fail and needs to be fixed. "
+                     "If all tests pass, please remove this mark.")
   def test_build(
       self,
       feature_spec,
@@ -592,5 +595,3 @@ class _Analyzer(
                                        structured_outputs)
 
 
-if __name__ == '__main__':
-  tft_unit.main()

tensorflow_transform/beam/analyzer_cache_test.py

@@ -311,5 +311,3 @@ def expand(self, pbegin):
             beam_test_util.equal_to([test_cache_dict[key].cache_dict['b']]))
 
 
-if __name__ == '__main__':
-  test_case.main()

tensorflow_transform/beam/analyzer_impls_test.py

@@ -136,5 +136,3 @@ def testJoinBoundarieRows(self, input_boundaries, expected_boundaries,
     self.assertAllEqual(num_buckets, expected_num_buckets)
 
 
-if __name__ == '__main__':
-  tft_unit.main()

tensorflow_transform/beam/annotators_test.py

@@ -259,5 +259,3 @@ def preprocessing_fn(inputs):
     )
 
 
-if __name__ == '__main__':
-  tft_unit.main()