Issue-489: Initial support for parsing Selenium IDE project files

karate-core/src/main/java/com/intuit/karate/selenium/domain/SideProject.java

@@ -0,0 +1,152 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2017 Intuit Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.intuit.karate.selenium.domain;
+
+import com.intuit.karate.FileUtils;
+import com.jayway.jsonpath.DocumentContext;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * @author vmchukky
+ */
+
+// SideProject <-> Feature (Top level feature calling other features) ???
+public class SideProject extends TestBase {
+
+    String url;
+    String version;
+    List<String> urls; //??? TODO: figure out url -vs- urls
+    // List<String> plugins;
+    List<TestSuite> suites;
+    final HashMap<String, String> variables;
+
+    public SideProject(DocumentContext doc) {
+        super(doc.read("id"), doc.read("name"));
+        this.suites = new ArrayList<>();
+        this.url = doc.read("$.url");
+        this.version = doc.read("$.version");
+        this.urls = doc.read("$.urls");
+        this.variables = new HashMap<>();
+        List<Map<String, Object>> suiteList = doc.read("$.suites");
+        for (Map<String, Object> suite : suiteList) {
+            this.suites.add(new TestSuite(suite, doc));
+        }
+        // order of command execution within a testcase is kept intact, we also have order of
+        // testsuites (aka features) and testcases (aka scenarios) within a suite (if needed)
+        // but we loose the order of tests (without any associated testsuite) intermingled with
+        // testsuites (but may be that is ok???)
+        // if project has tests:[test-1, test-1-suite-1, test-2-suite-1, test-3, test-1-suite-2]
+        // then the order of suites will be:
+        // suite-1<test-1-sute-1,test-2-suite-1>, suite-2<test-1-suite-2>
+        // and the order of tests (which are not associated with any suite) will be:
+        // no-name<test-1, test-3> (and is added/executed as the last feature)???
+
+        List<Map<String, Object>> testsWithoutAnySuite = doc.read("$.tests");
+        if (testsWithoutAnySuite != null) {
+            List<TestCase> testsInDefaultSuite = new ArrayList<>();
+            for (Map<String, Object> test : testsWithoutAnySuite) {
+                testsInDefaultSuite.add(new TestCase(test));
+            }
+            if (!testsInDefaultSuite.isEmpty()) {
+                this.suites.add(new TestSuite(testsInDefaultSuite));
+            }
+        }
+    }
+
+    public String getUrl() {
+        return url;
+    }
+
+    public String getVersion() {
+        return version;
+    }
+
+    public List<String> getUrls() {
+        return urls;
+    }
+
+    public List<TestSuite> getSuites() {
+        return suites;
+    }
+
+    public String convert(File dir, String configJson) {
+        StringBuilder sb = new StringBuilder("Feature: Selenium IDE Project - ")
+                .append(name).append("\n\tid = ").append(id).append("\n\tconfig = ")
+                .append(configJson).append("\n\n");
+
+        appendScenario(sb, configJson, true); //header -> setUp session
+
+        sb.append("* def driverParams = {session: #(").append(DRIVER_SESSION).append(")}\n");
+
+        String testUrl;
+        int index = 0;
+        String featureName;
+        for (TestSuite suite : suites) {
+            featureName = suite.getIdentifierName() + ".feature";
+            // need to double check this logic
+            testUrl = (index < urls.size()) ? urls.get(index++) : url;
+            FileUtils.writeToFile(new File(dir, featureName), suite.convert(testUrl, variables));
+            sb.append("\n# calling testsuite ").append(suite.name)
+                    .append("\n* json featureResponse = call read('./")
+                    .append(featureName).append("') ").append("driverParams\n");
+        }
+
+        sb.append("\n");
+        appendScenario(sb, configJson, false); //footer -> tearDown session
+        sb.append("Given url ").append(DRIVER_SESSION_URL)
+                .append("\nWhen method DELETE\nThen status 200\n");
+
+        return sb.toString();
+    }
+
+    private StringBuilder appendScenario(StringBuilder sb, String configJson, boolean isHeader) {
+        String name = "Header";
+        String method = "POST";
+        String sessionId = "response.sessionId";
+        if (!isHeader) {
+            name = "Footer";
+            method = "GET";
+            sessionId = "response.value[0].id";
+        }
+        return sb.append("Scenario: ").append(name).append(" for Project\n")
+                .append("* copy ").append(DRIVER)
+                .append(" = ").append(configJson).append('\n')
+                .append("Given url ").append(DRIVER_URL).append(" + '/session'")
+                .append(isHeader ? "\n" : " + 's'\n") // append sessions for footer
+                .append("And request { desiredCapabilities: { caps: {browserName: '#(")
+                .append(DRIVER_BROWSER).append(")'} } }\n")
+                .append("When method ").append(method).append("\nThen status 200\n")
+                .append("And assert response.status == 0\n")
+                .append("* json ").append(DRIVER_SESSION).append(" = {}\n")
+                .append("* set ").append(DRIVER_SESSION_ID).append(" = ").append(sessionId)
+                .append("\n* set ").append(DRIVER_SESSION_URL).append(" = ")
+                .append(DRIVER_URL).append(" + '/session/' + ").append(DRIVER_SESSION_ID).append("\n");
+    }
+
+}

karate-core/src/main/java/com/intuit/karate/selenium/domain/TestBase.java

@@ -0,0 +1,69 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2017 Intuit Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.intuit.karate.selenium.domain;
+
+import java.util.Map;
+
+/**
+ * @author vmchukky
+ */
+public abstract class TestBase {
+    static final String PAGE_TITLE_VAR = "pageTitle";
+    static final String DRIVER_ELEMENT_ID_VAR = "webdriverElementId";
+
+    static final String DRIVER = "webDriver";
+    static final String DRIVER_URL = DRIVER + '.' + "url";
+    static final String DRIVER_BROWSER = DRIVER + '.' + "browser";
+    static final String DRIVER_SESSION = "session";
+    static final String DRIVER_SESSION_ID = DRIVER_SESSION + '.' + "id";
+    static final String DRIVER_SESSION_URL = DRIVER_SESSION + '.' + "url";
+
+
+    protected final String id;
+    protected final String name;
+
+    public TestBase(String id, String name) {
+        this.id = id;
+        this.name = name.trim().replace(" ", "_");
+    }
+
+    public TestBase(Map<String, Object> json) {
+        this.id = (String) json.get("id");
+        this.name = (String) json.get("name");
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    // used to name the feature file / scenario name etc
+    public String getIdentifierName() {
+        return name.trim() + '-' + id.trim();
+    }
+
+}

karate-core/src/main/java/com/intuit/karate/selenium/domain/TestCase.java

@@ -0,0 +1,58 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2017 Intuit Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.intuit.karate.selenium.domain;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * @author vmchukky
+ */
+
+// TestCase <-> Scenario ???
+public class TestCase extends TestBase {
+    List<TestCommand> commands;
+
+    public TestCase(Map<String, Object> testJson) {
+        super(testJson);
+        this.commands = new ArrayList<>();
+        List<Map<String, Object>> commandList = (List<Map<String, Object>>) testJson.get("commands");
+        for (Map<String, Object> commandJson : commandList) {
+            this.commands.add(new TestCommand(commandJson));
+        }
+    }
+
+    public String convert(String url, HashMap<String, String> variables) {
+        StringBuilder sb = new StringBuilder("\nScenario: ")
+                .append(getIdentifierName());
+
+        for (TestCommand command : commands) {
+            sb.append(command.convert(url, variables));
+        }
+
+        return sb.toString();
+    }
+}