+1
-1
@@ -16,7 +16,7 @@
|
||||
|
||||
import { BuildTable } from '../BuildTable/BuildTable';
|
||||
import React from 'react';
|
||||
import { useBuildRuns } from '../../hooks/useBuildRuns';
|
||||
import { useBuildRuns } from '../../hooks';
|
||||
import { useEntity } from '@backstage/plugin-catalog-react';
|
||||
|
||||
export const EntityPageAzurePipelines = (props: { defaultLimit?: number }) => {
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
export * from './useAllTeams';
|
||||
export * from './useDashboardPullRequests';
|
||||
export * from './usePullRequests';
|
||||
export * from './useRepoBuilds';
|
||||
export * from './useUserEmail';
|
||||
export * from './useUserTeamIds';
|
||||
export * from './useReadme';
|
||||
export * from './useBuildRuns';
|
||||
|
||||
@@ -1,126 +0,0 @@
|
||||
/*
|
||||
* Copyright 2021 The Backstage Authors
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import React from 'react';
|
||||
import { renderHook, waitFor } from '@testing-library/react';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { RepoBuild } from '@backstage/plugin-azure-devops-common';
|
||||
import { TestApiProvider } from '@backstage/test-utils';
|
||||
import { AzureDevOpsApi, azureDevOpsApiRef } from '../api';
|
||||
import { useRepoBuilds } from './useRepoBuilds';
|
||||
|
||||
describe('useRepoBuilds', () => {
|
||||
const azureDevOpsApiMock = {
|
||||
getRepoBuilds: jest.fn(),
|
||||
};
|
||||
const azureDevOpsApi =
|
||||
azureDevOpsApiMock as Partial<AzureDevOpsApi> as AzureDevOpsApi;
|
||||
|
||||
const Wrapper = (props: { children?: React.ReactNode }) => (
|
||||
<TestApiProvider apis={[[azureDevOpsApiRef, azureDevOpsApi]]}>
|
||||
{props.children}
|
||||
</TestApiProvider>
|
||||
);
|
||||
|
||||
it('should provide an array of RepoBuild', async () => {
|
||||
const entity: Entity = {
|
||||
apiVersion: 'backstage.io/v1alpha1',
|
||||
kind: 'Component',
|
||||
metadata: {
|
||||
namespace: 'default',
|
||||
name: 'project-repo',
|
||||
annotations: {
|
||||
'dev.azure.com/project-repo': 'projectName/repoName',
|
||||
},
|
||||
},
|
||||
};
|
||||
const repoBuilds: RepoBuild[] = [
|
||||
{
|
||||
id: 1,
|
||||
title: 'title-1',
|
||||
source: 'awanlin',
|
||||
link: 'https://dev.azure.com/org/project/repo',
|
||||
},
|
||||
{
|
||||
id: 2,
|
||||
title: 'title-2',
|
||||
source: 'awanlin',
|
||||
link: 'https://dev.azure.com/org/project/repo',
|
||||
},
|
||||
{
|
||||
id: 3,
|
||||
title: 'title-3',
|
||||
source: 'awanlin',
|
||||
link: 'https://dev.azure.com/org/project/repo',
|
||||
},
|
||||
];
|
||||
azureDevOpsApiMock.getRepoBuilds.mockResolvedValue({
|
||||
items: repoBuilds,
|
||||
});
|
||||
const { result } = renderHook(() => useRepoBuilds(entity), {
|
||||
wrapper: Wrapper,
|
||||
});
|
||||
|
||||
expect(result.current.loading).toEqual(true);
|
||||
|
||||
await waitFor(() => {
|
||||
expect(result.current).toEqual({
|
||||
error: undefined,
|
||||
items: repoBuilds,
|
||||
loading: false,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('should return throw when annotation missing', async () => {
|
||||
const entity: Entity = {
|
||||
apiVersion: 'backstage.io/v1alpha1',
|
||||
kind: 'Component',
|
||||
metadata: {
|
||||
namespace: 'default',
|
||||
name: 'project-repo',
|
||||
},
|
||||
};
|
||||
|
||||
expect(() =>
|
||||
renderHook(() => useRepoBuilds(entity), {
|
||||
wrapper: Wrapper,
|
||||
}),
|
||||
).toThrow('Value for annotation "dev.azure.com/project" was not found');
|
||||
});
|
||||
|
||||
it('should return throw when annotation invalid', async () => {
|
||||
const entity: Entity = {
|
||||
apiVersion: 'backstage.io/v1alpha1',
|
||||
kind: 'Component',
|
||||
metadata: {
|
||||
namespace: 'default',
|
||||
name: 'project-repo',
|
||||
annotations: {
|
||||
'dev.azure.com/project-repo': 'fake',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
expect(() =>
|
||||
renderHook(() => useRepoBuilds(entity), {
|
||||
wrapper: Wrapper,
|
||||
}),
|
||||
).toThrow(
|
||||
'Invalid value for annotation "dev.azure.com/project-repo"; expected format is: <project-name>/<repo-name>, found: "fake"',
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -1,57 +0,0 @@
|
||||
/*
|
||||
* Copyright 2021 The Backstage Authors
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import {
|
||||
RepoBuild,
|
||||
RepoBuildOptions,
|
||||
} from '@backstage/plugin-azure-devops-common';
|
||||
|
||||
import { AZURE_DEVOPS_DEFAULT_TOP } from '../constants';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { azureDevOpsApiRef } from '../api';
|
||||
import { useApi } from '@backstage/core-plugin-api';
|
||||
import useAsync from 'react-use/lib/useAsync';
|
||||
import { getAnnotationValuesFromEntity } from '../utils';
|
||||
|
||||
/**
|
||||
* @deprecated Use `useBuildRuns` instead
|
||||
*/
|
||||
export function useRepoBuilds(
|
||||
entity: Entity,
|
||||
defaultLimit?: number,
|
||||
): {
|
||||
items?: RepoBuild[];
|
||||
loading: boolean;
|
||||
error?: Error;
|
||||
} {
|
||||
const top = defaultLimit ?? AZURE_DEVOPS_DEFAULT_TOP;
|
||||
const options: RepoBuildOptions = {
|
||||
top: top,
|
||||
};
|
||||
|
||||
const api = useApi(azureDevOpsApiRef);
|
||||
|
||||
const { value, loading, error } = useAsync(() => {
|
||||
const { project, repo } = getAnnotationValuesFromEntity(entity);
|
||||
return api.getRepoBuilds(project, repo as string, options);
|
||||
}, [api, entity]);
|
||||
|
||||
return {
|
||||
items: value?.items,
|
||||
loading,
|
||||
error,
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user