Merge pull request #105 from tarilabs/tarilabs-20240806-sync

periodic sync upstream KF to midstream ODH

.github/workflows/ui-frontend-build.yml

@@ -23,6 +23,10 @@ jobs:
         working-directory: clients/ui/frontend
         run: npm install
 
+      - name: Run tests
+        working-directory: clients/ui/frontend
+        run: npm run test:cypress-ci
+
       - name: Clean
         working-directory: clients/ui/frontend
         run: npm run build:clean

.openapi-generator-ignore

@@ -45,3 +45,5 @@ internal/server/openapi/.openapi-generator-ignore
 internal/server/openapi/api_model_registry_service_service.go
 internal/server/openapi/README.md
 internal/server/openapi/main.go
+internal/server/openapi/error.go
+internal/server/openapi/helpers.go

clients/python/Makefile

@@ -22,7 +22,6 @@ lint:
 
 .PHONY: tidy
 tidy:
-	rm -rf src/mr_openapi/docs
 	poetry run ruff check --fix --unsafe-fixes || true
 	poetry run black src/mr_openapi
 

clients/python/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "model-registry"
-version = "0.2.4a1"
+version = "0.2.5a1"
 description = "Client for Kubeflow Model Registry"
 authors = ["Isabella Basso do Amaral <[email protected]>"]
 license = "Apache-2.0"

clients/python/src/.openapi-generator-ignore

