Fail when saving page as MHTML provides information about the cause.

content/browser/download/mhtml_generation_browsertest.cc

 // 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.
 
 #include <stdint.h>
+#include <memory>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/macros.h"
 #include "base/run_loop.h"
 #include "base/strings/utf_string_conversions.h"
+#include "base/test/histogram_tester.h"
 #include "base/threading/thread_restrictions.h"
 #include "content/browser/renderer_host/render_process_host_impl.h"
 #include "content/common/frame_messages.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/mhtml_generation_params.h"
 #include "content/public/test/browser_test_utils.h"
 #include "content/public/test/content_browser_test.h"
 #include "content/public/test/content_browser_test_utils.h"
 #include "content/public/test/test_utils.h"
@@ skipping 79 matching lines @@
     GenerateMHTML(MHTMLGenerationParams(path), url);
   }
 
   void GenerateMHTML(const MHTMLGenerationParams& params, const GURL& url) {
     NavigateToURL(shell(), url);
     GenerateMHTMLForCurrentPage(params);
   }
 
   void GenerateMHTMLForCurrentPage(const MHTMLGenerationParams& params) {
     base::RunLoop run_loop;
+    histogram_tester_.reset(new base::HistogramTester());
 
     shell()->web_contents()->GenerateMHTML(
         params, base::Bind(&MHTMLGenerationTest::MHTMLGenerated,
                            base::Unretained(this),
                            run_loop.QuitClosure()));
 
     // Block until the MHTML is generated.
     run_loop.Run();
 
     EXPECT_TRUE(has_mhtml_callback_run());
@@ skipping 63 matching lines @@
       int actual_number_of_matches = delegate.Wait(shell()->web_contents());
       EXPECT_EQ(0, actual_number_of_matches)
           << "Verifying that \"" << forbidden_substring << "\" doesn't "
           << "appear in the text of web contents of "
           << shell()->web_contents()->GetURL().spec();
     }
   }
 
   bool has_mhtml_callback_run() const { return has_mhtml_callback_run_; }
   int64_t file_size() const { return file_size_; }
+  base::HistogramTester* histogram_tester() { return histogram_tester_.get(); }
 
   base::ScopedTempDir temp_dir_;
 
  private:
   void MHTMLGenerated(base::Closure quit_closure, int64_t size) {
     has_mhtml_callback_run_ = true;
     file_size_ = size;
     quit_closure.Run();
   }
 
   bool has_mhtml_callback_run_;
   int64_t file_size_;
+  std::unique_ptr<base::HistogramTester> histogram_tester_;
 };
 
 // Tests that generating a MHTML does create contents.
 // Note that the actual content of the file is not tested, the purpose of this
 // test is to ensure we were successful in creating the MHTML data from the
 // renderer.
 IN_PROC_BROWSER_TEST_F(MHTMLGenerationTest, GenerateMHTML) {
   base::FilePath path(temp_dir_.GetPath());
   path = path.Append(FILE_PATH_LITERAL("test.mht"));
 
   GenerateMHTML(path, embedded_test_server()->GetURL("/simple_page.html"));
   ASSERT_FALSE(HasFailure());
 
   // Make sure the actual generated file has some contents.
   EXPECT_GT(file_size(), 0);  // Verify the size reported by the callback.
   EXPECT_GT(ReadFileSizeFromDisk(path), 100);  // Verify the actual file size.
 
   {
     base::ThreadRestrictions::ScopedAllowIO allow_io_for_content_verification;
     std::string mhtml;
     ASSERT_TRUE(base::ReadFileToString(path, &mhtml));
     EXPECT_THAT(mhtml,
                 HasSubstr("Content-Transfer-Encoding: quoted-printable"));
   }
+
+  // Checks that the final status reported to UMA is correct.
+  histogram_tester()->ExpectUniqueSample(
+      "PageSerialization.MhtmlGeneration.FinalSaveStatus",
+      static_cast<int>(MhtmlSaveStatus::SUCCESS), 1);
 }
 
 class GenerateMHTMLAndExitRendererMessageFilter : public BrowserMessageFilter {
  public:
   GenerateMHTMLAndExitRendererMessageFilter(
       RenderProcessHostImpl* render_process_host)
       : BrowserMessageFilter(FrameMsgStart),
         render_process_host_(render_process_host) {}
 
  protected:
@@ skipping 105 matching lines @@
 }
 
 IN_PROC_BROWSER_TEST_F(MHTMLGenerationTest, InvalidPath) {
   base::FilePath path(FILE_PATH_LITERAL("/invalid/file/path"));
 
   GenerateMHTML(path, embedded_test_server()->GetURL(
                           "/download/local-about-blank-subframes.html"));
   ASSERT_FALSE(HasFailure());  // No failures with the invocation itself?
 
   EXPECT_EQ(file_size(), -1);  // Expecting that the callback reported failure.
+
+  // Checks that the final status reported to UMA is correct.
+  histogram_tester()->ExpectUniqueSample(
+      "PageSerialization.MhtmlGeneration.FinalSaveStatus",
+      static_cast<int>(MhtmlSaveStatus::FILE_CREATION_ERROR), 1);
 }
 
 // Tests that MHTML generated using the default 'quoted-printable' encoding does
 // not contain the 'binary' Content-Transfer-Encoding header, and generates
 // base64 encoding for the image part.
 IN_PROC_BROWSER_TEST_F(MHTMLGenerationTest, GenerateNonBinaryMHTMLWithImage) {
   base::FilePath path(temp_dir_.GetPath());
   path = path.Append(FILE_PATH_LITERAL("test_binary.mht"));
 
   GURL url(embedded_test_server()->GetURL("/page_with_image.html"));
@@ skipping 79 matching lines @@
   EXPECT_EQ(-1, file_size());
 
   std::string mhtml;
   {
     base::ThreadRestrictions::ScopedAllowIO allow_io_for_content_verification;
     ASSERT_TRUE(base::ReadFileToString(path, &mhtml));
   }
 
   // Make sure the contents are missing.
   EXPECT_THAT(mhtml, Not(HasSubstr("test body")));
+
+  // Checks that the final status reported to UMA is correct.
+  histogram_tester()->ExpectUniqueSample(
+      "PageSerialization.MhtmlGeneration.FinalSaveStatus",
+      static_cast<int>(MhtmlSaveStatus::FRAME_SERIALIZATION_FORBIDDEN), 1);
 }
 
 IN_PROC_BROWSER_TEST_F(MHTMLGenerationTest,
                        GenerateMHTMLIgnoreNoStoreSubFrame) {
   base::FilePath path(temp_dir_.GetPath());
   path = path.Append(FILE_PATH_LITERAL("test.mht"));
 
   GURL url(embedded_test_server()->GetURL("/page_with_nostore_iframe.html"));
 
   // Generate MHTML, specifying the FailForNoStoreMainFrame policy.
@@ skipping 157 matching lines @@
 
   // Make sure that URLs of both frames are present
   // (note that these are single-line regexes).
   EXPECT_THAT(
       mhtml,
       ContainsRegex("Content-Location:.*/frame_tree/page_with_one_frame.html"));
   EXPECT_THAT(mhtml, ContainsRegex("Content-Location:.*/title1.html"));
 }
 
 }  // namespace content