Merge lp:~veebers/stock-ticker-mobile-app/mock-server-for-testing into lp:stock-ticker-mobile-app

[Christopher Lee]

Introduce a mock http server for use in testing (no need to hit external network).
Modify application so that it can take a data source url as an argument (enabling use of the mock server).

[Nicholas Skaggs (nskaggs)]

Veebers, any feedback from the developers?

[Robert Steckroth (robertsteckroth)]

I would need to take time off of work to do it. I almost had 3 days this
week, but... I should be available sooner than later.
I do not know how functional the mock server will be in development either.
The unit tests should not rely on application code. The application
run-time functions which switch the server url should be removed and a url
set in the autopilot.
Other than that, it will be difficult to get the merge through at its
current state.

On Mon, Dec 2, 2013 at 3:36 PM, Nicholas Skaggs <
<email address hidden>> wrote:

> Veebers, any feedback from the developers?
> --
>
> https://code.launchpad.net/~veebers/stock-ticker-mobile-app/mock-server-for-testing/+merge/194971
> Your team Stock Ticker Developers is requested to review the proposed
> merge of lp:~veebers/stock-ticker-mobile-app/mock-server-for-testing into
> lp:stock-ticker-mobile-app.
>

--
<surgemcgee> Systems/Software Engineer

[Nicholas Skaggs (nskaggs)]

Robert, any chance to further this? Sounds like you want to change how dataServerUrl is set?

[Robert Steckroth (robertsteckroth)]

I do have some extra time this week, hmm..

On Wed, Jan 22, 2014 at 5:01 PM, Nicholas Skaggs <
<email address hidden>> wrote:

> Robert, any chance to further this? Sounds like you want to change how
> dataServerUrl is set?
> --
>
> https://code.launchpad.net/~veebers/stock-ticker-mobile-app/mock-server-for-testing/+merge/194971
> Your team Stock Ticker Developers is requested to review the proposed
> merge of lp:~veebers/stock-ticker-mobile-app/mock-server-for-testing into
> lp:stock-ticker-mobile-app.
>

--
<surgemcgee>

[Alan Pope 🍺🐧🐱 🦄 (popey)]

This has been idle for some months now. Is it still relevant and will it be reviewed at soon?
It's one of our oldest merge requests.

[Nicholas Skaggs (nskaggs)]

It's contingent on what is happening from an application development standpoint. If the app is going to be changed, as suggested by Robert, the tests just need small tweaks to work. If it merges now, there's some qml changes that might not be in agreement with that.

[Robert Steckroth (robertsteckroth)]

That changeset was too ambitious. Also, I personally do not like the
offline unit testing setup. I will be adding Indurate database 1.3 support
soon and do not plan on incorporating that branch.
It is unfortunate however, as the python work was very professional.

On Wed, Apr 30, 2014 at 3:28 PM, Nicholas Skaggs <
<email address hidden>> wrote:

> It's contingent on what is happening from an application development
> standpoint. If the app is going to be changed, as suggested by Robert, the
> tests just need small tweaks to work. If it merges now, there's some qml
> changes that might not be in agreement with that.
> --
>
> https://code.launchpad.net/~veebers/stock-ticker-mobile-app/mock-server-for-testing/+merge/194971
> Your team Stock Ticker Developers is requested to review the proposed
> merge of lp:~veebers/stock-ticker-mobile-app/mock-server-for-testing into
> lp:stock-ticker-mobile-app.
>

--
<surgemcgee>

[David Planella (dpm)]

From the last comments, my recommendation would then be to mark the branch as Rejected. Christopher, please accept our apologies for the unresponsiveness on this branch. Feel free to reach out to me ('dpm'), popey or balloons on IRC for any questions.

review: Disapprove

[Nicholas Skaggs (nskaggs)]

I've rejected the merge, but think the code in mock_data_server.py is very useful as a reference.

Unmerged revisions

76. By Christopher Lee on 2013-11-13

Initial server working

75. By Christopher Lee on 2013-11-12

Further additions to assist in mocking server.

74. By Christopher Lee on 2013-11-12

Enable being able to use a different datasource.

=== modified file 'Add_Stocks_page.qml'
--- Add_Stocks_page.qml	2013-08-28 03:15:07 +0000
+++ Add_Stocks_page.qml	2013-11-13 02:26:42 +0000
@@ -27,6 +27,7 @@
     property string active_search_tick: ""
     property string before_after_space: "00"
     //   This is used as two varibles > 0 is for has space at begining of line in `function update_search_text`
