Add support for component builds in alternate_version_generator.

chrome/installer/test/alternate_version_generator.cc

 // Copyright (c) 2011 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.
 
 // The file contains the implementation of the mini_installer re-versioner.
 // The main function (GenerateNextVersion) does the following in a temp dir:
 // - Extracts and unpacks setup.exe and the Chrome-bin folder from
 //   mini_installer.exe.
 // - Inspects setup.exe to determine the current version.
 // - Runs through all .dll and .exe files:
@@ skipping 42 matching lines @@
 #include "chrome/installer/test/resource_updater.h"
 #include "chrome/installer/util/lzma_util.h"
 
 namespace {
 
 const wchar_t k7zaExe[] = L"7za.exe";
 const wchar_t k7zaPathRelative[] = L"..\\..\\third_party\\lzma_sdk\\Executable";
 const wchar_t kB7[] = L"B7";
 const wchar_t kBl[] = L"BL";
 const wchar_t kChromeBin[] = L"Chrome-bin";
-const wchar_t kChromePacked7z[] = L"chrome.packed.7z";
+const wchar_t kChromePacked7z[] = L"CHROME.PACKED.7Z";
+const wchar_t kChrome7z[] = L"CHROME.7Z";
 const wchar_t kExe[] = L"exe";
 const wchar_t kExpandExe[] = L"expand.exe";
 const wchar_t kExtDll[] = L".dll";
 const wchar_t kExtExe[] = L".exe";
 const wchar_t kMakeCab[] = L"makecab.exe";
 const wchar_t kSetupEx_[] = L"setup.ex_";
 const wchar_t kSetupExe[] = L"setup.exe";
 const char kSwitch7zaPath[] = "7za_path";
 const wchar_t kTempDirPrefix[] = L"mini_installer_test_temp";
 
@@ skipping 49 matching lines @@
   explicit ChromeVersion(ULONGLONG value) : version_(value) { }
   WORD major() const { return static_cast<WORD>(version_ >> 48); }
   WORD minor() const { return static_cast<WORD>(version_ >> 32); }
   WORD build() const { return static_cast<WORD>(version_ >> 16); }
   WORD patch() const { return static_cast<WORD>(version_); }
   DWORD high() const { return static_cast<DWORD>(version_ >> 32); }
   DWORD low() const { return static_cast<DWORD>(version_); }
   ULONGLONG value() const { return version_; }
   void set_value(ULONGLONG value) { version_ = value; }
   std::wstring ToString() const;
+  std::string ToASCII() const;
+
  private:
   ULONGLONG version_;
 };  // class ChromeVersion
 
 std::wstring ChromeVersion::ToString() const {
   wchar_t buffer[24];
   int string_len =
       swprintf_s(&buffer[0], arraysize(buffer), L"%hu.%hu.%hu.%hu",
                  major(), minor(), build(), patch());
   DCHECK_NE(-1, string_len);
   DCHECK_GT(static_cast<int>(arraysize(buffer)), string_len);
   return std::wstring(&buffer[0], string_len);
 }
 
