paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

Add examples for gitlab:group:ensureExists scaffolder action and improve related tests

Browse Source 
Signed-off-by: parmar-abhinav <abhinavparmar147@gmail.com>
This commit is contained in:
parmar-abhinav
2024-04-07 10:23:10 +05:30
parent 51104134d6
commit 52f40ea81a
4 changed files with 290 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/proud-queens-mix.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend-module-gitlab': minor
---
Add examples for gitlab:group:ensureExists scaffolder action & improve related tests
plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabGroupEnsureExistsAction.examples.test.ts
+198
View File
@@ -0,0 +1,198 @@
/*
* Copyright 2023 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 { createGitlabGroupEnsureExistsAction } from './createGitlabGroupEnsureExistsAction';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ConfigReader } from '@backstage/core-app-api';
import { ScmIntegrations } from '@backstage/integration';
import yaml from 'yaml';
import { examples } from './createGitlabGroupEnsureExistsAction.examples';
const mockGitlabClient = {
Groups: {
search: jest.fn(),
create: jest.fn(),
},
};
jest.mock('@gitbeaker/node', () => ({
Gitlab: class {
constructor() {
return mockGitlabClient;
}
},
}));
describe('gitlab:group:ensureExists', () => {
const mockContext = createMockActionContext();
afterEach(() => {
jest.resetAllMocks();
});
it(`Should ${examples[0].description}`, async () => {
mockGitlabClient.Groups.search.mockResolvedValue([]);
mockGitlabClient.Groups.create.mockResolvedValue({
id: 3,
full_path: 'group1',
});
const config = new ConfigReader({
integrations: {
gitlab: [
{
host: 'gitlab.com',
token: 'tokenlols',
apiBaseUrl: 'https://api.gitlab.com',
},
],
},
});
const integrations = ScmIntegrations.fromConfig(config);
const action = createGitlabGroupEnsureExistsAction({ integrations });
await action.handler({
...mockContext,
input: yaml.parse(examples[0].example).steps[0].input,
});
expect(mockGitlabClient.Groups.create).toHaveBeenCalledWith(
'group1',
'group1',
{},
);
expect(mockContext.output).toHaveBeenCalledWith('groupId', 3);
});
it(`Should ${examples[1].description}`, async () => {
mockGitlabClient.Groups.search.mockResolvedValue([
{
id: 1,
full_path: 'group1',
},
]);
mockGitlabClient.Groups.create.mockResolvedValue({
id: 3,
full_path: 'group1/group2',
});
const config = new ConfigReader({
integrations: {
gitlab: [
{
host: 'gitlab.com',
token: 'tokenlols',
apiBaseUrl: 'https://api.gitlab.com',
},
],
},
});
const integrations = ScmIntegrations.fromConfig(config);
const action = createGitlabGroupEnsureExistsAction({ integrations });
await action.handler({
...mockContext,
input: yaml.parse(examples[1].example).steps[0].input,
});
expect(mockGitlabClient.Groups.create).toHaveBeenCalledWith(
'group2',
'group2',
{
parent_id: 1,
},
);
expect(mockContext.output).toHaveBeenCalledWith('groupId', 3);
});
it(`Should ${examples[2].description}`, async () => {
mockGitlabClient.Groups.search.mockResolvedValue([
{
id: 1,
full_path: 'group1',
},
{
id: 2,
full_path: 'group1/group2',
},
]);
mockGitlabClient.Groups.create.mockResolvedValue({
id: 3,
full_path: 'group1/group2/group3',
});
const config = new ConfigReader({
integrations: {
gitlab: [
{
host: 'gitlab.com',
token: 'tokenlols',
apiBaseUrl: 'https://api.gitlab.com',
},
],
},
});
const integrations = ScmIntegrations.fromConfig(config);
const action = createGitlabGroupEnsureExistsAction({ integrations });
await action.handler({
...mockContext,
input: yaml.parse(examples[2].example).steps[0].input,
});
expect(mockGitlabClient.Groups.create).toHaveBeenCalledWith(
'group3',
'group3',
{
parent_id: 2,
},
);
expect(mockContext.output).toHaveBeenCalledWith('groupId', 3);
});
it(`Should ${examples[3].description}`, async () => {
const config = new ConfigReader({
integrations: {
gitlab: [
{
host: 'gitlab.com',
token: 'tokenlols',
apiBaseUrl: 'https://api.gitlab.com',
},
],
},
});
const integrations = ScmIntegrations.fromConfig(config);
const action = createGitlabGroupEnsureExistsAction({ integrations });
await action.handler({
...mockContext,
isDryRun: yaml.parse(examples[3].example).steps[0].isDryRun,
input: yaml.parse(examples[3].example).steps[0].input,
});
expect(mockGitlabClient.Groups.search).not.toHaveBeenCalled();
expect(mockGitlabClient.Groups.create).not.toHaveBeenCalled();
expect(mockContext.output).toHaveBeenCalledWith('groupId', 42);
});
});
plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabGroupEnsureExistsAction.examples.ts
+85
View File
@@ -0,0 +1,85 @@
/*
* Copyright 2023 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 { TemplateExample } from '@backstage/plugin-scaffolder-node';
import yaml from 'yaml';
export const examples: TemplateExample[] = [
{
description: 'Creating a group at the top level',
example: yaml.stringify({
steps: [
{
id: 'gitlabGroup',
name: 'Group',
action: 'gitlab:group:ensureExists',
input: {
repoUrl: 'gitlab.com',
path: ['group1'],
},
},
],
}),
},
{
description: 'Create a group nested within another group',
example: yaml.stringify({
steps: [
{
id: 'gitlabGroup',
name: 'Group',
action: 'gitlab:group:ensureExists',
input: {
repoUrl: 'gitlab.com',
path: ['group1', 'group2'],
},
},
],
}),
},
{
description: 'Create a group nested within multiple other groups',
example: yaml.stringify({
steps: [
{
id: 'gitlabGroup',
name: 'Group',
action: 'gitlab:group:ensureExists',
input: {
repoUrl: 'gitlab.com',
path: ['group1', 'group2', 'group3'],
},
},
],
}),
},
{
description: 'Create a group in dry run mode',
example: yaml.stringify({
steps: [
{
id: 'gitlabGroup',
name: 'Group',
action: 'gitlab:group:ensureExists',
isDryRun: true,
input: {
repoUrl: 'https://gitlab.com/my-repo',
path: ['group1', 'group2', 'group3'],
},
},
],
}),
},
];
plugins/scaffolder-backend-module-gitlab/src/actions/createGitlabGroupEnsureExistsAction.ts
+2
View File
@@ -21,6 +21,7 @@ import { GroupSchema } from '@gitbeaker/core/dist/types/resources/Groups';
import commonGitlabConfig from '../commonGitlabConfig';
import { getToken } from '../util';
import { z } from 'zod';
import { examples } from './createGitlabGroupEnsureExistsAction.examples';
/**
* Creates an `gitlab:group:ensureExists` Scaffolder action.
@@ -36,6 +37,7 @@ export const createGitlabGroupEnsureExistsAction = (options: {
id: 'gitlab:group:ensureExists',
description: 'Ensures a Gitlab group exists',
supportsDryRun: true,
examples,
schema: {
input: commonGitlabConfig.merge(
z.object({