Merge pull request #310 from SeleniumHQ/snapshot-plugins

snapshot plugins commands, to reduce clutter in the project

Author: corevo

packages/selenium-ide/src/neo/IO/filesystem.js

@@ -70,9 +70,11 @@ export function saveProject(_project) {
 }
 
 function downloadProject(project) {
-  return exportProject(project).then(code => {
-    project.code = code;
-    Object.assign(project, Manager.emitDependencies());
+  return exportProject(project).then(snapshot => {
+    if (snapshot) {
+      project.snapshot = snapshot;
+      Object.assign(project, Manager.emitDependencies());
+    }
     return browser.downloads.download({
       filename: project.name + ".side",
       url: createBlob("application/json", beautify(JSON.stringify(project), { indent_size: 2 })),
@@ -84,7 +86,7 @@ function downloadProject(project) {
 
 function exportProject(project) {
   return Manager.validatePluginExport(project).then(() => {
-    return Selianize(project, { silenceErrors: true }).catch(err => {
+    return Selianize(project, { silenceErrors: true, skipStdLibEmitting: true }).catch(err => {
       const markdown = ParseError(err && err.message || err);
       ModalState.showAlert({
         title: "Error saving project",

packages/selenium-side-runner/package.json

@@ -35,6 +35,7 @@
     "js-yaml": "^3.10.0",
     "rimraf": "^2.6.2",
     "selenium-webdriver": "^3.6.0",
+    "selianize": "*",
     "winston": "^2.4.0"
   },
   "devDependencies": {

packages/selenium-side-runner/src/index.js

@@ -25,6 +25,7 @@ import program from "commander";
 import winston from "winston";
 import rimraf from "rimraf";
 import { js_beautify as beautify } from "js-beautify";
+import Selianize from "selianize";
 import Capabilities from "./capabilities";
 import Config from "./config";
 import metadata from "../package.json";
@@ -101,7 +102,7 @@ configuration.baseUrl = program.baseUrl ? program.baseUrl : configuration.baseUr
 let projectPath;
 
 function runProject(project) {
-  if (!project.code || project.version !== "1.0") {
+  if (project.version !== "1.0") {
     return Promise.reject(new TypeError(`The project ${project.name} is of older format, open and save it again using the IDE.`));
   }
   projectPath = `side-suite-${project.name}`;
@@ -118,56 +119,59 @@ function runProject(project) {
     },
     dependencies: project.dependencies || {}
   }));
-  const tests = project.code.tests.reduce((tests, test) => {
-    return tests += test.code;
-  }, "const tests = {};").concat("module.exports = tests;");
-  writeJSFile(path.join(projectPath, "commons"), tests, ".js");
-  project.code.suites.forEach(suite => {
-    if (!suite.tests) {
-      // not parallel
-      const cleanup = suite.persistSession ? "" : "beforeEach(() => {vars = {};});afterEach(async () => (cleanup()));";
-      writeJSFile(path.join(projectPath, suite.name), `// This file was generated using Selenium IDE\nconst tests = require("./commons.js");${suite.code}${cleanup}`);
-    } else if (suite.tests.length) {
-      fs.mkdirSync(path.join(projectPath, suite.name));
-      // parallel suite
-      suite.tests.forEach(test => {
-        writeJSFile(path.join(projectPath, suite.name, test.name), `// This file was generated using Selenium IDE\nconst tests = require("../commons.js");${suite.code}${test.code}`);
-      });
-    }
-  });
-  winston.info(`Running ${project.name}`);
 
-  return new Promise((resolve, reject) => {
-    let npmInstall;
-    if (project.dependencies && Object.keys(project.dependencies).length) {
-      npmInstall = new Promise((resolve, reject) => {
-        const child = fork(require.resolve("./npm"), { cwd: path.join(process.cwd(), projectPath), stdio: "inherit" });
+  return Selianize(project, { silenceErrors: true }, project.snapshot).then((code) => {
+    const tests = code.tests.reduce((tests, test) => {
+      return tests += test.code;
+    }, "const tests = {};").concat("module.exports = tests;");
+    writeJSFile(path.join(projectPath, "commons"), tests, ".js");
+    code.suites.forEach(suite => {
+      if (!suite.tests) {
+        // not parallel
+        const cleanup = suite.persistSession ? "" : "beforeEach(() => {vars = {};});afterEach(async () => (cleanup()));";
+        writeJSFile(path.join(projectPath, suite.name), `// This file was generated using Selenium IDE\nconst tests = require("./commons.js");${code.globalConfig}${suite.code}${cleanup}`);
+      } else if (suite.tests.length) {
+        fs.mkdirSync(path.join(projectPath, suite.name));
+        // parallel suite
+        suite.tests.forEach(test => {
+          writeJSFile(path.join(projectPath, suite.name, test.name), `// This file was generated using Selenium IDE\nconst tests = require("../commons.js");${code.globalConfig}${suite.code}${test.code}`);
+        });
+      }
+    });
+    winston.info(`Running ${project.name}`);
+
+    return new Promise((resolve, reject) => {
+      let npmInstall;
+      if (project.dependencies && Object.keys(project.dependencies).length) {
+        npmInstall = new Promise((resolve, reject) => {
+          const child = fork(require.resolve("./npm"), { cwd: path.join(process.cwd(), projectPath), stdio: "inherit" });
+          child.on("exit", (code) => {
+            if (code) {
+              reject();
+            } else {
+              resolve();
+            }
+          });
+        });
+      } else {
+        npmInstall = Promise.resolve();
+      }
+      npmInstall.then(() => {
+        const child = fork(require.resolve("./child"), [
+          "--testMatch", `{**/*${program.filter}*/*.test.js,**/*${program.filter}*.test.js}`
+        ].concat(program.maxWorkers ? ["-w", program.maxWorkers] : []), { cwd: path.join(process.cwd(), projectPath), stdio: "inherit" });
+
         child.on("exit", (code) => {
+          console.log("");
+          rimraf.sync(projectPath);
           if (code) {
             reject();
           } else {
             resolve();
           }
         });
-      });
-    } else {
-      npmInstall = Promise.resolve();
-    }
-    npmInstall.then(() => {
-      const child = fork(require.resolve("./child"), [
-        "--testMatch", `{**/*${program.filter}*/*.test.js,**/*${program.filter}*.test.js}`
-      ].concat(program.maxWorkers ? ["-w", program.maxWorkers] : []), { cwd: path.join(process.cwd(), projectPath), stdio: "inherit" });
-
-      child.on("exit", (code) => {
-        console.log("");
-        rimraf.sync(projectPath);
-        if (code) {
-          reject();
-        } else {
-          resolve();
-        }
-      });
-    }).catch(reject);
+      }).catch(reject);
+    });
   });
 }
 

packages/selianize/__tests__/command.spec.js

@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-import CommandEmitter from "../src/command";
+import CommandEmitter, { registerEmitter } from "../src/command";
 import { Commands } from "../../selenium-ide/src/neo/models/Command";
 
 describe("command code emitter", () => {
@@ -41,7 +41,7 @@ describe("command code emitter", () => {
       target: "/",
       value: ""
     };
-    return expect(CommandEmitter.emit(command)).resolves.toBe(`await driver.get(BASE_URL + "${command.target}");`);
+    return expect(CommandEmitter.emit(command)).resolves.toBe(`await driver.get((new URL("${command.target}", BASE_URL)).href);`);
   });
   it("should emit `open` with absolute url", () => {
     const command = {
@@ -637,4 +637,49 @@ describe("command code emitter", () => {
       }).not.toThrow();
     });
   });
+  it("should skip emitting stdlib command when skipStdLibEmitting is set", () => {
+    const command = {
+      command: "open",
+      target: "/",
+      value: ""
+    };
+    return expect(CommandEmitter.emit(command, { skipStdLibEmitting: true })).resolves.toEqual({ skipped: true });
+  });
+  it("should emit a snapshot for a non-stdlib command when skipStdLibEmitting is set", () => {
+    const command = {
+      command: "aNewCommand",
+      target: "",
+      value: ""
+    };
+    registerEmitter(command.command, () => ("new command code"));
+    return expect(CommandEmitter.emit(command, { skipStdLibEmitting: true })).resolves.toBe("new command code");
+  });
+  it("should throw an error for an invalid non-stdlib command even when skipStdLibEmitting is set", () => {
+    const command = {
+      command: "errorCommand",
+      target: "",
+      value: ""
+    };
+    registerEmitter(command.command, () => {
+      throw new Error("an error occurred");
+    });
+    return expect(CommandEmitter.emit(command, { skipStdLibEmitting: true })).rejects.toThrow("an error occurred");
+  });
+  it("should not throw an error for an unknown command when skipStdLibEmitting is set", () => {
+    const command = {
+      command: "doesntExist",
+      target: "",
+      value: ""
+    };
+    return expect(CommandEmitter.emit(command, { skipStdLibEmitting: true })).resolves.toEqual({ skipped: true });
+  });
+  it("should return the snapshot when an unknown command is being emitted with snapshot sent", () => {
+    const command = {
+      command: "doesntExist",
+      target: "",
+      value: ""
+    };
+    const snapshot = "this commands snapshot";
+    return expect(CommandEmitter.emit(command, undefined, snapshot)).resolves.toBe(snapshot);
+  });
 });

packages/selianize/__tests__/configuration.spec.js

@@ -22,6 +22,30 @@ describe("configuration code emitter", () => {
     const project = {
       url: "http://www.seleniumhq.org"
     };
-    return expect(ConfigurationEmitter.emit(project)).resolves.toBe(`global.BASE_URL = configuration.baseUrl || '${project.url}';let vars = {};`);
+    return expect(ConfigurationEmitter.emit(project)).resolves.toBe(`global.URL = require('url').URL;global.BASE_URL = configuration.baseUrl || '${project.url}';let vars = {};`);
+  });
+  it("should skip emitting project configuration when skipStdLibEmitting is set and there are no config hooks", () => {
+    const project = {
+      url: "http://www.seleniumhq.org"
+    };
+    return expect(ConfigurationEmitter.emit(project, { skipStdLibEmitting: true })).resolves.toEqual({
+      skipped: true
+    });
+  });
+  it("should append the configuration snapshot to the config", () => {
+    const project = {
+      url: "http://www.seleniumhq.org"
+    };
+    const snapshot = "extra global config";
+    return expect(ConfigurationEmitter.emit(project, undefined, snapshot)).resolves.toBe(`global.URL = require('url').URL;global.BASE_URL = configuration.baseUrl || '${project.url}';let vars = {};${snapshot}`);
+  });
+  it("should emit a snapshot of the hooks when skipStdLibEmitting is set", () => {
+    const project = {
+      url: "http://www.seleniumhq.org"
+    };
+    ConfigurationEmitter.registerHook(() => ("some config code"));
+    return expect(ConfigurationEmitter.emit(project, { skipStdLibEmitting: true })).resolves.toEqual({
+      snapshot: "some config code"
+    });
   });
 });

packages/selianize/__tests__/index.spec.js

@@ -29,7 +29,7 @@ describe("Selenium code serializer", () => {
     const hook = jest.fn();
     hook.mockReturnValue(Promise.resolve("some code the the top"));
     RegisterConfigurationHook(hook);
-    return expect((await Selianize(project)).suites[0].code).toMatch(/some code the the top/);
+    return expect((await Selianize(project)).globalConfig).toMatch(/some code the the top/);
   });
   it("should register a suite emitter hook", async () => {
     const project = JSON.parse(fs.readFileSync(path.join(__dirname, "test-files", "project-3-single-test.side")));

packages/selianize/__tests__/suite.spec.js

@@ -26,7 +26,9 @@ describe("suite emitter", () => {
       timeout: "30",
       tests: []
     };
-    return expect(SuiteEmitter.emit(suite, {})).resolves.toBe(`jest.setTimeout(30000);describe("${suite.name}", () => {});`);
+    return expect(SuiteEmitter.emit(suite, {})).resolves.toEqual({
+      code: `jest.setTimeout(30000);describe("${suite.name}", () => {});`
+    });
   });
   it("should emit a suite with a single empty test", async () => {
     const tests = {
@@ -44,7 +46,9 @@ describe("suite emitter", () => {
     };
     return expect(SuiteEmitter.emit(suite, {
       1: await TestCaseEmitter.emit(tests["1"])
-    })).resolves.toBe(`jest.setTimeout(30000);describe("${suite.name}", () => {it("${tests["1"].name}", async () => {await tests.example_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});});`);
+    })).resolves.toEqual({
+      code: `jest.setTimeout(30000);describe("${suite.name}", () => {it("${tests["1"].name}", async () => {await tests.example_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});});`
+    });
   });
   it("should emit a suite with multiple empty tests", async () => {
     const tests = {
@@ -74,7 +78,9 @@ describe("suite emitter", () => {
       1: await TestCaseEmitter.emit(tests["1"]),
       2: await TestCaseEmitter.emit(tests["2"]),
       3: await TestCaseEmitter.emit(tests["3"])
-    })).resolves.toBe(`jest.setTimeout(30000);describe("${suite.name}", () => {it("${tests["1"].name}", async () => {await tests.example_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});it("${tests["2"].name}", async () => {await tests.second_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});it("${tests["3"].name}", async () => {await tests.third_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});});`);
+    })).resolves.toEqual({
+      code: `jest.setTimeout(30000);describe("${suite.name}", () => {it("${tests["1"].name}", async () => {await tests.example_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});it("${tests["2"].name}", async () => {await tests.second_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});it("${tests["3"].name}", async () => {await tests.third_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});});`
+    });
   });
   it("should emit a parallel suite", async () => {
     const tests = {
@@ -119,4 +125,46 @@ describe("suite emitter", () => {
         code: `jest.setTimeout(30000);test("${tests["3"].name}", async () => {await tests.third_test_case(driver, vars);await driver.getTitle().then(title => {expect(title).toBeDefined();});});`
       }]);
   });
+  it("should skip emitting when skipStdLibEmitting is set and no hooks are registered", () => {
+    const suite = {
+      id: "1",
+      name: "example suite",
+      timeout: "30",
+      tests: []
+    };
+    return expect(SuiteEmitter.emit(suite, {}, { skipStdLibEmitting: true })).resolves.toEqual({ skipped: true });
+  });
+  it("should emit a snapshot of the hooks when skipStdLibEmitting is set and hooks are registered", () => {
+    const suite = {
+      id: "1",
+      name: "example suite",
+      timeout: "30",
+      tests: []
+    };
+    SuiteEmitter.registerHook(() => ({
+      beforeAll: "beforeAll code",
+      before: "before code",
+      after: "after code",
+      afterAll: "afterAll code"
+    }));
+    return expect(SuiteEmitter.emit(suite, {}, { skipStdLibEmitting: true })).resolves.toEqual({
+      snapshot: {
+        hook: "beforeAll(async () => {beforeAll code});beforeEach(async () => {before code});afterEach(async () => {after code});afterAll(async () => {afterAll code});"
+      }
+    });
+  });
+  it("should append the snapshot to the normal hooks", () => {
+    const suite = {
+      id: "1",
+      name: "example suite",
+      timeout: "30",
+      tests: []
+    };
+    const snapshot = {
+      hook: "hook results"
+    };
+    return expect(SuiteEmitter.emit(suite, {}, undefined, snapshot)).resolves.toEqual({
+      code: "jest.setTimeout(30000);describe(\"example suite\", () => {beforeAll(async () => {beforeAll code});beforeEach(async () => {before code});afterEach(async () => {after code});afterAll(async () => {afterAll code});hook results});"
+    });
+  });
 });