wisp-schema 1.0.4 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d4abc3b624c92af7aadcbf233621d7dd14bd9f7c6be7a52be60aeb99ee84ba7
-  data.tar.gz: 3b2e61a24d7f9d5325d1147a59c95d8ab74de977d041a6b9699ffbcc1aa97640
+  metadata.gz: c39370e77a573a96df3057aeeac77d2a6ac7cf3c6b9ad4bebfdf543492a9d215
+  data.tar.gz: 29bab08d4ff6412aa9d1eff0c2af13d3367c250ef21e8b5d08ccea008770af3b
 SHA512:
-  metadata.gz: 3e476aa00de99f780fcffd78bea1c1a40cb2ad48ce69c93ae76bacaaadc32d24a3bc515c9112e78f53a781faa03edef9def86e2f347beb31fa1bd87af3bf23bb
-  data.tar.gz: c271a6d930237e77469b66eedd46fbb2f1e7fa32e3b8a7b9fc6ddcb72703248ac4bcdd18ea1a47e7e9426cac6ca56bd5cc7ea47792d11099db4d8d8b79d32d0f
+  metadata.gz: e91fab4052ffcc15083c7c214583b39537cc666a22ab1a4af9809b576769f8d0e439d3b60187afefa5eb2a2f8f2e4737466c84fa5462d66347d67ab199f20d82
+  data.tar.gz: eb08a417159349fe4ed8f9f5fe7c4dd34438149e29efa7f8f7d0d4615b496674721fd52f3a0363925ad449abb2f0f721f8960fdb3157f3ede3438252a6d1e6e4

data/canary-wisp.json

