1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/toolkit/components/downloads/test/unit/test_privatebrowsing.js Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,298 @@
1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.7 +
1.8 +/**
1.9 + Test download manager's interaction with the private browsing service.
1.10 +
1.11 + An overview of what this test does follows:
1.12 +
1.13 + * Create a download (Download-A) with specific details.
1.14 + * Check that Download-A is retrievable.
1.15 + * Enter private browsing mode.
1.16 + * Check that Download-A is not accessible.
1.17 + * Create another download (Download-B) with specific and different details.
1.18 + * Check that Download-B is retrievable.
1.19 + * Exit private browsing mode.
1.20 + * Check that Download-A is retrievable.
1.21 + * Check that Download-B is not accessible.
1.22 + * Create a new download (Download-C) with specific details.
1.23 + Start it and enter private browsing mode immediately after.
1.24 + * Check that Download-C has been paused.
1.25 + * Exit the private browsing mode.
1.26 + * Verify that Download-C resumes and finishes correctly now.
1.27 +**/
1.28 +
1.29 +Components.utils.import("resource://gre/modules/Services.jsm");
1.30 +
1.31 +this.__defineGetter__("dm", function() {
1.32 + delete this.dm;
1.33 + return this.dm = Cc["@mozilla.org/download-manager;1"].
1.34 + getService(Ci.nsIDownloadManager);
1.35 +});
1.36 +
1.37 +/**
1.38 + * Try to see if an active download is available using the |activeDownloads|
1.39 + * property.
1.40 + */
1.41 +function is_active_download_available(aGUID, aSrc, aDst, aName, aPrivate) {
1.42 + let enumerator = aPrivate ? dm.activePrivateDownloads : dm.activeDownloads;
1.43 + while (enumerator.hasMoreElements()) {
1.44 + let download = enumerator.getNext();
1.45 + if (download.guid == aGUID &&
1.46 + download.source.spec == aSrc &&
1.47 + download.targetFile.path == aDst.path &&
1.48 + download.displayName == aName &&
1.49 + download.isPrivate == aPrivate)
1.50 + return true;
1.51 + }
1.52 + return false;
1.53 +}
1.54 +
1.55 +function expect_download_present(aGUID, aSrc, aDst, aName, aPrivate) {
1.56 + is_download_available(aGUID, aSrc, aDst, aName, aPrivate, true);
1.57 +}
1.58 +
1.59 +function expect_download_absent(aGUID, aSrc, aDst, aName, aPrivate) {
1.60 + is_download_available(aGUID, aSrc, aDst, aName, aPrivate, false);
1.61 +}
1.62 +
1.63 +/**
1.64 + * Try to see if a download is available using the |getDownloadByGUID| method. The
1.65 + * download can both be active or inactive.
1.66 + */
1.67 +function is_download_available(aGUID, aSrc, aDst, aName, aPrivate, present) {
1.68 + do_test_pending();
1.69 + dm.getDownloadByGUID(aGUID, function(status, download) {
1.70 + if (!present) {
1.71 + do_check_eq(download, null);
1.72 + } else {
1.73 + do_check_neq(download, null);
1.74 + do_check_eq(download.guid, aGUID);
1.75 + do_check_eq(download.source.spec, aSrc);
1.76 + do_check_eq(download.targetFile.path, aDst.path);
1.77 + do_check_eq(download.displayName, aName);
1.78 + do_check_eq(download.isPrivate, aPrivate);
1.79 + }
1.80 + do_test_finished();
1.81 + });
1.82 +}
1.83 +
1.84 +function run_test() {
1.85 + if (oldDownloadManagerDisabled()) {
1.86 + return;
1.87 + }
1.88 +
1.89 + let prefBranch = Cc["@mozilla.org/preferences-service;1"].
1.90 + getService(Ci.nsIPrefBranch);
1.91 +
1.92 + do_test_pending();
1.93 + let httpserv = new HttpServer();
1.94 + httpserv.registerDirectory("/", do_get_cwd());
1.95 + httpserv.start(-1);
1.96 +
1.97 + let tmpDir = do_get_tempdir();
1.98 + const nsIWBP = Ci.nsIWebBrowserPersist;
1.99 +
1.100 + // make sure we're starting with an empty DB
1.101 + do_check_eq(dm.activeDownloadCount, 0);
1.102 + do_check_eq(dm.activePrivateDownloadCount, 0);
1.103 +
1.104 + let listener = {
1.105 + phase: 1,
1.106 + handledC: false,
1.107 + onDownloadStateChange: function(aState, aDownload)
1.108 + {
1.109 + switch (aDownload.state) {
1.110 + case dm.DOWNLOAD_FAILED:
1.111 + case dm.DOWNLOAD_CANCELED:
1.112 + case dm.DOWNLOAD_DIRTY:
1.113 + case dm.DOWNLOAD_BLOCKED_POLICY:
1.114 + // Fail!
1.115 + if (aDownload.targetFile.exists())
1.116 + aDownload.targetFile.remove(false);
1.117 + dm.removeListener(this);
1.118 + do_throw("Download failed (name: " + aDownload.displayName + ", state: " + aDownload.state + ")");
1.119 + do_test_finished();
1.120 + break;
1.121 +
1.122 + // We need to wait until Download-C has started, because otherwise it
1.123 + // won't be resumable, so the private browsing mode won't correctly pause it.
1.124 + case dm.DOWNLOAD_DOWNLOADING:
1.125 + if (aDownload.guid == downloadC && !this.handledC && this.phase == 2) {
1.126 + // Sanity check: Download-C must be resumable
1.127 + do_check_true(dlC.resumable);
1.128 +
1.129 + // Check that Download-A is accessible
1.130 + expect_download_present(downloadA, downloadASource,
1.131 + fileA, downloadAName, false);
1.132 +
1.133 + // Check that Download-B is not accessible
1.134 + expect_download_absent(downloadB, downloadBSource,
1.135 + fileB, downloadBName, true);
1.136 +
1.137 + // Check that Download-C is accessible
1.138 + expect_download_present(downloadC, downloadCSource,
1.139 + fileC, downloadCName, false);
1.140 +
1.141 + // only perform these checks the first time that Download-C is started
1.142 + this.handledC = true;
1.143 + }
1.144 + break;
1.145 +
1.146 + case dm.DOWNLOAD_FINISHED:
1.147 + do_check_true(aDownload.targetFile.exists());
1.148 + aDownload.targetFile.remove(false);
1.149 + this.onDownloadFinished();
1.150 + break;
1.151 + }
1.152 + },
1.153 + onStateChange: function(a, b, c, d, e) { },
1.154 + onProgressChange: function(a, b, c, d, e, f, g) { },
1.155 + onSecurityChange: function(a, b, c, d) { },
1.156 + onDownloadFinished: function () {
1.157 + switch (this.phase) {
1.158 + case 1: {
1.159 + do_check_eq(dm.activeDownloadCount, 0);
1.160 +
1.161 + // Create Download-B
1.162 + let dlB = addDownload(httpserv, {
1.163 + isPrivate: true,
1.164 + targetFile: fileB,
1.165 + sourceURI: downloadBSource,
1.166 + downloadName: downloadBName,
1.167 + runBeforeStart: function (aDownload) {
1.168 + // Check that Download-B is retrievable
1.169 + do_check_eq(dm.activePrivateDownloadCount, 1);
1.170 + do_check_eq(dm.activeDownloadCount, 0);
1.171 + do_check_true(is_active_download_available(aDownload.guid,
1.172 + downloadBSource, fileB, downloadBName, true));
1.173 + expect_download_present(aDownload.guid,
1.174 + downloadBSource, fileB, downloadBName, true);
1.175 + }
1.176 + });
1.177 + downloadB = dlB.guid;
1.178 +
1.179 + // wait for Download-B to finish
1.180 + ++this.phase;
1.181 + }
1.182 + break;
1.183 +
1.184 + case 2: {
1.185 + do_check_eq(dm.activeDownloadCount, 0);
1.186 +
1.187 + // Simulate last private browsing context triggering cleanup
1.188 + Services.obs.notifyObservers(null, "last-pb-context-exited", null);
1.189 +
1.190 + // Create Download-C
1.191 + dlC = addDownload(httpserv, {
1.192 + isPrivate: false,
1.193 + targetFile: fileC,
1.194 + sourceURI: downloadCSource,
1.195 + downloadName: downloadCName,
1.196 + runBeforeStart: function (aDownload) {
1.197 + // Check that Download-C is retrievable
1.198 + do_check_eq(dm.activePrivateDownloadCount, 0);
1.199 + do_check_true(is_active_download_available(aDownload.guid,
1.200 + downloadCSource, fileC, downloadCName, false));
1.201 + expect_download_present(aDownload.guid,
1.202 + downloadCSource, fileC, downloadCName, false);
1.203 + }
1.204 + });
1.205 + downloadC = dlC.guid;
1.206 +
1.207 + // wait for Download-C to finish
1.208 + ++this.phase;
1.209 +
1.210 + // Check that Download-A is accessible
1.211 + expect_download_present(downloadA, downloadASource,
1.212 + fileA, downloadAName, false);
1.213 +
1.214 + // Check that Download-B is not accessible
1.215 + expect_download_absent(downloadB, downloadBSource,
1.216 + fileB, downloadBName, true);
1.217 + }
1.218 + break;
1.219 +
1.220 + case 3: {
1.221 + do_check_eq(dm.activePrivateDownloadCount, 0);
1.222 +
1.223 + // Check that Download-A is accessible
1.224 + expect_download_present(downloadA, downloadASource,
1.225 + fileA, downloadAName, false);
1.226 +
1.227 + // Check that Download-B is not accessible
1.228 + expect_download_absent(downloadB, downloadBSource,
1.229 + fileB, downloadBName, true);
1.230 +
1.231 + // Check that Download-C is accessible
1.232 + expect_download_present(downloadC, downloadCSource,
1.233 + fileC, downloadCName, false);
1.234 +
1.235 + // cleanup
1.236 + dm.removeListener(this);
1.237 + httpserv.stop(do_test_finished);
1.238 + }
1.239 + break;
1.240 +
1.241 + default:
1.242 + do_throw("Unexpected phase: " + this.phase);
1.243 + break;
1.244 + }
1.245 + }
1.246 + };
1.247 +
1.248 + dm.addPrivacyAwareListener(listener);
1.249 + dm.addPrivacyAwareListener(getDownloadListener());
1.250 +
1.251 + // properties of Download-A
1.252 + let downloadA = -1;
1.253 + const downloadASource = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAAXNSR0IArs4c6QAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB9gKHhQaLFEVkXsAAAAIdEVYdENvbW1lbnQA9syWvwAABXZJREFUaN7VmnuIVUUcxz/3uma5ZJJmrZGVuZWupGSZsVNwTRYJYk8vRzd6o0kglgpm9q/ZEhlBUEssUpTtqMixl6LlURtDwyzCWmLxkZZL6qZRi/nc/tjf2Ybjufd6797HOrDM7NzfmfP9zfzm9zxwkbdEIRYxyhsCTAYmAWOBkcAwYBBwFugEDgN7gd3AdmCTtn5HWRkwynsamA7U5bnEBqBFW395SRkwylsIzAWqnOnvgTVAG3AIOA4cAwYAlwFDgZuAUcB4YApQIc+2A29p6zcWlQGjvEeBJUC1TO0BmoAPtfXbc1yrH/AwMB+YKNNtwGJt/VUFZ8Ao713gOfn3O2CBtv7mAt2hUcAi4BmZatLWn10QBozyRgArgFoRixe09d8vhkYxypsKfAwMBrYBDdr6B/JmwChvNLBWRCYA6rX1/y6mWjTKqwQ+BVIiUvXa+q3p6JNZdj4E3wJMKTZ4AG39TuA+oFnevVaw5MaAiE01sEJbf4a2/rlSGSdt/S5gJrAqxJATA3Jha4GdwFPlsLDChBZbUSuYst8BUZUr5cKOyVU9FuFODAZagWuAaVEVG3cCS6SfWW7wchLHgcci2OIZEAtbDWzR1l/dVxw2bf1N4X0QjD2tIkI7V/oF7qQyqa40a58Rd6EVWA+8Z3VwNI4wwxqIs/e7OHnNVgdbY2gWAQ8JxsbzTkAcsyog0NbfeYGbUwFcBdwLvAq0KpNK5bHJlcDNwBPAFmVS7yiTSkZOYQ+wGqgSrOeJ0HTpmzO9yeogEf6JozZOrCfisK1VJjUihzWSwNXiRhwTktnA8zGPNkewdjMg/nwdcBr45EK3zerglNXBj1YHDSKjAJdHRTDLGl1WB4etDpYDs5yfZsWQfwUcAeoEc88JTA4JemFtX3fG+cYH651xdcxlPgd84WIOGZgk/Te9UBa7nfF1ea7hXvR/09BsdzGHDIyV/ucya8ypzvjrNDS7XMyhGh0p/S+9ePlYZ3zwQh9SJpUAhgD3A8tk+i/g5TSP7HcxhwwMk/5ILxiY74w3ZgGdziYclQiv0epgXxqaDhG1YS4DlY5hIofd6w/cAiwUxwvgH+CNPDdhKHAnMAHYl8YqnzXKOxFirsj1DVksagcw3epgfzY7EFmzUkRwLjADWKVM6k2rg3lplhgQNWSd0g/KkZ8zAtoCrwCjrQ6+zHVTrA46rQ52iD35SKZfVCZVH+OdDgT6hZjDEzgs4G9Md3Tpdq8IbZnjfc6RqNBtwx3MPSewV/pRfcD5dFX5HTG/17iYkxEjNIG+1S6NmRvvYk5GrFtdHwBd44x/i/l9sos5ZGCT9DcY5Y0pMwOuPVkXucBXSqzegzkpurVDgmeAhlIjViY1UJnUXcqkWkSNIq710qgZEA20Icxsu3agRURojlHeEm39E0UE3JWF5FfgEauDQ87uJ5yIseW8gEZS3O2iTp8s8SGcpDujvU4CmRqrg2hU+IBY/XY3HZ+ICepfk8VGauuf7AuqyCivQtRrNfCSm4aPxp2Nko8cLoz0lTZPwLdFawhxeaHFYYbCKK+2D+z+bU4+aHHW1KJkvppEvNYY5VWVOSv3mSibprjCRyLDw1Z07i5gkrb+6RKDvwTYDNwNbNPWV3F0mbLTDXIfbges5O1LBf4K4FsB35bJNiUzpPMOAPWywETgJ6O860sA/lpxE8bxf4EjbZUm1xLTn8CD2vpbiwA8IdpmKdCfQpSYIi9wi3yfA89q6/9RIPC3Ah9IOAmFLPJFXuSWWbskenpbW39HnsZpGvC4k04pXpk1xmK7he6DdKckNwI/AAejJSkJBWvorn/dI35XaQvdMYxk+tTgEHBKsgeDRa6jrTyfGsQwUraPPS769h+G3Ox+KOb9iAAAAABJRU5ErkJggg==";
1.254 + const downloadADest = "download-file-A";
1.255 + const downloadAName = "download-A";
1.256 +
1.257 + // properties of Download-B
1.258 + let downloadB = -1;
1.259 + const downloadBSource = "data:application/octet-stream;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAAXNSR0IArs4c6QAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB9gKHhQaLFEVkXsAAAAIdEVYdENvbW1lbnQA9syWvwAABXZJREFUaN7VmnuIVUUcxz/3uma5ZJJmrZGVuZWupGSZsVNwTRYJYk8vRzd6o0kglgpm9q/ZEhlBUEssUpTtqMixl6LlURtDwyzCWmLxkZZL6qZRi/nc/tjf2Ybjufd6797HOrDM7NzfmfP9zfzm9zxwkbdEIRYxyhsCTAYmAWOBkcAwYBBwFugEDgN7gd3AdmCTtn5HWRkwynsamA7U5bnEBqBFW395SRkwylsIzAWqnOnvgTVAG3AIOA4cAwYAlwFDgZuAUcB4YApQIc+2A29p6zcWlQGjvEeBJUC1TO0BmoAPtfXbc1yrH/AwMB+YKNNtwGJt/VUFZ8Ao713gOfn3O2CBtv7mAt2hUcAi4BmZatLWn10QBozyRgArgFoRixe09d8vhkYxypsKfAwMBrYBDdr6B/JmwChvNLBWRCYA6rX1/y6mWjTKqwQ+BVIiUvXa+q3p6JNZdj4E3wJMKTZ4AG39TuA+oFnevVaw5MaAiE01sEJbf4a2/rlSGSdt/S5gJrAqxJATA3Jha4GdwFPlsLDChBZbUSuYst8BUZUr5cKOyVU9FuFODAZagWuAaVEVG3cCS6SfWW7wchLHgcci2OIZEAtbDWzR1l/dVxw2bf1N4X0QjD2tIkI7V/oF7qQyqa40a58Rd6EVWA+8Z3VwNI4wwxqIs/e7OHnNVgdbY2gWAQ8JxsbzTkAcsyog0NbfeYGbUwFcBdwLvAq0KpNK5bHJlcDNwBPAFmVS7yiTSkZOYQ+wGqgSrOeJ0HTpmzO9yeogEf6JozZOrCfisK1VJjUihzWSwNXiRhwTktnA8zGPNkewdjMg/nwdcBr45EK3zerglNXBj1YHDSKjAJdHRTDLGl1WB4etDpYDs5yfZsWQfwUcAeoEc88JTA4JemFtX3fG+cYH651xdcxlPgd84WIOGZgk/Te9UBa7nfF1ea7hXvR/09BsdzGHDIyV/ucya8ypzvjrNDS7XMyhGh0p/S+9ePlYZ3zwQh9SJpUAhgD3A8tk+i/g5TSP7HcxhwwMk/5ILxiY74w3ZgGdziYclQiv0epgXxqaDhG1YS4DlY5hIofd6w/cAiwUxwvgH+CNPDdhKHAnMAHYl8YqnzXKOxFirsj1DVksagcw3epgfzY7EFmzUkRwLjADWKVM6k2rg3lplhgQNWSd0g/KkZ8zAtoCrwCjrQ6+zHVTrA46rQ52iD35SKZfVCZVH+OdDgT6hZjDEzgs4G9Md3Tpdq8IbZnjfc6RqNBtwx3MPSewV/pRfcD5dFX5HTG/17iYkxEjNIG+1S6NmRvvYk5GrFtdHwBd44x/i/l9sos5ZGCT9DcY5Y0pMwOuPVkXucBXSqzegzkpurVDgmeAhlIjViY1UJnUXcqkWkSNIq710qgZEA20Icxsu3agRURojlHeEm39E0UE3JWF5FfgEauDQ87uJ5yIseW8gEZS3O2iTp8s8SGcpDujvU4CmRqrg2hU+IBY/XY3HZ+ICepfk8VGauuf7AuqyCivQtRrNfCSm4aPxp2Nko8cLoz0lTZPwLdFawhxeaHFYYbCKK+2D+z+bU4+aHHW1KJkvppEvNYY5VWVOSv3mSibprjCRyLDw1Z07i5gkrb+6RKDvwTYDNwNbNPWV3F0mbLTDXIfbges5O1LBf4K4FsB35bJNiUzpPMOAPWywETgJ6O860sA/lpxE8bxf4EjbZUm1xLTn8CD2vpbiwA8IdpmKdCfQpSYIi9wi3yfA89q6/9RIPC3Ah9IOAmFLPJFXuSWWbskenpbW39HnsZpGvC4k04pXpk1xmK7he6DdKckNwI/AAejJSkJBWvorn/dI35XaQvdMYxk+tTgEHBKsgeDRa6jrTyfGsQwUraPPS769h+G3Ox+KOb9iAAAAABJRU5ErkJggg==";
1.260 + const downloadBDest = "download-file-B";
1.261 + const downloadBName = "download-B";
1.262 +
1.263 + // properties of Download-C
1.264 + let downloadC = -1;
1.265 + const downloadCSource = "http://localhost:" +
1.266 + httpserv.identity.primaryPort +
1.267 + "/head_download_manager.js";
1.268 + const downloadCDest = "download-file-C";
1.269 + const downloadCName = "download-C";
1.270 +
1.271 + // Create all target files
1.272 + let fileA = tmpDir.clone();
1.273 + fileA.append(downloadADest);
1.274 + fileA.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, 0666);
1.275 + let fileB = tmpDir.clone();
1.276 + fileB.append(downloadBDest);
1.277 + fileB.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, 0666);
1.278 + let fileC = tmpDir.clone();
1.279 + fileC.append(downloadCDest);
1.280 + fileC.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, 0666);
1.281 +
1.282 + // use js closures to access dlC
1.283 + let dlC;
1.284 +
1.285 + // Create Download-A
1.286 + let dlA = addDownload(httpserv, {
1.287 + isPrivate: false,
1.288 + targetFile: fileA,
1.289 + sourceURI: downloadASource,
1.290 + downloadName: downloadAName,
1.291 + runBeforeStart: function (aDownload) {
1.292 + // Check that Download-A is retrievable
1.293 + do_check_eq(dm.activePrivateDownloadCount, 0);
1.294 + do_check_true(is_active_download_available(aDownload.guid, downloadASource, fileA, downloadAName, false));
1.295 + expect_download_present(aDownload.guid, downloadASource, fileA, downloadAName, false);
1.296 + }
1.297 + });
1.298 + downloadA = dlA.guid;
1.299 +
1.300 + // wait for Download-A to finish
1.301 +}
