// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package org.chromium.chrome.browser.offlinepages;
import android.os.Build;
import androidx.test.core.app.ApplicationProvider;
import androidx.test.filters.SmallTest;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.chromium.base.ContentUriUtils;
import org.chromium.base.ThreadUtils;
import org.chromium.base.task.PostTask;
import org.chromium.base.task.TaskTraits;
import org.chromium.base.test.util.Batch;
import org.chromium.base.test.util.CommandLineFlags;
import org.chromium.base.test.util.DisabledTest;
import org.chromium.base.test.util.MaxAndroidSdkLevel;
import org.chromium.base.test.util.MinAndroidSdkLevel;
import org.chromium.chrome.browser.flags.ChromeSwitches;
import org.chromium.chrome.browser.offlinepages.OfflinePageBridge.OfflinePageModelObserver;
import org.chromium.chrome.browser.offlinepages.OfflinePageBridge.SavePageCallback;
import org.chromium.chrome.browser.profiles.Profile;
import org.chromium.chrome.browser.profiles.ProfileManager;
import org.chromium.chrome.test.ChromeJUnit4ClassRunner;
import org.chromium.chrome.test.ChromeTabbedActivityTestRule;
import org.chromium.chrome.test.batch.BlankCTATabInitialStateRule;
import org.chromium.components.offlinepages.SavePageResult;
import org.chromium.net.NetworkChangeNotifier;
import org.chromium.net.test.EmbeddedTestServer;
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicInteger;
/** Unit tests for {@link OfflinePageArchivePublisherBridge}. */
@RunWith(ChromeJUnit4ClassRunner.class)
@CommandLineFlags.Add({ChromeSwitches.DISABLE_FIRST_RUN_EXPERIENCE})
@Batch(Batch.PER_CLASS)
public class OfflinePageArchivePublisherBridgeTest {
@ClassRule
public static ChromeTabbedActivityTestRule sActivityTestRule =
new ChromeTabbedActivityTestRule();
@Rule
public BlankCTATabInitialStateRule mInitialStateRule =
new BlankCTATabInitialStateRule(sActivityTestRule, false);
private static final String TEST_PAGE = "/chrome/test/data/android/about.html";
private static final int TIMEOUT_MS = 5000;
private static final ClientId TEST_CLIENT_ID =
new ClientId(OfflinePageBridge.DOWNLOAD_NAMESPACE, "1234");
private OfflinePageBridge mOfflinePageBridge;
private EmbeddedTestServer mTestServer;
private String mTestPage;
private Profile mProfile;
private void initializeBridgeForProfile() throws InterruptedException {
final Semaphore semaphore = new Semaphore(0);
PostTask.runOrPostTask(
TaskTraits.UI_DEFAULT,
() -> {
// Ensure we start in an offline state.
mOfflinePageBridge = OfflinePageBridge.getForProfile(mProfile);
if (mOfflinePageBridge == null
|| mOfflinePageBridge.isOfflinePageModelLoaded()) {
semaphore.release();
return;
}
mOfflinePageBridge.addObserver(
new OfflinePageModelObserver() {
@Override
public void offlinePageModelLoaded() {
semaphore.release();
mOfflinePageBridge.removeObserver(this);
}
});
});
Assert.assertTrue(semaphore.tryAcquire(TIMEOUT_MS, TimeUnit.MILLISECONDS));
}
@Before
public void setUp() throws Exception {
ThreadUtils.runOnUiThreadBlocking(
() -> {
// Ensure we start in an offline state.
NetworkChangeNotifier.forceConnectivityState(false);
if (!NetworkChangeNotifier.isInitialized()) {
NetworkChangeNotifier.init();
}
});
ThreadUtils.runOnUiThreadBlocking(
() -> {
mProfile = ProfileManager.getLastUsedRegularProfile();
});
initializeBridgeForProfile();
Assert.assertNotNull(mOfflinePageBridge);
mTestServer =
EmbeddedTestServer.createAndStartServer(
ApplicationProvider.getApplicationContext());
mTestPage = mTestServer.getURL(TEST_PAGE);
}
@After
public void tearDown() {
mTestServer.stopAndDestroyServer();
}
@Test
@SmallTest
@MaxAndroidSdkLevel(
value = Build.VERSION_CODES.P,
reason =
"On Android Q+, publish offline pages to the downloads collection "
+ "rather than DownloadManager.")
public void testAddCompletedDownload() throws InterruptedException, TimeoutException {
Assert.assertTrue(OfflinePageArchivePublisherBridge.isAndroidDownloadManagerInstalled());
sActivityTestRule.loadUrl(mTestPage);
savePage(TEST_CLIENT_ID);
OfflinePageItem page = OfflineTestUtil.getAllPages().get(0);
long downloadId =
OfflinePageArchivePublisherBridge.addCompletedDownload(
page.getTitle(),
"description",
page.getFilePath(),
page.getFileSize(),
page.getUrl(),
"");
Assert.assertNotEquals(0L, downloadId);
}
@Test
@SmallTest
@MaxAndroidSdkLevel(
value = Build.VERSION_CODES.P,
reason =
"On Android Q+, publish offline pages to the downloads collection "
+ "rather than DownloadManager.")
public void testRemove() throws InterruptedException, TimeoutException {
Assert.assertTrue(OfflinePageArchivePublisherBridge.isAndroidDownloadManagerInstalled());
sActivityTestRule.loadUrl(mTestPage);
savePage(TEST_CLIENT_ID);
OfflinePageItem page = OfflineTestUtil.getAllPages().get(0);
long downloadId =
OfflinePageArchivePublisherBridge.addCompletedDownload(
page.getTitle(),
"description",
page.getFilePath(),
page.getFileSize(),
page.getUrl(),
"");
Assert.assertNotEquals(0L, downloadId);
long[] ids = new long[] {downloadId};
Assert.assertEquals(1, OfflinePageArchivePublisherBridge.remove(ids));
}
/**
* TODO(crbug.com/40683443): This test fails on Android Q/10 (SDK 29). Leaving it enabled for
* now as there's currently no bot running tests with that OS version.
*/
@Test
@SmallTest
@MinAndroidSdkLevel(29)
@DisabledTest(message = "https://crbug.com/1068408")
public void testPublishArchiveToDownloadsCollection()
throws InterruptedException, TimeoutException {
// Save a page and publish.
sActivityTestRule.loadUrl(mTestPage);
savePage(TEST_CLIENT_ID);
OfflinePageItem page = OfflineTestUtil.getAllPages().get(0);
String publishedUri =
OfflinePageArchivePublisherBridge.publishArchiveToDownloadsCollection(page);
Assert.assertFalse(publishedUri.isEmpty());
Assert.assertTrue(ContentUriUtils.isContentUri(publishedUri));
Assert.assertTrue(ContentUriUtils.contentUriExists(publishedUri));
}
/**
* Tests that Chrome will gracefully handle Android not being able to generate unique filenames
* with a large enough unique number. See https://crbug.com/1010916#c2 for context.
*
* <p>TODO(crbug.com/40683443): This test fails on Android Q/10 (SDK 29). Leaving it enabled for
* now as there's currently no bot running tests with that OS version.
*/
@Test
@SmallTest
@MinAndroidSdkLevel(29)
@DisabledTest(message = "https://crbug.com/1068408")
public void
testPublishArchiveToDownloadsCollection_NoCrashWhenAndroidCantGenerateUniqueFilename()
throws InterruptedException, TimeoutException {
// Save a page and publish.
sActivityTestRule.loadUrl(mTestPage);
savePage(TEST_CLIENT_ID);
OfflinePageItem page = OfflineTestUtil.getAllPages().get(0);
final int supportedDuplicatesCount = 32;
for (int i = 0; i < supportedDuplicatesCount; i++) {
Assert.assertFalse(
"At re-publish iteration #" + i,
OfflinePageArchivePublisherBridge.publishArchiveToDownloadsCollection(page)
.isEmpty());
}
// Should fail unique filename generation at the next attempt, and fail gracefully.
Assert.assertTrue(
OfflinePageArchivePublisherBridge.publishArchiveToDownloadsCollection(page)
.isEmpty());
}
// Returns offline ID.
private void savePage(final ClientId clientId) throws InterruptedException {
final Semaphore semaphore = new Semaphore(0);
final AtomicInteger result = new AtomicInteger(SavePageResult.MAX_VALUE);
ThreadUtils.runOnUiThreadBlocking(
() -> {
mOfflinePageBridge.savePage(
sActivityTestRule.getWebContents(),
clientId,
new SavePageCallback() {
@Override
public void onSavePageDone(
int savePageResult, String url, long offlineId) {
result.set(savePageResult);
semaphore.release();
}
});
});
Assert.assertTrue(semaphore.tryAcquire(TIMEOUT_MS, TimeUnit.MILLISECONDS));
Assert.assertEquals(SavePageResult.SUCCESS, result.get());
}
}
Codebase Browser
chromium