@lambdatest/smartui-cli 1.0.0

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@lambdatest/smartui-cli",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Lambdatest/smartui-cli"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@lambdatest/smartui-logger": "1.0.0",
+    "@lambdatest/smartui-core": "1.0.0",
+    "commander": "^11.0.0",
+    "fs": "^0.0.1-security",
+    "path": "^0.12.7",
+    "url": "^0.11.1"
+  },
+  "devDependencies": {
+    "@lambdatest/smartui-logger": "file:../logger",
+    "@lambdatest/smartui-core": "file:../core"
+  }
+}

package/src/capture.js

@@ -0,0 +1,15 @@
+import SmartUI from "@lambdatest/smartui-core"
+import { parse } from './validate.js';
+
+async function capture(file, options, log) {
+  let screenshots = parse(file);
+  log.debug(screenshots);
+  options.screenshots = screenshots
+  const smartui = new SmartUI();
+  await smartui.createBuild(options, log);
+  await smartui.capture(options, log);
+  await smartui.cleanup(true, log);
+
+}
+
+export { capture };

package/src/config.js

@@ -0,0 +1,79 @@
+import fs from 'fs';
+import { ABNORMAL_EXIT } from './constant.js';
+import path from 'path';
+
+export const defaultScreenshotConfig = [
+    {
+        "name": "lambdatest-home-page",
+        "url": "https://www.lambdatest.com",
+        "waitForTimeout": 1000
+    },
+    {
+        "name": "example-page",
+        "url": "https://example.com/"
+    }
+]
+
+export const defaultSmartUIWebConfig = {
+    web: {
+        browsers: [
+            'chrome',
+            'firefox',
+            'safari',
+            'edge'
+        ],
+        resolutions: [
+            [1920, 1080],
+            [1366, 768],
+            [360, 640],
+        ]
+    }
+};
+
+export function createWebConfig(filepath, log) {
+    // default filepath
+    filepath = filepath || 'smartui-web.json';
+    let filetype = path.extname(filepath);
+    if (filetype != '.json') {
+        log.error(`Error: Web Config file must have .json extension`);
+        process.exitCode = ABNORMAL_EXIT;
+        return
+    }
+
+    // verify the file does not already exist
+    if (fs.existsSync(filepath)) {
+        log.error(`Error: SmartUI Web Config already exists: ${filepath}`);
+        log.error(`To create a new file, please specify the file name like: 'smartui config:create-web webConfig.json'`);
+        process.exitCode = ABNORMAL_EXIT;
+        return
+    }
+
+    // write stringified default config options to the filepath
+    fs.mkdirSync(path.dirname(filepath), { recursive: true });
+    fs.writeFileSync(filepath, JSON.stringify(defaultSmartUIWebConfig, null, 2) + '\n');
+    log.info(`Created SmartUI Web Config: ${filepath}`);
+};
+
+export function createWebStaticConfig(filepath, log) {
+    // default filepath
+    filepath = filepath || 'url.json';
+    let filetype = path.extname(filepath);
+    if (filetype != '.json') {
+        log.error(`Error: Config file must have .json extension`);
+        process.exitCode = ABNORMAL_EXIT;
+        return
+    }
+
+    // verify the file does not already exist
+    if (fs.existsSync(filepath)) {
+        log.error(`Error: web-static config already exists: ${filepath}`);
+        log.error(`To create a new file, please specify the file name like: 'smartui config:create-web links.json'`);
+        process.exitCode = ABNORMAL_EXIT;
+        return
+    }
+
+    // write stringified default config options to the filepath
+    fs.mkdirSync(path.dirname(filepath), { recursive: true });
+    fs.writeFileSync(filepath, JSON.stringify(defaultScreenshotConfig, null, 2) + '\n');
+    log.info(`Created web-static config: ${filepath}`);
+};

package/src/constant.js

@@ -0,0 +1,9 @@
+
+// Error codes
+export const ABNORMAL_EXIT = 1;
+export const MAX_RESOLUTIONS = 5
+export const MIN_RESOLUTION_WIDTH = 320
+export const MIN_RESOLUTION_HEIGHT = 320
+export const MAX_RESOLUTION_WIDTH = 7680
+export const MAX_RESOLUTION_HEIGHT = 7680
+export const VALID_BROWSERS = ['chrome', 'safari', 'firefox', 'edge'];

package/src/index.js

@@ -0,0 +1,49 @@
+import { Command, Option } from 'commander';
+import { capture } from './capture.js';
+import { logger } from '@lambdatest/smartui-logger';
+import { validateScreenshotConfig } from './validate.js';
+import packageJson from '../package.json' assert { type: 'json' };
+import { createWebConfig, createWebStaticConfig } from './config.js';
+
+const program = new Command();
+
+program
+  .name('smartui')
+  .description('CLI to help you to take screenshot SmartUI  on LambdaTest platform')
+  .addOption(new Option('--env <prod|stage>', 'Runtime environment option').choices(['prod', 'stage']));
+
+program
+  .command('capture <file>')
+  .description('capture')
+  .option('-c --config <file>', 'Config file path')
+  .action(async function (file, options) {
+    const log = await logger();
+    options.env = program.opts().env || 'prod';
+    log.info('SmartUI Capture CLI v' + packageJson.version);
+    options.config = validateScreenshotConfig(file, options, log);
+    log.info('config validation done');
+    log.debug(options);
+    capture(file, options, log);
+  });
+
+program.command('config:create-web')
+  .description('Create SmartUI Web config file')
+  .argument('[filepath]', 'Optional config filepath')
+  .action(async function (filepath, options) {
+    const log = await logger();
+    log.info('SmartUI Config CLI v' + packageJson.version);
+    log.info('\n');
+    createWebConfig(filepath, log);
+  });
+
+program.command('config:web-static')
+  .description('Create Web Static config file')
+  .argument('[filepath]', 'Optional config filepath')
+  .action(async function (filepath, options) {
+    const log = await logger();
+    log.info('SmartUI Config CLI v' + packageJson.version);
+    log.info('\n');
+    createWebStaticConfig(filepath, log);
+  });
+
+program.parse();

