@backstage/backend-test-utils 1.6.0 → 1.7.0-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/dist/services/mockCredentials.cjs.js +36 -14
  3. package/dist/services/mockCredentials.cjs.js.map +1 -1
  4. package/package.json +11 -11
package/CHANGELOG.md CHANGED
@@ -1,5 +1,37 @@
1
1
  # @backstage/backend-test-utils
2
2
 
3
+ ## 1.7.0-next.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/config@1.3.3-next.0
9
+ - @backstage/plugin-permission-common@0.9.1-next.0
10
+ - @backstage/backend-defaults@0.11.1-next.1
11
+ - @backstage/backend-app-api@1.2.5-next.0
12
+ - @backstage/backend-plugin-api@1.4.1-next.0
13
+ - @backstage/plugin-auth-node@0.6.5-next.0
14
+ - @backstage/plugin-events-node@0.4.13-next.0
15
+
16
+ ## 1.7.0-next.0
17
+
18
+ ### Minor Changes
19
+
20
+ - ead925a: Add a standard `toString` on credentials objects
21
+
22
+ ### Patch Changes
23
+
24
+ - Updated dependencies
25
+ - @backstage/backend-defaults@0.11.1-next.0
26
+ - @backstage/backend-app-api@1.2.4
27
+ - @backstage/plugin-auth-node@0.6.4
28
+ - @backstage/backend-plugin-api@1.4.0
29
+ - @backstage/plugin-events-node@0.4.12
30
+ - @backstage/config@1.3.2
31
+ - @backstage/errors@1.2.7
32
+ - @backstage/types@1.2.1
33
+ - @backstage/plugin-permission-common@0.9.0
34
+
3
35
  ## 1.6.0
4
36
 
5
37
  ### Minor Changes
