feat: Makefile for contrib for Issue #2364 (#2366)

kevjumba · adchia · web-flow · commit a02325b20f4d · 2022-03-07T20:57:23.000-08:00
* Add make file

Signed-off-by: Kevin Zhang &lt;kzhang@tecton.ai&gt;

* Fix makefile

Signed-off-by: Kevin Zhang &lt;kzhang@tecton.ai&gt;

* Clean up

Signed-off-by: Kevin Zhang &lt;kzhang@tecton.ai&gt;

* Add documentation

Signed-off-by: Kevin Zhang &lt;kzhang@tecton.ai&gt;

* Clean up

Signed-off-by: Kevin Zhang &lt;kzhang@tecton.ai&gt;

* Update documentation

Signed-off-by: Kevin Zhang &lt;kzhang@tecton.ai&gt;

* update make target

Signed-off-by: Kevin Zhang &lt;kzhang@tecton.ai&gt;

Co-authored-by: Danny Chiao &lt;danny@tecton.ai&gt;
diff --git a/Makefile b/Makefile
@@ -72,6 +72,9 @@ test-python:
 test-python-integration:
 	FEAST_USAGE=False IS_TEST=True python -m pytest -n 8 --integration sdk/python/tests
 
+test-python-universal-contrib:
+	PYTHONPATH='.' FULL_REPO_CONFIGS_MODULE=sdk.python.feast.infra.offline_stores.contrib.contrib_repo_configuration FEAST_USAGE=False IS_TEST=True python -m pytest -n 8 --integration --universal sdk/python/tests
+
 test-python-universal-local:
 	FEAST_USAGE=False IS_TEST=True FEAST_IS_LOCAL_TEST=True python -m pytest -n 8 --integration --universal sdk/python/tests
 
@@ -198,4 +201,4 @@ build-sphinx: compile-protos-python
 	cd 	$(ROOT_DIR)/sdk/python/docs && $(MAKE) build-api-source
 
 build-templates:
-	python infra/scripts/compile-templates.py
+	python infra/scripts/compile-templates.py
diff --git a/docs/how-to-guides/adding-or-reusing-tests.md b/docs/how-to-guides/adding-or-reusing-tests.md
@@ -161,6 +161,13 @@ The key fixtures are the `environment` and `universal_data_sources` fixtures, wh
 * In `repo_configuration.py` add a new`IntegrationTestRepoConfig` or two (depending on how many online stores you want to test).
 * Run the full test suite with `make test-python-integration.`
 
+### Including a new offline / online store in the main Feast repo from external plugins with community maintainers.
+
+* This folder is for plugins that are officially maintained with community owners. Place the APIs in feast/infra/offline_stores/contrib/.
+* Extend `data_source_creator.py` for your offline store and implement the required APIs.
+* In `contrib_repo_configuration.py` add a new `IntegrationTestRepoConfig` (depending on how many online stores you want to test).
+* Run the test suite on the contrib test suite with `make test-python-contrib-universal`.
+
 ### To include a new online store
 
 * In `repo_configuration.py` add a new config that maps to a serialized version of configuration you need in `feature_store.yaml` to setup the online store.
diff --git a/sdk/python/feast/infra/offline_stores/contrib/__init__.py b/sdk/python/feast/infra/offline_stores/contrib/__init__.py
diff --git a/sdk/python/feast/infra/offline_stores/contrib/contrib_repo_configuration.py b/sdk/python/feast/infra/offline_stores/contrib/contrib_repo_configuration.py
@@ -0,0 +1,10 @@
+from tests.integration.feature_repos.integration_test_repo_config import (
+    IntegrationTestRepoConfig,
+)
+from tests.integration.feature_repos.universal.data_sources.spark_data_source_creator import (
+    SparkDataSourceCreator,
+)
+
+FULL_REPO_CONFIGS = [
+    IntegrationTestRepoConfig(offline_store_creator=SparkDataSourceCreator)
+]