@@ -83,6 +83,7 @@
     },
     "click": {
       "type": "object",
+      "action_type": "action",
       "title": "Click",
       "description": "Clicks on the UI element",
       "properties": {
@@ -90,9 +91,11 @@
           "enum": ["click"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         },
         "button": {"title": "Mouse Button", "type": "string", "enum": ["left", "middle", "right"]},
         "hold": {"title": "And Hold", "type": "boolean"},
@@ -103,6 +106,7 @@
     },
     "double_click": {
       "type": "object",
+      "action_type": "action",
       "title": "Double Click",
       "description": "Double-clicks on the UI element",
       "properties": {
@@ -110,9 +114,11 @@
           "enum": ["double_click"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         }
       },
       "additionalProperties": false,
@@ -120,6 +126,7 @@
     },
     "fill": {
       "type": "object",
+      "action_type": "action",
       "title": "Fill",
       "description": "Fills the text field with specified content",
       "properties": {
@@ -127,9 +134,11 @@
           "enum": ["fill"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         },
         "text": {"title": "Text", "type": "string"}
       },
@@ -138,6 +147,7 @@
     },
     "type": {
       "type": "object",
+      "action_type": "action",
       "title": "Type",
       "description": "Types in specified text",
       "properties": {
@@ -145,6 +155,7 @@
           "enum": ["type"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "text": {"title": "Text", "type": "string"}
       },
       "additionalProperties": false,
@@ -152,6 +163,7 @@
     },
     "send_key": {
       "type": "object",
+      "action_type": "action",
       "title": "Press Key",
       "description": "Press specified key or key combination.",
       "properties": {
@@ -159,6 +171,7 @@
           "enum": ["send_key"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "key": {"title": "Key", "type": "string"},
         "modifier": {"title": "Modifier", "type": "string"}
       },
@@ -167,6 +180,7 @@
     },
     "hover": {
       "type": "object",
+      "action_type": "action",
       "title": "Hover",
       "description": "Hovers over specified element",
       "properties": {
@@ -174,9 +188,11 @@
           "enum": ["hover"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         }
       },
       "additionalProperties": false,
@@ -184,6 +200,7 @@
     },
     "select": {
       "type": "object",
+      "action_type": "action",
       "title": "Select",
       "description": "Selects specified item from the dropdown",
       "properties": {
@@ -191,9 +208,11 @@
           "enum": ["select"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         },
         "option": {
           "title": "Option",
@@ -205,19 +224,22 @@
     },
     "refresh": {
       "type": "object",
+      "action_type": "action",
       "title": "Refresh",
       "description": "Refreshes the webpage",
       "properties": {
         "action": {
           "enum": ["refresh"]
         },
-        "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"}
+        "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"}
       },
       "additionalProperties": false,
       "required": ["action"]
     },
     "navigate": {
       "type": "object",
+      "action_type": "action",
       "title": "Navigate",
       "description": "Navigates to specified URL",
       "properties": {
@@ -225,6 +247,7 @@
           "enum": ["navigate"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "url": {"title": "URL", "type": "string"},
         "tab": {"title": "Tab", "type": "string", "enum": ["current", "new", "incognito"]}
       },
@@ -233,19 +256,22 @@
     },
     "close_tab": {
       "type": "object",
+      "action_type": "action",
       "title": "Close Tab",
       "description": "Closes current browser tab",
       "properties": {
         "action": {
           "enum": ["close_tab"]
         },
-        "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"}
+        "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"}
       },
       "additionalProperties": false,
       "required": ["action"]
     },
     "scroll": {
       "type": "object",
+      "action_type": "action",
       "title": "Scroll",
       "description": "Scrolls the page into specified direction until target is reached",
       "properties": {
@@ -253,10 +279,12 @@
           "enum": ["scroll"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "direction": {"title": "Direction", "type": "string", "enum": ["up", "down", "left", "right"]},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         }
       },
       "additionalProperties": false,
@@ -264,6 +292,7 @@
     },
     "wait": {
       "type": "object",
+      "action_type": "action",
       "title": "Wait",
       "description": "Waits for a number of seconds",
       "properties": {
@@ -271,6 +300,7 @@
           "enum": ["wait"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "seconds": {"title": "seconds", "type": "integer"}
       },
       "additionalProperties": false,
@@ -278,6 +308,7 @@
     },
     "drag_and_drop": {
       "type": "object",
+      "action_type": "action",
       "title": "Drag and drop",
       "description": "Drag and drop",
       "properties": {
@@ -285,13 +316,15 @@
           "enum": ["drag_and_drop"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "object": {
           "title": "Object",
           "$ref": "#/definitions/noun"
         },
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         }
       },
       "additionalProperties": false,
@@ -299,6 +332,7 @@
     },
     "embedded_test": {
       "type": "object",
+      "action_type": "embedded_test",
       "title": "Embedded Test",
       "description": "Embeds a Test",
       "properties": {
@@ -315,6 +349,7 @@
     },
     "tester_instruction": {
       "type": "object",
+      "action_type": "action",
       "title": "Tester Instruction",
       "description": "An action for a human to complete",
       "properties": {
@@ -322,6 +357,7 @@
           "enum": ["tester_instruction"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "instruction": {"title": "Instruction", "type": "string"}
       },
       "additionalProperties": false,
@@ -329,13 +365,15 @@
     },
     "observe": {
       "type": "object",
+      "action_type": "assertion",
       "title": "Observe",
       "description": "Checks if element of the UI is visible or not",
       "properties": {
-        "assertion": {
+        "action": {
           "enum": ["observe"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "object": {
           "title": "Object",
           "$ref": "#/definitions/noun"
@@ -347,35 +385,39 @@
         }
       },
       "additionalProperties": false,
-      "required": ["assertion", "object", "visibility"]
+      "required": ["action", "object", "visibility"]
     },
     "loaded": {
       "type": "object",
+      "action_type": "assertion",
       "title": "Loaded",
       "description": "Checks if specified page has loaded",
       "properties": {
-        "assertion": {
+        "action": {
           "enum": ["loaded"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "page": {"title": "Page", "type": "string"}
       },
       "additionalProperties": false,
-      "required": ["assertion", "page"]
+      "required": ["action", "page"]
     },
     "tester_confirmation": {
       "type": "object",
+      "action_type": "assertion",
       "title": "Tester Confirmation",
       "description": "Ask a question to confirm a behavior",
       "properties": {
-        "assertion": {
+        "action": {
           "enum": ["tester_confirmation"]
         },
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "id": {"title": "Action ID", "type": "integer"},
         "confirmation": {"title": "confirmation", "type": "string"}
       },
       "additionalProperties": false,
-      "required": ["assertion", "confirmation"]
+      "required": ["action", "confirmation"]
     }
   },
   "type": "object",

data/lib/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Wisp
-  VERSION = '1.0.4'
-  STABLE_VERSION = '0.18.1'
+  VERSION = '1.2.1'
+  STABLE_VERSION = '1.2.1'
+  CANARY_VERSION = '2.0.0'
 end

data/lib/wisp-schema.rb

@@ -4,18 +4,44 @@ require 'semantic'
 require_relative 'version'
 
 module Wisp
+  class NotSupportedAction < StandardError
+  end
+
   SCHEMA_PATH = File.expand_path('../wisp.json', __dir__)
   NOUNS_PATH = File.expand_path('../nouns.json', __dir__)
 
   CANARY_SCHEMA_PATH = File.expand_path('../canary-wisp.json', __dir__)
   CANARY_NOUNS_PATH = File.expand_path('../canary-nouns.json', __dir__)
 
+  ACTIONS = [
+    "click",
+    "close_tab",
+    "double_click",
+    "drag_and_drop",
+    "fill",
+    "hover",
+    "loaded",
+    "navigate",
+    "observe",
+    "refresh",
+    "scroll",
+    "select",
+    "send_key",
+    "tester_confirmation",
+    "tester_instruction",
+    "type",
+    "wait",
+  ].freeze
+
   SEMANTIC_STABLE_VERSION = Semantic::Version.new(STABLE_VERSION)
 
-  def wisp_schemer(raw_version)
-    version = Semantic::Version.new(raw_version)
+  def is_canary?(raw_version)
+    Semantic::Version.new(raw_version) > SEMANTIC_STABLE_VERSION
+  end
+  module_function :is_canary?
 
-    if version > SEMANTIC_STABLE_VERSION
+  def wisp_schemer(raw_version)
+    if is_canary?(raw_version)
       JSONSchemer.schema(Pathname.new(Wisp::CANARY_SCHEMA_PATH))
     else
       JSONSchemer.schema(Pathname.new(Wisp::SCHEMA_PATH))
@@ -24,13 +50,22 @@ module Wisp
   module_function :wisp_schemer
 
   def nouns_schemer(raw_version)
-    version = Semantic::Version.new(raw_version)
-
-    if version > SEMANTIC_STABLE_VERSION
+    if is_canary?(raw_version)
       JSONSchemer.schema(Pathname.new(Wisp::CANARY_NOUNS_PATH))
     else
       JSONSchemer.schema(Pathname.new(Wisp::NOUNS_PATH))
     end
   end
   module_function :nouns_schemer
+
+  def action_schemer(raw_version, action)
+    raise NotSupportedAction unless ACTIONS.include?(action)
+
+    if is_canary?(raw_version)
+      JSONSchemer.schema(Pathname.new(File.expand_path("../canary/actions/#{action}.json", __dir__)))
+    else
+      JSONSchemer.schema(Pathname.new(File.expand_path("../stable/actions/#{action}.json", __dir__)))
+    end
+  end
+  module_function :action_schemer
 end

data/stable/actions/click.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "action_type": "action",
+  "title": "Click",
+  "description": "Clicks on the UI element",
+  "properties": {
+    "action": {
+      "enum": ["click"]
+    },
+    "id": {"title": "Action ID", "type": "integer"},
+    "target": {
+      "title": "Target",
+      "$ref": "ui_element_reference.json"
+    },
+    "button": {"title": "Mouse Button", "type": "string", "enum": ["left", "middle", "right"]},
+    "hold": {"title": "And Hold", "type": "boolean"},
+    "hold_seconds": {"title": "Hold seconds", "type": "integer"},
+    "version": {
+      "type": "string",
+      "title": "Version"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["action", "target", "button", "hold", "version"]
+}

data/stable/actions/close_tab.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "action_type": "action",
+  "title": "Close Tab",
+  "description": "Closes current browser tab",
+  "properties": {
+    "action": {
+      "enum": ["close_tab"]
+    },
+    "id": {"title": "Action ID", "type": "integer"},
+    "version": {
+      "type": "string",
+      "title": "Version"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["action", "version"]
+}