package/src/validate.js

@@ -0,0 +1,134 @@
+import fs from 'fs';
+import { ABNORMAL_EXIT, VALID_BROWSERS, MAX_RESOLUTIONS, MAX_RESOLUTION_WIDTH, MAX_RESOLUTION_HEIGHT, MIN_RESOLUTION_WIDTH, MIN_RESOLUTION_HEIGHT } from './constant.js';
+import { URL } from 'url';
+import { defaultSmartUIWebConfig } from './config.js'
+
+
+// Parse the JSON data
+export function parse(file) {
+    const data = fs.readFileSync(file, 'utf-8');
+    return JSON.parse(data);
+}
+
+export function validateScreenshotConfig(configFile, options, log) {
+    log.info(`file :  ${configFile}`)
+
+    // Check if file exists
+    if (Object.keys(configFile).length) {
+        try {
+            fs.promises.access(configFile);
+        } catch (error) {
+            log.error(`Error: Either File does not exist ${configFile} or doesn't have read permissions. Trace : ${error}`);
+            log.debug(error)
+            process.exit(ABNORMAL_EXIT);
+        }
+    }
+
+
+    let screenshots = {};
+    // Check JSON Parse Error
+    if (Object.keys(configFile).length) {
+        try {
+            screenshots = parse(configFile)
+        } catch (error) {
+            log.error('Error: Invalid file, capture command only supports json file');
+            process.exit(ABNORMAL_EXIT);
+        }
+    }
+
+    log.debug(screenshots)
+
+    //Check for URLs should not be empty
+    for (const screenshot of screenshots) {
+        if (!screenshot.name || screenshot.name == '') {
+            log.error(`Error: Missing screenshot name in ${configFile}`);
+            process.exit(ABNORMAL_EXIT);
+        }
+        if (!screenshot.url || screenshot.url == '') {
+            log.error('Error: Missing required URL for screenshot : '+screenshot.name);
+            process.exit(ABNORMAL_EXIT);
+        }
+        //Check for URLs should valid (like abcd in URL)
+        try {
+            new URL(screenshot.url);
+        } catch (error) {
+            log.error('Error: Invalid screenshot URL: ' + screenshot.url);
+            process.exit(ABNORMAL_EXIT);
+        }
+    }
+
+    log.debug(options)
+
+    //Check for smartui-web.json
+    let webConfigFile = options.config
+    // Verify config file exists
+    if (!fs.existsSync(webConfigFile)) {
+        log.error(`Error: Config file not found, will use default configs`);
+        return defaultSmartUIWebConfig
+    }
+
+    // Parse JSON
+    let webConfig;
+    try {
+        webConfig = JSON.parse(fs.readFileSync(webConfigFile));
+    } catch (error) {
+        log.error('Error: ', error.message);
+        process.exit(ABNORMAL_EXIT);
+    }
+    if (webConfig && webConfig.web) {
+        try {
+            validateConfigBrowsers(webConfig.web.browsers);
+            webConfig.web.resolutions = validateConfigResolutions(webConfig.web.resolutions);
+        } catch (error) {
+            log.error(`Error: Invalid webConfig, ${error.message}`);
+            process.exit(ABNORMAL_EXIT);
+        }
+        return webConfig
+    } else {
+        log.error(`No webConfig found in ${webConfigFile} file, will use default configs`);
+        return defaultSmartUIWebConfig
+    }
+}
+
+
+function validateConfigBrowsers(browsers) {
+    if (browsers.length == 0) {
+        throw new ValidationError('empty browsers list.');
+    }
+    const set = new Set();
+    for (let element of browsers) {
+        if (!VALID_BROWSERS.includes(element.toLowerCase()) || set.has(element)) {
+            throw new ValidationError(`invalid or duplicate value for browser. Accepted browsers are ${VALID_BROWSERS.join(',')}`);
+        }
+        set.add(element);
+    };
+}
+
+function validateConfigResolutions(resolutions) {
+    if (!Array.isArray(resolutions)) {
+        throw new ValidationError('invalid resolutions.');
+    }
+    if (resolutions.length == 0) {
+        throw new ValidationError('empty resolutions list in config.');
+    }
+    if (resolutions.length > 5) {
+        throw new ValidationError(`max resolutions: ${MAX_RESOLUTIONS}`);
+    }
+    let res = [];
+    resolutions.forEach(element => {
+        if (!Array.isArray(element) || element.length == 0 || element.length > 2) {
+            throw new ValidationError('invalid resolutions.');
+        }
+        let width = element[0];
+        let height = element[1];
+        if (typeof width != 'number' || width < MIN_RESOLUTION_WIDTH || width > MAX_RESOLUTION_WIDTH) {
+            throw new ValidationError(`width must be > ${MIN_RESOLUTION_WIDTH}, < ${MAX_RESOLUTION_WIDTH}`);
+        }
+        if (height && (typeof height != 'number' || height < MIN_RESOLUTION_WIDTH || height > MAX_RESOLUTION_WIDTH)) {
+            throw new ValidationError(`height must be > ${MIN_RESOLUTION_HEIGHT}, < ${MAX_RESOLUTION_HEIGHT}`);
+        }
+        res.push([width, height || 0]);
+    });
+
+    return res
+}