+std::string ChromeVersion::ToASCII() const {
+  char buffer[24];
+  int string_len = sprintf_s(&buffer[0], arraysize(buffer), "%hu.%hu.%hu.%hu",
+                             major(), minor(), build(), patch());
+  DCHECK_NE(-1, string_len);
+  DCHECK_GT(static_cast<int>(arraysize(buffer)), string_len);
+  return std::string(&buffer[0], string_len);
+}
 
 // A read/write mapping of a file.
 // Note: base::MemoryMappedFile is not used because it doesn't support
 // read/write mappings.  Adding such support across all platforms for this
 // Windows-only test code seems like overkill.
 class MappedFile {
  public:
   MappedFile() : size_(), mapping_(), view_() { }
   ~MappedFile();
   bool Initialize(base::File file);
@@ skipping 113 matching lines @@
 
 // Retrieves the version number of setup.exe in |work_dir| from its version
 // resource, placing the value in |version|.  Returns true on success.
 bool GetSetupExeVersion(const base::FilePath& work_dir,
                         ChromeVersion* version) {
   return GetFileVersion(work_dir.Append(&kSetupExe[0]), version);
 }
 
 
 // Replace all occurrences in the sequence [|dest_first|, |dest_last) that
 // equals [|src_first|, |src_last) with the sequence at |replacement_first| of

[gab, 2016/01/25 21:00:12]

existing nit : Missing | after "last" in both instances above.

[grt (UTC plus 2), 2016/01/26 00:13:45]

Done.

 // the same length.  Returns true on success.  If non-NULL, |replacements_made|

[gab, 2016/01/25 21:00:12]

Says |replacement_first| has to be the same length as |src_last - src_first| but
nothing enforces that?

[grt (UTC plus 2), 2016/01/26 00:13:45]

Correct. This is consistent with various C++ library functions which take a pair
of [begin,end) iterators for a source and a single output iterator for the
destination of an operation.

 // is set to true/false accordingly.
 bool ReplaceAll(uint8_t* dest_first,
                 uint8_t* dest_last,
                 const uint8_t* src_first,
                 const uint8_t* src_last,
                 const uint8_t* replacement_first,
                 bool* replacements_made) {
   bool result = true;
   bool changed = false;
   do {
@@ skipping 21 matching lines @@
 struct VisitResourceContext {
   ChromeVersion current_version;
   std::wstring current_version_str;
   ChromeVersion new_version;
   std::wstring new_version_str;
 };  // struct VisitResourceContext
 
 // Replaces the old version with the new in a resource.  A first pass is made to
 // replace the string form (e.g., "9.0.584.0").  If any replacements are made, a
 // second pass is made to replace the binary form (e.g., 0x0000024800000009).
+// A final pass is made to replace the ASCII string form.
 void VisitResource(const upgrade_test::EntryPath& path,
                    uint8_t* data,
                    DWORD size,
                    DWORD code_page,
                    uintptr_t context) {
   VisitResourceContext& ctx = *reinterpret_cast<VisitResourceContext*>(context);
 
   // Replace all occurrences of current_version_str with new_version_str
   bool changing_version = false;
   if (ReplaceAll(
           data, data + size,
           reinterpret_cast<const uint8_t*>(ctx.current_version_str.c_str()),
           reinterpret_cast<const uint8_t*>(ctx.current_version_str.c_str() +
                                            ctx.current_version_str.size() + 1),
           reinterpret_cast<const uint8_t*>(ctx.new_version_str.c_str()),
           &changing_version) &&
       changing_version) {
-    // Replace all occurrences of current_version with new_version
+    // Replace all binary occurrences of current_version with new_version.
     struct VersionPair {
       DWORD high;
       DWORD low;
     };
     VersionPair cur_ver = {
       ctx.current_version.high(), ctx.current_version.low()
     };
     VersionPair new_ver = {
       ctx.new_version.high(), ctx.new_version.low()
     };
     ReplaceAll(data, data + size, reinterpret_cast<const uint8_t*>(&cur_ver),
                reinterpret_cast<const uint8_t*>(&cur_ver) + sizeof(cur_ver),
                reinterpret_cast<const uint8_t*>(&new_ver), NULL);
   }
+
+  // Replace all ASCII occurrences of current_version with new_version.
+  std::string old_version(ctx.current_version.ToASCII());

[gab, 2016/01/25 21:00:12]

s/old_version/current_version/ for consistency

[grt (UTC plus 2), 2016/01/26 00:13:45]

Done.

+  std::string new_version(ctx.new_version.ToASCII());
+  ReplaceAll(data, data + size, reinterpret_cast<uint8_t*>(&old_version[0]),
+             reinterpret_cast<uint8_t*>(&old_version[old_version.size()]),
+             reinterpret_cast<uint8_t*>(&new_version[0]), NULL);
 }
 
 // Updates the version strings and numbers in all of |image_file|'s resources.
 bool UpdateVersionIfMatch(const base::FilePath& image_file,
                           VisitResourceContext* context) {
   if (!context ||
       context->current_version_str.size() < context->new_version_str.size()) {
     return false;
   }
 
@@ skipping 26 matching lines @@
       } else {
         result = true;
       }
     }
   } else {
     PLOG(DFATAL) << "Failed to open \"" << image_file.value() << "\"";
   }
   return result;
 }
 
