# Copyright 2021 Collate # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """ OpenMetadata high-level API Dashboard test """ import uuid from unittest import TestCase from metadata.generated.schema.api.data.createDashboard import ( CreateDashboardEntityRequest, ) from metadata.generated.schema.api.services.createDashboardService import ( CreateDashboardServiceEntityRequest, ) from metadata.generated.schema.api.teams.createUser import CreateUserEntityRequest from metadata.generated.schema.entity.data.dashboard import Dashboard from metadata.generated.schema.entity.services.dashboardService import ( DashboardService, DashboardServiceType, ) from metadata.generated.schema.type.entityReference import EntityReference from metadata.ingestion.ometa.ometa_api import OpenMetadata from metadata.ingestion.ometa.openmetadata_rest import MetadataServerConfig class OMetaDashboardTest(TestCase): """ Run this integration test with the local API available Install the ingestion package before running the tests """ service_entity_id = None server_config = MetadataServerConfig(api_endpoint="http://localhost:8585/api") metadata = OpenMetadata(server_config) assert metadata.health_check() user = metadata.create_or_update( data=CreateUserEntityRequest(name="random-user", email="random@user.com"), ) owner = EntityReference(id=user.id, type="user") service = CreateDashboardServiceEntityRequest( name="test-service-dashboard", serviceType=DashboardServiceType.Superset, dashboardUrl="https://localhost:1000", ) service_type = "dashboardService" @classmethod def setUpClass(cls) -> None: """ Prepare ingredients """ cls.service_entity = cls.metadata.create_or_update(data=cls.service) cls.entity = Dashboard( id=uuid.uuid4(), name="test", service=EntityReference(id=cls.service_entity.id, type=cls.service_type), fullyQualifiedName="test-service-dashboard.test", ) cls.create = CreateDashboardEntityRequest( name="test", service=EntityReference(id=cls.service_entity.id, type=cls.service_type), ) @classmethod def tearDownClass(cls) -> None: """ Clean up """ _id = str( cls.metadata.get_by_name( entity=Dashboard, fqdn="test-service-dashboard.test" ).id.__root__ ) service_id = str( cls.metadata.get_by_name( entity=DashboardService, fqdn="test-service-dashboard" ).id.__root__ ) cls.metadata.delete(entity=Dashboard, entity_id=_id) cls.metadata.delete(entity=DashboardService, entity_id=service_id) def test_create(self): """ We can create a Dashboard and we receive it back as Entity """ res = self.metadata.create_or_update(data=self.create) self.assertEqual(res.name, self.entity.name) self.assertEqual(res.service.id, self.entity.service.id) self.assertEqual(res.owner, None) def test_update(self): """ Updating it properly changes its properties """ res_create = self.metadata.create_or_update(data=self.create) updated = self.create.dict(exclude_unset=True) updated["owner"] = self.owner updated_entity = CreateDashboardEntityRequest(**updated) res = self.metadata.create_or_update(data=updated_entity) # Same ID, updated algorithm self.assertEqual(res.service.id, updated_entity.service.id) self.assertEqual(res_create.id, res.id) self.assertEqual(res.owner.id, self.user.id) def test_get_name(self): """ We can fetch a Dashboard by name and get it back as Entity """ self.metadata.create_or_update(data=self.create) res = self.metadata.get_by_name( entity=Dashboard, fqdn=self.entity.fullyQualifiedName ) self.assertEqual(res.name, self.entity.name) def test_get_id(self): """ We can fetch a Dashboard by ID and get it back as Entity """ self.metadata.create_or_update(data=self.create) # First pick up by name res_name = self.metadata.get_by_name( entity=Dashboard, fqdn=self.entity.fullyQualifiedName ) # Then fetch by ID res = self.metadata.get_by_id( entity=Dashboard, entity_id=str(res_name.id.__root__) ) self.assertEqual(res_name.id, res.id) def test_list(self): """ We can list all our Dashboards """ self.metadata.create_or_update(data=self.create) res = self.metadata.list_entities(entity=Dashboard, limit=100) # Fetch our test Database. We have already inserted it, so we should find it data = next( iter(ent for ent in res.entities if ent.name == self.entity.name), None ) assert data def test_delete(self): """ We can delete a Dashboard by ID """ self.metadata.create_or_update(data=self.create) # Find by name res_name = self.metadata.get_by_name( entity=Dashboard, fqdn=self.entity.fullyQualifiedName ) # Then fetch by ID res_id = self.metadata.get_by_id( entity=Dashboard, entity_id=str(res_name.id.__root__) ) # Delete self.metadata.delete(entity=Dashboard, entity_id=str(res_id.id.__root__)) # Then we should not find it res = self.metadata.list_entities(entity=Dashboard) assert not next( iter( ent for ent in res.entities if ent.fullyQualifiedName == self.entity.fullyQualifiedName ), None, )