[Fleet] Add functional tests for bundled packages (#126595)

* Add first pass functional tests for bundled packages

* Address PR feedback + fix TS errors

* Move docker wait hook

* Move setupFleetAndAgents call in test

* Try disabling bundled tests to debug CI

* Fix failing jest tests

* Fix type errors

* Fix type errors

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

.gitignore

@@ -95,4 +95,3 @@ fleet-server-*
 elastic-agent.yml
 fleet-server.yml
 
-/x-pack/plugins/fleet/server/bundled_packages

src/dev/build/tasks/bundle_fleet_packages.ts

@@ -11,7 +11,7 @@ import JSON5 from 'json5';
 import { readCliArgs } from '../args';
 import { Task, read, downloadToDisk } from '../lib';
 
-const BUNDLED_PACKAGES_DIR = 'x-pack/plugins/fleet/server/bundled_packages';
+const BUNDLED_PACKAGES_DIR = 'x-pack/plugins/fleet/target/bundled_packages';
 
 interface FleetPackage {
   name: string;

src/dev/precommit_hook/casing_check_config.js

@@ -61,9 +61,6 @@ export const IGNORE_FILE_GLOBS = [
 
   'x-pack/plugins/maps/server/fonts/**/*',
 
-  // Bundled package names typically use a format like ${pkgName}-${pkgVersion}, so don't lint them
-  'x-pack/plugins/fleet/server/bundled_packages/**/*',
-
   // Bazel default files
   '**/WORKSPACE.bazel',
   '**/BUILD.bazel',

x-pack/plugins/fleet/common/openapi/bundled.json

@@ -621,6 +621,19 @@
                           "type"
                         ]
                       }
+                    },
+                    "_meta": {
+                      "type": "object",
+                      "properties": {
+                        "install_source": {
+                          "type": "string",
+                          "enum": [
+                            "registry",
+                            "upload",
+                            "bundled"
+                          ]
+                        }
+                      }
                     }
                   },
                   "required": [

x-pack/plugins/fleet/common/openapi/bundled.yaml

@@ -382,6 +382,15 @@ paths:
                       required:
                         - id
                         - type
+                  _meta:
+                    type: object
+                    properties:
+                      install_source:
+                        type: string
+                        enum:
+                          - registry
+                          - upload
+                          - bundled
                 required:
                   - items
       operationId: install-package

x-pack/plugins/fleet/common/openapi/paths/epm@packages@{pkg_name}@{pkg_version}.yaml

@@ -64,6 +64,15 @@ post:
                   required:
                     - id
                     - type
+              _meta:
+                type: object
+                properties:
+                  install_source:
+                    type: string
+                    enum:
+                      - registry
+                      - upload
+                      - bundled
             required:
               - items
   operationId: install-package

x-pack/plugins/fleet/common/types/models/epm.ts

@@ -43,7 +43,7 @@ export interface DefaultPackagesInstallationError {
 }
 
 export type InstallType = 'reinstall' | 'reupdate' | 'rollback' | 'update' | 'install' | 'unknown';
-export type InstallSource = 'registry' | 'upload';
+export type InstallSource = 'registry' | 'upload' | 'bundled';
 
 export type EpmPackageInstallStatus =
   | 'installed'

x-pack/plugins/fleet/common/types/rest_spec/epm.ts

@@ -12,6 +12,7 @@ import type {
   PackageInfo,
   PackageUsageStats,
   InstallType,
+  InstallSource,
 } from '../models/epm';
 
 export interface GetCategoriesRequest {
@@ -108,6 +109,9 @@ export interface InstallPackageRequest {
 
 export interface InstallPackageResponse {
   items: AssetReference[];
+  _meta: {
+    install_source: InstallSource;
+  };
   // deprecated in 8.0
   response?: AssetReference[];
 }
@@ -123,6 +127,7 @@ export interface InstallResult {
   status?: 'installed' | 'already_installed';
   error?: Error;
   installType: InstallType;
+  installSource: InstallSource;
 }
 
 export interface BulkInstallPackageInfo {

x-pack/plugins/fleet/server/routes/epm/handlers.ts

@@ -267,9 +267,13 @@ export const installPackageFromRegistryHandler: FleetRequestHandler<
     force: request.body?.force,
     ignoreConstraints: request.body?.ignore_constraints,
   });
+
   if (!res.error) {
     const body: InstallPackageResponse = {
       items: res.assets || [],
+      _meta: {
+        install_source: res.installSource,
+      },
     };
     return response.ok({ body });
   } else {
@@ -342,6 +346,9 @@ export const installPackageByUploadHandler: FleetRequestHandler<
     const body: InstallPackageResponse = {
       items: res.assets || [],
       response: res.assets || [],
+      _meta: {
+        install_source: res.installSource,
+      },
     };
     return response.ok({ body });
   } else {

x-pack/plugins/fleet/server/routes/epm/index.ts

@@ -242,7 +242,7 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
         response
       );
       if (resp.payload?.items) {
-        return response.ok({ body: { response: resp.payload.items } });
+        return response.ok({ body: { ...resp.payload, response: resp.payload.items } });
       }
       return resp;
     }

x-pack/plugins/fleet/server/services/epm/packages/bundled_packages.ts

@@ -12,7 +12,7 @@ import type { BundledPackage } from '../../../types';
 import { appContextService } from '../../app_context';
 import { splitPkgKey } from '../registry';
 
-const BUNDLED_PACKAGE_DIRECTORY = path.join(__dirname, '../../../bundled_packages');
+const BUNDLED_PACKAGE_DIRECTORY = path.join(__dirname, '../../../../target/bundled_packages');
 
 export async function getBundledPackages(): Promise<BundledPackage[]> {
   try {

x-pack/plugins/fleet/server/services/epm/packages/install.test.ts

@@ -83,6 +83,7 @@ describe('install', () => {
       .mockImplementation(() => Promise.resolve({ packageInfo: { license: 'basic' } } as any));
 
     mockGetBundledPackages.mockReset();
+    (install._installPackage as jest.Mock).mockClear();
   });
 
   describe('registry', () => {

x-pack/plugins/fleet/server/services/epm/packages/install.ts

@@ -276,6 +276,7 @@ async function installPackageFromRegistry({
           ],
           status: 'already_installed',
           installType,
+          installSource: 'registry',
         };
       }
     }
@@ -307,7 +308,7 @@ async function installPackageFromRegistry({
         ...telemetryEvent,
         errorMessage: err.message,
       });
-      return { error: err, installType };
+      return { error: err, installType, installSource: 'registry' };
     }
 
     const savedObjectsImporter = appContextService
@@ -338,7 +339,7 @@ async function installPackageFromRegistry({
           ...telemetryEvent,
           status: 'success',
         });
-        return { assets, status: 'installed', installType };
+        return { assets, status: 'installed', installType, installSource: 'registry' };
       })
       .catch(async (err: Error) => {
         logger.warn(`Failure to install package [${pkgName}]: [${err.toString()}]`);
@@ -355,7 +356,7 @@ async function installPackageFromRegistry({
           ...telemetryEvent,
           errorMessage: err.message,
         });
-        return { error: err, installType };
+        return { error: err, installType, installSource: 'registry' };
       });
   } catch (e) {
     sendEvent({
@@ -365,6 +366,7 @@ async function installPackageFromRegistry({
     return {
       error: e,
       installType,
+      installSource: 'registry',
     };
   }
 }
@@ -454,7 +456,7 @@ async function installPackageByUpload({
       ...telemetryEvent,
       errorMessage: e.message,
     });
-    return { error: e, installType };
+    return { error: e, installType, installSource: 'upload' };
   }
 }
 
@@ -463,9 +465,10 @@ export type InstallPackageParams = {
 } & (
   | ({ installSource: Extract<InstallSource, 'registry'> } & InstallRegistryPackageParams)
   | ({ installSource: Extract<InstallSource, 'upload'> } & InstallUploadedArchiveParams)
+  | ({ installSource: Extract<InstallSource, 'bundled'> } & InstallUploadedArchiveParams)
 );
 
-export async function installPackage(args: InstallPackageParams) {
+export async function installPackage(args: InstallPackageParams): Promise<InstallResult> {
   if (!('installSource' in args)) {
     throw new Error('installSource is required');
   }
@@ -487,19 +490,19 @@ export async function installPackage(args: InstallPackageParams) {
         `found bundled package for requested install of ${pkgkey} - installing from bundled package archive`
       );
 
-      const response = installPackageByUpload({
+      const response = await installPackageByUpload({
         savedObjectsClient,
         esClient,
         archiveBuffer: matchingBundledPackage.buffer,
         contentType: 'application/zip',
         spaceId,
       });
 
-      return response;
+      return { ...response, installSource: 'bundled' };
     }
 
     logger.debug(`kicking off install of ${pkgkey} from registry`);
-    const response = installPackageFromRegistry({
+    const response = await installPackageFromRegistry({
       savedObjectsClient,
       pkgkey,
       esClient,
@@ -510,7 +513,7 @@ export async function installPackage(args: InstallPackageParams) {
     return response;
   } else if (args.installSource === 'upload') {
     const { archiveBuffer, contentType, spaceId } = args;
-    const response = installPackageByUpload({
+    const response = await installPackageByUpload({
       savedObjectsClient,
       esClient,
       archiveBuffer,
@@ -519,7 +522,6 @@ export async function installPackage(args: InstallPackageParams) {
     });
     return response;
   }
-  // @ts-expect-error s/b impossibe b/c `never` by this point, but just in case
   throw new Error(`Unknown installSource: ${args.installSource}`);
 }
 

x-pack/plugins/fleet/server/services/preconfiguration.test.ts

@@ -143,6 +143,7 @@ jest.mock('./epm/packages/install', () => ({
         return {
           error: new Error(installError),
           installType: 'install',
+          installSource: 'registry',
         };
       }
 
@@ -157,6 +158,7 @@ jest.mock('./epm/packages/install', () => ({
       return {
         status: 'installed',
         installType: 'install',
+        installSource: 'registry',
       };
     } else if (args.installSource === 'upload') {
       const { archiveBuffer } = args;
@@ -168,7 +170,7 @@ jest.mock('./epm/packages/install', () => ({
       const packageInstallation = { name: pkgName, version: '1.0.0', title: pkgName };
       mockInstalledPackages.set(pkgName, packageInstallation);
 
-      return { status: 'installed', installType: 'install' };
+      return { status: 'installed', installType: 'install', installSource: 'upload' };
     }
   },
   ensurePackagesCompletedInstall() {

x-pack/test/fleet_api_integration/apis/epm/index.js

@@ -14,6 +14,7 @@ export default function loadTests({ loadTestFile }) {
     loadTestFile(require.resolve('./file'));
     loadTestFile(require.resolve('./template'));
     loadTestFile(require.resolve('./ilm'));
+    // loadTestFile(require.resolve('./install_bundled'));
     loadTestFile(require.resolve('./install_by_upload'));
     loadTestFile(require.resolve('./install_endpoint'));
     loadTestFile(require.resolve('./install_overrides'));