blob: ce7a30ee8c1034635966fe39553fc528c269ef31 [file] [log] [blame]
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stddef.h>
#include <stdint.h>
#include <string>
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/single_thread_task_runner.h"
#include "base/strings/string16.h"
#include "components/offline_pages/core/offline_page_archiver.h"
class GURL;
namespace base {
class FilePath;
} // namespace base
namespace offline_pages {
// A test archiver class, which allows for testing offline pages without a need
// for an actual web contents.
class OfflinePageTestArchiver : public OfflinePageArchiver {
class Observer {
virtual ~Observer() {}
virtual void SetLastPathCreatedByArchiver(
const base::FilePath& file_path) = 0;
Observer* observer,
const GURL& url,
ArchiverResult result,
const base::string16& result_title,
int64_t size_to_report,
const std::string& digest_to_report,
const scoped_refptr<base::SingleThreadTaskRunner>& task_runner);
~OfflinePageTestArchiver() override;
// OfflinePageArchiver implementation:
void CreateArchive(const base::FilePath& archives_dir,
const CreateArchiveParams& create_archive_params,
content::WebContents* web_contents,
CreateArchiveCallback callback) override;
void PublishArchive(
const OfflinePageItem& offline_page,
const scoped_refptr<base::SequencedTaskRunner>& background_task_runner,
const base::FilePath& publish_directory,
SystemDownloadManager* download_manager,
PublishArchiveDoneCallback publish_done_callback) override;
// Completes the creation of archive. Should be used with |set_delayed| set to
// true.
void CompleteCreateArchive();
// When set to true, |CompleteCreateArchive| should be called explicitly for
// the process to finish.
// TODO(fgorski): See if we can move this to the constructor.
void set_delayed(bool delayed) { delayed_ = delayed; }
// Allows to explicitly specify a file name for the tests.
// TODO(fgorski): See if we can move this to the constructor.
void set_filename(const base::FilePath& filename) { filename_ = filename; }
const CreateArchiveParams& create_archive_params() const {
return create_archive_params_;
bool create_archive_called() const { return create_archive_called_; }
void set_archive_attempt_failure(bool fail) {
archive_attempt_failure_ = fail;
// Not owned. Outlives OfflinePageTestArchiver.
Observer* observer_;
GURL url_;
base::FilePath archives_dir_;
CreateArchiveParams create_archive_params_;
base::FilePath filename_;
ArchiverResult result_;
int64_t size_to_report_;
bool create_archive_called_;
bool publish_archive_called_;
bool archive_attempt_failure_;
bool delayed_;
base::string16 result_title_;
std::string digest_to_report_;
CreateArchiveCallback callback_;
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
} // namespace offline_pages