[Http] Prevent the internal HttpService being used in tests outside Core (#223238)

## Summary

Objective: avoid exposing the entire API surface area of `HttpService`
(and it's internal preboot/setup/start contracts) to test code outside
core.

* Refactor the `createHttpService -> createInternalHttpService` mock
test helper moved to scoped folder
`./src/core/server/integration_tests/utilities`
* Create an "integration test ready" version of the original
`createHttpService` for plugins to use from
`@kbn/core-http-server-mocks`
* Clean up some types
* Refactor the 2 plugin test usages of the internal `HttpService`

### Notes

* We have been exposing this surface area already in
`src/core/packages/http/server-mocks/src/http_service.mock.ts`. But it
seems to not have a adoption outside Core code... I wonder if we need a
concept of `mock-internal`?
* I don't think this is a **massive** issue, I just happened to realise
this when [messing
around](#222956) with an
`HttpService` related refactor. Would be nice to not leak more
information about internal code than necessary (it's clearly too late
for that, but maybe we can improve the situation for HttpService a bit).

---------

Co-authored-by: kibanamachine <[email protected]>

Author: jloleysens

src/core/packages/http/server-mocks/index.ts

@@ -18,4 +18,13 @@ export type {
   InternalHttpServiceSetupMock,
   InternalHttpServiceStartMock,
 } from './src/http_service.mock';
-export { createCoreContext, createHttpService, createConfigService } from './src/test_utils';
+export {
+  createCoreContext,
+  createHttpService,
+  createConfigService,
+  type HttpIntegrationTestService,
+  type HttpIntegrationServicePrebootContractMock,
+  type HttpIntegrationServiceSetupContractMock,
+  type HttpIntegrationServiceStartContractMock,
+  type HttpIntegrationServiceStopContractMock,
+} from './src/test_utils';

src/core/packages/http/server-mocks/src/test_utils.ts

@@ -14,7 +14,10 @@ import { ByteSizeValue } from '@kbn/config-schema';
 import { Env } from '@kbn/config';
 import { getEnvOptions, configServiceMock } from '@kbn/config-mocks';
 import type { CoreContext } from '@kbn/core-base-server-internal';
+import { contextServiceMock } from '@kbn/core-http-context-server-mocks';
+import { executionContextServiceMock } from '@kbn/core-execution-context-server-mocks';
 import { loggingSystemMock } from '@kbn/core-logging-server-mocks';
+import type { IRouter } from '@kbn/core-http-server';
 import {
   type HttpConfigType,
   type ExternalUrlConfigType,
@@ -125,21 +128,58 @@ export const createCoreContext = (overrides: Partial<CoreContext> = {}): CoreCon
 });
 
 /**
- * Creates a concrete HttpService with a mocked context.
+ * A mock of the HttpService that can be used in tests.
+ *
+ * @remarks intended to mirror the pubilc HTTP contracts where possible to avoid
+ *          drifting or leaking too many internal details of the actual HttpService.
  */
-export const createHttpService = ({
-  buildNum,
-  ...overrides
-}: Partial<CoreContext & { buildNum: number }> = {}): HttpService => {
-  const ctx = createCoreContext(overrides);
-  if (buildNum !== undefined) {
-    ctx.env = {
-      ...ctx.env,
-      packageInfo: {
-        ...ctx.env.packageInfo,
-        buildNum,
-      },
-    };
-  }
-  return new HttpService(ctx);
+export interface HttpIntegrationTestService {
+  preboot: () => Promise<void>;
+  setup: () => Promise<{ createRouter: (path: string) => IRouter<any>; server: { listener: any } }>;
+  start: () => Promise<void>;
+  stop: () => Promise<void>;
+}
+
+export type HttpIntegrationServicePrebootContractMock = Awaited<
+  ReturnType<HttpIntegrationTestService['preboot']>
+>;
+
+export type HttpIntegrationServiceSetupContractMock = Awaited<
+  ReturnType<HttpIntegrationTestService['setup']>
+>;
+
+export type HttpIntegrationServiceStartContractMock = Awaited<
+  ReturnType<HttpIntegrationTestService['start']>
+>;
+
+export type HttpIntegrationServiceStopContractMock = Awaited<
+  ReturnType<HttpIntegrationTestService['stop']>
+>;
+
+/**
+ * Creates an HTTP service instance for external services to test against.
+ * @public
+ */
+export const createHttpService = (): HttpIntegrationTestService => {
+  const ctx = createCoreContext();
+  const svc = new HttpService(ctx);
+  return {
+    preboot: async () => {
+      await svc.preboot({
+        context: contextServiceMock.createPrebootContract(),
+      });
+    },
+    setup: () => {
+      return svc.setup({
+        context: contextServiceMock.createSetupContract(),
+        executionContext: executionContextServiceMock.createInternalSetupContract(),
+      });
+    },
+    start: async () => {
+      await svc.start();
+    },
+    stop: async () => {
+      await svc.stop();
+    },
+  };
 };

src/core/packages/http/server-mocks/tsconfig.json

@@ -22,6 +22,8 @@
     "@kbn/repo-info",
     "@kbn/config",
     "@kbn/core-base-server-internal",
+    "@kbn/core-http-context-server-mocks",
+    "@kbn/core-execution-context-server-mocks",
   ],
   "exclude": [
     "target/**/*",

src/core/packages/test-helpers/test-utils/index.ts

@@ -7,6 +7,6 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-export { setupServer } from './src/setup_server';
+export { setupServer, type SetupServerReturn } from './src/setup_server';
 export { createExportableType } from './src/create_exportable_type';
 export { createHiddenTypeVariants } from './src/create_hidden_type_variants';

src/core/packages/test-helpers/test-utils/src/setup_server.ts

@@ -9,7 +9,8 @@
 
 import { executionContextServiceMock } from '@kbn/core-execution-context-server-mocks';
 import { ContextService } from '@kbn/core-http-context-server-internal';
-import { createHttpService, createCoreContext } from '@kbn/core-http-server-mocks';
+import { HttpService } from '@kbn/core-http-server-internal';
+import { createCoreContext } from '@kbn/core-http-server-mocks';
 import { contextServiceMock } from '@kbn/core-http-context-server-mocks';
 import { savedObjectsClientMock } from '@kbn/core-saved-objects-api-server-mocks';
 import { typeRegistryMock } from '@kbn/core-saved-objects-base-server-mocks';
@@ -43,8 +44,7 @@ function createCoreServerRequestHandlerContextMock() {
 export const setupServer = async (coreId: symbol = defaultCoreId) => {
   const coreContext = createCoreContext({ coreId });
   const contextService = new ContextService(coreContext);
-
-  const server = createHttpService(coreContext);
+  const server = new HttpService(coreContext);
   await server.preboot({ context: contextServiceMock.createPrebootContract() });
   const httpSetup = await server.setup({
     context: contextService.setup({ pluginDependencies: new Map() }),
@@ -57,8 +57,19 @@ export const setupServer = async (coreId: symbol = defaultCoreId) => {
   });
 
   return {
-    server,
-    httpSetup,
+    server: {
+      listener: httpSetup.server.listener,
+      start: async () => {
+        await server.start();
+      },
+      stop: async () => {
+        await server.stop();
+      },
+    },
+    createRouter: httpSetup.createRouter.bind(httpSetup),
+    registerRouteHandlerContext: httpSetup.registerRouteHandlerContext.bind(httpSetup),
     handlerContext,
   };
 };
+
+export type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;

src/core/packages/test-helpers/test-utils/tsconfig.json

@@ -21,7 +21,8 @@
     "@kbn/core-saved-objects-base-server-mocks",
     "@kbn/core-saved-objects-server",
     "@kbn/core-saved-objects-server-mocks",
-    "@kbn/core-ui-settings-server-mocks"
+    "@kbn/core-ui-settings-server-mocks",
+    "@kbn/core-http-server-internal"
   ],
   "exclude": [
     "target/**/*",

src/core/server/integration_tests/capabilities/capabilities_service.test.ts

@@ -14,14 +14,14 @@ import { getEnvOptions } from '@kbn/config-mocks';
 import { loggingSystemMock } from '@kbn/core-logging-server-mocks';
 import { executionContextServiceMock } from '@kbn/core-execution-context-server-mocks';
 import { contextServiceMock } from '@kbn/core-http-context-server-mocks';
+import type { CapabilitiesSetup } from '@kbn/core-capabilities-server';
+import { CapabilitiesService } from '@kbn/core-capabilities-server-internal';
 import {
   HttpService,
   InternalHttpServicePreboot,
   InternalHttpServiceSetup,
 } from '@kbn/core-http-server-internal';
-import { createHttpService } from '@kbn/core-http-server-mocks';
-import type { CapabilitiesSetup } from '@kbn/core-capabilities-server';
-import { CapabilitiesService } from '@kbn/core-capabilities-server-internal';
+import { createInternalHttpService } from '../utilities';
 
 const coreId = Symbol('core');
 
@@ -36,7 +36,7 @@ describe('CapabilitiesService', () => {
   let serviceSetup: CapabilitiesSetup;
 
   beforeEach(async () => {
-    server = createHttpService();
+    server = createInternalHttpService();
     httpPreboot = await server.preboot({ context: contextServiceMock.createPrebootContract() });
     httpSetup = await server.setup({
       context: contextServiceMock.createSetupContract(),

src/core/server/integration_tests/core_app/bundle_routes.test.ts

@@ -14,9 +14,9 @@ import { loggingSystemMock } from '@kbn/core-logging-server-mocks';
 import { executionContextServiceMock } from '@kbn/core-execution-context-server-mocks';
 import { contextServiceMock } from '@kbn/core-http-context-server-mocks';
 import type { IRouter } from '@kbn/core-http-server';
-import { HttpService } from '@kbn/core-http-server-internal';
-import { createHttpService } from '@kbn/core-http-server-mocks';
 import { registerRouteForBundle, FileHashCache } from '@kbn/core-apps-server-internal';
+import { HttpService } from '@kbn/core-http-server-internal';
+import { createInternalHttpService } from '../utilities';
 
 const buildHash = 'buildHash';
 const fooPluginFixture = resolve(__dirname, './__fixtures__/plugin/foo');
@@ -32,7 +32,7 @@ describe('bundle routes', () => {
     logger = loggingSystemMock.create();
     fileHashCache = new FileHashCache();
 
-    server = createHttpService({ logger });
+    server = createInternalHttpService({ logger });
     await server.preboot({ context: contextServiceMock.createPrebootContract() });
   });
 

src/core/server/integration_tests/http/lifecycle.test.ts

@@ -15,10 +15,10 @@ import { executionContextServiceMock } from '@kbn/core-execution-context-server-
 import { contextServiceMock } from '@kbn/core-http-context-server-mocks';
 import { ensureRawRequest } from '@kbn/core-http-router-server-internal';
 import { HttpService } from '@kbn/core-http-server-internal';
-import { createHttpService } from '@kbn/core-http-server-mocks';
 import { Env } from '@kbn/config';
 import { REPO_ROOT } from '@kbn/repo-info';
 import { getEnvOptions } from '@kbn/config-mocks';
+import { createInternalHttpService } from '../utilities';
 
 let server: HttpService;
 
@@ -35,7 +35,7 @@ const kibanaVersion = Env.createDefault(REPO_ROOT, getEnvOptions()).packageInfo.
 
 beforeEach(async () => {
   logger = loggingSystemMock.create();
-  server = createHttpService({ logger });
+  server = createInternalHttpService({ logger });
   await server.preboot({ context: contextServiceMock.createPrebootContract() });
 });
 

src/core/server/integration_tests/http/lifecycle_handlers.test.ts

@@ -11,14 +11,15 @@ import supertest from 'supertest';
 import { kibanaPackageJson } from '@kbn/repo-info';
 import type { IRouter, RouteRegistrar } from '@kbn/core-http-server';
 import { contextServiceMock } from '@kbn/core-http-context-server-mocks';
-import { createConfigService, createHttpService } from '@kbn/core-http-server-mocks';
+import { createConfigService } from '@kbn/core-http-server-mocks';
 import { HttpService, HttpServerSetup } from '@kbn/core-http-server-internal';
 import { executionContextServiceMock } from '@kbn/core-execution-context-server-mocks';
 import { schema } from '@kbn/config-schema';
 import { IConfigServiceMock } from '@kbn/config-mocks';
 import { Logger } from '@kbn/logging';
 import { loggerMock } from '@kbn/logging-mocks';
 import { KIBANA_BUILD_NR_HEADER } from '@kbn/core-http-common';
+import { createInternalHttpService } from '../utilities';
 
 const actualVersion = kibanaPackageJson.version;
 const versionHeader = 'kbn-version';
@@ -63,7 +64,7 @@ describe('core lifecycle handlers', () => {
   beforeEach(async () => {
     const configService = createConfigService(testConfig);
     logger = loggerMock.create();
-    server = createHttpService({ configService, logger });
+    server = createInternalHttpService({ configService, logger });
     await server.preboot({ context: contextServiceMock.createPrebootContract() });
     const serverSetup = await server.setup(setupDeps);
     router = serverSetup.createRouter('/');
@@ -270,7 +271,7 @@ describe('core lifecycle handlers', () => {
           restrictInternalApis: true,
         },
       });
-      server = createHttpService({ configService });
+      server = createInternalHttpService({ configService });
       await server.preboot({ context: contextServiceMock.createPrebootContract() });
       const serverSetup = await server.setup(setupDeps);
       router = serverSetup.createRouter('/');
@@ -348,7 +349,7 @@ describe('core lifecycle handlers with restrict internal routes enforced', () =>
   beforeEach(async () => {
     logger = loggerMock.create();
     const configService = createConfigService({ server: { restrictInternalApis: true } });
-    server = createHttpService({ configService, logger });
+    server = createInternalHttpService({ configService, logger });
 
     await server.preboot({ context: contextServiceMock.createPrebootContract() });
     const serverSetup = await server.setup(setupDeps);
@@ -427,7 +428,7 @@ describe('core lifecycle handlers with no strict client version check', () => {
         },
       },
     });
-    server = createHttpService({ configService, logger, buildNum: 1234 });
+    server = createInternalHttpService({ configService, logger, buildNum: 1234 });
     await server.preboot({ context: contextServiceMock.createPrebootContract() });
     const serverSetup = await server.setup(setupDeps);
     router = serverSetup.createRouter('/');