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

Loosen up the type some more

Browse Source
This commit is contained in:
Mattias Frinnström
2020-10-26 17:18:32 +01:00
parent fe9ec8f988
commit 2e9d34fd87
9 changed files with 21 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.test.ts
+4 -4
View File
@@ -78,7 +78,7 @@ describe('AzurePreparer', () => {
it('calls the clone command with the correct arguments for a repository', async () => {
const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
await preparer.prepare(mockEntity);
expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
1,
'https://dev.azure.com/backstage-org/backstage-project/_git/template-repo',
@@ -104,7 +104,7 @@ describe('AzurePreparer', () => {
},
]),
);
await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
await preparer.prepare(mockEntity);
expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
1,
'https://dev.azure.com/backstage-org/backstage-project/_git/template-repo',
@@ -122,7 +122,7 @@ describe('AzurePreparer', () => {
it('calls the clone command with the correct arguments for a repository when no path is provided', async () => {
const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
delete mockEntity.spec.path;
await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
await preparer.prepare(mockEntity);
expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
1,
'https://dev.azure.com/backstage-org/backstage-project/_git/template-repo',
@@ -134,7 +134,7 @@ describe('AzurePreparer', () => {
it('return the temp directory with the path to the folder if it is specified', async () => {
const preparer = new AzurePreparer(ConfigReader.fromConfigs([]));
mockEntity.spec.path = './template/test/1/2/3';
const response = await preparer.prepare(mockEntity, {});
const response = await preparer.prepare(mockEntity);
expect(response.split('\\').join('/')).toMatch(
/\/template\/test\/1\/2\/3$/,
plugins/scaffolder-backend/src/scaffolder/stages/prepare/azure.ts
+2 -2
View File
@@ -34,10 +34,10 @@ export class AzurePreparer implements PreparerBase {
async prepare(
template: TemplateEntityV1alpha1,
opts: { workingDirectory?: string },
opts?: { workingDirectory?: string },
): Promise<string> {
const { protocol, location } = parseLocationAnnotation(template);
const workingDirectory = opts.workingDirectory ?? os.tmpdir();
const workingDirectory = opts?.workingDirectory ?? os.tmpdir();
if (!['azure/api', 'url'].includes(protocol)) {
throw new InputError(
plugins/scaffolder-backend/src/scaffolder/stages/prepare/file.ts
+2 -2
View File
@@ -24,10 +24,10 @@ import { PreparerBase } from './types';
export class FilePreparer implements PreparerBase {
async prepare(
template: TemplateEntityV1alpha1,
opts: { workingDirectory?: string },
opts?: { workingDirectory?: string },
): Promise<string> {
const { protocol, location } = parseLocationAnnotation(template);
const workingDirectory = opts.workingDirectory ?? os.tmpdir();
const workingDirectory = opts?.workingDirectory ?? os.tmpdir();
if (protocol !== 'file') {
throw new InputError(
plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.test.ts
+4 -4
View File
@@ -76,7 +76,7 @@ describe('GitHubPreparer', () => {
});
it('calls the clone command with the correct arguments for a repository', async () => {
const preparer = new GithubPreparer();
await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
await preparer.prepare(mockEntity);
expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
1,
'https://github.com/benjdlambert/backstage-graphql-template',
@@ -89,7 +89,7 @@ describe('GitHubPreparer', () => {
it('calls the clone command with the correct arguments for a repository when no path is provided', async () => {
const preparer = new GithubPreparer();
delete mockEntity.spec.path;
await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
await preparer.prepare(mockEntity);
expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
1,
'https://github.com/benjdlambert/backstage-graphql-template',
@@ -103,7 +103,7 @@ describe('GitHubPreparer', () => {
it('return the temp directory with the path to the folder if it is specified', async () => {
const preparer = new GithubPreparer();
mockEntity.spec.path = './template/test/1/2/3';
const response = await preparer.prepare(mockEntity, {});
const response = await preparer.prepare(mockEntity);
expect(response.split('\\').join('/')).toMatch(
/\/template\/test\/1\/2\/3$/,
@@ -124,7 +124,7 @@ describe('GitHubPreparer', () => {
it('calls the clone command with the token when provided', async () => {
const preparer = new GithubPreparer({ token: 'abc' });
await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
await preparer.prepare(mockEntity);
expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
1,
'https://github.com/benjdlambert/backstage-graphql-template',
plugins/scaffolder-backend/src/scaffolder/stages/prepare/github.ts
+2 -2
View File
@@ -32,10 +32,10 @@ export class GithubPreparer implements PreparerBase {
async prepare(
template: TemplateEntityV1alpha1,
opts: { workingDirectory?: string },
opts?: { workingDirectory?: string },
): Promise<string> {
const { protocol, location } = parseLocationAnnotation(template);
const workingDirectory = opts.workingDirectory ?? os.tmpdir();
const workingDirectory = opts?.workingDirectory ?? os.tmpdir();
const { token } = this;
if (!['github', 'url'].includes(protocol)) {
plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.test.ts
+4 -4
View File
@@ -79,7 +79,7 @@ describe('GitLabPreparer', () => {
it(`calls the clone command with the correct arguments for a repository using the ${protocol} protocol`, async () => {
const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
mockEntity = mockEntityWithProtocol(protocol);
await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
await preparer.prepare(mockEntity);
expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
1,
'https://gitlab.com/benjdlambert/backstage-graphql-template',
@@ -106,7 +106,7 @@ describe('GitLabPreparer', () => {
]),
);
mockEntity = mockEntityWithProtocol(protocol);
await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
await preparer.prepare(mockEntity);
expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
1,
'https://gitlab.com/benjdlambert/backstage-graphql-template',
@@ -125,7 +125,7 @@ describe('GitLabPreparer', () => {
const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
mockEntity = mockEntityWithProtocol(protocol);
delete mockEntity.spec.path;
await preparer.prepare(mockEntity, { workingDirectory: '/workDir' });
await preparer.prepare(mockEntity);
expect(mocks.Clone.clone).toHaveBeenNthCalledWith(
1,
'https://gitlab.com/benjdlambert/backstage-graphql-template',
@@ -138,7 +138,7 @@ describe('GitLabPreparer', () => {
const preparer = new GitlabPreparer(ConfigReader.fromConfigs([]));
mockEntity = mockEntityWithProtocol(protocol);
mockEntity.spec.path = './template/test/1/2/3';
const response = await preparer.prepare(mockEntity, {});
const response = await preparer.prepare(mockEntity);
expect(response.split('\\').join('/')).toMatch(
/\/template\/test\/1\/2\/3$/,
plugins/scaffolder-backend/src/scaffolder/stages/prepare/gitlab.ts
+2 -2
View File
@@ -35,10 +35,10 @@ export class GitlabPreparer implements PreparerBase {
async prepare(
template: TemplateEntityV1alpha1,
opts: { workingDirectory?: string },
opts?: { workingDirectory?: string },
): Promise<string> {
const { protocol, location } = parseLocationAnnotation(template);
const workingDirectory = opts.workingDirectory ?? os.tmpdir();
const workingDirectory = opts?.workingDirectory ?? os.tmpdir();
if (!['gitlab', 'gitlab/api', 'url'].includes(protocol)) {
throw new InputError(
plugins/scaffolder-backend/src/scaffolder/stages/prepare/types.ts
+1 -1
View File
@@ -25,7 +25,7 @@ export type PreparerBase = {
*/
prepare(
template: TemplateEntityV1alpha1,
opts: { logger: Logger; workingDirectory?: string },
opts?: { logger: Logger; workingDirectory?: string },
): Promise<string>;
};
plugins/scaffolder-backend/src/service/router.ts
-1
View File
@@ -16,7 +16,6 @@
import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
import { Config, JsonValue } from '@backstage/config';
import os from 'os';
import fs from 'fs-extra';
import Docker from 'dockerode';
import express from 'express';