Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tests for version details and Refactoring model registry folder structure #2786

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions frontend/src/__mocks__/mockModelArtifact.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { ModelArtifact } from '~/concepts/modelRegistry/types';

export const mockModelArtifact = (): ModelArtifact => ({
createTimeSinceEpoch: '1712234877179',
id: '1',
lastUpdateTimeSinceEpoch: '1712234877179',
name: 'fraud detection model version 1',
description: 'Description of model version',
artifactType: 'model-artifact',
customProperties: {},
storagePath: 'test path',
uri: 'https://huggingface.io/mnist.onnx',
});
10 changes: 10 additions & 0 deletions frontend/src/__mocks__/mockModelArtifactList.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/* eslint-disable camelcase */
import { ModelArtifactList } from '~/concepts/modelRegistry/types';
import { mockModelArtifact } from './mockModelArtifact';

export const mockModelArtifactList = (): ModelArtifactList => ({
items: [mockModelArtifact()],
nextPageToken: '',
pageSize: 0,
size: 1,
});
1 change: 1 addition & 0 deletions frontend/src/__mocks__/mockModelVersion.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ export const mockModelVersion = ({
name,
state: ModelVersionState.ARCHIVED,
registeredModelId,
description: 'Description of model version',
});
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ describe('Model Registry', () => {

modelRegistry.tabEnabled();
});