+    property string dataServerUrl: "http://d.yimg.com/autoc.finance.yahoo.com/" // Can be overwritten for testing.
 
     Timer {
         id: reloadTrigger
@@ -55,7 +56,6 @@
 
     function text_change_handler() {
         log("text_change_handler()")
-
         // Find the current word the user is editing by spaces before and after current word at cursor
         var cursor_to_end = addStockTextField.text.substr(addStockTextField.cursorPosition).split(' ')
         var cursor_to_begining = addStockTextField.text.substr(0, addStockTextField.cursorPosition+cursor_to_end[0].length).split(' ')
@@ -73,7 +73,7 @@
         matchIndicator = true
         active_search_tick = search_word
         before_after_space = before_after
-        xhr.open("GET","http://d.yimg.com/autoc.finance.yahoo.com/autoc?query="+search_word+"&callback=YAHOO.Finance.SymbolSuggest.ssCallback", true);
+        xhr.open("GET", dataServerUrl + "autoc?query="+search_word+"&callback=YAHOO.Finance.SymbolSuggest.ssCallback", true);
         xhr.onreadystatechange = function()
         {
             if ( xhr.readyState == xhr.DONE) {

=== modified file 'Stock_Ticker.qml'
--- Stock_Ticker.qml	2013-10-09 20:13:18 +0000
+++ Stock_Ticker.qml	2013-11-13 02:26:42 +0000
@@ -24,6 +24,17 @@
 
 
 MainView {
+    Arguments {
+        id: args
+
+        Argument {
+            name: "dataserver"
+            help: "Server to use for retrieving data (Useful for testing.)"
+            required: false
+            valueNames: ["URL"]
+        }
+    }
+
     // objectName for functional testing purposes (autopilot-qt5)
     objectName: "stockTicker"
     applicationName: "com.ubuntu.stock-ticker-mobile"
@@ -47,13 +58,26 @@
 
     property int dummyTextWidth // Holds the width of the percent sign in Stock_Component_Main
 
-    property string serverDomain: "http://www.surgemcgee.com:8080/"
-//    property string serverDomain: "http://localhost:8080/"
+    property string serverDomain: get_data_server() ? get_data_server() : "http://www.surgemcgee.com:8080/"
+    property string dataServer: get_data_server() ? get_data_server() : "http://finance.yahoo.com/"
 
     function log(message) {
          console.log("["+applicationName+"] "+message)
     }
 
+    // If no dataserver argument passed returns undefined, otherwise returns a cleaned up URL.
+    function get_data_server() {
+        var server = args.values.dataserver;
+        if (server === undefined)
+            return undefined
+        if (server.substr(0, 7) !== "http://")
+            server = "http://" + server
+        if (server.slice(-1) !== "/")
+            server += "/"
+
+        return server
+    }
+
     property string quoteParams: "?f=sabl1vpghojkc8dre7j1n&s="
     property var database: new Store.IndurateDatabase({name: "SockTickerMobile", version: "1.0", description: "The Stock Ticker core application database", size: 4}, LocalStorage)
     property var userTable: database.initTable(primaryTable, false, function(msg){ console.log(msg) })
@@ -413,7 +437,7 @@
 
     XmlListModel {
         id: newsFeed
-        source: "http://finance.yahoo.com/rss/headline?s="+chartTick
+        source: dataServer + "rss/headline?s=" +chartTick
         query: "/rss/channel/item"
         XmlRole { name: "title"; query: "title/string()" }
         XmlRole { name: "description"; query: "description/string()" }
@@ -672,7 +696,10 @@
                         width: parent.width - 10 // Subtract the main program border amount here
                         height: parent.height
                         anchors.horizontalCenter: parent.horizontalCenter
-                        Add_Stocks_page { id: addStocksTab }
+                        Add_Stocks_page {
+                            id: addStocksTab
+                            dataServerUrl: get_data_server() ? get_data_server() : Add_Stocks_page.dataServerUrl
+                        }
                     }
             }
         }

=== added file 'tests/autopilot/stock_ticker/mock_data_server.py'
--- tests/autopilot/stock_ticker/mock_data_server.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/stock_ticker/mock_data_server.py	2013-11-13 02:26:42 +0000
@@ -0,0 +1,144 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2013 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import BaseHTTPServer
+import errno
+import os
+import socket
+import threading
+from textwrap import dedent
+import re
+
+
+class HTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
+    """Simple HTTP request handler that mocks data and requests for testing."""
+
+    def _send_xml(self, xml):
+        self.send_response(200)
+        self.send_header("Content-Type", "application/xml")
+        self.end_headers()
+        self.wfile.write(
+            '<?xml version="1.0" encoding="UTF-8"?>{content}'.format(
+                content=xml
+            )
+        )
+
+    def _send_json(self, json):
+        self.send_response(200)
+        self.send_header(
+            "Content-Type",
+            "application/x-javascript; charset=utf-8"
+        )
+        self.end_headers()
+        self.wfile.write(json)
+
+    def send_stock_data(self):
+        match_check = re.compile("\&s=[\+]+goo")
+        if match_check.search(self.path) is not None:
+            google_stock_data = dedent(
+                '<stockInfo>'
+                '<currentStats stkent0="GOOG" '
+                'stkent1="1040.66" stkent2="1009.50" stkent3="1010.59" '
+                'stkent4="1112778" stkent5="1016.03" stkent6="1008.00" '
+                'stkent7="1015.93" stkent8="1009.51" stkent9="636.00" '
+                'stkent10="1041.52" stkent11="N/A - N/A" stkent12="0.00" '
+                'stkent13="27.65" stkent14="44.06" stkent15="337.6B" '
+                'stkent16="Google Inc."/>'
+                '</stockInfo>'
+            )
+            self._send_xml(google_stock_data)
+        else:
+            self._send_xml('<stockInfo></stockInfo>')
+
+    def send_autocomplete_data(self):
+        """Build up a response for the autocomplete.
+
+        Pad-out the wanted data with dummy data
+
+        """
+        google_result = dedent(
+            '{"symbol":"GOOG","name": "Google Inc.","exch": "NMS","type": "S",'
+            '"exchDisp":"NASDAQ","typeDisp":"Equity"}'
+        )
+        dummy_result = dedent(
+            '{"symbol":"DUMM","name": "Dummy Inc.","exch": "NMS","type": "S",'
+            '"exchDisp":"NASDAQ","typeDisp":"Equity"}'
+        )
+        result_list = "{google},{dummies}".format(
+            google=google_result,
+            dummies=",".join([dummy_result for x in range(9)])
+        )
+        json = dedent(
+            'YAHOO.Finance.SymbolSuggest.ssCallback('
+            '{"ResultSet":{"Query":"goo","Result":'
+            '['
+            '%s'
+            ']}})'
+            % result_list
+        )
+        self._send_json(json)
+
+    def do_GET(self):
+        try:
+            if self.path.startswith("/?f"):
+                self.send_stock_data()
+            elif self.path.startswith("/rss/2.0/headline"):
+                self._send_xml('<rss version="2.0"><channel/></rss>')
+            elif self.path.startswith("/autoc"):
+                self.send_autocomplete_data()
+            else:
+                self.send_response(200)
+                self.end_headers()
+                self.wfile.write("[[[[ UNKNOWN ]]]]")
+        except IOError as e:
+            pass
+
+class HTTPServerInAThread(threading.Thread):
+    """Simple custom HTTP server run in a separate thread."""
+
+    def __init__(self):
+        super(HTTPServerInAThread, self).__init__()
+        port = 12345
+        self.server = None
+        while self.server is None:
+            try:
+                self.server = BaseHTTPServer.HTTPServer(
+                    ("", port),
+                    HTTPRequestHandler
+                )
+            except socket.error as error:
+                if (error.errno == errno.EADDRINUSE):
+                    print "Port %d is already in use" % port
+                    port += 1
+                else:
+                    print os.strerror(error.errno)
+                    raise
+        self.server.allow_reuse_address = True
+
+    @property
+    def port(self):
+        return self.server.server_port
+
+    def run(self):
+        print "now serving on port %d" % self.port
+        self.server.serve_forever()
+
+    def shutdown(self):
+        self.server.shutdown()
+        self.server.server_close()
+
+
+__all__ = ["HTTPServerInAThread"]

=== modified file 'tests/autopilot/stock_ticker/tests/__init__.py'
--- tests/autopilot/stock_ticker/tests/__init__.py	2013-11-13 02:26:41 +0000
+++ tests/autopilot/stock_ticker/tests/__init__.py	2013-11-13 02:26:42 +0000
@@ -26,7 +26,7 @@
 from autopilot.testcase import AutopilotTestCase
 
 from ubuntuuitoolkit import emulators as toolkit_emulators
-from stock_ticker import emulators
+from stock_ticker import emulators, mock_data_server
 
 logger = logging.getLogger(__name__)
 
@@ -54,32 +54,43 @@
         self.temp_move_sqlite_db()
         self.addCleanup(self.restore_sqlite_db)
 
+        self.server = mock_data_server.HTTPServerInAThread()
+        self.server.start()
+        self.addCleanup(self.server.shutdown)
+
+        url = self._get_data_server_url()
         if os.path.exists(self.local_location):
-            self.launch_test_local()
+            self.launch_test_local(url)
         elif os.path.exists(self.installed_location):
-            self.launch_test_installed()
+            self.launch_test_installed(url)
         else:
-            self.launch_test_click()
-
-    def launch_test_local(self):
+            self.launch_test_click(url)
+
+    def _get_data_server_url(self):
+        return "http://localhost:%s" % self.server.port
+
+    def launch_test_local(self, server_url):
         self.app = self.launch_test_application(
             "qmlscene",
             self.local_location,
+            "--dataserver=%s" % server_url,
             app_type='qt',
             emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
 
-    def launch_test_installed(self):
+    def launch_test_installed(self, server_url):
         self.app = self.launch_test_application(
             "qmlscene",
             self.installed_location,
             "--desktop_file_hint=/usr/share/applications/"
             "stock-ticker-app.desktop",
+            "--dataserver=%s" % server_url,
             app_type='qt',
             emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
 
-    def launch_test_click(self):
+    def launch_test_click(self, server_url):
         self.app = self.launch_click_package(
             "com.ubuntu.stock-ticker-mobile",
+            "--dataserver=%s" % server_url,
             emulator_base=toolkit_emulators.UbuntuUIToolkitEmulatorBase)
 
     def temp_move_sqlite_db(self):