more consistent naming in tests

Author: rlindner81

test/docs.test.js

@@ -4,7 +4,7 @@ const { readFileSync } = require("fs");
 const { join } = require("path");
 
 describe("docs", () => {
-  it("documentation README / overview consistency check", async () => {
+  test("documentation README / overview consistency check", async () => {
     const headings = ["Getting Started", "Features", "Peers"];
     const readmeData = readFileSync(join(__dirname, "..", "README.md")).toString();
     const overviewData = readFileSync(join(__dirname, "..", "docs", "index.md")).toString();

test/featureToggles.test.js

@@ -91,22 +91,22 @@ describe("local integration test", () => {
   });
 
   describe("init", () => {
-    it("init fails resolving for bad config paths", async () => {
+    test("init fails resolving for bad config paths", async () => {
       const { readFile: readFileSpy } = require("fs");
       readFileSpy.mockImplementationOnce(fs.readFile);
       await expect(toggles.initializeFeatures({ configFile: "fantasy_name" })).rejects.toMatchInlineSnapshot(
         `[FeatureTogglesError: initialization aborted, could not read config file: ENOENT: no such file or directory, open 'fantasy_name']`
       );
     });
 
-    it("init fails processing for bad formats", async () => {
+    test("init fails processing for bad formats", async () => {
       const badConfig = { ...config, bla: undefined };
       await expect(toggles.initializeFeatures({ config: badConfig })).rejects.toMatchInlineSnapshot(
         `[FeatureTogglesError: initialization aborted, could not process configuration: feature configuration is not an object]`
       );
     });
 
-    it("init config precedence", async () => {
+    test("init config precedence", async () => {
       const { readFile: readFileSpy } = require("fs");
 
       const configForRuntime = {
@@ -206,7 +206,7 @@ describe("local integration test", () => {
   });
 
   describe("validations", () => {
-    it("two regex validations", async () => {
+    test("two regex validations", async () => {
       await toggles.initializeFeatures({
         config: {
           [FEATURE.A]: {
@@ -245,7 +245,7 @@ describe("local integration test", () => {
       expect(await toggles.changeFeatureValue(FEATURE.A, "foobar")).toBeUndefined();
     });
 
-    it("custom module validations just module from CWD", async () => {
+    test("custom module validations just module from CWD", async () => {
       jest.mock("./virtual-validator-just-module", () => jest.fn(), { virtual: true });
       const mockValidator = require("./virtual-validator-just-module");
       await toggles.initializeFeatures({
@@ -262,7 +262,7 @@ describe("local integration test", () => {
       expect(mockValidator).toHaveBeenCalledWith("fallback", undefined, undefined);
     });
 
-    it("custom module validations with call from CWD", async () => {
+    test("custom module validations with call from CWD", async () => {
       jest.mock("./virtual-validator-with-call", () => ({ validator: jest.fn() }), { virtual: true });
       const { validator: mockValidator } = require("./virtual-validator-with-call");
       await toggles.initializeFeatures({
@@ -279,7 +279,7 @@ describe("local integration test", () => {
       expect(mockValidator).toHaveBeenCalledWith("fallback", undefined, undefined);
     });
 
-    it("custom module validations just module from CONFIG_DIR", async () => {
+    test("custom module validations just module from CONFIG_DIR", async () => {
       jest.mock("./virtual-validator-just-module", () => jest.fn(), { virtual: true });
       const mockValidator = require("./virtual-validator-just-module");
       const { readFile: readFileSpy } = require("fs");
@@ -301,7 +301,7 @@ describe("local integration test", () => {
       expect(mockValidator).toHaveBeenCalledWith("fallback", undefined, undefined);
     });
 
-    it("custom module validations with call from CONFIG_DIR", async () => {
+    test("custom module validations with call from CONFIG_DIR", async () => {
       jest.mock("./virtual-validator-with-call", () => ({ validator: jest.fn() }), { virtual: true });
       const { validator: mockValidator } = require("./virtual-validator-with-call");
       const { readFile: readFileSpy } = require("fs");
@@ -329,7 +329,7 @@ describe("local integration test", () => {
       await toggles.initializeFeatures({ config });
     });
 
-    it("getFeaturesKeys, getFeatureValues, getFeaturesInfos", async () => {
+    test("getFeaturesKeys, getFeatureValues, getFeaturesInfos", async () => {
       expect(toggles.getFeaturesKeys()).toEqual(Object.keys(config));
 
       const featureStatesResult = await toggles.getFeaturesInfos();
@@ -361,7 +361,7 @@ describe("local integration test", () => {
       expect(redisWrapperLoggerSpy.warning).toHaveBeenCalledTimes(0);
     });
 
-    it("getFeatureValue, changeFeatureValue without scopes", async () => {
+    test("getFeatureValue, changeFeatureValue without scopes", async () => {
       const oldValue = toggles.getFeatureValue(FEATURE.E);
 
       const newValue = 9;
@@ -398,7 +398,7 @@ describe("local integration test", () => {
       expect(redisWrapperLoggerSpy.error).toHaveBeenCalledTimes(0);
     });
 
-    it("getFeatureValue with bad scopes", async () => {
+    test("getFeatureValue with bad scopes", async () => {
       const oldRootValue = 5;
       const trapValue = 9;
       const badScopeMap1 = null; // not an object
@@ -443,7 +443,7 @@ describe("local integration test", () => {
       expect(toggles.getFeatureValue(FEATURE.E, badScopeMap3)).toEqual(oldRootValue);
     });
 
-    it("getFeatureValue, changeFeatureValue with scopes", async () => {
+    test("getFeatureValue, changeFeatureValue with scopes", async () => {
       const rootOldValue = toggles.getFeatureValue(FEATURE.E);
 
       const scopeMap = { component: "c1", tenant: "t1" };
@@ -541,7 +541,7 @@ describe("local integration test", () => {
       expect(redisWrapperLoggerSpy.error).toHaveBeenCalledTimes(0);
     });
 
-    it("getFeatureValue, changeFeatureValue with scopes and clearSubScopes, resetFeatureValue", async () => {
+    test("getFeatureValue, changeFeatureValue with scopes and clearSubScopes, resetFeatureValue", async () => {
       const scopeMap = { component: "c1", tenant: "t1" };
       const subScopeMap = { layer: "l1", component: "c1", tenant: "t1" };
       const superScopeMap = { tenant: "t1" };
@@ -615,7 +615,7 @@ describe("local integration test", () => {
       expect(redisWrapperLoggerSpy.error).toHaveBeenCalledTimes(0);
     });
 
-    it("validateFeatureValue with invalid scopes", async () => {
+    test("validateFeatureValue with invalid scopes", async () => {
       // valid
       expect(await toggles.validateFeatureValue(FEATURE.C, "", { tenant: "t1" })).toMatchInlineSnapshot(`[]`);
 
@@ -668,7 +668,7 @@ describe("local integration test", () => {
       `);
     });
 
-    it("registerFeatureValueValidation, validateFeatureValue", async () => {
+    test("registerFeatureValueValidation, validateFeatureValue", async () => {
       const successfulValidator = () => undefined;
       const failingValidator1 = () => {
         throw new Error("bla1");

test/integration-local/featureToggles.integration.test.js

@@ -4,7 +4,7 @@ const cds = require("@sap/cds");
 const { SERVICE_ENDPOINTS } = require("../src/plugin");
 
 describe("plugin", () => {
-  it("all endpoints are covered", async () => {
+  test("all endpoints are covered", async () => {
     const csn = await cds.load(["./src/service/feature-service.cds"]);
     const csnEndpoints = Object.keys(csn.definitions).filter((name) => name.indexOf(".") !== -1);
     const coveredEndpoints = Object.values(SERVICE_ENDPOINTS).flat();

test/plugin.test.js

@@ -50,7 +50,7 @@ describe("redis wrapper test", () => {
     envMock._reset();
   });
 
-  it("_createMainClientAndConnect/_createSubscriberClientAndConnect shortcut", async () => {
+  test("_createMainClientAndConnect/_createSubscriberClientAndConnect shortcut", async () => {
     const shortcutMain = "shortcutMain";
     const shortcutSubscriber = "shortcutSubscriber";
     redisWrapper._._setMainClient(shortcutMain);
@@ -64,7 +64,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("_createClientBase local", async () => {
+  test("_createClientBase local", async () => {
     envMock.isOnCf = false;
     const client = redisWrapper._._createClientBase();
 
@@ -84,7 +84,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("_createClientBase on CF", async () => {
+  test("_createClientBase on CF", async () => {
     const mockUrl = "rediss://BAD_USERNAME:pwd@mockUrl";
     const mockUrlUsable = mockUrl.replace("BAD_USERNAME", "");
 
@@ -101,7 +101,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("getMainClient", async () => {
+  test("getMainClient", async () => {
     const client = await redisWrapper.getMainClient();
     expect(redis.createClient).toHaveBeenCalledTimes(1);
     expect(client.connect).toHaveBeenCalledTimes(1);
@@ -114,7 +114,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("getSubscriberClient", async () => {
+  test("getSubscriberClient", async () => {
     const client = await redisWrapper.getSubscriberClient();
     expect(redis.createClient).toHaveBeenCalledTimes(1);
     expect(redisWrapper._._getSubscriberClient()).toBe(client);
@@ -126,7 +126,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("_clientExec", async () => {
+  test("_clientExec", async () => {
     const result = await redisWrapper._._clientExec("SET", { key: "key", value: "value" });
     const client = redisWrapper._._getMainClient();
     expect(redis.createClient).toHaveBeenCalledTimes(1);
@@ -140,23 +140,23 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("type key", async () => {
+  test("type key", async () => {
     const result = await redisWrapper.type("key");
     expect(mockClient.TYPE).toHaveBeenCalledTimes(1);
     expect(mockClient.TYPE).toHaveBeenCalledWith("key");
     expect(result).toBe("TYPE_return");
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("get key", async () => {
+  test("get key", async () => {
     const result = await redisWrapper.get("key");
     expect(mockClient.GET).toHaveBeenCalledTimes(1);
     expect(mockClient.GET).toHaveBeenCalledWith("key");
     expect(result).toBe("GET_return");
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("getObject key", async () => {
+  test("getObject key", async () => {
     const resultObj = { result: "result" };
     mockClient.GET.mockImplementationOnce(async () => JSON.stringify(resultObj));
     const result = await redisWrapper.getObject("key");
@@ -166,15 +166,15 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("set key value", async () => {
+  test("set key value", async () => {
     const result = await redisWrapper.set("key", "value");
     expect(mockClient.SET).toHaveBeenCalledTimes(1);
     expect(mockClient.SET).toHaveBeenCalledWith("key", "value");
     expect(result).toBe("SET_return");
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("setObject key value", async () => {
+  test("setObject key value", async () => {
     const inputObj = { input: "input" };
     const result = await redisWrapper.setObject("key", inputObj);
     expect(mockClient.SET).toHaveBeenCalledTimes(1);
@@ -183,15 +183,15 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("del key", async () => {
+  test("del key", async () => {
     const result = await redisWrapper.del("key");
     expect(mockClient.DEL).toHaveBeenCalledTimes(1);
     expect(mockClient.DEL).toHaveBeenCalledWith("key");
     expect(result).toBe("DEL_return");
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("watchedGetSet", async () => {
+  test("watchedGetSet", async () => {
     const oldValue = "oldValue";
     mockClient.GET.mockImplementationOnce(async () => oldValue);
     mockMultiClient.EXEC.mockImplementationOnce(async () => ["OK"]);
@@ -213,7 +213,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("watchedGetSetObject", async () => {
+  test("watchedGetSetObject", async () => {
     const oldValue = { oldValue: "oldValue" };
     mockClient.GET.mockImplementationOnce(async () => JSON.stringify(oldValue));
     mockMultiClient.EXEC.mockImplementationOnce(async () => ["OK"]);
@@ -235,7 +235,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("watchedGetSetObject newValue = null", async () => {
+  test("watchedGetSetObject newValue = null", async () => {
     const oldValue = { oldValue: "oldValue" };
     mockClient.GET.mockImplementationOnce(async () => JSON.stringify(oldValue));
     mockMultiClient.EXEC.mockImplementationOnce(async () => [1]);
@@ -257,7 +257,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("watchedGetSetObject oldValue = newValue", async () => {
+  test("watchedGetSetObject oldValue = newValue", async () => {
     const oldValue = { oldValue: "oldValue" };
     mockClient.GET.mockImplementationOnce(async () => JSON.stringify(oldValue));
     const newValueCallback = jest.fn((oldValue) => oldValue);
@@ -276,7 +276,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("watchedGetSetObject 2x attempts on exec null reply", async () => {
+  test("watchedGetSetObject 2x attempts on exec null reply", async () => {
     const oldValue1 = { oldValue1: "oldValue" };
     const oldValue2 = { oldValue2: "oldValue" };
     mockClient.GET.mockImplementationOnce(async () => JSON.stringify(oldValue1));
@@ -309,7 +309,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("watchedGetSetObject with exec keeps returning null", async () => {
+  test("watchedGetSetObject with exec keeps returning null", async () => {
     const newValue1 = { newValue1: "newValue" };
     const oldValue1 = { oldValue1: "oldValue" };
     mockClient.GET.mockImplementation(async () => JSON.stringify(oldValue1));
@@ -334,7 +334,7 @@ describe("redis wrapper test", () => {
     mockMultiClient.EXEC.mockClear();
   });
 
-  it("watchedGetSetObject 2x attempts on exec throw", async () => {
+  test("watchedGetSetObject 2x attempts on exec throw", async () => {
     const oldValue1 = { oldValue1: "oldValue" };
     const oldValue2 = { oldValue2: "oldValue" };
     mockClient.GET.mockImplementationOnce(async () => JSON.stringify(oldValue1));
@@ -369,7 +369,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("watchedGetSetObject with exec keeps throwing", async () => {
+  test("watchedGetSetObject with exec keeps throwing", async () => {
     const newValue1 = { newValue1: "newValue" };
     const oldValue1 = { oldValue1: "oldValue" };
     mockClient.GET.mockImplementation(async () => JSON.stringify(oldValue1));
@@ -394,7 +394,7 @@ describe("redis wrapper test", () => {
     mockMultiClient.EXEC.mockClear();
   });
 
-  it("watchedHashGetSetObject", async () => {
+  test("watchedHashGetSetObject", async () => {
     const oldValue = { oldValue: "oldValue" };
     mockClient.HGET.mockImplementationOnce(async () => JSON.stringify(oldValue));
     mockMultiClient.EXEC.mockImplementationOnce(async () => [1]);
@@ -416,15 +416,15 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("publishMessage", async () => {
+  test("publishMessage", async () => {
     const result = await redisWrapper.publishMessage(channel, message);
     expect(mockClient.PUBLISH).toHaveBeenCalledTimes(1);
     expect(mockClient.PUBLISH).toHaveBeenCalledWith(channel, message);
     expect(result).toBe("PUBLISH_return");
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("_subscribedMessageHandler error", async () => {
+  test("_subscribedMessageHandler error", async () => {
     const mockUrl = "rediss://BAD_USERNAME:pwd@mockUrl";
 
     envMock.isOnCf = true;
@@ -446,7 +446,7 @@ describe("redis wrapper test", () => {
     );
   });
 
-  it("registerMessageHandler and subscribe", async () => {
+  test("registerMessageHandler and subscribe", async () => {
     redisWrapper.registerMessageHandler(channel, mockMessageHandler);
     await redisWrapper.subscribe(channel);
 
@@ -470,7 +470,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("removeMessageHandler and unsubscribe", async () => {
+  test("removeMessageHandler and unsubscribe", async () => {
     redisWrapper._._getMessageHandlers().removeAllHandlers(channel);
     redisWrapper.registerMessageHandler(channel, mockMessageHandler);
     redisWrapper.registerMessageHandler(channel, mockMessageHandlerTwo);
@@ -490,7 +490,7 @@ describe("redis wrapper test", () => {
     expect(loggerSpy.error).not.toHaveBeenCalled();
   });
 
-  it("removeAllMessageHandlers", async () => {
+  test("removeAllMessageHandlers", async () => {
     redisWrapper._._getMessageHandlers().removeAllHandlers(channel);
     redisWrapper.registerMessageHandler(channel, mockMessageHandler);
     redisWrapper.registerMessageHandler(channel, mockMessageHandlerTwo);