wisp-schema 1.0.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26bfef5204aaa6c7200c00ad8fcc49aa4391cb1a878ecf9eb68ce43398fe7e96
-  data.tar.gz: e636be91af4d422043665bcc6b5a7d590c3bd4bcb36f3c4798cebc40fca57730
+  metadata.gz: '0393e542d263fda472a83d68da7e3eb8d4fa88e35f64cd3b9d54ffcbc3148c14'
+  data.tar.gz: 6fa9e976819a9c3c32a5c30778a91a7469c588348e97a87379907bf9071acfc5
 SHA512:
-  metadata.gz: d69ddde5d061d1ea40da2ef9943bc72349e2ef80fa0fb6ae357877ca5801e59857d849396a48552d9442f2323c040fd96e99f3f85f29700a1d08bb39e3f606f4
-  data.tar.gz: 1e8201a5e880f46b6ed2153b2c62c58c6a8bef82fda1a2a1708370eff5183f49ae62e7373e6c303f8e0809ce4b12e40adfe4d313ac7a1e88cbe24eef56845f5e
+  metadata.gz: ea5c4f4514e592bc001ab0794881a1a2e9d8e9fcb231b1f518b4ad422ce380f94bd956c3d3140efd1ef156397d8ba43a3a56129a22ce9299cf0f5e7ecec7b51c
+  data.tar.gz: 8c5d7d7091bdabc71ec16a57a0a5fdb3c9e208baa26377b108bdf9145eaad63671493950ff48888de8db48bc412ff5214ec6def17ad7b602a913be2af325d218

data/canary-wisp.json

@@ -77,11 +77,13 @@
         {"$ref": "#/definitions/tester_instruction"},
         {"$ref": "#/definitions/embedded_test"},
         {"$ref": "#/definitions/observe"},
+        {"$ref": "#/definitions/loaded"},
         {"$ref": "#/definitions/tester_confirmation"}
       ]
     },
     "click": {
       "type": "object",
+      "action_type": "action",
       "title": "Click",
       "description": "Clicks on the UI element",
       "properties": {
@@ -91,7 +93,8 @@
         "embedded_test_id": {"title": "Embedded Test 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"},
@@ -102,6 +105,7 @@
     },
     "double_click": {
       "type": "object",
+      "action_type": "action",
       "title": "Double Click",
       "description": "Double-clicks on the UI element",
       "properties": {
@@ -111,7 +115,8 @@
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         }
       },
       "additionalProperties": false,
@@ -119,6 +124,7 @@
     },
     "fill": {
       "type": "object",
+      "action_type": "action",
       "title": "Fill",
       "description": "Fills the text field with specified content",
       "properties": {
@@ -128,7 +134,8 @@
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         },
         "text": {"title": "Text", "type": "string"}
       },
