Check env-version upon component load

chrome/browser/component_updater/cros_component_installer.h

 // Copyright 2017 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_COMPONENT_UPDATER_CROS_COMPONENT_INSTALLER_H_
 #define CHROME_BROWSER_COMPONENT_UPDATER_CROS_COMPONENT_INSTALLER_H_
 
 #include <string>
 
 #include "build/build_config.h"
 #include "components/component_updater/component_updater_service.h"
 #include "components/component_updater/default_component_installer.h"
 #include "components/update_client/update_client.h"
 #include "crypto/sha2.h"
 
+//  Register and start installing a CrOS component.
+//
+//  Developer API usage:
+//  ...
+//  void load_callback(const std::string& result){
+//    if (result.empty) {
+//      // component is not mounted.
+//      return;
+//    }
+//    // [component mount point: result]
+//  }
+//  void install_callback(update_client::Error error){
+//    // error code: 1) update_client::Error::NONE, success 2) otherwise,
+//    // fail.
+//    // Even when error code other than NONE returned (your install failed),
+//    // component might has already being installed previously.
+//    // Plus, if you want to know current version of component.
+//    component_updater:CrOSComponent::LoadCrOSComponent(name, load_callback);

[waffles, 2017/05/30 22:12:17]

Sorry, I'm still confused about this API. We have Install and Load. What exactly
is the difference between these two?

Am I right that:

Install: Go get the latest thing from the network.
Load: Go get the latest thing without the network.

Is there any reason to not just have:
Load: Go get the latest thing without the network (if available), else get the
latest thing from the network?

[xiaochu, 2017/05/31 15:40:11]

Done.

This makes sense. Thanks!

+//  }
+//  ...
+//  component_updater::CrOSComponent::InstallCrOSComponent(
+//            name,
+//            base::Bind(&install_callback));
+//
 namespace component_updater {
 
 #if defined(OS_CHROMEOS)
 struct ComponentConfig {
   std::string name;
   std::string env_version;
   std::string sha2hashstr;
   ComponentConfig(const std::string& name,
                   const std::string& env_version,
                   const std::string& sha2hashstr);
   ~ComponentConfig();
 };
 
 using ConfigMap = std::map<std::string, std::map<std::string, std::string>>;
 
 class CrOSComponentInstallerTraits : public ComponentInstallerTraits {
  public:
   explicit CrOSComponentInstallerTraits(const ComponentConfig& config);
   ~CrOSComponentInstallerTraits() override {}
 
  private:
+  FRIEND_TEST_ALL_PREFIXES(CrOSComponentInstallerTest, IsCompatibleOrNot);
+  FRIEND_TEST_ALL_PREFIXES(CrOSComponentInstallerTest,
+                           ComponentReadyCorrectManifest);
+  FRIEND_TEST_ALL_PREFIXES(CrOSComponentInstallerTest,
+                           ComponentReadyWrongManifest);
   // The following methods override ComponentInstallerTraits.
   bool SupportsGroupPolicyEnabledComponentUpdates() const override;
   bool RequiresNetworkEncryption() const override;
   update_client::CrxInstaller::Result OnCustomInstall(
       const base::DictionaryValue& manifest,
       const base::FilePath& install_dir) override;
   bool VerifyInstallation(const base::DictionaryValue& manifest,
                           const base::FilePath& install_dir) const override;
   void ComponentReady(const base::Version& version,
                       const base::FilePath& path,
                       std::unique_ptr<base::DictionaryValue> manifest) override;
   base::FilePath GetRelativeInstallDir() const override;
   void GetHash(std::vector<uint8_t>* hash) const override;
   std::string GetName() const override;
   update_client::InstallerAttributes GetInstallerAttributes() const override;
   std::vector<std::string> GetMimeTypes() const override;
+
+  virtual bool IsCompatible(const std::string& env_version_str,
+                            const std::string& min_env_version_str);
   std::string name;
   std::string env_version;
   uint8_t kSha2Hash_[crypto::kSHA256Length] = {};
 
   DISALLOW_COPY_AND_ASSIGN(CrOSComponentInstallerTraits);
 };
 
 // This class contains functions used to register and install a component.
 class CrOSComponent {
  public:
-  //  Register and start installing a CrOS component.
-  //  |install_callback| is triggered after install finishes and returns error
-  //  code.
-  //
-  //  example:
-  //  ...
-  //  void load_callback(const std::string& result){
-  //    if (result.empty) {
-  //      // component is not mounted.
-  //      return;
-  //    }
-  //    // [component mount point: result]
-  //  }
-  //  void install_callback(update_client::Error error){
-  //    // switch(error){
-  //    //   case update_client::Error::NONE:
-  //    //     // component is installed
-  //    //     break;
-  //    //   case update_client::Error::INVALID_ARGUMENT:
-  //    //     // your install failed due to your wrong parameters.
-  //    //     break;
-  //    //   default:
-  //    //     // your install failed due to system failure.
-  //    //     break;
-  //    // }
-  //    // Even when error code other than NONE returned (your install failed),
-  //    // component might has already being installed previously.
-  //    // Plus, if you want to know current version of component.
-  //    component_updater:CrOSComponent::LoadCrOSComponent(name, load_callback);
-  //  }
-  //  ...
-  //    component_updater::CrOSComponent::InstallCrOSComponent(
-  //              name,
-  //              base::Bind(&install_callback));
-  //
-  static bool InstallCrOSComponent(
+  static void InstallCrOSComponent(
       const std::string& name,
       const update_client::Callback& install_callback);
 
-  static void LoadCrOSComponent(
+ private:
+  // Install a component (called by InstallCrOSComponent).
+  static void InstallCrOSComponent(
+      ComponentUpdateService* cus,
       const std::string& name,
-      const base::Callback<void(const std::string&)>& mount_callback);
-
- private:
-  CrOSComponent() {}
-  // Register a component.
+      const update_client::Callback& install_callback);
+  // Register a component (called by InstallCrOSComponent).
   static void RegisterCrOSComponentInternal(ComponentUpdateService* cus,
                                             const ComponentConfig& config,
                                             const base::Closure& callback);
   // A helper function to pass into RegisterCrOSComonentInternal as a callback.
   // It calls OnDemandUpdate to install the component right after being
   // registered.
   static void InstallChromeOSComponent(
       ComponentUpdateService* cus,
       const std::string& id,
       const update_client::Callback& install_callback);
+
+ public:

[waffles, 2017/05/30 22:12:17]

Group all public members together. Same for private.

[xiaochu, 2017/05/31 15:40:11]

Done.

+  static void LoadCrOSComponent(
+      const std::string& name,
+      const base::Callback<void(const std::string&)>& load_callback);
+
+ private:
+  FRIEND_TEST_ALL_PREFIXES(CrOSComponentInstallerTest,
+                           RegisterComponentSuccess);
+  FRIEND_TEST_ALL_PREFIXES(CrOSComponentInstallerTest, RegisterComponentFail);
+  CrOSComponent() {}
 };
 #endif  // defined(OS_CHROMEOS)
 
 }  // namespace component_updater
 
 #endif  // CHROME_BROWSER_COMPONENT_UPDATER_CROS_COMPONENT_INSTALLER_H_