it('No registered models in the selected Model Registry', () => {
initIntercepts({
disableModelRegistryFeature: false,
Expand All @@ -92,7 +93,7 @@ describe('Model Registry', () => {
modelRegistry.shouldregisteredModelsEmpty();
});

it('Model registry table', () => {
it('Registered model table', () => {
initIntercepts({
disableModelRegistryFeature: false,
});
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
/* eslint-disable camelcase */
import {
mockDashboardConfig,
mockK8sResourceList,
mockRouteK8sResourceModelRegistry,
} from '~/__mocks__';
import { mockComponents } from '~/__mocks__/mockComponents';
import { mockModelRegistry } from '~/__mocks__/mockModelRegistry';
import { ModelRegistryModel, RouteModel } from '~/__tests__/cypress/cypress/utils/models';
import { MODEL_REGISTRY_API_VERSION } from '~/concepts/modelRegistry/const';
import { modelVersionDetails } from '~/__tests__/cypress/cypress/pages/modelRegistry/modelVersionDetails';
import { mockRegisteredModel } from '~/__mocks__/mockRegisteredModel';
import { mockModelVersion } from '~/__mocks__/mockModelVersion';
import { mockModelVersionList } from '~/__mocks__/mockModelVersionList';
import { mockModelArtifactList } from '~/__mocks__/mockModelArtifactList';
import { verifyRelativeURL } from '~/__tests__/cypress/cypress/utils/url';
import { ModelRegistryMetadataType } from '~/concepts/modelRegistry/types';

const initIntercepts = () => {
cy.interceptOdh(
'GET /api/config',
mockDashboardConfig({
disableModelRegistry: false,
}),
);
cy.interceptOdh('GET /api/components', { query: { installed: 'true' } }, mockComponents());

cy.interceptK8sList(ModelRegistryModel, mockK8sResourceList([mockModelRegistry({})]));

cy.interceptK8s(ModelRegistryModel, mockModelRegistry({}));

cy.interceptK8s(
RouteModel,
mockRouteK8sResourceModelRegistry({
name: 'modelregistry-sample-http',
namespace: 'odh-model-registries',
}),
);

cy.interceptOdh(
`GET /api/service/modelregistry/modelregistry-sample/api/model_registry/${MODEL_REGISTRY_API_VERSION}/registered_models/1`,
mockRegisteredModel({}),
);

cy.interceptOdh(
`GET /api/service/modelregistry/modelregistry-sample/api/model_registry/${MODEL_REGISTRY_API_VERSION}/registered_models/1/versions`,
mockModelVersionList({
items: [
mockModelVersion({ name: 'Version 1', author: 'Author 1', registeredModelId: '1' }),
mockModelVersion({
author: 'Author 2',
registeredModelId: '1',
id: '2',
name: 'Version 2',
}),
],
}),
);

cy.interceptOdh(
`GET /api/service/modelregistry/modelregistry-sample/api/model_registry/${MODEL_REGISTRY_API_VERSION}/model_versions/:id`,
{ path: { id: '1' } },
mockModelVersion({
id: '1',
name: 'Version 1',
customProperties: {
'Testing label': {
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
Financial: {
metadataType: ModelRegistryMetadataType.STRING,
string_value: 'non-empty',
},
'Financial data': {
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Fraud detection': {
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Long label data to be truncated abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc abc':
{
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Machine learning': {
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Next data to be overflow': {
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Label x': {
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Label y': {
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Label z': {
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
},
}),
);

cy.interceptOdh(
`GET /api/service/modelregistry/modelregistry-sample/api/model_registry/${MODEL_REGISTRY_API_VERSION}/model_versions/:id`,
{ path: { id: '2' } },
mockModelVersion({ id: '2', name: 'Version 2' }),
);

cy.interceptOdh(
`GET /api/service/modelregistry/modelregistry-sample/api/model_registry/${MODEL_REGISTRY_API_VERSION}/model_versions/1/artifacts`,
mockModelArtifactList(),
);
};

describe('Model version details', () => {
beforeEach(() => {
initIntercepts();
modelVersionDetails.visit();
});

it('Model version details page header', () => {
verifyRelativeURL('/modelRegistry/modelregistry-sample/registeredModels/1/versions/1/details');
cy.findByTestId('app-page-title').should('have.text', 'Version 1');
cy.findByTestId('breadcrumb-version-name').should('have.text', 'Version 1');
});

it('Model version details tab', () => {
modelVersionDetails.findVersionId().contains('1');
modelVersionDetails.findDescription().should('have.text', 'Description of model version');
modelVersionDetails.findMoreLabelsButton().contains('6 more');
modelVersionDetails.findMoreLabelsButton().click();
modelVersionDetails.shouldContainsModalLabels([
'Testing label',
'Financial',
'Financial data',
'Fraud detection',
'Machine learning',
'Next data to be overflow',
'Label x',
'Label y',
'Label z',
]);
modelVersionDetails.findStorageLocation().contains('https://huggingface.io/mnist.onnx');
});

it('Switching model versions', () => {
modelVersionDetails.findVersionId().contains('1');
modelVersionDetails.findModelVersionDropdownButton().click();
modelVersionDetails.findModelVersionDropdownSearch().fill('Version 2');
modelVersionDetails.findModelVersionDropdownItem('Version 2').click();
modelVersionDetails.findVersionId().contains('2');
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { be } from '~/__tests__/cypress/cypress/utils/should';
import { ModelRegistryModel } from '~/__tests__/cypress/cypress/utils/models';
import { verifyRelativeURL } from '~/__tests__/cypress/cypress/utils/url';
import { mockRegisteredModel } from '~/__mocks__/mockRegisteredModel';
import { ModelVersion } from '~/concepts/modelRegistry/types';
import { ModelRegistryMetadataType, ModelVersion } from '~/concepts/modelRegistry/types';
import { mockModelVersion } from '~/__mocks__/mockModelVersion';

type HandlersProps = {
Expand All @@ -28,39 +28,39 @@ const initIntercepts = ({
id: '1',
customProperties: {
Financial: {
metadataType: 'MetadataStringValue',
metadataType: ModelRegistryMetadataType.STRING,
string_value: 'non-empty',
},
'Financial data': {
metadataType: 'MetadataStringValue',
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Fraud detection': {
metadataType: 'MetadataStringValue',
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Test label': {
metadataType: 'MetadataStringValue',
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Machine learning': {
metadataType: 'MetadataStringValue',
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Next data to be overflow': {
metadataType: 'MetadataStringValue',
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Test label x': {
metadataType: 'MetadataStringValue',
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Test label y': {
metadataType: 'MetadataStringValue',
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
'Test label z': {
metadataType: 'MetadataStringValue',
metadataType: ModelRegistryMetadataType.STRING,
string_value: '',
},
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { modelVersionUrl } from '~/pages/modelRegistry/screens/routeUtils';

class ModelVersionDetails {
visit() {
cy.visit(modelVersionUrl('1', '1', 'modelregistry-sample'));
this.wait();
}

private wait() {
cy.findByTestId('app-page-title').should('exist');
cy.testA11y();
}

findVersionId() {
return cy.findByTestId('model-version-id');
}

findDescription() {
return cy.findByTestId('model-version-description');
}

findMoreLabelsButton() {
return cy.findByTestId('label-group').find('button');
}

findStorageLocation() {
return cy.findByTestId('storage-location');
}

shouldContainsModalLabels(labels: string[]) {
cy.findByTestId('label-group').within(() => labels.map((label) => cy.contains(label)));
return this;
}

findModelVersionDropdownButton() {
return cy.findByTestId('model-version-toggle-button');
}

findModelVersionDropdownSearch() {
return cy.findByTestId('search-input');
}

findModelVersionDropdownItem(name: string) {
return cy.findByTestId('model-version-selector-list').find('li').contains(name);
}
}

export const modelVersionDetails = new ModelVersionDetails();
24 changes: 21 additions & 3 deletions frontend/src/__tests__/cypress/cypress/support/commands/odh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import { K8sResourceListResult, K8sStatus } from '@openshift/dynamic-plugin-sdk-
import type { GenericStaticResponse, RouteHandlerController } from 'cypress/types/net-stubbing';
import { BaseMetricCreationResponse, BaseMetricListResponse } from '~/api';
import {
ModelArtifactList,
ModelVersion,
ModelVersionList,
RegisteredModel,
RegisteredModelList,
Expand Down Expand Up @@ -321,16 +323,32 @@ declare global {
): Cypress.Chainable<null>;

interceptOdh(
type: 'DELETE /api/service/pipelines/:projectId/dspa/apis/v2beta1/recurringruns/:pipeline_id',
options: { path: { projectId: string; pipeline_id: string } },
response: OdhResponse<K8sStatus>,
type: `GET /api/service/modelregistry/modelregistry-sample/api/model_registry/v1alpha3/registered_models/1`,
response: OdhResponse<RegisteredModel | undefined>,
): Cypress.Chainable<null>;

interceptOdh(
type: `GET /api/service/modelregistry/modelregistry-sample/api/model_registry/v1alpha3/model_versions/:id`,
options: { path: { id: string } },
response: OdhResponse<ModelVersion | undefined>,
): Cypress.Chainable<null>;

interceptOdh(
type: `GET /api/service/modelregistry/modelregistry-sample/api/model_registry/v1alpha3/model_versions/1/artifacts`,
response: OdhResponse<ModelArtifactList | undefined>,
): Cypress.Chainable<null>;

interceptOdh(
type: 'GET /api/service/modelregistry/modelregistry-sample/api/model_registry/v1alpha3/registered_models/1/versions',
response: OdhResponse<ModelVersionList | undefined>,
): Cypress.Chainable<null>;

interceptOdh(
type: 'DELETE /api/service/pipelines/:projectId/dspa/apis/v2beta1/recurringruns/:pipeline_id',
options: { path: { projectId: string; pipeline_id: string } },
response: OdhResponse<K8sStatus>,
): Cypress.Chainable<null>;

interceptOdh(
type: 'GET /api/rolebindings/opendatahub/openshift-ai-notebooks-image-pullers',
response: OdhResponse<K8sResourceListResult<RoleBindingKind>>,
Expand Down
13 changes: 10 additions & 3 deletions frontend/src/components/EditableLabelsDescriptionListGroup.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,18 @@ const EditableLabelsDescriptionListGroup: React.FC<EditableTextDescriptionListGr
isSavingEdits={isSavingEdits}
contentWhenEditing={
<LabelGroup
data-testid="label-group"
isEditable={!isSavingEdits}
numLabels={unsavedLabels.length}
addLabelControl={
!isSavingEdits && (
<Label color="blue" variant="outline" isOverflowLabel onClick={toggleAddLabelModal}>
<Label
textMaxWidth="40ch"
color="blue"
variant="outline"
isOverflowLabel
onClick={toggleAddLabelModal}
>
Add label
</Label>
)
Expand Down Expand Up @@ -151,9 +158,9 @@ const EditableLabelsDescriptionListGroup: React.FC<EditableTextDescriptionListGr
setIsEditing(false);
}}
>
<LabelGroup>
<LabelGroup data-testid="label-group">
{labels.map((label) => (
<Label key={label} color="blue" data-testid="label">
<Label textMaxWidth="40ch" key={label} color="blue" data-testid="label">
{label}
</Label>
))}
Expand Down
Loading
Loading