@empiricalrun/test-gen 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @empiricalrun/test-gen
 
+## 0.2.0
+
+### Minor Changes
+
+- 5333d3b: feat: add support for creating test case using google sheet
+
+## 0.1.3
+
+### Patch Changes
+
+- b32c561: fix: increase readability of logs
+
 ## 0.1.2
 
 ### Patch Changes

package/dist/bin/index.js

@@ -7,15 +7,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const openai_1 = __importDefault(require("openai"));
 const path_1 = __importDefault(require("path"));
-// const { scenarios } = require("./scenarios");
 const typescript_1 = __importDefault(require("typescript"));
 const prettier_1 = __importDefault(require("prettier"));
 const eslint_1 = require("eslint");
 const dotenv_1 = __importDefault(require("dotenv"));
-const yaml_1 = require("yaml");
+const logger_1 = require("./logger");
+const scenarios_1 = require("./scenarios");
 dotenv_1.default.config({
     path: [".env.local", ".env"],
 });
+const logger = new logger_1.CustomLogger();
 async function readFilesInDirectory(dir = "") {
     let files = [];
     const items = await fs_extra_1.default.readdir(dir);
@@ -67,7 +68,6 @@ async function getLLMResult(instruction) {
         ],
         model: "gpt-4o",
     });
-    console.log("generated completion");
     const response = completion.choices[0]?.message.content || "";
     return response;
 }
@@ -83,32 +83,24 @@ function validateTypescript(filePath) {
     const errors = [];
     const syntacticDiagnostics = program.getSyntacticDiagnostics(sourceFile);
     if (syntacticDiagnostics.length > 0) {
-        console.log("Syntactic errors:");
         syntacticDiagnostics.forEach((diagnostic) => {
             const { line, character } = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start);
             const message = typescript_1.default.flattenDiagnosticMessageText(diagnostic.messageText, "\n");
-            console.log(`${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`);
+            logger.log(`${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`);
             if (typeof diagnostic.messageText === "string") {
                 errors.push(diagnostic.messageText);
             }
         });
     }
-    else {
-        console.log("No syntactic errors.");
-    }
     // Get and report any semantic errors
     const semanticDiagnostics = program.getSemanticDiagnostics(sourceFile);
     if (semanticDiagnostics.length > 0) {
-        console.log("Semantic errors:");
         semanticDiagnostics.forEach((diagnostic) => {
-            console.log(diagnostic.messageText);
-            if (typeof diagnostic.messageText == "string") {
-                errors.push(diagnostic.messageText);
-            }
+            errors.push(diagnostic.messageText.toString());
         });
     }
-    else {
-        console.log("No semantic errors.");
+    if (!errors.length) {
+        logger.success("Found no type issues!");
     }
     return errors;
 }
@@ -120,7 +112,7 @@ async function formatCode(filePath) {
         filepath: filePath,
     });
     fs_extra_1.default.writeFileSync(filePath, formattedContent);
