Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
This commit is contained in:
bnechyporenko
2024-02-26 22:08:17 +01:00
committed by blam
parent 6766c4e743
commit 4f25522da9
95 changed files with 152 additions and 147 deletions
+1 -1
View File
@@ -12,7 +12,7 @@
'@backstage/plugin-scaffolder-backend-module-azure': patch
'@backstage/plugin-scaffolder-backend-module-gitea': patch
'@backstage/plugin-scaffolder-backend-module-rails': patch
'@backstage/scaffolder-test-utils': patch
'@backstage/plugin-scaffolder-node-test-utils': patch
'@backstage/plugin-scaffolder-backend': patch
---
@@ -15,7 +15,7 @@ What is inevitably going to happen during the time.
Example how to use it:
```typescript
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
const mockContext = createMockActionContext({
input: { repoUrl: 'dev.azure.com?repo=repo&owner=owner&organization=org' },
@@ -1 +0,0 @@
# @backstage/scaffolder-test-utils
@@ -48,7 +48,7 @@
},
"devDependencies": {
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
},
"files": [
"dist"
@@ -21,7 +21,7 @@ import { ScmIntegrations } from '@backstage/integration';
import { WebApi } from 'azure-devops-node-api';
import { initRepoAndPush } from '@backstage/plugin-scaffolder-node';
import { examples } from './azure.examples';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
jest.mock('azure-devops-node-api', () => ({
WebApi: jest.fn(),
@@ -36,7 +36,7 @@ import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { WebApi } from 'azure-devops-node-api';
import { initRepoAndPush } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('publish:azure', () => {
const config = new ConfigReader({
@@ -50,7 +50,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"msw": "^1.0.0"
},
"files": [
@@ -33,7 +33,7 @@ import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { initRepoAndPush } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('publish:bitbucketCloud', () => {
const config = new ConfigReader({
@@ -22,7 +22,7 @@ import { examples } from './bitbucketCloudPipelinesRun.examples';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('bitbucket:pipelines:run', () => {
const config = new ConfigReader({
@@ -20,7 +20,7 @@ import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { createBitbucketPipelinesRunAction } from './bitbucketCloudPipelinesRun';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('bitbucket:pipelines:run', () => {
const config = new ConfigReader({
@@ -50,7 +50,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"msw": "^1.0.0"
},
"files": [
@@ -33,7 +33,7 @@ import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { initRepoAndPush } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('publish:bitbucketServer', () => {
const config = new ConfigReader({
@@ -32,7 +32,7 @@ import { setupServer } from 'msw/node';
import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('publish:bitbucketServer:pull-request', () => {
const config = new ConfigReader({
@@ -53,7 +53,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"msw": "^1.0.0"
},
"files": [
@@ -36,7 +36,7 @@ import { initRepoAndPush } from '@backstage/plugin-scaffolder-node';
import yaml from 'yaml';
import { sep } from 'path';
import { examples } from './bitbucket.examples';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('publish:bitbucket', () => {
const config = new ConfigReader({
@@ -32,7 +32,7 @@ import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { initRepoAndPush } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('publish:bitbucket', () => {
const config = new ConfigReader({
@@ -54,7 +54,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"msw": "^1.0.0"
},
"files": [
@@ -27,7 +27,7 @@ import { setupServer } from 'msw/node';
import { examples } from './confluenceToMarkdown.examples';
import yaml from 'yaml';
import { ActionContext } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('confluence:transform:markdown examples', () => {
const baseUrl = `https://confluence.example.com`;
@@ -26,7 +26,7 @@ import {
import type { ActionContext } from '@backstage/plugin-scaffolder-node';
import { rest } from 'msw';
import { setupServer } from 'msw/node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('confluence:transform:markdown', () => {
const baseUrl = `https://nodomain.confluence.com`;
@@ -53,7 +53,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"@types/command-exists": "^1.2.0",
"@types/fs-extra": "^11.0.0"
},
@@ -22,7 +22,7 @@ import { createMockDirectory } from '@backstage/backend-test-utils';
import { createFetchCookiecutterAction } from './cookiecutter';
import { join } from 'path';
import type { ActionContext } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
const executeShellCommand = jest.fn();
const commandExists = jest.fn();
@@ -49,7 +49,7 @@
"@backstage/backend-common": "workspace:^",
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"msw": "^1.0.0"
},
"files": [
@@ -34,7 +34,7 @@ import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { initRepoAndPush } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('publish:gerrit', () => {
const config = new ConfigReader({
@@ -25,7 +25,7 @@ import { createPublishGerritReviewAction } from './gerritReview';
import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { commitAndPushRepo } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('publish:gerrit:review', () => {
const config = new ConfigReader({
@@ -49,7 +49,7 @@
"@backstage/backend-common": "workspace:^",
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"msw": "^1.0.0"
},
"files": [
@@ -19,7 +19,7 @@ import { createPublishGiteaAction } from './gitea';
import { initRepoAndPush } from '@backstage/plugin-scaffolder-node';
import { rest } from 'msw';
import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { setupServer } from 'msw/node';
jest.mock('@backstage/plugin-scaffolder-node', () => {
@@ -53,7 +53,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"@types/libsodium-wrappers": "^0.7.10",
"fs-extra": "^11.2.0",
"jest-when": "^3.1.0",
@@ -37,7 +37,7 @@ import {
initRepoAndPush,
} from '@backstage/plugin-scaffolder-node';
import { ConfigReader } from '@backstage/config';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import {
DefaultGithubCredentialsProvider,
GithubCredentialsProvider,
@@ -35,7 +35,7 @@ jest.mock('@backstage/plugin-scaffolder-node', () => {
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { ConfigReader } from '@backstage/config';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import {
DefaultGithubCredentialsProvider,
GithubCredentialsProvider,
@@ -22,7 +22,7 @@ import {
import { ConfigReader } from '@backstage/config';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createGithubActionsDispatchAction } from './githubActionsDispatch';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import yaml from 'yaml';
import { examples } from './githubActionsDispatch.examples';
@@ -21,7 +21,7 @@ import {
} from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { createGithubActionsDispatchAction } from './githubActionsDispatch';
const mockOctokit = {
@@ -22,7 +22,7 @@ import {
} from '@backstage/integration';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createGithubAutolinksAction } from './githubAutolinks';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { examples } from './githubAutolinks.examples';
import yaml from 'yaml';
@@ -21,7 +21,7 @@ import {
ScmIntegrations,
} from '@backstage/integration';
import { createMockDirectory } from '@backstage/backend-test-utils';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createGithubAutolinksAction } from './githubAutolinks';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { createGithubDeployKeyAction } from './githubDeployKey';
import yaml from 'yaml';
import { examples } from './githubDeployKey.examples';
@@ -16,7 +16,7 @@
import { createGithubDeployKeyAction } from './githubDeployKey';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { createGithubEnvironmentAction } from './githubEnvironment';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
@@ -15,7 +15,7 @@
*/
import { createGithubEnvironmentAction } from './githubEnvironment';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
@@ -15,7 +15,7 @@
*/
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ConfigReader } from '@backstage/config';
import {
DefaultGithubCredentialsProvider,
@@ -20,7 +20,7 @@ import {
DefaultGithubCredentialsProvider,
GithubCredentialsProvider,
} from '@backstage/integration';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ConfigReader } from '@backstage/config';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { getOctokitOptions } from './helpers';
@@ -21,7 +21,7 @@ import {
GithubCredentialsProvider,
ScmIntegrations,
} from '@backstage/integration';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { createPublishGithubPullRequestAction } from './githubPullRequest';
import yaml from 'yaml';
import { examples } from './githubPullRequest.examples';
@@ -27,7 +27,7 @@ import {
import fs from 'fs-extra';
import { createPublishGithubPullRequestAction } from './githubPullRequest';
import { createMockDirectory } from '@backstage/backend-test-utils';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
// Make sure root logger is initialized ahead of FS mock
createRootLogger();
@@ -29,7 +29,7 @@ import {
GithubCredentialsProvider,
ScmIntegrations,
} from '@backstage/integration';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { createGithubRepoCreateAction } from './githubRepoCreate';
import { entityRefToName } from './gitHelpers';
import yaml from 'yaml';
@@ -15,7 +15,7 @@
*/
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
jest.mock('./gitHelpers', () => {
return {
@@ -29,7 +29,7 @@ import {
TemplateAction,
initRepoAndPush,
} from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ConfigReader } from '@backstage/config';
import {
DefaultGithubCredentialsProvider,
@@ -60,7 +60,7 @@ import {
initRepoAndPush,
} from '@backstage/plugin-scaffolder-node';
import { ConfigReader } from '@backstage/config';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import {
DefaultGithubCredentialsProvider,
GithubCredentialsProvider,
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ConfigReader } from '@backstage/config';
import {
DefaultGithubCredentialsProvider,
@@ -20,7 +20,7 @@ import {
DefaultGithubCredentialsProvider,
GithubCredentialsProvider,
} from '@backstage/integration';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ConfigReader } from '@backstage/config';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
@@ -57,7 +57,7 @@
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/core-app-api": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"jest-date-mock": "^1.0.8"
},
"files": [
@@ -15,7 +15,7 @@
*/
import { createGitlabGroupEnsureExistsAction } from './createGitlabGroupEnsureExistsAction';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ConfigReader } from '@backstage/core-app-api';
import { ScmIntegrations } from '@backstage/integration';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { createGitlabIssueAction, IssueType } from './createGitlabIssueAction';
import { ConfigReader } from '@backstage/core-app-api';
import { ScmIntegrations } from '@backstage/integration';
@@ -18,7 +18,7 @@ import { ScmIntegrations } from '@backstage/integration';
import yaml from 'yaml';
import { createGitlabProjectAccessTokenAction } from './createGitlabProjectAccessTokenAction'; // Adjust the import based on your project structure
import { examples } from './createGitlabProjectAccessTokenAction.examples';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { DateTime } from 'luxon';
@@ -15,7 +15,7 @@
*/
import { createGitlabProjectDeployTokenAction } from './createGitlabProjectDeployTokenAction';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import yaml from 'yaml';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
jest.mock('@backstage/plugin-scaffolder-node', () => {
return {
@@ -30,7 +30,7 @@ import { createPublishGitlabAction } from './gitlab';
import { ScmIntegrations } from '@backstage/integration';
import { ConfigReader } from '@backstage/config';
import { initRepoAndPush } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
const mockGitlabClient = {
Namespaces: {
@@ -19,7 +19,7 @@ import { ScmIntegrations } from '@backstage/integration';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createPublishGitlabMergeRequestAction } from './gitlabMergeRequest';
import { createMockDirectory } from '@backstage/backend-test-utils';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
// Make sure root logger is initialized ahead of FS mock
createRootLogger();
@@ -19,7 +19,7 @@ import { ScmIntegrations } from '@backstage/integration';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { createMockDirectory } from '@backstage/backend-test-utils';
import { createGitlabRepoPushAction } from './gitlabRepoPush';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
// Make sure root logger is initialized ahead of FS mock
createRootLogger();
@@ -51,7 +51,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"@types/command-exists": "^1.2.0",
"@types/fs-extra": "^11.0.0",
"@types/node": "^18.17.8",
@@ -34,7 +34,7 @@ import { resolve as resolvePath } from 'path';
import { createFetchRailsAction } from './index';
import { fetchContents } from '@backstage/plugin-scaffolder-node';
import { createMockDirectory } from '@backstage/backend-test-utils';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('fetch:rails', () => {
const mockDir = createMockDirectory();
@@ -46,7 +46,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"@backstage/types": "workspace:^",
"msw": "^2.0.0"
},
@@ -15,7 +15,7 @@
*/
import { setupRequestMockHandlers } from '@backstage/backend-test-utils';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ConfigReader } from '@backstage/config';
import { InputError } from '@backstage/errors';
import { ActionContext } from '@backstage/plugin-scaffolder-node';
@@ -39,7 +39,7 @@
"dependencies": {
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/plugin-scaffolder-node": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"@backstage/types": "workspace:^",
"winston": "^3.2.1",
"yeoman-environment": "^3.9.1"
@@ -18,7 +18,7 @@ import { yeomanRun } from './yeomanRun';
jest.mock('./yeomanRun');
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import os from 'os';
import { createRunYeomanAction } from './yeoman';
import type { ActionContext } from '@backstage/plugin-scaffolder-node';
+1 -1
View File
@@ -95,7 +95,7 @@
"devDependencies": {
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/scaffolder-test-utils": "workspace:^",
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^",
"@types/fs-extra": "^11.0.0",
"@types/nunjucks": "^3.1.4",
"@types/supertest": "^2.0.8",
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { CatalogApi } from '@backstage/catalog-client';
import { Entity } from '@backstage/catalog-model';
import { createFetchCatalogEntityAction } from './fetch';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { CatalogApi } from '@backstage/catalog-client';
import { Entity } from '@backstage/catalog-model';
import { createFetchCatalogEntityAction } from './fetch';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { CatalogApi } from '@backstage/catalog-client';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { CatalogApi } from '@backstage/catalog-client';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
@@ -20,7 +20,7 @@ jest.mock('fs-extra');
const fsMock = fs as jest.Mocked<typeof fs>;
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { createCatalogWriteAction } from './write';
import { resolve as resolvePath } from 'path';
import * as yaml from 'yaml';
@@ -21,7 +21,7 @@ jest.mock('fs-extra');
const fsMock = fs as jest.Mocked<typeof fs>;
import os from 'os';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { ANNOTATION_ORIGIN_LOCATION } from '@backstage/catalog-model';
import { createCatalogWriteAction } from './write';
import { resolve as resolvePath } from 'path';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { Writable } from 'stream';
import { createDebugLogAction } from './log';
import { join } from 'path';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { Writable } from 'stream';
import { createDebugLogAction } from './log';
import { join } from 'path';
@@ -18,7 +18,7 @@ import { createWaitAction } from './wait';
import { Writable } from 'stream';
import { examples } from './wait.examples';
import yaml from 'yaml';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('debug:wait examples', () => {
const action = createWaitAction();
@@ -16,7 +16,7 @@
import { createWaitAction } from './wait';
import { Writable } from 'stream';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
describe('debug:wait', () => {
const action = createWaitAction();
@@ -22,7 +22,7 @@ import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
import { createFetchPlainAction } from './plain';
import { fetchContents } from '@backstage/plugin-scaffolder-node';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { examples } from './plain.examples';
jest.mock('@backstage/plugin-scaffolder-node', () => ({
@@ -20,7 +20,7 @@ jest.mock('@backstage/plugin-scaffolder-node', () => {
});
import { resolve as resolvePath } from 'path';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { UrlReader } from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
jest.mock('@backstage/plugin-scaffolder-node', () => {
const actual = jest.requireActual('@backstage/plugin-scaffolder-node');
@@ -20,7 +20,7 @@ jest.mock('@backstage/plugin-scaffolder-node', () => {
});
import { resolve as resolvePath } from 'path';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { UrlReader } from '@backstage/backend-common';
import { ConfigReader } from '@backstage/config';
import { ScmIntegrations } from '@backstage/integration';
@@ -18,7 +18,7 @@ import { join as joinPath, sep as pathSep } from 'path';
import fs from 'fs-extra';
import { resolvePackagePath, UrlReader } from '@backstage/backend-common';
import { ScmIntegrations } from '@backstage/integration';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { createFetchTemplateAction } from './template';
import {
ActionContext,
@@ -30,7 +30,7 @@ import {
TemplateAction,
} from '@backstage/plugin-scaffolder-node';
import { createMockDirectory } from '@backstage/backend-test-utils';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
type FetchTemplateInput = ReturnType<
typeof createFetchTemplateAction
@@ -15,7 +15,7 @@
*/
import { createFilesystemDeleteAction } from './delete';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import { resolve as resolvePath } from 'path';
import fs from 'fs-extra';
import yaml from 'yaml';
@@ -16,7 +16,7 @@
import { resolve as resolvePath } from 'path';
import { createFilesystemDeleteAction } from './delete';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import fs from 'fs-extra';
import { createMockDirectory } from '@backstage/backend-test-utils';
@@ -16,7 +16,7 @@
import { resolve as resolvePath } from 'path';
import { createFilesystemRenameAction } from './rename';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import fs from 'fs-extra';
import yaml from 'yaml';
import { examples } from './rename.examples';
@@ -32,7 +32,7 @@ describe('fs:rename examples', () => {
const mockContext = createMockActionContext({
input: {
files: files,
files,
},
workspacePath,
});
@@ -16,7 +16,7 @@
import { resolve as resolvePath } from 'path';
import { createFilesystemRenameAction } from './rename';
import { createMockActionContext } from '@backstage/scaffolder-test-utils';
import { createMockActionContext } from '@backstage/plugin-scaffolder-node-test-utils';
import fs from 'fs-extra';
import { createMockDirectory } from '@backstage/backend-test-utils';
@@ -0,0 +1 @@
# @backstage/plugin-scaffolder-node-test-utils
@@ -1,4 +1,4 @@
# @backstage/scaffolder-test-utils
# @backstage/plugin-scaffolder-node-test-utils
Contains utilities that can be used when testing scaffolder features.
@@ -8,5 +8,5 @@ Install the package via Yarn into your own packages:
```sh
cd <package-dir> # if within a monorepo
yarn add --dev @backstage/scaffolder-test-utils
yarn add --dev @backstage/plugin-scaffolder-node-test-utils
```
@@ -1,32 +1,32 @@
## API Report File for "@backstage/scaffolder-test-utils"
## API Report File for "@backstage/plugin-scaffolder-node-test-utils"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { ActionContext } from '@backstage/plugin-scaffolder-node';
import { JsonObject } from '@backstage/types';
import { TaskSecrets } from '@backstage/plugin-scaffolder-node';
import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
import {ActionContext} from './index';
import {JsonObject} from '@backstage/types';
import {TaskSecrets} from './index';
import {TemplateInfo} from './index';
import * as winston from 'winston';
import { Writable } from 'stream';
import {Writable} from 'stream';
// @public
export const createMockActionContext: <
TActionInput extends JsonObject = JsonObject,
TActionOutput extends JsonObject = JsonObject,
TActionInput extends JsonObject = JsonObject,
TActionOutput extends JsonObject = JsonObject,
>(
options?:
| {
options?:
| {
input?: TActionInput | undefined;
logger?: winston.Logger | undefined;
logStream?: Writable | undefined;
secrets?: TaskSecrets | undefined;
templateInfo?: TemplateInfo | undefined;
workspacePath?: string | undefined;
}
| undefined,
}
| undefined,
) => ActionContext<TActionInput, TActionOutput>;
// (No @packageDocumentation comment for this package)
@@ -1,8 +1,8 @@
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: backstage-scaffolder-test-utils
title: '@backstage/scaffolder-test-utils'
name: backstage-plugin-scaffolder-node-test-utils
title: '@backstage/plugin-scaffolder-node-test-utils'
spec:
lifecycle: experimental
type: backstage-node-library
@@ -1,5 +1,5 @@
{
"name": "@backstage/scaffolder-test-utils",
"name": "@backstage/plugin-scaffolder-node-test-utils",
"version": "0.0.1",
"main": "src/index.ts",
"types": "src/index.ts",
@@ -37,9 +37,8 @@ import {
type FormValidation,
} from './createAsyncValidators';
import { ReviewState, type ReviewStateProps } from '../ReviewState';
import { useTemplateSchema } from '../../hooks/useTemplateSchema';
import { useTemplateSchema, useFormDataFromQuery } from '../../hooks';
import validator from '@rjsf/validator-ajv8';
import { useFormDataFromQuery } from '../../hooks';
import { useTransformSchemaToProps } from '../../hooks/useTransformSchemaToProps';
import { hasErrors } from './utils';
import * as FieldOverrides from './FieldOverrides';
@@ -112,6 +111,18 @@ export const Stepper = (stepperProps: StepperProps) => {
const [errors, setErrors] = useState<undefined | FormValidation>();
const styles = useStyles();
const templateName =
typeof formState.name === 'string'
? formState.name
: props.templateName ?? 'unknown';
const backLabel =
presentation?.buttonLabels?.backButtonText ?? backButtonText;
const createLabel =
presentation?.buttonLabels?.createButtonText ?? createButtonText;
const reviewLabel =
presentation?.buttonLabels?.reviewButtonText ?? reviewButtonText;
const extensions = useMemo(() => {
return Object.fromEntries(
props.extensions.map(({ name, component }) => [name, component]),
@@ -147,10 +158,8 @@ export const Stepper = (stepperProps: StepperProps) => {
const handleCreate = useCallback(() => {
props.onCreate(formState);
const name =
typeof formState.name === 'string' ? formState.name : undefined;
analytics.captureEvent('create', name ?? props.templateName ?? 'unknown');
}, [props, formState, analytics]);
analytics.captureEvent('click', `[${templateName}]: ${createLabel}`);
}, [props, formState, analytics, templateName, createLabel]);
const currentStep = useTransformSchemaToProps(steps[activeStep], { layouts });
@@ -174,20 +183,16 @@ export const Stepper = (stepperProps: StepperProps) => {
setErrors(undefined);
setActiveStep(prevActiveStep => {
const stepNum = prevActiveStep + 1;
analytics.captureEvent('click', `Next Step (${stepNum})`);
analytics.captureEvent(
'click',
`[${templateName}]: Next Step (${stepNum})`,
);
return stepNum;
});
}
setFormState(current => ({ ...current, ...formData }));
};
const backLabel =
presentation?.buttonLabels?.backButtonText ?? backButtonText;
const createLabel =
presentation?.buttonLabels?.createButtonText ?? createButtonText;
const reviewLabel =
presentation?.buttonLabels?.reviewButtonText ?? reviewButtonText;
return (
<>
{isValidating && <LinearProgress variant="indeterminate" />}
@@ -214,7 +219,7 @@ export const Stepper = (stepperProps: StepperProps) => {
);
})}
<MuiStep>
<MuiStepLabel>Review</MuiStepLabel>
<MuiStepLabel>${reviewLabel}</MuiStepLabel>
</MuiStep>
</MuiStepper>
<div className={styles.formWrapper}>
@@ -274,7 +279,7 @@ export const Stepper = (stepperProps: StepperProps) => {
className={styles.backButton}
disabled={activeStep < 1}
>
Back
{backLabel}
</Button>
<Button
variant="contained"
+30 -30
View File
@@ -8209,7 +8209,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
azure-devops-node-api: ^12.0.0
yaml: ^2.0.0
languageName: unknown
@@ -8227,7 +8227,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
fs-extra: ^11.2.0
msw: ^1.0.0
node-fetch: ^2.6.7
@@ -8247,7 +8247,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
fs-extra: ^11.2.0
msw: ^1.0.0
node-fetch: ^2.6.7
@@ -8269,7 +8269,7 @@ __metadata:
"@backstage/plugin-scaffolder-backend-module-bitbucket-cloud": "workspace:^"
"@backstage/plugin-scaffolder-backend-module-bitbucket-server": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
fs-extra: ^11.2.0
msw: ^1.0.0
node-fetch: ^2.6.7
@@ -8289,7 +8289,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
fs-extra: ^11.2.0
git-url-parse: ^14.0.0
msw: ^1.0.0
@@ -8311,7 +8311,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
"@backstage/types": "workspace:^"
"@types/command-exists": ^1.2.0
"@types/fs-extra": ^11.0.0
@@ -8334,7 +8334,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
msw: ^1.0.0
node-fetch: ^2.6.7
yaml: ^2.0.0
@@ -8353,7 +8353,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
msw: ^1.0.0
node-fetch: ^2.6.7
yaml: ^2.0.0
@@ -8372,7 +8372,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
"@octokit/webhooks": ^10.0.0
"@types/libsodium-wrappers": ^0.7.10
fs-extra: ^11.2.0
@@ -8399,7 +8399,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
"@gitbeaker/core": ^35.8.0
"@gitbeaker/node": ^35.8.0
"@gitbeaker/rest": ^39.25.0
@@ -8422,7 +8422,7 @@ __metadata:
"@backstage/errors": "workspace:^"
"@backstage/integration": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
"@backstage/types": "workspace:^"
"@types/command-exists": ^1.2.0
"@types/fs-extra": ^11.0.0
@@ -8443,7 +8443,7 @@ __metadata:
"@backstage/config": "workspace:^"
"@backstage/errors": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
"@backstage/types": "workspace:^"
msw: ^2.0.0
yaml: ^2.3.3
@@ -8458,7 +8458,7 @@ __metadata:
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
"@backstage/types": "workspace:^"
winston: ^3.2.1
yeoman-environment: ^3.9.1
@@ -8494,7 +8494,7 @@ __metadata:
"@backstage/plugin-scaffolder-backend-module-gitlab": "workspace:^"
"@backstage/plugin-scaffolder-common": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/scaffolder-test-utils": "workspace:^"
"@backstage/plugin-scaffolder-node-test-utils": "workspace:^"
"@backstage/types": "workspace:^"
"@types/express": ^4.17.6
"@types/fs-extra": ^11.0.0
@@ -8539,6 +8539,22 @@ __metadata:
languageName: unknown
linkType: soft
"@backstage/plugin-scaffolder-node-test-utils@workspace:^, @backstage/plugin-scaffolder-node-test-utils@workspace:plugins/scaffolder-node-test-utils":
version: 0.0.0-use.local
resolution: "@backstage/plugin-scaffolder-node-test-utils@workspace:plugins/scaffolder-node-test-utils"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-test-utils": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/plugin-scaffolder-common": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/types": "workspace:^"
"@testing-library/jest-dom": ^6.0.0
"@types/react": "*"
winston: ^3.2.1
languageName: unknown
linkType: soft
"@backstage/plugin-scaffolder-node@workspace:^, @backstage/plugin-scaffolder-node@workspace:plugins/scaffolder-node":
version: 0.0.0-use.local
resolution: "@backstage/plugin-scaffolder-node@workspace:plugins/scaffolder-node"
@@ -9878,22 +9894,6 @@ __metadata:
languageName: unknown
linkType: soft
"@backstage/scaffolder-test-utils@workspace:^, @backstage/scaffolder-test-utils@workspace:packages/scaffolder-test-utils":
version: 0.0.0-use.local
resolution: "@backstage/scaffolder-test-utils@workspace:packages/scaffolder-test-utils"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-test-utils": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/plugin-scaffolder-common": "workspace:^"
"@backstage/plugin-scaffolder-node": "workspace:^"
"@backstage/types": "workspace:^"
"@testing-library/jest-dom": ^6.0.0
"@types/react": "*"
winston: ^3.2.1
languageName: unknown
linkType: soft
"@backstage/test-utils@workspace:^, @backstage/test-utils@workspace:packages/test-utils":
version: 0.0.0-use.local
resolution: "@backstage/test-utils@workspace:packages/test-utils"