@@ -137,6 +144,7 @@
     },
     "type": {
       "type": "object",
+      "action_type": "action",
       "title": "Type",
       "description": "Types in specified text",
       "properties": {
@@ -151,6 +159,7 @@
     },
     "send_key": {
       "type": "object",
+      "action_type": "action",
       "title": "Press Key",
       "description": "Press specified key or key combination.",
       "properties": {
@@ -166,6 +175,7 @@
     },
     "hover": {
       "type": "object",
+      "action_type": "action",
       "title": "Hover",
       "description": "Hovers over specified element",
       "properties": {
@@ -175,7 +185,8 @@
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         }
       },
       "additionalProperties": false,
@@ -183,6 +194,7 @@
     },
     "select": {
       "type": "object",
+      "action_type": "action",
       "title": "Select",
       "description": "Selects specified item from the dropdown",
       "properties": {
@@ -192,7 +204,8 @@
         "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         },
         "option": {
           "title": "Option",
@@ -204,6 +217,7 @@
     },
     "refresh": {
       "type": "object",
+      "action_type": "action",
       "title": "Refresh",
       "description": "Refreshes the webpage",
       "properties": {
@@ -217,6 +231,7 @@
     },
     "navigate": {
       "type": "object",
+      "action_type": "action",
       "title": "Navigate",
       "description": "Navigates to specified URL",
       "properties": {
@@ -232,6 +247,7 @@
     },
     "close_tab": {
       "type": "object",
+      "action_type": "action",
       "title": "Close Tab",
       "description": "Closes current browser tab",
       "properties": {
@@ -245,6 +261,7 @@
     },
     "scroll": {
       "type": "object",
+      "action_type": "action",
       "title": "Scroll",
       "description": "Scrolls the page into specified direction until target is reached",
       "properties": {
@@ -255,7 +272,8 @@
         "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,
@@ -263,6 +281,7 @@
     },
     "wait": {
       "type": "object",
+      "action_type": "action",
       "title": "Wait",
       "description": "Waits for a number of seconds",
       "properties": {
@@ -277,6 +296,7 @@
     },
     "drag_and_drop": {
       "type": "object",
+      "action_type": "action",
       "title": "Drag and drop",
       "description": "Drag and drop",
       "properties": {
@@ -290,7 +310,8 @@
         },
         "target": {
           "title": "Target",
-          "$ref": "#/definitions/noun"
+          "$ref": "#/definitions/noun",
+          "type": "ui_element_reference"
         }
       },
       "additionalProperties": false,
@@ -298,6 +319,7 @@
     },
     "embedded_test": {
       "type": "object",
+      "action_type": "embedded_test",
       "title": "Embedded Test",
       "description": "Embeds a Test",
       "properties": {
@@ -314,6 +336,7 @@
     },
     "tester_instruction": {
       "type": "object",
+      "action_type": "action",
       "title": "Tester Instruction",
       "description": "An action for a human to complete",
       "properties": {
@@ -328,10 +351,11 @@
     },
     "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"},
@@ -346,21 +370,37 @@
         }
       },
       "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": {
+        "action": {
+          "enum": ["loaded"]
+        },
+        "embedded_test_id": {"title": "Embedded Test ID", "type": "integer"},
+        "page": {"title": "Page", "type": "string"}
+      },
+      "additionalProperties": false,
+      "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"},
         "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.3'
-  STABLE_VERSION = '0.18.1'
+  VERSION = '1.2.0'
+  STABLE_VERSION = '1.2.0'
+  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,25 @@
+{
+  "$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"]
+    },
+    "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,18 @@
+{
+  "$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"]
+    },
+    "version": {
+      "type": "string",
+      "title": "Version"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["action", "version"]
+}

data/stable/actions/double_click.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "action_type": "action",
+  "title": "Double Click",
+  "description": "Double-clicks on the UI element",
+  "properties": {
+    "action": {
+      "enum": ["double_click"]
+    },
+    "target": {
+      "title": "Target",
+      "$ref": "ui_element_reference.json"
+    },
+    "version": {
+      "type": "string",
+      "title": "Version"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["action", "target", "version"]
+}

data/stable/actions/drag_and_drop.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "action_type": "action",
+  "title": "Drag and drop",
+  "description": "Drag and drop",
+  "properties": {
+    "action": {
+      "enum": ["drag_and_drop"]
+    },
+    "object": {
+      "title": "Object",
+      "$ref": "ui_element_reference.json"
+    },
+    "target": {
+      "title": "Target",
+      "$ref": "ui_element_reference.json"
+    },
+    "version": {
+      "type": "string",
+      "title": "Version"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["action", "target", "object", "version"]
+}

data/stable/actions/fill.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "action_type": "action",
+  "title": "Fill",
+  "description": "Fills the text field with specified content",
+  "properties": {
+    "action": {
+      "enum": ["fill"]
+    },
+    "target": {
+      "title": "Target",
+      "$ref": "ui_element_reference.json"
+    },
+    "text": {"title": "Text", "type": "string"},
+    "version": {
+      "type": "string",
+      "title": "Version"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["action", "target", "text", "version"]
+}