-    console.log("File formatted successfully.");
+    logger.success("File formatted successfully!");
 }
 async function stripAndPrependImports(content) {
     const imports = content.match(/import.* from.*;/g);
@@ -141,12 +133,12 @@ async function generateTest(scenarios, file) {
     const pomPrompt = await generatePromptFromDirectory("./pages");
     const testFileContent = fs_extra_1.default.readFileSync(file, "utf-8");
     for (const i in scenarios) {
+        console.log("\n\n");
         const scenario = scenarios[i];
-        console.log("Generating test for scenario: ", scenario?.name);
+        logger.log("Generating test for scenario:", scenario?.name);
         //TODO: improve this logic. its buggy
         if (testFileContent.includes(`test("${scenario?.name}"`)) {
-            console.log("test already exists for this scenario", scenario?.name);
-            console.log("skipping test generation");
+            logger.success("Test already exists for this scenario");
             continue;
         }
         const instruction = `
@@ -183,25 +175,27 @@ async function generateTest(scenarios, file) {
         - Donot repeat steps which are already mentioned in the "test.beforeEach" block
         - Add import statements at the beginning of the output.
         `;
-        console.log("constructed instruction for llm");
         let response = await getLLMResult(instruction);
+        logger.success("Test generated successfully!");
         const contents = fs_extra_1.default.readFileSync(file, "utf-8");
         const [prependContent, strippedContent] = await stripAndPrependImports(response);
         await fs_extra_1.default.writeFile(file, prependContent + contents + `\n\n${strippedContent}`, "utf-8");
-        console.log("Linting generated output");
+        logger.log("Linting generated code...");
         await lintErrors(file);
-        console.log("Validating types");
+        logger.log("Validating types...");
         let errors = validateTypescript(file);
         const maxIteration = 2;
         let counter = 0;
         while (errors.length > 0) {
-            console.log(errors);
             const fileContent = fs_extra_1.default.readFileSync(file, "utf-8");
             counter += 1;
             if (counter > maxIteration) {
-                console.log(`Max iteration limit reached. Please review the file ${file} and manually fix the typescript errors.`);
+                logger.error(`Unable to fix typescript errors. Please review ${file} manually and fix the typescript errors. Run the test-gen command again, once errors are fixed`);
                 break;
             }
+            logger.warn("Found few errors while validating types:");
+            errors.forEach(e => logger.warn(e));
+            logger.log("Trying to fix above errors...");
             const instruction = `
         You are a software engineer who is given a task to create test basis a scenario provided to you.
         You will be provided with current tests, fixtures and page object models for you to use and write test.
@@ -230,35 +224,26 @@ async function generateTest(scenarios, file) {
         - Donot modify anything else apart from the code required to fix typescript error
         `;
             response = await getLLMResult(instruction);
-            console.log("fixed");
-            console.log(response);
-            errors = validateTypescript(file);
             await fs_extra_1.default.writeFile(file, response, "utf-8");
+            await lintErrors(file);
+            errors = validateTypescript(file);
         }
-        console.log("formatting spec file");
         await formatCode(file);
     }
 }
 (async function main() {
     if (process.argv.length != 3) {
-        console.log("Provide a path to scenarios path to generate test");
+        logger.error("Please provide path to scenarios using command:", "npx @empiricalrun/test-gen <SCENARIOS_FILE_PATH>");
         process.exit(1);
     }
-    else {
-        const scenariosPath = process.argv[2];
-        const file = fs_extra_1.default.readFileSync(path_1.default.resolve(process.cwd(), scenariosPath), 'utf8');
-        const fileName = scenariosPath.split('/').pop()?.split(".")[0];
-        const config = (0, yaml_1.parse)(file);
-        const scenarios = config.scenarios;
-        const fileDir = config.dir || "./tests";
-        const filePath = `${fileDir}/${fileName}.spec.ts`;
-        if (fs_extra_1.default.existsSync(filePath)) {
-            console.log("Spec file already exists, skipping generation");
-        }
-        else {
-            console.log("Spec file does not exist, creating new spec file");
-            fs_extra_1.default.createFileSync(filePath);
+    const scenariosPath = process.argv[2];
+    const testGenConfigs = await (0, scenarios_1.generateScenarios)(scenariosPath);
+    for (const testGenConfig of testGenConfigs) {
+        const specPath = testGenConfig.specPath;
+        if (!fs_extra_1.default.existsSync(specPath)) {
+            logger.log(`Creating a new spec file: ${specPath}`);
+            fs_extra_1.default.createFileSync(specPath);
         }
-        await generateTest(scenarios, filePath);
+        await generateTest(testGenConfig.scenarios, specPath);
     }
 })();

package/dist/bin/logger/index.d.ts

@@ -0,0 +1,13 @@
+export interface Logger {
+    log: (message?: string, ...optionalParams: any[]) => void;
+    warn: (message?: string, ...optionalParams: any[]) => void;
+    error: (message?: string, ...optionalParams: any[]) => void;
+    success: (message?: string, ...optionalParams: any[]) => void;
+}
+export declare class CustomLogger implements Logger {
+    log(message?: string, ...optionalParams: any[]): void;
+    warn(message?: string, ...optionalParams: any[]): void;
+    success(message?: string, ...optionalParams: any[]): void;
+    error(message?: string, ...optionalParams: any[]): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/bin/logger/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/bin/logger/index.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC1D,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC3D,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC5D,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;CAC/D;AAED,qBAAa,YAAa,YAAW,MAAM;IACzC,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE;IAI9C,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE;IAI/C,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE;IAIlD,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE;CAGjD"}

package/dist/bin/logger/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomLogger = void 0;
+const picocolors_1 = require("picocolors");
+class CustomLogger {
+    log(message, ...optionalParams) {
+        console.log("🪵 ", (0, picocolors_1.cyan)(message), ...optionalParams);
+    }
+    warn(message, ...optionalParams) {
+        console.log("🟡 ", (0, picocolors_1.yellow)(message), ...optionalParams);
+    }
+    success(message, ...optionalParams) {
+        console.log("✅", (0, picocolors_1.green)(message), ...optionalParams);
+    }
+    error(message, ...optionalParams) {
+        console.log("🚨", (0, picocolors_1.red)(message), ...optionalParams);
+    }
+}
+exports.CustomLogger = CustomLogger;

package/dist/bin/scenarios/index.d.ts

@@ -0,0 +1,7 @@
+import { Scenario } from '../types';
+declare function generateScenarios(scenariosPath: string): Promise<{
+    specPath: string;
+    scenarios: Scenario[];
+}[]>;
+export { generateScenarios };
+//# sourceMappingURL=index.d.ts.map

package/dist/bin/scenarios/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/bin/scenarios/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAsEpC,iBAAe,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,QAAQ,EAAE,CAAA;CAAC,EAAE,CAAC,CAM7G;AAID,OAAO,EACH,iBAAiB,EACpB,CAAA"}

package/dist/bin/scenarios/index.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateScenarios = void 0;
+const google_auth_library_1 = require("google-auth-library");
+const slugify_1 = __importDefault(require("slugify"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const yaml_1 = require("yaml");
+/**
+ * Method to update / add scenarios to the repo.
+ * @param path
+ * @returns updated paths of scenarios
+ */
+async function generateScenariosUsingGsheet(path) {
+    const { GoogleSpreadsheet } = await import("google-spreadsheet");
+    const url = new URL(path);
+    const docId = url.pathname.split("/")[3];
+    const searchParams = new URLSearchParams(url.hash.split("#")[1]);
+    const sheetId = Number(searchParams.get("gid")) || 0;
+    // TODO: use oauth 2
+    const serviceAccountAuth = new google_auth_library_1.JWT({
+        email: process.env.GOOGLE_SERVICE_EMAIL,
+        key: process.env.GOOGLE_SERVICE_EMAIL_PRIVATE_KEY,
+        scopes: ['https://www.googleapis.com/auth/spreadsheets'],
+    });
+    const doc = new GoogleSpreadsheet(docId, serviceAccountAuth);
+    await doc.loadInfo();
+    const sheet = doc.sheetsById[sheetId];
+    const rows = await sheet.getRows();
+    const map = new Map();
+    rows.forEach(r => {
+        // TODO: fix for case insensitive
+        const category = r.get("Category");
+        const name = r.get("Scenario");
+        const steps = (r.get("Steps").split("\n")).map((s) => s.trim()).filter((s) => !!s.length);
+        const assert = r.get("Assert");
+        const specPath = category ? `./tests/${category}.spec.ts` : `./tests/${(0, slugify_1.default)(name)}.spec.ts`;
+        const scenario = {
+            steps,
+            name,
+            assert
+        };
+        if (!map.get(specPath)) {
+            map.set(specPath, [scenario]);
+        }
+        else {
+            const scenarios = map.get(specPath);
+            scenarios.push(scenario);
+            map.set(specPath, scenarios);
+        }
+    });
+    const results = [];
+    for (const [specPath, scenarios] of map.entries()) {
+        results.push({
+            specPath,
+            scenarios
+        });
+    }
+    return results;
+}
+async function generateScenariosUsingYAML(scenariosPath) {
+    const file = await fs_extra_1.default.readFile(path_1.default.resolve(process.cwd(), scenariosPath), 'utf8');
+    const fileName = scenariosPath.split('/').pop()?.split(".")[0];
+    const config = (0, yaml_1.parse)(file);
+    const fileDir = config.dir || "./tests";
+    config.specPath = `${fileDir}/${fileName}.spec.ts`;
+    return [config];
+}
+async function generateScenarios(scenariosPath) {
+    if (scenariosPath.startsWith("https://docs.google.com/spreadsheets")) {
+        return await generateScenariosUsingGsheet(scenariosPath);
+    }
+    else {
+        return await generateScenariosUsingYAML(scenariosPath);
+    }
+}
+exports.generateScenarios = generateScenarios;

package/dist/bin/types/index.d.ts

@@ -0,0 +1,15 @@
+export type FileContent = {
+    filePath: string;
+    content: string;
+};
+export type TestGenConfig = {
+    dir?: string;
+    specPath?: string;
+    scenarios: Scenario[];
+};
+export type Scenario = {
+    name: string;
+    steps: string[];
+    assert: string;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/bin/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/bin/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAA;AAEH,MAAM,MAAM,aAAa,GAAG;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,QAAQ,EAAE,CAAC;CACzB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAClB,CAAA"}

package/dist/bin/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/test-gen",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,8 +18,12 @@
     "dotenv": "^16.4.5",
     "eslint": "^8.57.0",
     "fs-extra": "^11.2.0",
+    "google-auth-library": "^9.10.0",
+    "google-spreadsheet": "^4.1.2",
     "openai": "^4.47.2",
+    "picocolors": "^1.0.1",
     "prettier": "^3.2.5",
+    "slugify": "^1.6.6",
     "typescript": "^5.3.3",
     "yaml": "^2.4.2"
   },