+bool UpdateManifestVersion(const base::FilePath& manifest,
+                           VisitResourceContext* context) {
+  std::string contents;
+  if (!base::ReadFileToString(manifest, &contents))
+    return false;
+  std::string old_version(context->current_version.ToASCII());
+  std::string new_version(context->new_version.ToASCII());
+  bool modified = false;
+  if (!ReplaceAll(reinterpret_cast<uint8_t*>(&contents[0]),
+                  reinterpret_cast<uint8_t*>(&contents[contents.size()]),
+                  reinterpret_cast<uint8_t*>(&old_version[0]),
+                  reinterpret_cast<uint8_t*>(&old_version[old_version.size()]),

[gab, 2016/01/25 21:00:12]

Would reinterpret_cast<uint8_t*>(old_version.end()) be valid? Feels using
begin()/end() would be cleaner if possible..?

[grt (UTC plus 2), 2016/01/26 00:13:45]

I don't think so. While the iterator must act like a pointer in that operator*
would "dereference" it, the iterator itself is likely a lot more than just a
pointer, so the typecast would lead to badness.

+                  reinterpret_cast<uint8_t*>(&new_version[0]), &modified)) {
+    return false;
+  }
+  DCHECK(modified);
+  return base::WriteFile(manifest, &contents[0], contents.size()) ==
+         contents.size();
+}
+
 bool IncrementNewVersion(upgrade_test::Direction direction,
                          VisitResourceContext* ctx) {
   DCHECK(ctx);
 
   // Figure out a past or future version with the same string length as this one
   // by decrementing or incrementing each component.
   LONGLONG incrementer = (direction == upgrade_test::PREVIOUS_VERSION ? -1 : 1);
 
   do {
     if (incrementer == 0) {
@@ skipping 35 matching lines @@
       break;
     }
     std::wstring extension = file.Extension();
     if (extension == &kExtExe[0] || extension == &kExtDll[0]) {
       doing_great = UpdateVersionIfMatch(file, &ctx);
     }
   } while (doing_great);
 
   // Change the versioned directory.
   base::FilePath chrome_bin = work_dir.Append(&kChromeBin[0]);
-  doing_great = base::Move(chrome_bin.Append(ctx.current_version_str),
-                           chrome_bin.Append(ctx.new_version_str));
+  if (doing_great) {

[gab, 2016/01/25 21:00:12]

If we don't do anything and just run to returning false at end when we stop
|doing_great|, why not instead return false on first failure and drop this
variable?

[grt (UTC plus 2), 2016/01/26 00:13:45]

Good point. I probably wrote this when I was allergic to early-exit. :-)

+    doing_great = base::Move(chrome_bin.Append(ctx.current_version_str),
+                             chrome_bin.Append(ctx.new_version_str));
+  }
+
+  // Update the manifest.
+  base::FilePath current_manifest =
+      chrome_bin.Append(ctx.new_version_str)
+          .Append(ctx.current_version_str + L".manifest");

[gab, 2016/01/25 21:00:12]

Please link this CL to http://crbug.com/581133 which I just filed so that we
know there is potential cleanup here when we get rid of the version manifest.

[grt (UTC plus 2), 2016/01/26 00:13:45]

Done.

+  if (doing_great && base::PathExists(current_manifest)) {
+    base::FilePath new_manifest =
+        current_manifest.DirName().Append(ctx.new_version_str + L".manifest");
+    doing_great = base::Move(current_manifest, new_manifest) &&
+                  UpdateManifestVersion(new_manifest, &ctx);
+  }
 
   if (doing_great) {
     // Report the version numbers if requested.
     if (original_version != NULL)
       original_version->assign(ctx.current_version_str);
     if (new_version != NULL)
       new_version->assign(ctx.new_version_str);
   }
 
   return doing_great;
@@ skipping 62 matching lines @@
   // Copy the original mini_installer.
   base::FilePath mini_installer =
       work_dir.directory().Append(original_installer_path.BaseName());
   if (!base::CopyFile(original_installer_path, mini_installer)) {
     LOG(DFATAL) << "Failed copying \"" << original_installer_path.value()
                 << "\" to \"" << mini_installer.value() << "\"";
     return false;
   }
 
   base::FilePath setup_ex_ = work_dir.directory().Append(&kSetupEx_[0]);
