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

Add initial support for displaying Run resources #2414

Merged
merged 1 commit into from
Aug 18, 2022
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
1 change: 1 addition & 0 deletions base/200-clusterrole-tenant.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ rules:
- pipelines
- pipelineruns
- pipelineresources
- runs
verbs:
- get
- list
Expand Down
1 change: 1 addition & 0 deletions overlays/patches/read-write/clusterrole-tenant-patch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
- pipelines
- pipelineruns
- pipelineresources
- runs
verbs:
- create
- update
Expand Down
11 changes: 11 additions & 0 deletions packages/utils/src/utils/router.js
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,17 @@ export const paths = {
return '/:type/:name';
}
},
runs: {
all() {
return '/runs';
},
byName() {
return byNamespace({ path: '/runs/:runName' });
},
byNamespace() {
return byNamespace({ path: '/runs' });
}
},
settings() {
return '/settings';
},
Expand Down
22 changes: 22 additions & 0 deletions packages/utils/src/utils/router.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ const namespace = 'fake_namespace';
const pipelineName = 'fake_pipelineName';
const pipelineResourceName = 'fake_pipelineResourceName';
const pipelineRunName = 'fake_pipelineRunName';
const runName = 'fake_runName';
const taskName = 'fake_taskName';
const taskRunName = 'fake_taskRunName';
const triggerName = 'fake_triggerName';
Expand Down Expand Up @@ -276,6 +277,27 @@ describe('rawCRD', () => {
});
});

describe('runs', () => {
it('all', () => {
expect(urls.runs.all()).toEqual(generatePath(paths.runs.all()));
});

it('byName', () => {
expect(urls.runs.byName({ namespace, runName })).toEqual(
generatePath(paths.runs.byName(), {
namespace,
runName
})
);
});

it('byNamespace', () => {
expect(urls.runs.byNamespace({ namespace })).toEqual(
generatePath(paths.runs.byNamespace(), { namespace })
);
});
});

it('settings', () => {
expect(urls.settings()).toEqual(generatePath(paths.settings()));
});
Expand Down
1 change: 1 addition & 0 deletions src/api/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ export * from './extensions';
export * from './pipelineResources';
export * from './pipelineRuns';
export * from './pipelines';
export * from './runs';
export * from './serviceAccounts';
export * from './taskRuns';
export * from './tasks';
Expand Down
2 changes: 1 addition & 1 deletion src/api/pipelineRuns.js
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ export function rerunPipelineRun(pipelineRun) {
generateName: getGenerateNamePrefixForRerun(name),
labels: {
...labels,
reruns: name
'dashboard.tekton.dev/rerunOf': name
},
namespace
};
Expand Down
64 changes: 64 additions & 0 deletions src/api/runs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/*
Copyright 2022 The Tekton 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 { deleteRequest, get } from './comms';
import {
getQueryParams,
getTektonAPI,
useCollection,
useResource
} from './utils';

export function deleteRun({ name, namespace }) {
const uri = getTektonAPI('runs', { name, namespace, version: 'v1alpha1' });
return deleteRequest(uri);
}

function getRunsAPI({ filters, isWebSocket, name, namespace }) {
return getTektonAPI(
'runs',
{ isWebSocket, namespace, version: 'v1alpha1' },
getQueryParams({ filters, name })
);
}

export function getRuns({ filters = [], namespace } = {}) {
const uri = getRunsAPI({ filters, namespace });
return get(uri);
}

export function getRun({ name, namespace }) {
const uri = getTektonAPI('runs', { name, namespace, version: 'v1alpha1' });
return get(uri);
}

export function useRuns(params) {
const webSocketURL = getRunsAPI({ ...params, isWebSocket: true });
return useCollection({
api: getRuns,
kind: 'Run',
params,
webSocketURL
});
}

export function useRun(params, queryConfig) {
const webSocketURL = getRunsAPI({ ...params, isWebSocket: true });
return useResource({
api: getRun,
kind: 'Run',
params,
queryConfig,
webSocketURL
});
}
87 changes: 87 additions & 0 deletions src/api/runs.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
/*
Copyright 2022 The Tekton 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 fetchMock from 'fetch-mock';

import * as API from './runs';
import * as utils from './utils';

it('deleteRun', () => {
const name = 'foo';
const data = { fake: 'Run' };
fetchMock.delete(`end:${name}`, data);
return API.deleteRun({ name }).then(run => {
expect(run).toEqual(data);
fetchMock.restore();
});
});

it('getRun', () => {
const name = 'foo';
const data = { fake: 'Run' };
fetchMock.get(`end:${name}`, data);
return API.getRun({ name }).then(run => {
expect(run).toEqual(data);
fetchMock.restore();
});
});

it('getRuns', () => {
const data = {
items: 'Runs'
};
fetchMock.get(/runs/, data);
return API.getRuns({ filters: [] }).then(runs => {
expect(runs).toEqual(data);
fetchMock.restore();
});
});

it('useRuns', () => {
const query = { fake: 'query' };
const params = { fake: 'params' };
jest.spyOn(utils, 'useCollection').mockImplementation(() => query);
expect(API.useRuns(params)).toEqual(query);
expect(utils.useCollection).toHaveBeenCalledWith(
expect.objectContaining({
api: API.getRuns,
kind: 'Run',
params
})
);
});

it('useRun', () => {
const query = { fake: 'query' };
const params = { fake: 'params' };
jest.spyOn(utils, 'useResource').mockImplementation(() => query);
expect(API.useRun(params)).toEqual(query);
expect(utils.useResource).toHaveBeenCalledWith(
expect.objectContaining({
api: API.getRun,
kind: 'Run',
params
})
);

const queryConfig = { fake: 'queryConfig' };
API.useRun(params, queryConfig);
expect(utils.useResource).toHaveBeenCalledWith(
expect.objectContaining({
api: API.getRun,
kind: 'Run',
params,
queryConfig
})
);
});
2 changes: 1 addition & 1 deletion src/api/taskRuns.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ export function rerunTaskRun(taskRun) {
generateName: getGenerateNamePrefixForRerun(name),
labels: {
...labels,
reruns: name
'dashboard.tekton.dev/rerunOf': name
},
namespace
};
Expand Down
13 changes: 13 additions & 0 deletions src/containers/App/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ import {
Pipelines,
ReadWriteRoute,
ResourceList,
Run,
Runs,
Settings,
SideNav,
TaskRun,
Expand Down Expand Up @@ -303,6 +305,17 @@ export function App({ lang }) {
<Route path={paths.taskRuns.byName()} exact>
<TaskRun />
</Route>

<Route path={paths.runs.all()}>
<Runs />
</Route>
<Route path={paths.runs.byNamespace()} exact>
<Runs />
</Route>
<Route path={paths.runs.byName()} exact>
<Run />
</Route>

<Route path={paths.clusterTasks.all()} exact>
<ClusterTasks />
</Route>
Expand Down
Loading