package/dist/services/mockCredentials.cjs.js CHANGED
@@ -22,10 +22,19 @@ function validateUserEntityRef(ref) {
22
22
  exports.mockCredentials = void 0;
23
23
  ((mockCredentials2) => {
24
24
  function none() {
25
- return {
25
+ const result = {
26
26
  $$type: "@backstage/BackstageCredentials",
27
27
  principal: { type: "none" }
28
28
  };
29
+ Object.defineProperties(result, {
30
+ toString: {
31
+ enumerable: false,
32
+ configurable: true,
33
+ writable: true,
34
+ value: () => `mockCredentials{nonePrincipal}`
35
+ }
36
+ });
37
+ return result;
29
38
  }
30
39
  mockCredentials2.none = none;
31
40
  ((none2) => {
@@ -36,24 +45,29 @@ exports.mockCredentials = void 0;
36
45
  })(none = mockCredentials2.none || (mockCredentials2.none = {}));
37
46
  function user(userEntityRef = DEFAULT_MOCK_USER_ENTITY_REF, options) {
38
47
  validateUserEntityRef(userEntityRef);
39
- return Object.defineProperty(
40
- {
41
- $$type: "@backstage/BackstageCredentials",
42
- principal: {
43
- type: "user",
44
- userEntityRef,
45
- ...options?.actor && {
46
- actor: { type: "service", subject: options.actor.subject }
47
- }
48
+ const result = {
49
+ $$type: "@backstage/BackstageCredentials",
50
+ principal: {
51
+ type: "user",
52
+ userEntityRef,
53
+ ...options?.actor && {
54
+ actor: { type: "service", subject: options.actor.subject }
48
55
  }
56
+ }
57
+ };
58
+ Object.defineProperties(result, {
59
+ toString: {
60
+ enumerable: false,
61
+ configurable: true,
62
+ value: () => `mockCredentials{userPrincipal{${userEntityRef}${options?.actor ? `,actor={${options.actor.subject}}` : ""}}}`
49
63
  },
50
- "token",
51
- {
64
+ token: {
52
65
  enumerable: false,
53
66
  configurable: true,
54
67
  value: user.token()
55
68
  }
56
- );
69
+ });
70
+ return result;
57
71
  }
58
72
  mockCredentials2.user = user;
59
73
  ((user2) => {
@@ -109,7 +123,7 @@ exports.mockCredentials = void 0;
109
123
  limitedUser2.invalidCookie = invalidCookie;
110
124
  })(limitedUser = mockCredentials2.limitedUser || (mockCredentials2.limitedUser = {}));
111
125
  function service(subject = DEFAULT_MOCK_SERVICE_SUBJECT, accessRestrictions) {
112
- return {
126
+ const result = {
113
127
  $$type: "@backstage/BackstageCredentials",
114
128
  principal: {
115
129
  type: "service",
@@ -117,6 +131,14 @@ exports.mockCredentials = void 0;
117
131
  ...accessRestrictions ? { accessRestrictions } : {}
118
132
  }
119
133
  };
134
+ Object.defineProperties(result, {
135
+ toString: {
136
+ enumerable: false,
137
+ configurable: true,
138
+ value: () => `mockCredentials{servicePrincipal{${subject}${accessRestrictions ? `,accessRestrictions=${JSON.stringify(accessRestrictions)}` : ""}}}`
139
+ }
140
+ });
141
+ return result;
120
142
  }
121
143
  mockCredentials2.service = service;
122
144
  ((service2) => {
package/dist/services/mockCredentials.cjs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"mockCredentials.cjs.js","sources":["../../src/services/mockCredentials.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n BackstageCredentials,\n BackstageNonePrincipal,\n BackstagePrincipalAccessRestrictions,\n BackstageServicePrincipal,\n BackstageUserPrincipal,\n} from '@backstage/backend-plugin-api';\n\nexport const DEFAULT_MOCK_USER_ENTITY_REF = 'user:default/mock';\nexport const DEFAULT_MOCK_SERVICE_SUBJECT = 'external:test-service';\n\nexport const MOCK_AUTH_COOKIE = 'backstage-auth';\n\nexport const MOCK_NONE_TOKEN = 'mock-none-token';\n\nexport const MOCK_USER_TOKEN = 'mock-user-token';\nexport const MOCK_USER_TOKEN_PREFIX = 'mock-user-token:';\nexport const MOCK_INVALID_USER_TOKEN = 'mock-invalid-user-token';\n\nexport const MOCK_USER_LIMITED_TOKEN_PREFIX = 'mock-limited-user-token:';\nexport const MOCK_INVALID_USER_LIMITED_TOKEN =\n 'mock-invalid-limited-user-token';\n\nexport const MOCK_SERVICE_TOKEN = 'mock-service-token';\nexport const MOCK_SERVICE_TOKEN_PREFIX = 'mock-service-token:';\nexport const MOCK_INVALID_SERVICE_TOKEN = 'mock-invalid-service-token';\n\nfunction validateUserEntityRef(ref: string) {\n if (!ref.match(/^.+:.+\\/.+$/)) {\n throw new TypeError(\n `Invalid user entity reference '${ref}', expected <kind>:<namespace>/<name>`,\n );\n }\n}\n\n/**\n * The payload that can be encoded into a mock user token.\n * @internal\n */\nexport type UserTokenPayload = {\n sub?: string;\n actor?: { subject: string };\n};\n\n/**\n * The payload that can be encoded into a mock service token.\n * @internal\n */\nexport type ServiceTokenPayload = {\n sub?: string; // service subject\n obo?: string; // user entity reference\n target?: string; // target plugin id\n};\n\n/**\n * @public\n */\nexport namespace mockCredentials {\n /**\n * Creates a mocked credentials object for a unauthenticated principal.\n */\n export function none(): BackstageCredentials<BackstageNonePrincipal> {\n return {\n $$type: '@backstage/BackstageCredentials',\n principal: { type: 'none' },\n };\n }\n\n /**\n * Utilities related to none credentials.\n */\n export namespace none {\n /**\n * Returns an authorization header that translates to unauthenticated\n * credentials.\n *\n * This is useful when one wants to explicitly test unauthenticated requests\n * while still using the default behavior of the mock HttpAuthService where\n * it defaults to user credentials.\n */\n export function header(): string {\n // NOTE: there is no .token() version of this because only the\n // HttpAuthService should know about and consume this token\n return `Bearer ${MOCK_NONE_TOKEN}`;\n }\n }\n\n /**\n * Creates a mocked credentials object for a user principal.\n *\n * The default user entity reference is 'user:default/mock'.\n */\n export function user(\n userEntityRef: string = DEFAULT_MOCK_USER_ENTITY_REF,\n options?: { actor?: { subject: string } },\n ): BackstageCredentials<BackstageUserPrincipal> {\n validateUserEntityRef(userEntityRef);\n return Object.defineProperty(\n {\n $$type: '@backstage/BackstageCredentials',\n principal: {\n type: 'user',\n userEntityRef,\n ...(options?.actor && {\n actor: { type: 'service', subject: options.actor.subject },\n }),\n },\n },\n 'token',\n {\n enumerable: false,\n configurable: true,\n value: user.token(),\n },\n );\n }\n\n /**\n * Utilities related to user credentials.\n */\n export namespace user {\n /**\n * Creates a mocked user token. If a payload is provided it will be encoded\n * into the token and forwarded to the credentials object when authenticated\n * by the mock auth service.\n */\n export function token(\n userEntityRef?: string,\n options?: { actor?: { subject: string } },\n ): string {\n if (userEntityRef) {\n validateUserEntityRef(userEntityRef);\n return `${MOCK_USER_TOKEN_PREFIX}${JSON.stringify({\n sub: userEntityRef,\n ...(options?.actor && {\n actor: { subject: options.actor.subject },\n }),\n } satisfies UserTokenPayload)}`;\n }\n return MOCK_USER_TOKEN;\n }\n\n /**\n * Returns an authorization header with a mocked user token. If a payload is\n * provided it will be encoded into the token and forwarded to the\n * credentials object when authenticated by the mock auth service.\n */\n export function header(userEntityRef?: string): string {\n return `Bearer ${token(userEntityRef)}`;\n }\n\n export function invalidToken(): string {\n return MOCK_INVALID_USER_TOKEN;\n }\n\n export function invalidHeader(): string {\n return `Bearer ${invalidToken()}`;\n }\n }\n\n /**\n * Creates a mocked credentials object for a user principal with limited\n * access.\n *\n * The default user entity reference is 'user:default/mock'.\n */\n export function limitedUser(\n userEntityRef: string = DEFAULT_MOCK_USER_ENTITY_REF,\n ): BackstageCredentials<BackstageUserPrincipal> {\n return user(userEntityRef);\n }\n\n /**\n * Utilities related to limited user credentials.\n */\n export namespace limitedUser {\n /**\n * Creates a mocked limited user token. If a payload is provided it will be\n * encoded into the token and forwarded to the credentials object when\n * authenticated by the mock auth service.\n */\n export function token(\n userEntityRef: string = DEFAULT_MOCK_USER_ENTITY_REF,\n ): string {\n validateUserEntityRef(userEntityRef);\n return `${MOCK_USER_LIMITED_TOKEN_PREFIX}${JSON.stringify({\n sub: userEntityRef,\n } satisfies UserTokenPayload)}`;\n }\n\n /**\n * Returns an authorization header with a mocked limited user token. If a\n * payload is provided it will be encoded into the token and forwarded to\n * the credentials object when authenticated by the mock auth service.\n */\n export function cookie(userEntityRef?: string): string {\n return `${MOCK_AUTH_COOKIE}=${token(userEntityRef)}`;\n }\n\n export function invalidToken(): string {\n return MOCK_INVALID_USER_LIMITED_TOKEN;\n }\n\n export function invalidCookie(): string {\n return `${MOCK_AUTH_COOKIE}=${invalidToken()}`;\n }\n }\n\n /**\n * Creates a mocked credentials object for a service principal.\n *\n * The default subject is 'external:test-service', and no access restrictions.\n */\n export function service(\n subject: string = DEFAULT_MOCK_SERVICE_SUBJECT,\n accessRestrictions?: BackstagePrincipalAccessRestrictions,\n ): BackstageCredentials<BackstageServicePrincipal> {\n return {\n $$type: '@backstage/BackstageCredentials',\n principal: {\n type: 'service',\n subject,\n ...(accessRestrictions ? { accessRestrictions } : {}),\n },\n };\n }\n\n /**\n * Utilities related to service credentials.\n */\n export namespace service {\n /**\n * Options for the creation of mock service tokens.\n */\n export type TokenOptions = {\n onBehalfOf: BackstageCredentials;\n targetPluginId: string;\n };\n\n /**\n * Creates a mocked service token. The provided options will be encoded into\n * the token and forwarded to the credentials object when authenticated by\n * the mock auth service.\n */\n export function token(options?: TokenOptions): string {\n if (options) {\n const { targetPluginId, onBehalfOf } = options; // for fixed ordering\n\n const oboPrincipal = onBehalfOf?.principal as\n | BackstageServicePrincipal\n | BackstageUserPrincipal\n | BackstageNonePrincipal;\n const obo =\n oboPrincipal.type === 'user' ? oboPrincipal.userEntityRef : undefined;\n const subject =\n oboPrincipal.type === 'service' ? oboPrincipal.subject : undefined;\n\n return `${MOCK_SERVICE_TOKEN_PREFIX}${JSON.stringify({\n sub: subject,\n obo,\n target: targetPluginId,\n } satisfies ServiceTokenPayload)}`;\n }\n return MOCK_SERVICE_TOKEN;\n }\n\n /**\n * Returns an authorization header with a mocked service token. The provided\n * options will be encoded into the token and forwarded to the credentials\n * object when authenticated by the mock auth service.\n */\n export function header(options?: TokenOptions): string {\n return `Bearer ${token(options)}`;\n }\n\n export function invalidToken(): string {\n return MOCK_INVALID_SERVICE_TOKEN;\n }\n\n export function invalidHeader(): string {\n return `Bearer ${invalidToken()}`;\n }\n }\n}\n"],"names":["mockCredentials","none","user","limitedUser","service"],"mappings":";;AAwBO,MAAM,4BAA+B,GAAA;AACrC,MAAM,4BAA+B,GAAA;AAErC,MAAM,gBAAmB,GAAA;AAEzB,MAAM,eAAkB,GAAA;AAExB,MAAM,eAAkB,GAAA;AACxB,MAAM,sBAAyB,GAAA;AAC/B,MAAM,uBAA0B,GAAA;AAEhC,MAAM,8BAAiC,GAAA;AACvC,MAAM,+BACX,GAAA;AAEK,MAAM,kBAAqB,GAAA;AAC3B,MAAM,yBAA4B,GAAA;AAClC,MAAM,0BAA6B,GAAA;AAE1C,SAAS,sBAAsB,GAAa,EAAA;AAC1C,EAAA,IAAI,CAAC,GAAA,CAAI,KAAM,CAAA,aAAa,CAAG,EAAA;AAC7B,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,kCAAkC,GAAG,CAAA,qCAAA;AAAA,KACvC;AAAA;AAEJ;AAwBiBA;AAAA,CAAV,CAAUA,gBAAV,KAAA;AAIE,EAAA,SAAS,IAAqD,GAAA;AACnE,IAAO,OAAA;AAAA,MACL,MAAQ,EAAA,iCAAA;AAAA,MACR,SAAA,EAAW,EAAE,IAAA,EAAM,MAAO;AAAA,KAC5B;AAAA;AAJK,EAAAA,gBAAS,CAAA,IAAA,GAAA,IAAA;AAUT,EAAA,CAAA,CAAUC,KAAV,KAAA;AASE,IAAA,SAAS,MAAiB,GAAA;AAG/B,MAAA,OAAO,UAAU,eAAe,CAAA,CAAA;AAAA;AAH3B,IAAAA,KAAS,CAAA,MAAA,GAAA,MAAA;AAAA,GATD,EAAA,IAAA,GAAAD,gBAAA,CAAA,IAAA,KAAAA,gBAAA,CAAA,IAAA,GAAA,EAAA,CAAA,CAAA;AAqBV,EAAS,SAAA,IAAA,CACd,aAAwB,GAAA,4BAAA,EACxB,OAC8C,EAAA;AAC9C,IAAA,qBAAA,CAAsB,aAAa,CAAA;AACnC,IAAA,OAAO,MAAO,CAAA,cAAA;AAAA,MACZ;AAAA,QACE,MAAQ,EAAA,iCAAA;AAAA,QACR,SAAW,EAAA;AAAA,UACT,IAAM,EAAA,MAAA;AAAA,UACN,aAAA;AAAA,UACA,GAAI,SAAS,KAAS,IAAA;AAAA,YACpB,OAAO,EAAE,IAAA,EAAM,WAAW,OAAS,EAAA,OAAA,CAAQ,MAAM,OAAQ;AAAA;AAC3D;AACF,OACF;AAAA,MACA,OAAA;AAAA,MACA;AAAA,QACE,UAAY,EAAA,KAAA;AAAA,QACZ,YAAc,EAAA,IAAA;AAAA,QACd,KAAA,EAAO,KAAK,KAAM;AAAA;AACpB,KACF;AAAA;AAtBK,EAAAA,gBAAS,CAAA,IAAA,GAAA,IAAA;AA4BT,EAAA,CAAA,CAAUE,KAAV,KAAA;AAME,IAAS,SAAA,KAAA,CACd,eACA,OACQ,EAAA;AACR,MAAA,IAAI,aAAe,EAAA;AACjB,QAAA,qBAAA,CAAsB,aAAa,CAAA;AACnC,QAAA,OAAO,CAAG,EAAA,sBAAsB,CAAG,EAAA,IAAA,CAAK,SAAU,CAAA;AAAA,UAChD,GAAK,EAAA,aAAA;AAAA,UACL,GAAI,SAAS,KAAS,IAAA;AAAA,YACpB,KAAO,EAAA,EAAE,OAAS,EAAA,OAAA,CAAQ,MAAM,OAAQ;AAAA;AAC1C,SAC0B,CAAC,CAAA,CAAA;AAAA;AAE/B,MAAO,OAAA,eAAA;AAAA;AAbF,IAAAA,KAAS,CAAA,KAAA,GAAA,KAAA;AAqBT,IAAA,SAAS,OAAO,aAAgC,EAAA;AACrD,MAAO,OAAA,CAAA,OAAA,EAAU,KAAM,CAAA,aAAa,CAAC,CAAA,CAAA;AAAA;AADhC,IAAAA,KAAS,CAAA,MAAA,GAAA,MAAA;AAIT,IAAA,SAAS,YAAuB,GAAA;AACrC,MAAO,OAAA,uBAAA;AAAA;AADF,IAAAA,KAAS,CAAA,YAAA,GAAA,YAAA;AAIT,IAAA,SAAS,aAAwB,GAAA;AACtC,MAAO,OAAA,CAAA,OAAA,EAAU,cAAc,CAAA,CAAA;AAAA;AAD1B,IAAAA,KAAS,CAAA,aAAA,GAAA,aAAA;AAAA,GAnCD,EAAA,IAAA,GAAAF,gBAAA,CAAA,IAAA,KAAAA,gBAAA,CAAA,IAAA,GAAA,EAAA,CAAA,CAAA;AA8CV,EAAS,SAAA,WAAA,CACd,gBAAwB,4BACsB,EAAA;AAC9C,IAAA,OAAO,KAAK,aAAa,CAAA;AAAA;AAHpB,EAAAA,gBAAS,CAAA,WAAA,GAAA,WAAA;AAST,EAAA,CAAA,CAAUG,YAAV,KAAA;AAME,IAAS,SAAA,KAAA,CACd,gBAAwB,4BAChB,EAAA;AACR,MAAA,qBAAA,CAAsB,aAAa,CAAA;AACnC,MAAA,OAAO,CAAG,EAAA,8BAA8B,CAAG,EAAA,IAAA,CAAK,SAAU,CAAA;AAAA,QACxD,GAAK,EAAA;AAAA,OACqB,CAAC,CAAA,CAAA;AAAA;AANxB,IAAAA,YAAS,CAAA,KAAA,GAAA,KAAA;AAcT,IAAA,SAAS,OAAO,aAAgC,EAAA;AACrD,MAAA,OAAO,CAAG,EAAA,gBAAgB,CAAI,CAAA,EAAA,KAAA,CAAM,aAAa,CAAC,CAAA,CAAA;AAAA;AAD7C,IAAAA,YAAS,CAAA,MAAA,GAAA,MAAA;AAIT,IAAA,SAAS,YAAuB,GAAA;AACrC,MAAO,OAAA,+BAAA;AAAA;AADF,IAAAA,YAAS,CAAA,YAAA,GAAA,YAAA;AAIT,IAAA,SAAS,aAAwB,GAAA;AACtC,MAAA,OAAO,CAAG,EAAA,gBAAgB,CAAI,CAAA,EAAA,YAAA,EAAc,CAAA,CAAA;AAAA;AADvC,IAAAA,YAAS,CAAA,aAAA,GAAA,aAAA;AAAA,GA5BD,EAAA,WAAA,GAAAH,gBAAA,CAAA,WAAA,KAAAA,gBAAA,CAAA,WAAA,GAAA,EAAA,CAAA,CAAA;AAsCV,EAAS,SAAA,OAAA,CACd,OAAkB,GAAA,4BAAA,EAClB,kBACiD,EAAA;AACjD,IAAO,OAAA;AAAA,MACL,MAAQ,EAAA,iCAAA;AAAA,MACR,SAAW,EAAA;AAAA,QACT,IAAM,EAAA,SAAA;AAAA,QACN,OAAA;AAAA,QACA,GAAI,kBAAA,GAAqB,EAAE,kBAAA,KAAuB;AAAC;AACrD,KACF;AAAA;AAXK,EAAAA,gBAAS,CAAA,OAAA,GAAA,OAAA;AAiBT,EAAA,CAAA,CAAUI,QAAV,KAAA;AAcE,IAAA,SAAS,MAAM,OAAgC,EAAA;AACpD,MAAA,IAAI,OAAS,EAAA;AACX,QAAM,MAAA,EAAE,cAAgB,EAAA,UAAA,EAAe,GAAA,OAAA;AAEvC,QAAA,MAAM,eAAe,UAAY,EAAA,SAAA;AAIjC,QAAA,MAAM,GACJ,GAAA,YAAA,CAAa,IAAS,KAAA,MAAA,GAAS,aAAa,aAAgB,GAAA,KAAA,CAAA;AAC9D,QAAA,MAAM,OACJ,GAAA,YAAA,CAAa,IAAS,KAAA,SAAA,GAAY,aAAa,OAAU,GAAA,KAAA,CAAA;AAE3D,QAAA,OAAO,CAAG,EAAA,yBAAyB,CAAG,EAAA,IAAA,CAAK,SAAU,CAAA;AAAA,UACnD,GAAK,EAAA,OAAA;AAAA,UACL,GAAA;AAAA,UACA,MAAQ,EAAA;AAAA,SACqB,CAAC,CAAA,CAAA;AAAA;AAElC,MAAO,OAAA,kBAAA;AAAA;AAnBF,IAAAA,QAAS,CAAA,KAAA,GAAA,KAAA;AA2BT,IAAA,SAAS,OAAO,OAAgC,EAAA;AACrD,MAAO,OAAA,CAAA,OAAA,EAAU,KAAM,CAAA,OAAO,CAAC,CAAA,CAAA;AAAA;AAD1B,IAAAA,QAAS,CAAA,MAAA,GAAA,MAAA;AAIT,IAAA,SAAS,YAAuB,GAAA;AACrC,MAAO,OAAA,0BAAA;AAAA;AADF,IAAAA,QAAS,CAAA,YAAA,GAAA,YAAA;AAIT,IAAA,SAAS,aAAwB,GAAA;AACtC,MAAO,OAAA,CAAA,OAAA,EAAU,cAAc,CAAA,CAAA;AAAA;AAD1B,IAAAA,QAAS,CAAA,aAAA,GAAA,aAAA;AAAA,GAjDD,EAAA,OAAA,GAAAJ,gBAAA,CAAA,OAAA,KAAAA,gBAAA,CAAA,OAAA,GAAA,EAAA,CAAA,CAAA;AAAA,CA7KF,EAAAA,uBAAA,KAAAA,uBAAA,GAAA,EAAA,CAAA,CAAA;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"mockCredentials.cjs.js","sources":["../../src/services/mockCredentials.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n BackstageCredentials,\n BackstageNonePrincipal,\n BackstagePrincipalAccessRestrictions,\n BackstageServicePrincipal,\n BackstageUserPrincipal,\n} from '@backstage/backend-plugin-api';\n\nexport const DEFAULT_MOCK_USER_ENTITY_REF = 'user:default/mock';\nexport const DEFAULT_MOCK_SERVICE_SUBJECT = 'external:test-service';\n\nexport const MOCK_AUTH_COOKIE = 'backstage-auth';\n\nexport const MOCK_NONE_TOKEN = 'mock-none-token';\n\nexport const MOCK_USER_TOKEN = 'mock-user-token';\nexport const MOCK_USER_TOKEN_PREFIX = 'mock-user-token:';\nexport const MOCK_INVALID_USER_TOKEN = 'mock-invalid-user-token';\n\nexport const MOCK_USER_LIMITED_TOKEN_PREFIX = 'mock-limited-user-token:';\nexport const MOCK_INVALID_USER_LIMITED_TOKEN =\n 'mock-invalid-limited-user-token';\n\nexport const MOCK_SERVICE_TOKEN = 'mock-service-token';\nexport const MOCK_SERVICE_TOKEN_PREFIX = 'mock-service-token:';\nexport const MOCK_INVALID_SERVICE_TOKEN = 'mock-invalid-service-token';\n\nfunction validateUserEntityRef(ref: string) {\n if (!ref.match(/^.+:.+\\/.+$/)) {\n throw new TypeError(\n `Invalid user entity reference '${ref}', expected <kind>:<namespace>/<name>`,\n );\n }\n}\n\n/**\n * The payload that can be encoded into a mock user token.\n * @internal\n */\nexport type UserTokenPayload = {\n sub?: string;\n actor?: { subject: string };\n};\n\n/**\n * The payload that can be encoded into a mock service token.\n * @internal\n */\nexport type ServiceTokenPayload = {\n sub?: string; // service subject\n obo?: string; // user entity reference\n target?: string; // target plugin id\n};\n\n/**\n * @public\n */\nexport namespace mockCredentials {\n /**\n * Creates a mocked credentials object for a unauthenticated principal.\n */\n export function none(): BackstageCredentials<BackstageNonePrincipal> {\n const result = {\n $$type: '@backstage/BackstageCredentials',\n principal: { type: 'none' },\n } as const;\n Object.defineProperties(result, {\n toString: {\n enumerable: false,\n configurable: true,\n writable: true,\n value: () => `mockCredentials{nonePrincipal}`,\n },\n });\n return result;\n }\n\n /**\n * Utilities related to none credentials.\n */\n export namespace none {\n /**\n * Returns an authorization header that translates to unauthenticated\n * credentials.\n *\n * This is useful when one wants to explicitly test unauthenticated requests\n * while still using the default behavior of the mock HttpAuthService where\n * it defaults to user credentials.\n */\n export function header(): string {\n // NOTE: there is no .token() version of this because only the\n // HttpAuthService should know about and consume this token\n return `Bearer ${MOCK_NONE_TOKEN}`;\n }\n }\n\n /**\n * Creates a mocked credentials object for a user principal.\n *\n * The default user entity reference is 'user:default/mock'.\n */\n export function user(\n userEntityRef: string = DEFAULT_MOCK_USER_ENTITY_REF,\n options?: { actor?: { subject: string } },\n ): BackstageCredentials<BackstageUserPrincipal> {\n validateUserEntityRef(userEntityRef);\n const result = {\n $$type: '@backstage/BackstageCredentials',\n principal: {\n type: 'user',\n userEntityRef,\n ...(options?.actor && {\n actor: { type: 'service', subject: options.actor.subject } as const,\n }),\n },\n } as const;\n Object.defineProperties(result, {\n toString: {\n enumerable: false,\n configurable: true,\n value: () =>\n `mockCredentials{userPrincipal{${userEntityRef}${\n options?.actor ? `,actor={${options.actor.subject}}` : ''\n }}}`,\n },\n token: {\n enumerable: false,\n configurable: true,\n value: user.token(),\n },\n });\n return result;\n }\n\n /**\n * Utilities related to user credentials.\n */\n export namespace user {\n /**\n * Creates a mocked user token. If a payload is provided it will be encoded\n * into the token and forwarded to the credentials object when authenticated\n * by the mock auth service.\n */\n export function token(\n userEntityRef?: string,\n options?: { actor?: { subject: string } },\n ): string {\n if (userEntityRef) {\n validateUserEntityRef(userEntityRef);\n return `${MOCK_USER_TOKEN_PREFIX}${JSON.stringify({\n sub: userEntityRef,\n ...(options?.actor && {\n actor: { subject: options.actor.subject },\n }),\n } satisfies UserTokenPayload)}`;\n }\n return MOCK_USER_TOKEN;\n }\n\n /**\n * Returns an authorization header with a mocked user token. If a payload is\n * provided it will be encoded into the token and forwarded to the\n * credentials object when authenticated by the mock auth service.\n */\n export function header(userEntityRef?: string): string {\n return `Bearer ${token(userEntityRef)}`;\n }\n\n export function invalidToken(): string {\n return MOCK_INVALID_USER_TOKEN;\n }\n\n export function invalidHeader(): string {\n return `Bearer ${invalidToken()}`;\n }\n }\n\n /**\n * Creates a mocked credentials object for a user principal with limited\n * access.\n *\n * The default user entity reference is 'user:default/mock'.\n */\n export function limitedUser(\n userEntityRef: string = DEFAULT_MOCK_USER_ENTITY_REF,\n ): BackstageCredentials<BackstageUserPrincipal> {\n return user(userEntityRef);\n }\n\n /**\n * Utilities related to limited user credentials.\n */\n export namespace limitedUser {\n /**\n * Creates a mocked limited user token. If a payload is provided it will be\n * encoded into the token and forwarded to the credentials object when\n * authenticated by the mock auth service.\n */\n export function token(\n userEntityRef: string = DEFAULT_MOCK_USER_ENTITY_REF,\n ): string {\n validateUserEntityRef(userEntityRef);\n return `${MOCK_USER_LIMITED_TOKEN_PREFIX}${JSON.stringify({\n sub: userEntityRef,\n } satisfies UserTokenPayload)}`;\n }\n\n /**\n * Returns an authorization header with a mocked limited user token. If a\n * payload is provided it will be encoded into the token and forwarded to\n * the credentials object when authenticated by the mock auth service.\n */\n export function cookie(userEntityRef?: string): string {\n return `${MOCK_AUTH_COOKIE}=${token(userEntityRef)}`;\n }\n\n export function invalidToken(): string {\n return MOCK_INVALID_USER_LIMITED_TOKEN;\n }\n\n export function invalidCookie(): string {\n return `${MOCK_AUTH_COOKIE}=${invalidToken()}`;\n }\n }\n\n /**\n * Creates a mocked credentials object for a service principal.\n *\n * The default subject is 'external:test-service', and no access restrictions.\n */\n export function service(\n subject: string = DEFAULT_MOCK_SERVICE_SUBJECT,\n accessRestrictions?: BackstagePrincipalAccessRestrictions,\n ): BackstageCredentials<BackstageServicePrincipal> {\n const result = {\n $$type: '@backstage/BackstageCredentials',\n principal: {\n type: 'service',\n subject,\n ...(accessRestrictions ? { accessRestrictions } : {}),\n },\n } as const;\n Object.defineProperties(result, {\n toString: {\n enumerable: false,\n configurable: true,\n value: () =>\n `mockCredentials{servicePrincipal{${subject}${\n accessRestrictions\n ? `,accessRestrictions=${JSON.stringify(accessRestrictions)}`\n : ''\n }}}`,\n },\n });\n return result;\n }\n\n /**\n * Utilities related to service credentials.\n */\n export namespace service {\n /**\n * Options for the creation of mock service tokens.\n */\n export type TokenOptions = {\n onBehalfOf: BackstageCredentials;\n targetPluginId: string;\n };\n\n /**\n * Creates a mocked service token. The provided options will be encoded into\n * the token and forwarded to the credentials object when authenticated by\n * the mock auth service.\n */\n export function token(options?: TokenOptions): string {\n if (options) {\n const { targetPluginId, onBehalfOf } = options; // for fixed ordering\n\n const oboPrincipal = onBehalfOf?.principal as\n | BackstageServicePrincipal\n | BackstageUserPrincipal\n | BackstageNonePrincipal;\n const obo =\n oboPrincipal.type === 'user' ? oboPrincipal.userEntityRef : undefined;\n const subject =\n oboPrincipal.type === 'service' ? oboPrincipal.subject : undefined;\n\n return `${MOCK_SERVICE_TOKEN_PREFIX}${JSON.stringify({\n sub: subject,\n obo,\n target: targetPluginId,\n } satisfies ServiceTokenPayload)}`;\n }\n return MOCK_SERVICE_TOKEN;\n }\n\n /**\n * Returns an authorization header with a mocked service token. The provided\n * options will be encoded into the token and forwarded to the credentials\n * object when authenticated by the mock auth service.\n */\n export function header(options?: TokenOptions): string {\n return `Bearer ${token(options)}`;\n }\n\n export function invalidToken(): string {\n return MOCK_INVALID_SERVICE_TOKEN;\n }\n\n export function invalidHeader(): string {\n return `Bearer ${invalidToken()}`;\n }\n }\n}\n"],"names":["mockCredentials","none","user","limitedUser","service"],"mappings":";;AAwBO,MAAM,4BAA+B,GAAA;AACrC,MAAM,4BAA+B,GAAA;AAErC,MAAM,gBAAmB,GAAA;AAEzB,MAAM,eAAkB,GAAA;AAExB,MAAM,eAAkB,GAAA;AACxB,MAAM,sBAAyB,GAAA;AAC/B,MAAM,uBAA0B,GAAA;AAEhC,MAAM,8BAAiC,GAAA;AACvC,MAAM,+BACX,GAAA;AAEK,MAAM,kBAAqB,GAAA;AAC3B,MAAM,yBAA4B,GAAA;AAClC,MAAM,0BAA6B,GAAA;AAE1C,SAAS,sBAAsB,GAAa,EAAA;AAC1C,EAAA,IAAI,CAAC,GAAA,CAAI,KAAM,CAAA,aAAa,CAAG,EAAA;AAC7B,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,kCAAkC,GAAG,CAAA,qCAAA;AAAA,KACvC;AAAA;AAEJ;AAwBiBA;AAAA,CAAV,CAAUA,gBAAV,KAAA;AAIE,EAAA,SAAS,IAAqD,GAAA;AACnE,IAAA,MAAM,MAAS,GAAA;AAAA,MACb,MAAQ,EAAA,iCAAA;AAAA,MACR,SAAA,EAAW,EAAE,IAAA,EAAM,MAAO;AAAA,KAC5B;AACA,IAAA,MAAA,CAAO,iBAAiB,MAAQ,EAAA;AAAA,MAC9B,QAAU,EAAA;AAAA,QACR,UAAY,EAAA,KAAA;AAAA,QACZ,YAAc,EAAA,IAAA;AAAA,QACd,QAAU,EAAA,IAAA;AAAA,QACV,OAAO,MAAM,CAAA,8BAAA;AAAA;AACf,KACD,CAAA;AACD,IAAO,OAAA,MAAA;AAAA;AAbF,EAAAA,gBAAS,CAAA,IAAA,GAAA,IAAA;AAmBT,EAAA,CAAA,CAAUC,KAAV,KAAA;AASE,IAAA,SAAS,MAAiB,GAAA;AAG/B,MAAA,OAAO,UAAU,eAAe,CAAA,CAAA;AAAA;AAH3B,IAAAA,KAAS,CAAA,MAAA,GAAA,MAAA;AAAA,GATD,EAAA,IAAA,GAAAD,gBAAA,CAAA,IAAA,KAAAA,gBAAA,CAAA,IAAA,GAAA,EAAA,CAAA,CAAA;AAqBV,EAAS,SAAA,IAAA,CACd,aAAwB,GAAA,4BAAA,EACxB,OAC8C,EAAA;AAC9C,IAAA,qBAAA,CAAsB,aAAa,CAAA;AACnC,IAAA,MAAM,MAAS,GAAA;AAAA,MACb,MAAQ,EAAA,iCAAA;AAAA,MACR,SAAW,EAAA;AAAA,QACT,IAAM,EAAA,MAAA;AAAA,QACN,aAAA;AAAA,QACA,GAAI,SAAS,KAAS,IAAA;AAAA,UACpB,OAAO,EAAE,IAAA,EAAM,WAAW,OAAS,EAAA,OAAA,CAAQ,MAAM,OAAQ;AAAA;AAC3D;AACF,KACF;AACA,IAAA,MAAA,CAAO,iBAAiB,MAAQ,EAAA;AAAA,MAC9B,QAAU,EAAA;AAAA,QACR,UAAY,EAAA,KAAA;AAAA,QACZ,YAAc,EAAA,IAAA;AAAA,QACd,KAAO,EAAA,MACL,CAAiC,8BAAA,EAAA,aAAa,CAC5C,EAAA,OAAA,EAAS,KAAQ,GAAA,CAAA,QAAA,EAAW,OAAQ,CAAA,KAAA,CAAM,OAAO,CAAA,CAAA,CAAA,GAAM,EACzD,CAAA,EAAA;AAAA,OACJ;AAAA,MACA,KAAO,EAAA;AAAA,QACL,UAAY,EAAA,KAAA;AAAA,QACZ,YAAc,EAAA,IAAA;AAAA,QACd,KAAA,EAAO,KAAK,KAAM;AAAA;AACpB,KACD,CAAA;AACD,IAAO,OAAA,MAAA;AAAA;AA9BF,EAAAA,gBAAS,CAAA,IAAA,GAAA,IAAA;AAoCT,EAAA,CAAA,CAAUE,KAAV,KAAA;AAME,IAAS,SAAA,KAAA,CACd,eACA,OACQ,EAAA;AACR,MAAA,IAAI,aAAe,EAAA;AACjB,QAAA,qBAAA,CAAsB,aAAa,CAAA;AACnC,QAAA,OAAO,CAAG,EAAA,sBAAsB,CAAG,EAAA,IAAA,CAAK,SAAU,CAAA;AAAA,UAChD,GAAK,EAAA,aAAA;AAAA,UACL,GAAI,SAAS,KAAS,IAAA;AAAA,YACpB,KAAO,EAAA,EAAE,OAAS,EAAA,OAAA,CAAQ,MAAM,OAAQ;AAAA;AAC1C,SAC0B,CAAC,CAAA,CAAA;AAAA;AAE/B,MAAO,OAAA,eAAA;AAAA;AAbF,IAAAA,KAAS,CAAA,KAAA,GAAA,KAAA;AAqBT,IAAA,SAAS,OAAO,aAAgC,EAAA;AACrD,MAAO,OAAA,CAAA,OAAA,EAAU,KAAM,CAAA,aAAa,CAAC,CAAA,CAAA;AAAA;AADhC,IAAAA,KAAS,CAAA,MAAA,GAAA,MAAA;AAIT,IAAA,SAAS,YAAuB,GAAA;AACrC,MAAO,OAAA,uBAAA;AAAA;AADF,IAAAA,KAAS,CAAA,YAAA,GAAA,YAAA;AAIT,IAAA,SAAS,aAAwB,GAAA;AACtC,MAAO,OAAA,CAAA,OAAA,EAAU,cAAc,CAAA,CAAA;AAAA;AAD1B,IAAAA,KAAS,CAAA,aAAA,GAAA,aAAA;AAAA,GAnCD,EAAA,IAAA,GAAAF,gBAAA,CAAA,IAAA,KAAAA,gBAAA,CAAA,IAAA,GAAA,EAAA,CAAA,CAAA;AA8CV,EAAS,SAAA,WAAA,CACd,gBAAwB,4BACsB,EAAA;AAC9C,IAAA,OAAO,KAAK,aAAa,CAAA;AAAA;AAHpB,EAAAA,gBAAS,CAAA,WAAA,GAAA,WAAA;AAST,EAAA,CAAA,CAAUG,YAAV,KAAA;AAME,IAAS,SAAA,KAAA,CACd,gBAAwB,4BAChB,EAAA;AACR,MAAA,qBAAA,CAAsB,aAAa,CAAA;AACnC,MAAA,OAAO,CAAG,EAAA,8BAA8B,CAAG,EAAA,IAAA,CAAK,SAAU,CAAA;AAAA,QACxD,GAAK,EAAA;AAAA,OACqB,CAAC,CAAA,CAAA;AAAA;AANxB,IAAAA,YAAS,CAAA,KAAA,GAAA,KAAA;AAcT,IAAA,SAAS,OAAO,aAAgC,EAAA;AACrD,MAAA,OAAO,CAAG,EAAA,gBAAgB,CAAI,CAAA,EAAA,KAAA,CAAM,aAAa,CAAC,CAAA,CAAA;AAAA;AAD7C,IAAAA,YAAS,CAAA,MAAA,GAAA,MAAA;AAIT,IAAA,SAAS,YAAuB,GAAA;AACrC,MAAO,OAAA,+BAAA;AAAA;AADF,IAAAA,YAAS,CAAA,YAAA,GAAA,YAAA;AAIT,IAAA,SAAS,aAAwB,GAAA;AACtC,MAAA,OAAO,CAAG,EAAA,gBAAgB,CAAI,CAAA,EAAA,YAAA,EAAc,CAAA,CAAA;AAAA;AADvC,IAAAA,YAAS,CAAA,aAAA,GAAA,aAAA;AAAA,GA5BD,EAAA,WAAA,GAAAH,gBAAA,CAAA,WAAA,KAAAA,gBAAA,CAAA,WAAA,GAAA,EAAA,CAAA,CAAA;AAsCV,EAAS,SAAA,OAAA,CACd,OAAkB,GAAA,4BAAA,EAClB,kBACiD,EAAA;AACjD,IAAA,MAAM,MAAS,GAAA;AAAA,MACb,MAAQ,EAAA,iCAAA;AAAA,MACR,SAAW,EAAA;AAAA,QACT,IAAM,EAAA,SAAA;AAAA,QACN,OAAA;AAAA,QACA,GAAI,kBAAA,GAAqB,EAAE,kBAAA,KAAuB;AAAC;AACrD,KACF;AACA,IAAA,MAAA,CAAO,iBAAiB,MAAQ,EAAA;AAAA,MAC9B,QAAU,EAAA;AAAA,QACR,UAAY,EAAA,KAAA;AAAA,QACZ,YAAc,EAAA,IAAA;AAAA,QACd,KAAO,EAAA,MACL,CAAoC,iCAAA,EAAA,OAAO,CACzC,EAAA,kBAAA,GACI,CAAuB,oBAAA,EAAA,IAAA,CAAK,SAAU,CAAA,kBAAkB,CAAC,CAAA,CAAA,GACzD,EACN,CAAA,EAAA;AAAA;AACJ,KACD,CAAA;AACD,IAAO,OAAA,MAAA;AAAA;AAxBF,EAAAA,gBAAS,CAAA,OAAA,GAAA,OAAA;AA8BT,EAAA,CAAA,CAAUI,QAAV,KAAA;AAcE,IAAA,SAAS,MAAM,OAAgC,EAAA;AACpD,MAAA,IAAI,OAAS,EAAA;AACX,QAAM,MAAA,EAAE,cAAgB,EAAA,UAAA,EAAe,GAAA,OAAA;AAEvC,QAAA,MAAM,eAAe,UAAY,EAAA,SAAA;AAIjC,QAAA,MAAM,GACJ,GAAA,YAAA,CAAa,IAAS,KAAA,MAAA,GAAS,aAAa,aAAgB,GAAA,KAAA,CAAA;AAC9D,QAAA,MAAM,OACJ,GAAA,YAAA,CAAa,IAAS,KAAA,SAAA,GAAY,aAAa,OAAU,GAAA,KAAA,CAAA;AAE3D,QAAA,OAAO,CAAG,EAAA,yBAAyB,CAAG,EAAA,IAAA,CAAK,SAAU,CAAA;AAAA,UACnD,GAAK,EAAA,OAAA;AAAA,UACL,GAAA;AAAA,UACA,MAAQ,EAAA;AAAA,SACqB,CAAC,CAAA,CAAA;AAAA;AAElC,MAAO,OAAA,kBAAA;AAAA;AAnBF,IAAAA,QAAS,CAAA,KAAA,GAAA,KAAA;AA2BT,IAAA,SAAS,OAAO,OAAgC,EAAA;AACrD,MAAO,OAAA,CAAA,OAAA,EAAU,KAAM,CAAA,OAAO,CAAC,CAAA,CAAA;AAAA;AAD1B,IAAAA,QAAS,CAAA,MAAA,GAAA,MAAA;AAIT,IAAA,SAAS,YAAuB,GAAA;AACrC,MAAO,OAAA,0BAAA;AAAA;AADF,IAAAA,QAAS,CAAA,YAAA,GAAA,YAAA;AAIT,IAAA,SAAS,aAAwB,GAAA;AACtC,MAAO,OAAA,CAAA,OAAA,EAAU,cAAc,CAAA,CAAA;AAAA;AAD1B,IAAAA,QAAS,CAAA,aAAA,GAAA,aAAA;AAAA,GAjDD,EAAA,OAAA,GAAAJ,gBAAA,CAAA,OAAA,KAAAA,gBAAA,CAAA,OAAA,GAAA,EAAA,CAAA,CAAA;AAAA,CA3MF,EAAAA,uBAAA,KAAAA,uBAAA,GAAA,EAAA,CAAA,CAAA;;;;;;;;;;;;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/backend-test-utils",
3
- "version": "1.6.0",
3
+ "version": "1.7.0-next.1",
4
4
  "description": "Test helpers library for Backstage backends",
5
5
  "backstage": {
6
6
  "role": "node-library"
@@ -57,15 +57,15 @@
57
57
  "test": "backstage-cli package test"
58
58
  },
59
59
  "dependencies": {
60
- "@backstage/backend-app-api": "^1.2.4",
61
- "@backstage/backend-defaults": "^0.11.0",
62
- "@backstage/backend-plugin-api": "^1.4.0",
63
- "@backstage/config": "^1.3.2",
64
- "@backstage/errors": "^1.2.7",
65
- "@backstage/plugin-auth-node": "^0.6.4",
66
- "@backstage/plugin-events-node": "^0.4.12",
67
- "@backstage/plugin-permission-common": "^0.9.0",
68
- "@backstage/types": "^1.2.1",
60
+ "@backstage/backend-app-api": "1.2.5-next.0",
61
+ "@backstage/backend-defaults": "0.11.1-next.1",
62
+ "@backstage/backend-plugin-api": "1.4.1-next.0",
63
+ "@backstage/config": "1.3.3-next.0",
64
+ "@backstage/errors": "1.2.7",
65
+ "@backstage/plugin-auth-node": "0.6.5-next.0",
66
+ "@backstage/plugin-events-node": "0.4.13-next.0",
67
+ "@backstage/plugin-permission-common": "0.9.1-next.0",
68
+ "@backstage/types": "1.2.1",
69
69
  "@keyv/memcache": "^2.0.1",
70
70
  "@keyv/redis": "^4.0.1",
71
71
  "@keyv/valkey": "^1.0.1",
@@ -90,7 +90,7 @@
90
90
  "zod-to-json-schema": "^3.20.4"
91
91
  },
92
92
  "devDependencies": {
93
- "@backstage/cli": "^0.33.0",
93
+ "@backstage/cli": "0.33.1-next.1",
94
94
  "@types/jest": "*",
95
95
  "@types/supertest": "^2.0.8",
96
96
  "supertest": "^7.0.0"