-  base::FilePath chrome_packed_7z =
-      work_dir.directory().Append(&kChromePacked7z[0]);
+  base::FilePath chrome_packed_7z;  // Empty for component builds.
+  base::FilePath chrome_7z;
+  const wchar_t* archive_resource_name = nullptr;
+  base::FilePath* archive_file = nullptr;
   // Load the original file and extract setup.ex_ and chrome.packed.7z
   {
     ResourceLoader resource_loader;
     std::pair<const uint8_t*, DWORD> resource_data;
 
     if (!resource_loader.Initialize(mini_installer))
       return false;
 
     // Write out setup.ex_
     if (!resource_loader.Load(&kSetupEx_[0], &kBl[0], &resource_data))
       return false;
     int written =
         base::WriteFile(setup_ex_,
                         reinterpret_cast<const char*>(resource_data.first),
                         static_cast<int>(resource_data.second));
     if (written != static_cast<int>(resource_data.second)) {
       LOG(DFATAL) << "Failed writing \"" << setup_ex_.value() << "\"";
       return false;
     }
 
-    // Write out chrome.packed.7z
-    if (!resource_loader.Load(&kChromePacked7z[0], &kB7[0], &resource_data))
+    // Write out chrome.packed.7z (static build) or chrome.7z (component build)
+    if (resource_loader.Load(&kChromePacked7z[0], &kB7[0], &resource_data)) {
+      archive_resource_name = &kChromePacked7z[0];
+      chrome_packed_7z = work_dir.directory().Append(archive_resource_name);
+      archive_file = &chrome_packed_7z;
+    } else if (resource_loader.Load(&kChrome7z[0], &kB7[0], &resource_data)) {
+      archive_resource_name = &kChrome7z[0];
+      chrome_7z = work_dir.directory().Append(archive_resource_name);
+      archive_file = &chrome_7z;
+    } else {
       return false;
-    written =
-        base::WriteFile(chrome_packed_7z,
-                        reinterpret_cast<const char*>(resource_data.first),
-                        static_cast<int>(resource_data.second));
+    }

[gab, 2016/01/25 21:00:12]

DCHECK(!archive_resource_name.empty());
DCHECK(!chrome_packed_7z.empty() || !chrome_7z.empty();
DCHECK(archive_file);

to document the expectations at this point.

[grt (UTC plus 2), 2016/01/26 00:13:45]

Done.

+    written = base::WriteFile(
+        *archive_file, reinterpret_cast<const char*>(resource_data.first),
+        static_cast<int>(resource_data.second));
     if (written != static_cast<int>(resource_data.second)) {
-      LOG(DFATAL) << "Failed writing \"" << chrome_packed_7z.value() << "\"";
+      LOG(DFATAL) << "Failed writing \"" << archive_file->value() << "\"";
       return false;
     }
   }
 
   // Expand setup.ex_
   base::FilePath setup_exe = setup_ex_.ReplaceExtension(&kExe[0]);
   std::wstring command_line;
   command_line.append(1, L'"')
     .append(&kExpandExe[0])
     .append(L"\" \"")
     .append(setup_ex_.value())
     .append(L"\" \"")
     .append(setup_exe.value())
     .append(1, L'\"');
   int exit_code;
   if (!RunProcessAndWait(NULL, command_line, &exit_code))
     return false;
   if (exit_code != 0) {
     LOG(DFATAL) << &kExpandExe[0] << " exited with code " << exit_code;
     return false;
   }
 
-  // Unpack chrome.packed.7z
-  std::wstring chrome_7z_name;
-  if (LzmaUtil::UnPackArchive(chrome_packed_7z.value(),
-                              work_dir.directory().value(),
-                              &chrome_7z_name) != NO_ERROR) {
-    LOG(DFATAL) << "Failed unpacking \"" << chrome_packed_7z.value() << "\"";
-    return false;
+  // Unpack chrome.packed.7z (static build only).
+  if (!chrome_packed_7z.empty()) {
+    std::wstring chrome_7z_name;
+    if (LzmaUtil::UnPackArchive(chrome_packed_7z.value(),
+                                work_dir.directory().value(),
+                                &chrome_7z_name) != NO_ERROR) {
+      LOG(DFATAL) << "Failed unpacking \"" << chrome_packed_7z.value() << "\"";
+      return false;
+    }
+    chrome_7z = base::FilePath(chrome_7z_name);
   }

[gab, 2016/01/25 21:00:12]

DCHECK(!chrome_7z.empty());

to document the expectations at this point

[grt (UTC plus 2), 2016/01/26 00:13:45]

Done.

 
   // Unpack chrome.7z
-  if (LzmaUtil::UnPackArchive(chrome_7z_name, work_dir.directory().value(),
+  if (LzmaUtil::UnPackArchive(chrome_7z.value(), work_dir.directory().value(),
                               NULL) != NO_ERROR) {
-    LOG(DFATAL) << "Failed unpacking \"" << chrome_7z_name << "\"";
+    LOG(DFATAL) << "Failed unpacking \"" << chrome_7z.value() << "\"";
     return false;
   }
 
   // Get rid of intermediate files
-  base::FilePath chrome_7z(chrome_7z_name);
   if (!base::DeleteFile(chrome_7z, false) ||
-      !base::DeleteFile(chrome_packed_7z, false) ||
+      (!chrome_packed_7z.empty() &&
+       !base::DeleteFile(chrome_packed_7z, false)) ||
       !base::DeleteFile(setup_ex_, false)) {
     LOG(DFATAL) << "Failed deleting intermediate files";
     return false;
   }
 
   // Increment the version in all files.
   ApplyAlternateVersion(work_dir.directory(), direction, original_version,
                         new_version);
 
   // Pack up files into chrome.7z
   if (!CreateArchive(chrome_7z, work_dir.directory().Append(&kChromeBin[0]), 0))
     return false;
 
-  // Compress chrome.7z into chrome.packed.7z
-  if (!CreateArchive(chrome_packed_7z, chrome_7z, 9))
+  // Compress chrome.7z into chrome.packed.7z for static builds.
+  if (!chrome_packed_7z.empty() &&
+      !CreateArchive(chrome_packed_7z, chrome_7z, 9)) {
     return false;
+  }
 
   // Compress setup.exe into setup.ex_
   command_line.assign(1, L'"')
       .append(&kMakeCab[0])
       .append(L"\" /D CompressionType=LZX /L \"")
       .append(work_dir.directory().value())
       .append(L"\" \"")
       .append(setup_exe.value());
   if (!RunProcessAndWait(NULL, command_line, &exit_code))
     return false;
   if (exit_code != 0) {
     LOG(DFATAL) << &kMakeCab[0] << " exited with code " << exit_code;
     return false;
   }
 
-  // Replace the mini_installer's setup.ex_ and chrome.packed.7z resources.
+  // Replace the mini_installer's setup.ex_ and chrome.packed.7z (or chrome.7z
+  // in component builds) resources.
   ResourceUpdater updater;
   if (!updater.Initialize(mini_installer) ||
       !updater.Update(&kSetupEx_[0], &kBl[0],
                       MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US),
                       setup_ex_) ||
-      !updater.Update(&kChromePacked7z[0], &kB7[0],
+      !updater.Update(archive_resource_name, &kB7[0],
                       MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US),
-                      chrome_packed_7z) ||
+                      *archive_file) ||
       !updater.Commit()) {
+    LOG(ERROR) << "It is common for this step to fail for very large resources,"
+                  " as is the case for Debug component=shared_library builds. "
+                  "Try with a Release or component=static_library build.";
     return false;
   }
 
   // Finally, move the updated mini_installer into place.
   return base::Move(mini_installer, target_path);
 }
 
 bool GenerateAlternatePEFileVersion(const base::FilePath& original_file,
                                     const base::FilePath& target_file,
                                     Direction direction) {
@@ skipping 34 matching lines @@
     return false;
   }
   ctx.current_version_str = ctx.current_version.ToString();
   ctx.new_version = ChromeVersion::FromString(version.GetString());
   ctx.new_version_str = ctx.new_version.ToString();
 
   return UpdateVersionIfMatch(target_file, &ctx);
 }
 
 }  // namespace upgrade_test