Merge lp:~mikemc/unity-scope-click/remove-invalid-account-and-sync into lp:unity-scope-click

[Mike McCracken]

- Handle invalidated tokens by removing UOA account. (LP: #1248326)

- Handle invalidated tokens by removing UOA account. (LP: #1248326)

Responds to an invalid-token error received while attempting to download an app by deleting the UOA account.
This is currently the best way to remove the token, as the U1 custom UI is required to correctly re-auth and it is not included in a signon plugin, which would be the officially supported way to use the UOA architecture.

Includes improved test coverage for ClickScope.install_app(), which required some visibility and inheritance tweaks in other parts of the code so that we could use Vala subclassing to provide fake objects for tests.

Removed outdated TODO comment about caching webservice - caching is
already done in click-webservice.vala

NOTE: the change in this branch to using a single ClickWebservice
member of the ClickScope object does not affect or effect caching.

Removed test_fetch_credentials, because as far as I can tell, it only
tested the fake class.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:86
http://jenkins.qa.ubuntu.com/job/unity-scope-click-ci/130/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-amd64-ci/28
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-armhf-ci/28

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scope-click-ci/130/rebuild

review: Approve (continuous-integration)

[dobey (dobey)]

review: Approve

[Roberto Alsina (ralsina)]

review: Approve

=== modified file 'src/click-scope.vala'
--- src/click-scope.vala	2013-12-10 22:21:24 +0000
+++ src/click-scope.vala	2013-12-17 20:34:09 +0000
@@ -79,11 +79,18 @@
   const string LABEL_REVIEWS = "Reviews";
   const string LABEL_COMMENTS = "Comments";
 
-  ClickInterface click_if = new ClickInterface ();
+  public ClickInterface click_if = new ClickInterface ();
+  public UbuntuoneCredentials u1creds = new UbuntuoneCredentials ();
+  public ClickWebservice webservice = new ClickWebservice ();
 
   public ClickScope ()
   {
   }
+  
+  // Wrapper to be overridden for tests:
+  protected virtual SignedDownload get_signed_download (HashTable<string, string> credentials) {
+      return new SignedDownload (credentials);
+  }
 
   Unity.Preview build_error_preview (string message) {
     var preview = new Unity.GenericPreview("Error", message, null);
@@ -107,9 +114,7 @@
 
   internal async Unity.Preview build_app_preview(Unity.ScopeResult result) {
     var app_id = result.metadata.get(METADATA_APP_ID).get_string();
-    var webservice = new ClickWebservice();
     try {
-        // TODO: add caching of this webservice call
         var details = yield webservice.get_details(app_id);
         var icon = new FileIcon(File.new_for_uri(details.icon_url));
         var screenshot = new FileIcon(File.new_for_uri(details.main_screenshot_url));
@@ -286,14 +291,12 @@
     public async GLib.ObjectPath install_app (string app_id) throws ClickScopeError {
         try {
             debug ("getting details for %s", app_id);
-            var click_ws = new ClickWebservice ();
-            var app_details = yield click_ws.get_details (app_id);
+            var app_details = yield webservice.get_details (app_id);
             debug ("got details: %s", app_details.title);
-            var u1creds = new UbuntuoneCredentials ();
             debug ("getting creds");
             var credentials = yield u1creds.get_credentials ();
             debug ("got creds");
-            var signed_download = new SignedDownload (credentials);
+            var signed_download = get_signed_download(credentials);
 
             var download_url = app_details.download_url;
 
@@ -304,6 +307,7 @@
         } catch (DownloadError download_error) {
             debug ("Got DownloadError: %s", download_error.message);
             if (download_error is DownloadError.INVALID_CREDENTIALS) {
+                yield u1creds.invalidate_credentials ();
                 throw new ClickScopeError.LOGIN_ERROR (download_error.message);
             } else {
                 throw new ClickScopeError.INSTALL_ERROR (download_error.message);

=== modified file 'src/click-webservice.vala'
--- src/click-webservice.vala	2013-12-10 22:21:24 +0000
+++ src/click-webservice.vala	2013-12-17 20:34:09 +0000
@@ -302,7 +302,7 @@
         }
     }
 
-    public async AppDetails get_details(string app_name) throws WebserviceError {
+    public virtual async AppDetails get_details(string app_name) throws WebserviceError {
         WebserviceError failure = null;
         string url = get_details_url().printf(app_name);
         string response = "{}";

=== modified file 'src/download-manager.vala'
--- src/download-manager.vala	2013-10-03 22:35:56 +0000
+++ src/download-manager.vala	2013-12-17 20:34:09 +0000
@@ -80,7 +80,7 @@
     }
 }
 
-errordomain DownloadError {
+public errordomain DownloadError {
     DOWNLOAD_ERROR,
     INVALID_CREDENTIALS
 }
@@ -99,7 +99,7 @@
     }
 }
 
-class SignedDownload : GLib.Object {
+public class SignedDownload : GLib.Object {
     const string CLICK_TOKEN_HEADER = "X-Click-Token";
 
     const string CONSUMER_KEY = "consumer_key";
@@ -163,7 +163,7 @@
         return click_token;
     }
 
-    public async GLib.ObjectPath start_download (string uri, string app_id) throws DownloadError {
+    public virtual async GLib.ObjectPath start_download (string uri, string app_id) throws DownloadError {
         debug ("Starting download");
 
         var click_token = yield fetch_click_token (uri);

=== modified file 'src/test-click-webservice.vala'
--- src/test-click-webservice.vala	2013-12-06 18:27:14 +0000
+++ src/test-click-webservice.vala	2013-12-17 20:34:09 +0000
@@ -16,7 +16,11 @@
 
 using Assertions;
 
-private const string FAKE_APP_ID = "FAKE_APP_ID";
+const string FAKE_APP_ID = "FAKE_APP_ID";
+const string FAKE_OBJECT_PATH = "/com/fake/object";
+const string FAKE_DOWNLOAD_ERROR_MESSAGE = "fake generic download error message";
+const string FAKE_CREDS_ERROR_MESSAGE = "fake creds error message";
+const string FAKE_INVALID_CREDS_ERROR_MESSAGE = "fake invalid creds message";
 
 public class ClickTestCase
 {
@@ -168,27 +172,181 @@
     }
 
     class FakeCredentials : UbuntuoneCredentials {
-        public async HashTable<string, string> get_credentials () throws CredentialsError {
+
+        public bool invalidate_called = false;
+        
+        public override async HashTable<string, string> get_credentials () throws CredentialsError {
             string credentials = "consumer_key=consumer&consumer_secret=consumer_secret&token=token&token_secret=token_secret";
             return Soup.Form.decode (credentials);
         }
-    }
-
-    public static void test_fetch_credentials ()
-    {
+
+        public override async void invalidate_credentials () throws CredentialsError {
+            this.invalidate_called = true;
+        }
+    }
+
+    class FakeClickWebservice : ClickWebservice {
+        public override async AppDetails get_details (string app_name) throws WebserviceError {
+            return new AppDetails.from_json (FAKE_JSON_PACKAGE_DETAILS);
+        }
+    }
+
+    class FakeSignedDownloadOK : SignedDownload {
+        public async override new GLib.ObjectPath start_download (string uri, string app_id) throws DownloadError {
+            return new GLib.ObjectPath (FAKE_OBJECT_PATH);
+        }
+
+        public FakeSignedDownloadOK (HashTable<string, string> credentials) {
+            base (credentials);
+        }
+    }
+
+    class ClickScopeWithFakeSignedDownloadOK : ClickScope {
+        protected override SignedDownload get_signed_download (HashTable<string, string> credentials) {
+            return new FakeSignedDownloadOK (credentials);
+        }
+    }
+
+    public static void test_install_app_ok ()
+    {    
         MainLoop mainloop = new MainLoop ();
-        var u1creds = new FakeCredentials ();
-
-         u1creds.get_credentials.begin((obj, res) => {
+
+        var scope = new ClickScopeWithFakeSignedDownloadOK ();
+        scope.click_if = new FakeClickInterface ();
+        scope.u1creds = new FakeCredentials ();
+        scope.webservice = new FakeClickWebservice ();
+
+        scope.install_app.begin (FAKE_APP_ID, (obj, res) => {
              mainloop.quit ();
              try {
-                 var creds = u1creds.get_credentials.end (res);
-                 assert (creds["consumer_key"] == "consumer");
+
+                 var objpath = scope.install_app.end (res);
+                 assert (objpath == FAKE_OBJECT_PATH);
+
              } catch (GLib.Error e) {
-                 error ("Can't fetch credentials: %s", e.message);
-             }
-         });
-        assert (run_with_timeout (mainloop, 10000));
+                 error ("Caught GLib.Error in test_install_app_ok: %s", e.message);
+             }
+         });
+        assert (run_with_timeout (mainloop, 10000));
+        
+    }
+
+    class FakeBadCredentials : UbuntuoneCredentials {
+        public override async new HashTable<string, string> get_credentials () throws CredentialsError {
+            throw new CredentialsError.CREDENTIALS_ERROR (FAKE_CREDS_ERROR_MESSAGE);
+        }
+    }
+
+    public static void test_install_app_bad_creds ()
+    {    
+        MainLoop mainloop = new MainLoop ();
+
+        var scope = new ClickScopeWithFakeSignedDownloadOK ();
+        scope.click_if = new FakeClickInterface ();
+        scope.u1creds = new FakeBadCredentials ();
+        scope.webservice = new FakeClickWebservice ();
+
+        scope.install_app.begin (FAKE_APP_ID, (obj, res) => {
+             mainloop.quit ();
+             try {
+
+                 var objpath = scope.install_app.end (res);
+                 assert_not_reached ();
+
+             } catch (ClickScopeError.LOGIN_ERROR e) {
+                 assert (e.message == FAKE_CREDS_ERROR_MESSAGE); 
+
+             } catch {
+                 assert_not_reached ();
+             }
+         });
+        assert (run_with_timeout (mainloop, 10000));
+    }
+
+    class FakeSignedDownloadInvalid : SignedDownload {
+        public async override new GLib.ObjectPath start_download (string uri, string app_id) throws DownloadError {
+            throw new DownloadError.INVALID_CREDENTIALS (FAKE_INVALID_CREDS_ERROR_MESSAGE);
+        }
+        public FakeSignedDownloadInvalid (HashTable<string, string> credentials) {
+            base (credentials);
+        }
+    }
+
+    class ClickScopeWithFakeSignedDownloadInvalid : ClickScope {
+        protected override SignedDownload get_signed_download (HashTable<string, string> credentials) {
+            return new FakeSignedDownloadInvalid (credentials);
+        }
+    }
+
+    public static void test_install_app_invalid_creds ()
+    {    
+        MainLoop mainloop = new MainLoop ();
+
+        var scope = new ClickScopeWithFakeSignedDownloadInvalid ();
+        scope.click_if = new FakeClickInterface ();
+        scope.u1creds = new FakeCredentials ();
+        scope.webservice = new FakeClickWebservice ();
+
+        scope.install_app.begin (FAKE_APP_ID, (obj, res) => {
+             mainloop.quit ();
+             try {
+
+                 var objpath = scope.install_app.end (res);
+                 assert_not_reached ();
+
+             } catch (ClickScopeError.LOGIN_ERROR e) {
+                 assert (e.message == FAKE_INVALID_CREDS_ERROR_MESSAGE); 
+                 assert (((FakeCredentials) scope.u1creds).invalidate_called == true);
+
+             } catch {
+                 assert_not_reached ();
+             }
+         });
+        assert (run_with_timeout (mainloop, 10000));
+        
+    }
+
+    class FakeSignedDownloadError : SignedDownload {
+        public async override new GLib.ObjectPath start_download (string uri, string app_id) throws DownloadError {
+            throw new DownloadError.DOWNLOAD_ERROR (FAKE_DOWNLOAD_ERROR_MESSAGE);
+        }
+        public FakeSignedDownloadError (HashTable<string, string> credentials) {
+            base (credentials);
+        }
+    }
+
+    class ClickScopeWithFakeSignedDownloadError : ClickScope {
+        protected override SignedDownload get_signed_download (HashTable<string, string> credentials) {
+            return new FakeSignedDownloadError (credentials);
+        }
+    }
+
+    public static void test_install_app_download_error ()
+    {    
+        MainLoop mainloop = new MainLoop ();
+
+        var scope = new ClickScopeWithFakeSignedDownloadError ();
+        scope.click_if = new FakeClickInterface ();
+        scope.u1creds = new FakeCredentials ();
+        scope.webservice = new FakeClickWebservice ();
+
+        scope.install_app.begin (FAKE_APP_ID, (obj, res) => {
+             mainloop.quit ();
+             try {
+
+                 var objpath = scope.install_app.end (res);
+                 assert_not_reached ();
+
+             } catch (ClickScopeError.INSTALL_ERROR e) {
+                 assert (e.message == FAKE_DOWNLOAD_ERROR_MESSAGE); 
+                 assert (((FakeCredentials) scope.u1creds).invalidate_called == false);
+
+             } catch {
+                 assert_not_reached ();
+             }
+         });
+        assert (run_with_timeout (mainloop, 10000));
+        
     }
 
     public static void test_click_get_dotdesktop ()
@@ -343,7 +501,10 @@
         Test.add_data_func ("/Unit/ClickChecker/Test_Parse_App_Details", test_parse_app_details);
         Test.add_data_func ("/Unit/ClickChecker/Test_Parse_Skinny_Details", test_parse_skinny_details);
         Test.add_data_func ("/Unit/ClickChecker/Test_Available_Apps", test_available_apps);
-        Test.add_data_func ("/Unit/ClickChecker/Test_Fetch_Credentials", test_fetch_credentials);
+        Test.add_data_func ("/Unit/ClickChecker/Test_Install_App_OK", test_install_app_ok);
+        Test.add_data_func ("/Unit/ClickChecker/Test_Install_App_Bad_Creds", test_install_app_bad_creds);
+        Test.add_data_func ("/Unit/ClickChecker/Test_Install_App_Invalid_Creds", test_install_app_invalid_creds);
+        Test.add_data_func ("/Unit/ClickChecker/Test_Install_App_Download_Error", test_install_app_download_error);
         Test.add_data_func ("/Unit/ClickChecker/Test_Click_GetDotDesktop", test_click_get_dotdesktop);
         Test.add_data_func ("/Unit/ClickChecker/Test_Scope_Build_Purchasing_Preview", 
                             test_scope_build_purchasing_preview);

=== modified file 'src/ubuntuone-credentials.vala'
--- src/ubuntuone-credentials.vala	2013-12-10 22:21:24 +0000
+++ src/ubuntuone-credentials.vala	2013-12-17 20:34:09 +0000
@@ -20,7 +20,7 @@
 
 public class UbuntuoneCredentials : GLib.Object {
 
-    public async HashTable<string, string> get_credentials () throws CredentialsError {
+    public virtual async HashTable<string, string> get_credentials () throws CredentialsError {
         string encoded_creds = null;
         string error_message = "";
 
@@ -59,4 +59,21 @@
         return Soup.Form.decode (encoded_creds);
 
     }
+
+    public virtual async void invalidate_credentials () throws CredentialsError {
+        Ag.Manager _manager = new Ag.Manager.for_service_type ("ubuntuone");
+        GLib.List<uint> _accts = _manager.list_by_service_type ("ubuntuone");
+
+        foreach (var account_id in _accts) {
+            debug ("Removing account id: %u", account_id);
+            var account = _manager.get_account (account_id);
+            account.delete();
+            try {
+                yield account.store_async();
+            } catch (Ag.AccountsError e) {
+                string error_message = "Please delete your existing Ubuntu One account and create a new one in System Settings.";
+                throw new CredentialsError.CREDENTIALS_ERROR(error_message);
+            }
+        }
+    }
 }