Refactored and revised extensions record API with associated browser test

BUG=123968
TEST=


Review URL: http://codereview.chromium.org/9716010

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@135539 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 158 insertions, 0 deletions

diff --git a/chrome/browser/extensions/extension_record_api.h b/chrome/browser/extensions/extension_record_api.h
new file mode 100644
index 0000000..afd6cfd
--- /dev/null
+++ b/chrome/browser/extensions/extension_record_api.h
@@ -0,0 +1,158 @@
+// Copyright (c) 2012 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.
+
+#ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_RECORD_API_H_
+#define CHROME_BROWSER_EXTENSIONS_EXTENSION_RECORD_API_H_
+#pragma once
+
+#include "chrome/browser/extensions/extension_function.h"
+#include "base/command_line.h"
+#include "base/file_path.h"
+#include "base/time.h"
+
+namespace {
+
+const FilePath::CharType kURLErrorsSuffix[] = FILE_PATH_LITERAL(".errors");
+const char kErrorsKey[] = "errors";
+const char kStatsKey[] = "stats";
+
+};
+
+// ProcessStrategy abstracts the API's starting and waiting on a test
+// browser instance.  This lets us browser-test the API without actually
+// firing up a sub browser instance.
+class ProcessStrategy {
+ public:
+   // Needed to void build warnings
+   virtual ~ProcessStrategy();
+
+   // Used only in test version to pump the blocking pool queue,
+   // which doesn't otherwise happen during test.
+   virtual void PumpBlockingPool() {}
+
+   // Start up process with given commandline.  Real version does just
+   // that; test version mocks it up, generating errors or good results,
+   // as configured.
+   virtual void RunProcess(const CommandLine& line) = 0;
+};
+
+// Production (default) version of ProcessStrategy.  See ProcessStrategy
+// comments for more info.  This subclass actually starts a sub browser
+// instance.
+class ProductionProcessStrategy : public ProcessStrategy {
+ public:
+  virtual void RunProcess(const CommandLine& line) OVERRIDE;
+};
+
+// Both page cycler calls (capture and replay) have a great deal in common,
+// including the need to build and write a url list file, set the user
+// data dir, start a sub-instance of Chrome, and parse a resultant error
+// file.  This base class encapslates those common elements.
+class RunPageCyclerFunction : public AsyncExtensionFunction {
+ public:
+
+  explicit RunPageCyclerFunction(ProcessStrategy* strategy);
+  virtual ~RunPageCyclerFunction();
+
+  // Gather common page cycler parameters and store them, then do blocking
+  // thread invocation of RunTestBrowser.
+  virtual bool RunImpl() OVERRIDE;
+
+  // Make a CommandLine copy of |original|, removing all switches in
+  // |to_remove|.
+  static CommandLine RemoveSwitches(const CommandLine& original,
+      const std::vector<std::string>& to_remove);
+
+  // Return ProcessStrategy, to allow for test versions.
+  virtual const ProcessStrategy &GetProcessStrategy();
+
+ protected:
+  // Parse the JS parameters, and store them as member data.
+  virtual bool ParseJSParameters() = 0;
+
+  // Do a vanilla test browser run, bracketing it immediately before and
+  // after with a call of AddSwitches to add special commandline options
+  // for Capture or Replay, and ReadReplyFiles to do any special post-run
+  // data collection.  Gather any error results into |errors_| and then do a
+  // BrowserThread call of Finish to return JS values.
+  virtual void RunTestBrowser();
+  virtual void AddSwitches(CommandLine* command_line) {}
+
+  // The test browser communicates URL errors, performance statistics, and
+  // possibly other data by posting them to text files.  ReadReplyFiles
+  // collects these data for return to the JS side caller.
+  virtual void ReadReplyFiles() {}
+
+  // Return the values gathered in RunTestBrowser.  No common code here; all
+  // logic is in subclasses.
+  virtual void Finish() {}
+
+  FilePath user_data_dir_;
+  std::string url_contents_;
+  std::vector<std::string> errors_;
+
+  // Base CommandLine on which to build the test browser CommandLine
+  CommandLine base_command_line_;
+
+  // ProcessStrategy to use for this run.
+  scoped_ptr<ProcessStrategy> process_strategy_;
+};
+
+class CaptureURLsFunction : public RunPageCyclerFunction {
+ public:
+  CaptureURLsFunction();
+  explicit CaptureURLsFunction(ProcessStrategy* strategy);
+
+ private:
+  virtual ~CaptureURLsFunction() {}
+
+  // Read the ReplayDetails parameter if it exists.
+  virtual bool ParseJSParameters() OVERRIDE;
+
+  // Add record-mode.
+  virtual void AddSwitches(CommandLine* command_line) OVERRIDE;
+
+  // Return error list.
+  virtual void Finish() OVERRIDE;
+
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.record.captureURLs");
+};
+
+class ReplayURLsFunction : public RunPageCyclerFunction {
+ public:
+  ReplayURLsFunction();
+  explicit ReplayURLsFunction(ProcessStrategy* strategy);
+
+ private:
+  virtual ~ReplayURLsFunction();
+
+  // Read the ReplayDetails parameter if it exists.
+  virtual bool ParseJSParameters() OVERRIDE;
+
+  // Add visit-urls-count and load-extension.
+  virtual void AddSwitches(CommandLine* command_line) OVERRIDE;
+
+  // Read stats file.
+  virtual void ReadReplyFiles() OVERRIDE;
+
+  // Return error list, statistical results, and runtime.
+  virtual void Finish() OVERRIDE;
+
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.record.replayURLs");
+
+  // These three data are additional information added to the sub-browser
+  // commandline.
+  int repeat_count_;
+  FilePath extension_path_;
+  FilePath stats_file_path_;
+
+  // This time datum marks the start and end of the sub-browser run.
+  base::Time timer_;
+
+  // These two data are additional information returned to caller.
+  int run_time_ms_;
+  std::string stats_;
+};
+
+#endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_RECORD_API_H_