Merge pull request #550 from calabash/feature/DeviceAgent-add-support-for-query-star

DeviceAgent::Client:  add support for query("*") and query("all *")

Author: jmoody

lib/run_loop/device_agent/client.rb

@@ -317,7 +317,7 @@ def server_version
 
       # @!visibility private
       def tree
-        options = http_options
+        options = tree_http_options
         request = request("tree")
         client = http_client(options)
         response = client.get(request)
@@ -397,6 +397,12 @@ def enter_text_without_keyboard_check(string)
       #  query({text: "\"To know is not enough.\""})
       #  query({text: %Q["To know is not enough."]})
       #
+      #  # Equivalent to Calabash query("*")
+      #  query({})
+      #
+      #  # Equivalent to Calabash query("all *")
+      #  query({all: true})
+      #
       # Querying for text with newlines is not supported yet.
       #
       # The query language supports the following keys:
@@ -469,45 +475,40 @@ def query(uiquery)
           raise ArgumentError, %Q[
 Unsupported key or keys found: '#{unknown_keys}'.
 
-Allowed keys for a query are: #{keys}
-
-]
-        end
-
-        has_any_key = (allowed_keys & uiquery.keys).any?
-        if !has_any_key
-          keys = allowed_keys.map { |key| ":#{key}" }.join(", ")
-          raise ArgumentError, %Q[
-Query does not contain any keysUnsupported key or keys found: '#{unknown_keys}'.
+Allowed keys for a query are:
 
-Allowed keys for a query are: #{keys}
+#{keys}
 
 ]
         end
 
-        parameters = merged_options.dup.tap { |hs| hs.delete(:all) }
-        if parameters.empty?
-          keys = allowed_keys.map { |key| ":#{key}" }.join(", ")
-          raise ArgumentError, %Q[
+        if _wildcard_query?(uiquery)
+          elements = _flatten_tree
+        else
+          parameters = merged_options.dup.tap { |hs| hs.delete(:all) }
+          if parameters.empty?
+            keys = allowed_keys.map { |key| ":#{key}" }.join(", ")
+            raise ArgumentError, %Q[
 Query must contain at least one of these keys:
 
 #{keys}
 
 ]
-        end
+          end
 
-        request = request("query", parameters)
-        client = http_client(http_options)
+          request = request("query", parameters)
+          client = http_client(http_options)
 
-        RunLoop.log_debug %Q[Sending query with parameters:
+          RunLoop.log_debug %Q[Sending query with parameters:
 
 #{JSON.pretty_generate(parameters)}
 
 ]
 
-        response = client.post(request)
-        hash = expect_300_response(response)
-        elements = hash["result"]
+          response = client.post(request)
+          hash = expect_300_response(response)
+          elements = hash["result"]
+        end
 
         if merged_options[:all]
           elements
@@ -1050,6 +1051,18 @@ def http_options
         end
       end
 
+      # @!visibility private
+      #
+      # Tree can take a very long time.
+      def tree_http_options
+        timeout = DEFAULTS[:http_timeout] * 6
+        {
+          :timeout => timeout,
+          :interval => 0.1,
+          :retries => (timeout/0.1).to_i
+        }
+      end
+
       # @!visibility private
       def server_pid
         options = http_options
@@ -1414,6 +1427,16 @@ def _dismiss_springboard_alerts
         response = client.post(request)
         expect_300_response(response)
       end
+
+      # @!visibility private
+      # Private method.  Do not call.
+      def _wildcard_query?(uiquery)
+        return true if uiquery.empty?
+        return false if uiquery.count != 1
+
+        uiquery.has_key?(:all)
+      end
+
     end
   end
 end

spec/lib/device_agent/client_spec.rb

@@ -451,4 +451,19 @@ def inspect; to_s; end
       expect(actual.all? { |element| element["children"] == nil }).to be_truthy
     end
   end
+
+  context "#_wildcard_query?" do
+    it "returns true if uiquery is empty" do
+      expect(client.send(:_wildcard_query?, {})).to be_truthy
+    end
+
+    it "returns true if uiquery contains only the :all key" do
+      expect(client.send(:_wildcard_query?, {:all => true})).to be_truthy
+      expect(client.send(:_wildcard_query?, {:all => false})).to be_truthy
+    end
+
+    it "return false otherwise" do
+      expect(client.send(:_wildcard_query?, {:type => "Button"})).to be_falsey
+    end
+  end
 end