@red-hat-developer-hub/e2e-test-utils 1.1.22 → 1.1.24

package/dist/utils/plugin-metadata.d.ts

@@ -1,108 +1,61 @@
-/**
- * Represents parsed plugin metadata from a Package CRD file.
- */
 export interface PluginMetadata {
-    /** The dynamic artifact path (e.g., ./dynamic-plugins/dist/plugin-name) */
     packagePath: string;
-    /** The plugin configuration from appConfigExamples[0].content */
     pluginConfig: Record<string, unknown>;
-    /** The package name (e.g., @backstage-community/plugin-tech-radar) */
     packageName: string;
-    /** Source metadata file path */
     sourceFile: string;
 }
+export interface PluginEntry {
+    package: string;
+    disabled?: boolean;
+    pluginConfig?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+export interface DynamicPluginsConfig {
+    plugins?: PluginEntry[];
+    includes?: string[];
+    [key: string]: unknown;
+}
 /**
- * Checks if plugin metadata handling should be enabled.
- * This controls both auto-generation and injection of plugin metadata.
+ * Detects if we're running in a nightly/periodic job context.
+ * Controls the entire nightly vs PR routing in deployment:
+ * - Nightly: uses metadata OCI refs (latest published versions), skips metadata injection
+ * - PR/local: uses metadata + OCI URL replacement
  *
- * Default: ENABLED (for local dev and PR builds)
- * Disabled when:
- * - RHDH_SKIP_PLUGIN_METADATA_INJECTION is set, OR
- * - JOB_NAME contains "periodic-" (nightly/periodic builds)
+ * Returns true when:
+ * - JOB_NAME contains "periodic-" (OpenShift CI nightly/periodic jobs), OR
+ * - E2E_NIGHTLY_MODE is set (manual override for local testing)
  */
-export declare function shouldInjectPluginMetadata(): boolean;
+export declare function isNightlyJob(): boolean;
 /**
  * Extracts the plugin name from a package path or OCI reference.
  *
  * Handles various formats:
  * - Local path: ./dynamic-plugins/dist/backstage-community-plugin-tech-radar
- * - OCI with integrity: oci://quay.io/rhdh/plugin@sha256:...!backstage-community-plugin-tech-radar
- * - OCI without integrity: oci://quay.io/rhdh/backstage-community-plugin-tech-radar:tag
- *
- * @param packageRef The package reference string
- * @returns The extracted plugin name
+ * - OCI with alias: oci://quay.io/rhdh/plugin@sha256:...!backstage-community-plugin-tech-radar
+ * - OCI without alias: oci://quay.io/rhdh/backstage-community-plugin-tech-radar:tag
  */
 export declare function extractPluginName(packageRef: string): string;
+export declare const DEFAULT_METADATA_PATH = "../metadata";
+export declare function getMetadataDirectory(metadataPath?: string): string | null;
+export declare function parseMetadataFile(filePath: string): Promise<PluginMetadata>;
+export declare function parseAllMetadataFiles(metadataDir: string): Promise<Map<string, PluginMetadata>>;
+/**
+ * Resolves plugin package references to their target OCI URLs where applicable.
+ *
+ * Resolution priority for each plugin:
+ * 1. PR OCI URL — if GIT_PR_NUMBER set and a PR image was published for this plugin
+ * 2. Metadata OCI ref — uses dynamicArtifact from metadata (latest published version)
+ * 3. Unchanged — local paths, npm packages, or other formats kept as-is
+ */
 /**
  * Returns a stable merge key for a plugin entry so OCI and local path for the same
  * logical plugin match when merging dynamic-plugins configs. Strips a trailing
  * "-dynamic" so e.g. backstage-community-plugin-catalog-backend-module-keycloak-dynamic
  * and ...-keycloak (from OCI) map to the same key.
- *
- * @param entry Plugin entry with optional package reference
- * @returns Normalized key for merge deduplication, or empty string if package is missing
  */
 export declare function getNormalizedPluginMergeKey(entry: {
     package?: string;
 }): string;
-/**
- * Default metadata directory path relative to the e2e-tests directory.
- * Follows the same pattern as user config paths (e.g., tests/config/dynamic-plugins.yaml).
- */
-export declare const DEFAULT_METADATA_PATH = "../metadata";
-/**
- * Gets the metadata directory path.
- * Uses the provided path or falls back to DEFAULT_METADATA_PATH.
- *
- * @param metadataPath Optional custom path to metadata directory
- * @returns The metadata directory path, or null if it doesn't exist
- */
-export declare function getMetadataDirectory(metadataPath?: string): string | null;
-/**
- * Parses a single metadata YAML file and extracts plugin configuration.
- *
- * @param filePath Path to the metadata YAML file
- * @returns PluginMetadata if valid, null otherwise
- */
-export declare function parseMetadataFile(filePath: string): Promise<PluginMetadata>;
-/**
- * Parses all metadata files in a directory and builds a map of plugin name to config.
- * The plugin name is extracted from the dynamicArtifact path for flexible matching.
- *
- * @param metadataDir Path to the metadata directory
- * @returns Map of plugin name to plugin configuration
- */
-export declare function parseAllMetadataFiles(metadataDir: string): Promise<Map<string, PluginMetadata>>;
-/**
- * Plugin entry in dynamic-plugins.yaml
- */
-export interface PluginEntry {
-    package: string;
-    disabled?: boolean;
-    pluginConfig?: Record<string, unknown>;
-    [key: string]: unknown;
-}
-/**
- * Dynamic plugins configuration structure
- */
-export interface DynamicPluginsConfig {
-    plugins?: PluginEntry[];
-    includes?: string[];
-    [key: string]: unknown;
-}
-/**
- * Injects plugin configurations from metadata into a dynamic plugins config.
- * Metadata config serves as the base, user-provided pluginConfig overrides it.
- *
- * Matching is done by extracting the plugin name from both the package reference
- * and the metadata's dynamicArtifact, allowing flexible matching across different
- * package formats (local paths, OCI references, etc.).
- *
- * @param dynamicPluginsConfig The dynamic plugins configuration to augment
- * @param metadataMap Map of plugin names to plugin metadata
- * @returns The augmented configuration with injected pluginConfigs
- */
-export declare function injectMetadataConfig(dynamicPluginsConfig: DynamicPluginsConfig, metadataMap: Map<string, PluginMetadata>): DynamicPluginsConfig;
 /**
  * Generates dynamic-plugins configuration for wrapper plugins
  * that need to be disabled. Each plugin entry contains:
@@ -114,25 +67,28 @@ export declare function injectMetadataConfig(dynamicPluginsConfig: DynamicPlugin
  */
 export declare function disablePluginWrappers(plugins: string[]): DynamicPluginsConfig;
 /**
- * Generates a complete dynamic-plugins configuration from metadata files.
- * Iterates through all metadata files and creates plugin entries with:
- * - package: the dynamicArtifact path
- * - disabled: false (enabled by default)
- * - pluginConfig: from appConfigExamples[0].content
+ * Auto-generates plugin entries from workspace metadata files.
+ * Creates raw entries with local paths and disabled: false.
+ * Does NOT include pluginConfig — that's handled by processPluginsForDeployment.
  *
- * @param metadataPath Optional custom path to metadata directory (default: ../metadata)
- * @returns Complete dynamic plugins configuration
- * @throws Error if metadata directory not found or no valid metadata files
+ * @param metadataPath Optional custom path to metadata directory
+ * @returns Plugin entries discovered from metadata
  */
-export declare function generateDynamicPluginsConfigFromMetadata(metadataPath?: string): Promise<DynamicPluginsConfig>;
+export declare function generatePluginsFromMetadata(metadataPath?: string): Promise<DynamicPluginsConfig>;
 /**
- * Main function to load and inject plugin metadata for PR builds.
- * For non-PR builds (nightly), returns the config unchanged.
+ * Processes a dynamic plugins configuration for deployment.
+ * Single entry point for both PR and nightly flows.
+ *
+ * Operations (in order):
+ * 1. Inject appConfigExamples from metadata (PR mode only, unless RHDH_SKIP_PLUGIN_METADATA_INJECTION is set)
+ * 2. Resolve all packages to OCI references:
+ *    - PR with GIT_PR_NUMBER: workspace plugins in PR build → pr_ tags, rest unchanged
+ *    - PR without GIT_PR_NUMBER: OCI plugins with metadata → metadata refs, rest unchanged
+ *    - Nightly: OCI plugins with metadata → metadata refs, rest unchanged
  *
- * @param dynamicPluginsConfig The dynamic plugins configuration
- * @param metadataPath Optional custom path to metadata directory (default: ../metadata)
- * @returns Augmented configuration with metadata (for PR) or unchanged (for nightly)
- * @throws Error if PR build but no metadata directory found
+ * @param config The merged dynamic plugins configuration
+ * @param metadataPath Optional custom path to metadata directory
+ * @returns Processed configuration ready for deployment
  */
-export declare function loadAndInjectPluginMetadata(dynamicPluginsConfig: DynamicPluginsConfig, metadataPath?: string): Promise<DynamicPluginsConfig>;
+export declare function processPluginsForDeployment(config: DynamicPluginsConfig, metadataPath?: string): Promise<DynamicPluginsConfig>;
 //# sourceMappingURL=plugin-metadata.d.ts.map

package/dist/utils/plugin-metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-metadata.d.ts","sourceRoot":"","sources":["../../src/utils/plugin-metadata.ts"],"names":[],"mappings":"AA8HA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,2EAA2E;IAC3E,WAAW,EAAE,MAAM,CAAC;IACpB,iEAAiE;IACjE,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,sEAAsE;IACtE,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAgBD;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,IAAI,OAAO,CAmBpD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAQ5D;AAED;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,MAAM,CAMT;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,gBAAgB,CAAC;AAEnD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,GAAE,MAA8B,GAC3C,MAAM,GAAG,IAAI,CAUf;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,cAAc,CAAC,CA0BzB;AAED;;;;;;GAMG;AACH,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAwBtC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AA4CD;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,oBAAoB,EAAE,oBAAoB,EAC1C,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,GACvC,oBAAoB,CAsCtB;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,oBAAoB,CAW7E;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,wCAAwC,CAC5D,YAAY,GAAE,MAA8B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CAsD/B;AAED;;;;;;;;GAQG;AACH,wBAAsB,2BAA2B,CAC/C,oBAAoB,EAAE,oBAAoB,EAC1C,YAAY,GAAE,MAA8B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CAuC/B"}
+{"version":3,"file":"plugin-metadata.d.ts","sourceRoot":"","sources":["../../src/utils/plugin-metadata.ts"],"names":[],"mappings":"AAWA,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAaD,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAID;;;;;;;;;GASG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAqBtC;AAID;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAI5D;AAYD,eAAO,MAAM,qBAAqB,gBAAgB,CAAC;AAEnD,wBAAgB,oBAAoB,CAClC,YAAY,GAAE,MAA8B,GAC3C,MAAM,GAAG,IAAI,CAQf;AAED,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,cAAc,CAAC,CAyBzB;AAED,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAwBtC;AA2JD;;;;;;;GAOG;AACH;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,MAAM,CAMT;AAqGD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,oBAAoB,CAW7E;AAED;;;;;;;GAOG;AACH,wBAAsB,2BAA2B,CAC/C,YAAY,GAAE,MAA8B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CAwB/B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,oBAAoB,EAC5B,YAAY,GAAE,MAA8B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CA6B/B"}