Convert runMany and runManySync to use injectManyWithMeta + move to seperate package (#7244)

* Convert runMany and runManySync to use injectManyWithMeta Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup type errors due to new Runnable requirements Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add documentation for verifyRunnablesAreDAG Signed-off-by: Sebastian Malton <sebastian@malton.name> * Simplify convertToWithIdWith Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move all utility functions to separate package Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move testing utilities to separate package Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move run-many and run-many-sync to separate package Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace all internal uses of utilities with new packages Signed-off-by: Sebastian Malton <sebastian@malton.name> * Use new @k8slens/run-many package in core Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add dep to open-lens Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup uses of @k8slens/test-utils Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup getGlobalOverride Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move tests to new package too Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup uses of AsyncResult and autoBind Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fixup remaining import issues Signed-off-by: Sebastian Malton <sebastian@malton.name> * Finial fixups to fix build Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix lint Signed-off-by: Sebastian Malton <sebastian@malton.name> * Revert moving "testUsingFakeTime" to separate package - This fixes tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix integration tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix unit test failing due to spelling fix Signed-off-by: Sebastian Malton <sebastian@malton.name> --------- Signed-off-by: Sebastian Malton <sebastian@malton.name>
2025-05-20 05:10:56 +00:00 · 2023-03-10 10:07:28 +02:00
1 parent ad9bafe2a5
commit 2789bcebcb
@@ -0,0 +1,3 @@
+# @k8slens/test-utils
+
+This package contains many useful utilities for testing.
@@ -0,0 +1,4 @@
+export * from "./src/flush-promises";
+export * from "./src/get-global-override-for-function";
+export * from "./src/get-global-override";
+export * from "./src/get-promise-status";
@@ -0,0 +1,2 @@
+module.exports =
+  require("@k8slens/jest").monorepoPackageConfig(__dirname).configForReact;
@@ -0,0 +1,27 @@
+{
+  "name": "@k8slens/test-utils",
+  "version": "1.0.0",
+  "description": "A collection of utilities for testing",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "private": false,
+  "files": [
+    "dist"
+  ],
+  "author": {
+    "name": "OpenLens Authors",
+    "email": "info@k8slens.dev"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/lensapp/lens",
+  "scripts": {
+    "build": "webpack",
+    "dev": "webpack --mode=development --watch",
+    "test": "jest --coverage --runInBand"
+  }
+}
@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { setImmediate } from "timers";
+
+export const flushPromises = () => new Promise(setImmediate);
@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { Injectable } from "@ogre-tools/injectable";
+import { getGlobalOverride } from "./get-global-override";
+import { camelCase } from "lodash/fp";
+
+export const getGlobalOverrideForFunction = (injectable: Injectable<Function, any, any>) => (
+  getGlobalOverride(injectable, () => (...args: any[]) => {
+    console.warn(
+      `Tried to invoke a function "${injectable.id}" without override. The args were:`,
+      args,
+    );
+
+    throw new Error(
+      `Tried to invoke a function "${injectable.id}" without override. Add eg. "di.override(${camelCase(injectable.id)}Mock)" to the unit test interested in this.`,
+    );
+  })
+);
@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { Injectable, Instantiate } from "@ogre-tools/injectable";
+
+export interface GlobalOverride<Instance, Param> {
+  injectable: Injectable<Instance, unknown, Param>;
+  overridingInstantiate: Instantiate<Instance, Param>;
+}
+
+export const getGlobalOverride = <Instance, Param>(
+  injectable: Injectable<Instance, unknown, Param>,
+  overridingInstantiate: (typeof injectable)["instantiate"],
+) => ({
+  injectable,
+  overridingInstantiate,
+});
@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { flushPromises } from "./flush-promises";
+
+export const getPromiseStatus = async (promise: Promise<unknown>) => {
+  const status = { fulfilled: false };
+
+  promise.finally(() => {
+    status.fulfilled = true;
+  });
+
+  await flushPromises();
+
+  return status;
+};
@@ -0,0 +1,3 @@
+{
+  "extends": "@k8slens/typescript/config/base.json"
+}
@@ -0,0 +1 @@
+module.exports = require("@k8slens/webpack").configForNode;
				`@@ -0,0 +1 @@`
				`module.exports = require("@k8slens/webpack").configForNode;`