@@ -21,3 +21,7 @@
 #docs/*.md
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
+
+# Model Registry OpenAPI:
+# Do not generate markdown for models coming from OpenAPI
+mr_openapi/docs/*.md

clients/python/src/.openapi-generator/FILES

@@ -4,59 +4,6 @@ mr_openapi/api/model_registry_service_api.py
 mr_openapi/api_client.py
 mr_openapi/api_response.py
 mr_openapi/configuration.py
-mr_openapi/docs/Artifact.md
-mr_openapi/docs/ArtifactList.md
-mr_openapi/docs/ArtifactState.md
-mr_openapi/docs/BaseArtifact.md
-mr_openapi/docs/BaseArtifactCreate.md
-mr_openapi/docs/BaseArtifactUpdate.md
-mr_openapi/docs/BaseExecution.md
-mr_openapi/docs/BaseExecutionCreate.md
-mr_openapi/docs/BaseExecutionUpdate.md
-mr_openapi/docs/BaseResource.md
-mr_openapi/docs/BaseResourceCreate.md
-mr_openapi/docs/BaseResourceList.md
-mr_openapi/docs/BaseResourceUpdate.md
-mr_openapi/docs/DocArtifact.md
-mr_openapi/docs/Error.md
-mr_openapi/docs/ExecutionState.md
-mr_openapi/docs/InferenceService.md
-mr_openapi/docs/InferenceServiceCreate.md
-mr_openapi/docs/InferenceServiceList.md
-mr_openapi/docs/InferenceServiceState.md
-mr_openapi/docs/InferenceServiceUpdate.md
-mr_openapi/docs/MetadataBoolValue.md
-mr_openapi/docs/MetadataDoubleValue.md
-mr_openapi/docs/MetadataIntValue.md
-mr_openapi/docs/MetadataProtoValue.md
-mr_openapi/docs/MetadataStringValue.md
-mr_openapi/docs/MetadataStructValue.md
-mr_openapi/docs/MetadataValue.md
-mr_openapi/docs/ModelArtifact.md
-mr_openapi/docs/ModelArtifactCreate.md
-mr_openapi/docs/ModelArtifactList.md
-mr_openapi/docs/ModelArtifactUpdate.md
-mr_openapi/docs/ModelRegistryServiceApi.md
-mr_openapi/docs/ModelVersion.md
-mr_openapi/docs/ModelVersionCreate.md
-mr_openapi/docs/ModelVersionList.md
-mr_openapi/docs/ModelVersionState.md
-mr_openapi/docs/ModelVersionUpdate.md
-mr_openapi/docs/OrderByField.md
-mr_openapi/docs/RegisteredModel.md
-mr_openapi/docs/RegisteredModelCreate.md
-mr_openapi/docs/RegisteredModelList.md
-mr_openapi/docs/RegisteredModelState.md
-mr_openapi/docs/RegisteredModelUpdate.md
-mr_openapi/docs/ServeModel.md
-mr_openapi/docs/ServeModelCreate.md
-mr_openapi/docs/ServeModelList.md
-mr_openapi/docs/ServeModelUpdate.md
-mr_openapi/docs/ServingEnvironment.md
-mr_openapi/docs/ServingEnvironmentCreate.md
-mr_openapi/docs/ServingEnvironmentList.md
-mr_openapi/docs/ServingEnvironmentUpdate.md
-mr_openapi/docs/SortOrder.md
 mr_openapi/exceptions.py
 mr_openapi/models/__init__.py
 mr_openapi/models/artifact.py
@@ -113,4 +60,57 @@ mr_openapi/models/serving_environment_update.py
 mr_openapi/models/sort_order.py
 mr_openapi/rest.py
 mr_openapi/test/__init__.py
+mr_openapi/test/test_artifact.py
+mr_openapi/test/test_artifact_list.py
+mr_openapi/test/test_artifact_state.py
+mr_openapi/test/test_base_artifact.py
+mr_openapi/test/test_base_artifact_create.py
+mr_openapi/test/test_base_artifact_update.py
+mr_openapi/test/test_base_execution.py
+mr_openapi/test/test_base_execution_create.py
+mr_openapi/test/test_base_execution_update.py
+mr_openapi/test/test_base_resource.py
+mr_openapi/test/test_base_resource_create.py
+mr_openapi/test/test_base_resource_list.py
+mr_openapi/test/test_base_resource_update.py
+mr_openapi/test/test_doc_artifact.py
+mr_openapi/test/test_error.py
+mr_openapi/test/test_execution_state.py
+mr_openapi/test/test_inference_service.py
+mr_openapi/test/test_inference_service_create.py
+mr_openapi/test/test_inference_service_list.py
+mr_openapi/test/test_inference_service_state.py
+mr_openapi/test/test_inference_service_update.py
+mr_openapi/test/test_metadata_bool_value.py
+mr_openapi/test/test_metadata_double_value.py
+mr_openapi/test/test_metadata_int_value.py
+mr_openapi/test/test_metadata_proto_value.py
+mr_openapi/test/test_metadata_string_value.py
+mr_openapi/test/test_metadata_struct_value.py
+mr_openapi/test/test_metadata_value.py
+mr_openapi/test/test_model_artifact.py
+mr_openapi/test/test_model_artifact_create.py
+mr_openapi/test/test_model_artifact_list.py
+mr_openapi/test/test_model_artifact_update.py
+mr_openapi/test/test_model_registry_service_api.py
+mr_openapi/test/test_model_version.py
+mr_openapi/test/test_model_version_create.py
+mr_openapi/test/test_model_version_list.py
+mr_openapi/test/test_model_version_state.py
+mr_openapi/test/test_model_version_update.py
+mr_openapi/test/test_order_by_field.py
+mr_openapi/test/test_registered_model.py
+mr_openapi/test/test_registered_model_create.py
+mr_openapi/test/test_registered_model_list.py
+mr_openapi/test/test_registered_model_state.py
+mr_openapi/test/test_registered_model_update.py
+mr_openapi/test/test_serve_model.py
+mr_openapi/test/test_serve_model_create.py
+mr_openapi/test/test_serve_model_list.py
+mr_openapi/test/test_serve_model_update.py
+mr_openapi/test/test_serving_environment.py
+mr_openapi/test/test_serving_environment_create.py
+mr_openapi/test/test_serving_environment_list.py
+mr_openapi/test/test_serving_environment_update.py
+mr_openapi/test/test_sort_order.py
 mr_openapi_README.md

clients/python/src/model_registry/__init__.py

@@ -1,6 +1,6 @@
 """Main package for the Kubeflow model registry."""
 
-__version__ = "0.2.4a1"
+__version__ = "0.2.5a1"
 
 from ._client import ModelRegistry
 

clients/ui/frontend/.env.cypress.mock

@@ -0,0 +1,2 @@
+# Test against prod build hosted by lightweight http server
+BASE_URL=http://localhost:9001

clients/ui/frontend/CONTRIBUTING.md

@@ -30,7 +30,7 @@ Once you have both services ready, you can open the dashboard locally at: `http:
 
 ## Debugging and Testing
 
-[TBD]
+See [frontend testing guidelines](docs/testing.md) for more information.
 
 ## Environment variables
 

clients/ui/frontend/docs/dev-setup.md

@@ -44,10 +44,10 @@ For in-depth local run guidance review the [contribution guidelines](../CONTRIBU
 
 ### Testing
 
-Run the tests.
+Run the mock tests.
 
   ```bash
-  npm run test
+  npm run test:cypress-ci
   ```
 
 For in-depth testing guidance review the [testing guidelines](./testing.md)

clients/ui/frontend/docs/testing.md

@@ -1,3 +1,36 @@
 # Model Registry UI Testing
 
-[TBD]
+## Cypress Tests
+
+Cypress is used to run tests against the frontend while mocking all network requests.
+
+Single command to run all Cypress tests or a specific test (build frontend, start HTTP server, run Cypress):
+
+```bash
+npm run test:cypress-ci
+
+npm run test:cypress-ci -- --spec "**/testfile.cy.ts"
+```
+
+Cypress tests require a frontend server to be running.
+
+To best match production, build the frontend and use a lightweight HTTP server to host the files. This method will require manual rebuilds when changes are made to the dashboard frontend code.
+
+```bash
+npm run cypress:server:build
+npm run cypress:server
+```
+
+To run all Cypress tests or a specific test headless
+
+```bash
+npm run cypress:run:mock
+
+npm run cypress:run:mock -- --spec "**/testfile.cy.ts"
+```
+
+To open the Cypress GUI run
+
+```bash
+npm run cypress:open:mock
+```