@checksum-ai/runtime 1.0.3 → 1.0.5

package/LICENSE

@@ -0,0 +1 @@
+Checksum license

package/checksum-root/README.md

@@ -0,0 +1 @@
+Checksum readme

package/checksum-root/checksum.config.ts

@@ -0,0 +1,56 @@
+import { RunMode, getChecksumConfig } from "@checksum-ai/runtime";
+
+export default getChecksumConfig({
+  /**
+   * Checksum runtime running mode -
+   * normal -   tests run normally
+   * heal -     checksum will attempt to heal tests that failed using fallback
+   * refactor - checksum will attempt to refactor and improve your tests
+   */
+  runMode: RunMode.Normal,
+
+  /**
+   * Insert here your Checksum API key
+   */
+  apiKey: "<API key>",
+
+  /**
+   * This is the base URL of the tested app
+   */
+  baseURL: "<base URL>",
+
+  /**
+   * Insert the account's username that will be used
+   * to login into your testing environment
+   */
+  username: "<username>",
+
+  /**
+   * Insert the account's password that will be used
+   * to login into your testing environment
+   */
+  password: "<password>",
+
+  options: {
+    /**
+     * Whether to fallback to ESRA if the action selector is not found
+     */
+    actionsESRAfallback: true,
+
+    /**
+     * Whether to use LLM fallback if action selector is not found
+     */
+    actionsLLMFallback: true,
+
+    /**
+     * Whether to use mock API data when running your tests
+     */
+    useMockData: false,
+
+    /**
+     * Print runtime logs.
+     * Use for debug only
+     */
+    printLogs: false,
+  },
+});

package/checksum-root/login.ts

@@ -0,0 +1,19 @@
+import { ChecksumConfig, IChecksumPage } from "@checksum-ai/runtime";
+
+/**
+ * Login method
+ */
+export default async function login(
+  page: IChecksumPage,
+  config: ChecksumConfig
+) {
+  /**
+   * Update this function to login to your application
+   * i.e.:
+   *    await page.goto('/login');
+   *    await page.getByPlaceholder("Email...").fill(config.username);
+   *    await page.getByPlaceholder("Password...").fill(config.password);
+   *    await page.getByText("Continue").click();
+   *    await page.waitForURL("/main");
+   */
+}

package/checksum-root/playwright.config.ts

@@ -0,0 +1,32 @@
+import { defineConfig, devices } from "@playwright/test";
+
+export default defineConfig({
+  timeout: 120000,
+  testMatch: [/.*.[.]checksum.spec.ts/],
+  testDir: ".",
+  /* disable parallel test runs */
+  workers: 1,
+  /* Run tests in files in parallel */
+  fullyParallel: false,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: "html",
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: "on",
+    video: "on",
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: "chromium",
+      use: { ...devices["Desktop Chrome"] },
+    },
+    {
+      name: "checksumpage",
+      use: { ...devices["Desktop Chrome"] },
+      testDir: "./src/lib/runtime",
+    },
+  ],
+});

package/cli.js

@@ -1,3 +1,16 @@
-export function init() {
-  console.log("cli init");
-}
+var g=Object.create;var l=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var f=Object.getOwnPropertyNames;var p=Object.getPrototypeOf,d=Object.prototype.hasOwnProperty;var k=(c,e,t,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of f(e))!d.call(c,o)&&o!==t&&l(c,o,{get:()=>e[o],enumerable:!(s=m(e,o))||s.enumerable});return c};var C=(c,e,t)=>(t=c!=null?g(p(c)):{},k(e||!c||!c.__esModule?l(t,"default",{value:c,enumerable:!0}):t,c));var i=require("fs"),r=C(require("child_process")),n=require("path"),y="checksum",u=class{constructor(){this.checksumConfig=void 0}async execute(){var e;switch(process.argv[2]){case"install":this.install();break;case"run":if(((e=process.argv)==null?void 0:e[3])==="--help"){await this.printHelp("run");break}await this.run(process.argv.slice(3));break;default:await this.printHelp()}process.exit(0)}async execCmd(e){let t=await r.spawn(e,{shell:!0,stdio:"inherit"});return new Promise((o,a)=>{t.on("exit",h=>{h===0?o(!0):a(new Error(`Checsum failed execution with code: ${h} for command: "${e}`))})})}async getCmdOutput(e){return new Promise(function(t,s){r.exec(e,(o,a,h)=>{if(o){s(`Error executing command: ${o.message}`);return}t(a)})})}async printHelp(e){switch(e){default:console.log(`
+Checksum CLI
+Usage: checksum [command] [options]
+
+Commands:
+install         installs checksum files and folders
+run             runs checksum tests
+help            prints this help message
+`);break;case"run":try{let t="npx playwright test --help",s=(await this.getCmdOutput(t)).replace(/npx playwright test/g,"yarn checksum run").split(`
+`);s.splice(5,0,"  --checksum-config=<config>   Checksum configuration in JSON format").join(`
+`),console.log(s.join(`
+`))}catch(t){console.log("Error",t.message)}break}}async run(e){e=this.getChecksumConfig(e);let t=`npx playwright test --config ${(0,n.join)(this.getRootDirPath(),"playwright.config.ts")} ${e.join(" ")}`;try{this.buildVolatileConfig(),await this.execCmd(t)}catch(s){console.log("Error",s.message)}finally{this.cleanup()}}buildVolatileConfig(){if(!this.checksumConfig)return;let e=this.getVolatileConfigPath(),t=`
+    import { RunMode, getChecksumConfig } from "@checksum-ai/runtime";
+    
+    export default getChecksumConfig(${JSON.stringify(this.checksumConfig,null,2)});
+    `;(0,i.writeFileSync)(e,t)}cleanup(){let e=this.getVolatileConfigPath();(0,i.existsSync)(e)&&(0,i.rmSync)(e)}getVolatileConfigPath(){return(0,n.join)(this.getRootDirPath(),"checksum.config.tmp.ts")}getChecksumConfig(e){for(let t of e)if(t.startsWith("--checksum-config"))try{return this.checksumConfig=JSON.parse(t.split("=")[1]),e.filter(s=>s!==t)}catch(s){console.log("Error parsing checksum config",s.message),this.checksumConfig=void 0}return e}install(){console.log("Creating Checksum directory and necessary files to run your tests");let e=this.getRootDirPath();if((0,i.existsSync)(this.getRootDirPath())||(0,i.mkdirSync)(e),!(0,i.existsSync)(this.getChecksumRootOrigin()))throw new Error("Could not find checksum root directory, please install @checksum-ai/runtime package");["checksum.config.ts","playwright.config.ts","login.ts","README.md"].forEach(t=>{(0,i.copyFileSync)((0,n.join)(this.getChecksumRootOrigin(),t),(0,n.join)(e,t))}),(0,i.mkdirSync)((0,n.join)(e,"tests"),{recursive:!0}),["esra","har","trace","log"].forEach(t=>{(0,i.mkdirSync)((0,n.join)(e,"test-data",t),{recursive:!0})})}getRootDirPath(){return(0,n.join)(process.cwd(),y)}getChecksumRootOrigin(){return(0,n.join)(process.cwd(),"node_modules","@checksum-ai","runtime","checksum-root")}};(async()=>await new u().execute())();