feat: ✨ support for adding new web config added (#79)

BoykaFramework · May 18, 2024 · 381d928 · 381d928
1 parent 5c74c7a
commit 381d928
Show file tree

Hide file tree

Showing 13 changed files with 345 additions and 224 deletions.
diff --git a/package.json b/package.json
@@ -38,16 +38,16 @@
     "url": "https://github.com/BoykaFramework/boyka-cli"
   },
   "devDependencies": {
-    "@eslint/js": "^9.2.0",
+    "@eslint/js": "^9.3.0",
     "@release-it/conventional-changelog": "^8.0.1",
     "@stylistic/eslint-plugin-js": "^2.1.0",
     "@stylistic/eslint-plugin-ts": "^2.1.0",
     "@tsconfig/node18": "^18.2.4",
-    "@types/node": "^20.12.11",
+    "@types/node": "^20.12.12",
     "@types/yargs": "^17.0.32",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
-    "@typescript-eslint/parser": "^7.2.0",
-    "eslint": "^9.2.0",
+    "@typescript-eslint/eslint-plugin": "^7.9.0",
+    "@typescript-eslint/parser": "^7.9.0",
+    "eslint": "^9.3.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^5.1.3",
@@ -56,10 +56,10 @@
     "prettier": "^3.2.5",
     "release-it": "^17.1.1",
     "typescript": "^5.4.5",
-    "typescript-eslint": "^7.8.0"
+    "typescript-eslint": "^7.9.0"
   },
   "dependencies": {
-    "@inquirer/prompts": "^5.0.2",
+    "@inquirer/prompts": "^5.0.4",
     "chalk": "^5.3.0",
     "nanospinner": "^1.1.0",
     "yargs": "^17.7.2"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/commands/configure_cmds/api.ts b/src/commands/configure_cmds/api.ts
@@ -1,5 +1,5 @@
 import { CommandModule } from 'yargs';
-import { epiLogMessage, errorMessage, failureMessage, helpMessage } from '../../utils/constants.js';
+import { epiLogMessage, failureMessage, handleCommand } from '../../utils/constants.js';
 import { handleAddApiConfig } from '../../handler/config/init/api.js';
 
 export const apiCommand = {
@@ -29,12 +29,6 @@ export const apiCommand = {
       .showHelpOnFail(true, failureMessage('API Config'))
       .epilog(epiLogMessage),
   handler: async (argv) => {
-    try {
-      await handleAddApiConfig(argv);
-      console.log(helpMessage);
-    } catch (error: any) {
-      console.error(errorMessage(error));
-      process.exit(1);
-    }
+    await handleCommand(handleAddApiConfig(argv));
   },
 } satisfies CommandModule;
diff --git a/src/commands/configure_cmds/init.ts b/src/commands/configure_cmds/init.ts
@@ -1,14 +1,6 @@
 import { CommandModule } from 'yargs';
-import {
-  capabilitiesHelpMessage,
-  epiLogMessage,
-  errorMessage,
-  failureMessage,
-  getTarget,
-  helpMessage,
-} from '../../utils/constants.js';
+import { epiLogMessage, failureMessage, handleCommand } from '../../utils/constants.js';
 import { handleConfigInit } from '../../handler/config/init/init.js';
-import { TargetProviders } from '../../types/enum-types.js';
 
 export const initCommand = {
   command: 'init',
@@ -26,16 +18,6 @@ export const initCommand = {
       .showHelpOnFail(true, failureMessage('Init Config'))
       .epilog(epiLogMessage),
   handler: async (argv) => {
-    try {
-      await handleConfigInit(argv);
-      const target = getTarget();
-      if (target && target !== TargetProviders.LOCAL) {
-        console.log(capabilitiesHelpMessage);
-      }
-      console.log(helpMessage);
-    } catch (error: any) {
-      console.error(errorMessage(error));
-      process.exit(1);
-    }
+    await handleCommand(handleConfigInit(argv));
   },
 } satisfies CommandModule;
diff --git a/src/commands/configure_cmds/web.ts b/src/commands/configure_cmds/web.ts
@@ -1,12 +1,19 @@
 import { CommandModule } from 'yargs';
-import { epiLogMessage, failureMessage } from '../../utils/constants.js';
+import { epiLogMessage, failureMessage, handleCommand } from '../../utils/constants.js';
+import { handleAddWebConfig } from '../../handler/config/init/web.js';
 
 export const webCommand = {
   command: 'web [name]',
   aliases: ['w'],
   describe: 'Add Web Boyka-Framework Config file',
   builder: (yargs) =>
     yargs
+      .option('p', {
+        alias: ['path'],
+        describe: 'Path to the config file',
+        default: `${process.cwd()}/src/test/resources`,
+        type: 'string',
+      })
       .positional('name', {
         demandOption: true,
         describe: 'Name of the Web config block',
@@ -16,12 +23,12 @@ export const webCommand = {
         if (!argv.name) {
           throw new Error('Web config name should be provided!');
         }
+        return true;
       })
       .help('help')
       .showHelpOnFail(true, failureMessage('Web config'))
       .epilog(epiLogMessage),
-  handler: (argv) => {
-    // TODO: web handler
-    console.log(`Handle Web Config ${argv.name}...`);
+  handler: async (argv) => {
+    await handleCommand(handleAddWebConfig(argv));
   },
 } satisfies CommandModule;
diff --git a/src/handler/config/init/api.ts b/src/handler/config/init/api.ts
@@ -1,7 +1,7 @@
 import { getConfigName } from '../../../questions/inputs.js';
 import { FrameworkSetting } from '../../../types/config-type.js';
 import { updateApi } from '../../update/api.js';
-import { defaultApiSetting } from '../../../types/default-type-values.js';
+import { defaultNewApiSetting } from '../../../types/default-type-values.js';
 import { ArgumentsCamelCase } from 'yargs';
 import { createConfigFile, loadJSON } from '../../../utils/json.js';
 import { configBlockExists } from '../../../utils/constants.js';
@@ -10,9 +10,7 @@ export const createApiSetting = async () => {
   const configName = await getConfigName('API');
   const frameworkSetting: FrameworkSetting = {
     api: {
-      [configName]: {
-        ...defaultApiSetting,
-      },
+      ...defaultNewApiSetting(configName),
     },
   };
   const api = frameworkSetting.api;
@@ -30,11 +28,7 @@ export const handleAddApiConfig = async (argv: ArgumentsCamelCase) => {
   if (apiSetting[name]) {
     throw new Error(configBlockExists('API', name));
   }
-  const newApiSetting = {
-    [name]: {
-      ...defaultApiSetting,
-    },
-  };
+  const newApiSetting = defaultNewApiSetting(name);
   await updateApi(newApiSetting[name]);
   settings.api = {
     ...apiSetting,

diff --git a/src/handler/config/init/mobile.ts b/src/handler/config/init/mobile.ts
@@ -1,17 +1,19 @@
 import { getConfigName } from '../../../questions/inputs.js';
 import { FrameworkSetting } from '../../../types/config-type.js';
 import { updateMobile } from '../../update/mobile.js';
-import { defaultUiSetting, defaultMobileSetting } from '../../../types/default-type-values.js';
+import { defaultUiSetting, defaultNewMobileSetting } from '../../../types/default-type-values.js';
+import { defaultDelaySetting } from '../../../types/default-type-values.js';
 
 export const createMobileSetting = async (platformType: string) => {
   const configName = await getConfigName(platformType);
   const frameworkSetting: FrameworkSetting = {
     ui: {
+      delay: {
+        ...defaultDelaySetting,
+      },
       ...defaultUiSetting,
       mobile: {
-        [configName]: {
-          ...defaultMobileSetting,
-        },
+        ...defaultNewMobileSetting(configName),
       },
     },
   };

diff --git a/src/handler/config/init/web.ts b/src/handler/config/init/web.ts
@@ -1,21 +1,52 @@
 import { getConfigName } from '../../../questions/inputs.js';
-import { FrameworkSetting } from '../../../types/config-type.js';
+import { FrameworkSetting, WebSetting } from '../../../types/config-type.js';
 import { updateWeb } from '../../update/web.js';
-import { defaultUiSetting, defaultWebSetting } from '../../../types/default-type-values.js';
+import { defaultNewWebSetting, defaultUiSetting } from '../../../types/default-type-values.js';
+import { ArgumentsCamelCase } from 'yargs';
+import { createConfigFile, loadJSON } from '../../../utils/json.js';
+import { configBlockExists } from '../../../utils/constants.js';
 
 export const createWebSetting = async () => {
   const configName = await getConfigName('Web');
   const frameworkSetting: FrameworkSetting = {
     ui: {
       ...defaultUiSetting,
       web: {
-        [configName]: {
-          ...defaultWebSetting,
-        },
+        ...defaultNewWebSetting(configName),
       },
     },
   };
   const web = frameworkSetting.ui?.web;
   if (web) await updateWeb(web[configName]);
   return frameworkSetting;
 };
+
+export const handleAddWebConfig = async (argv: ArgumentsCamelCase) => {
+  const name = argv.name as string;
+  const path = argv.path as string;
+  const configPath = path === '.' ? process.cwd() : path;
+
+  const settings = loadJSON(configPath) as FrameworkSetting;
+  let uiSetting = settings.ui;
+  let webSetting: { [key: string]: WebSetting };
+  if (uiSetting) {
+    webSetting = uiSetting.web;
+    if (webSetting[name]) {
+      throw new Error(configBlockExists('Web', name));
+    }
+  } else {
+    uiSetting = {
+      ...defaultUiSetting,
+    };
+  }
+  const newWebSetting = defaultNewWebSetting(name);
+  await updateWeb(newWebSetting[name]);
+  settings.ui = {
+    ...uiSetting,
+    web: {
+      ...webSetting,
+      ...newWebSetting,
+    },
+  };
+  createConfigFile(configPath, settings, 'updated');
+};
diff --git a/src/handler/update/web.ts b/src/handler/update/web.ts
@@ -13,6 +13,7 @@ export const updateWeb = async (config: WebSetting) => {
   config.target = target as TargetProviders;
   setTarget(config.target);
   if (config.target !== TargetProviders.LOCAL) {
+    config.capabilities = {};
     config.user_name = `\${env:${await getUserName()}}`;
     config.password = `\${env:${await getPassword()}}`;
   }

diff --git a/src/types/config-type.ts b/src/types/config-type.ts
@@ -63,7 +63,7 @@ export type DelaySetting = {
 
 export type UiSetting = {
   timeout: TimeoutSetting;
-  delay: DelaySetting;
+  delay?: DelaySetting;
   logging: UiLogSetting;
   screenshot: ScreenshotSetting;
   web?: { [key: string]: WebSetting };

diff --git a/src/types/default-type-values.ts b/src/types/default-type-values.ts
@@ -118,9 +118,6 @@ export const defaultDelaySetting: DelaySetting = {
 };
 
 export const defaultUiSetting: UiSetting = {
-  delay: {
-    ...defaultDelaySetting,
-  },
   logging: {
     ...defaultUiLogSetting,
   },
@@ -178,3 +175,26 @@ export const defaultMobileSetting: MobileSetting = {
   server: defaultServerSetting,
   device: defaultDeviceSetting,
 };
+
+export const defaultNewWebSetting = (configName: string): { [key: string]: WebSetting } => {
+  return {
+    [configName]: {
+      ...defaultWebSetting,
+    },
+  };
+};
+export const defaultNewMobileSetting = (configName: string): { [key: string]: MobileSetting } => {
+  return {
+    [configName]: {
+      ...defaultMobileSetting,
+    },
+  };
+};
+
+export const defaultNewApiSetting = (configName: string): { [key: string]: ApiSetting } => {
+  return {
+    [configName]: {
+      ...defaultApiSetting,
+    },
+  };
+};
diff --git a/src/types/enum-types.ts b/src/types/enum-types.ts
@@ -79,17 +79,17 @@ export enum ApplicationType {
 }
 
 export enum TestDataSource {
-  EXCEL,
+  EXCEL = 'EXCEL',
 }
 
 export enum PageLoadStrategy {
-  NONE,
-  EAGER,
-  NORMAL,
+  NONE = 'NONE',
+  EAGER = 'EAGER',
+  NORMAL = 'NORMAL',
 }
 
 export enum Speed {
-  FAST,
-  NORMAL,
-  SLOW,
+  FAST = 'FAST',
+  NORMAL = 'NORMAL',
+  SLOW = 'SLOW',
 }
diff --git a/src/utils/constants.ts b/src/utils/constants.ts
@@ -75,3 +75,17 @@ Boyka config file does not exist at [${path}].
 
 Create one by running command 'boyka config init'`,
   );
+
+export const handleCommand = async (handler: Promise<void>) => {
+  try {
+    await handler;
+    const target = getTarget();
+    if (target && target !== TargetProviders.LOCAL) {
+      console.log(capabilitiesHelpMessage);
+    }
+    console.log(helpMessage);
+  } catch (error: any) {
+    console.error(errorMessage(error));
+    process.exit(1);
+  }
+};