Split payload application code into a subdirectory.
This patch splits from the main libupdate_engine code the part that
is strictly used to download and apply a payload into a new static
library, moving the code to subdirectories. The new library is divided
in two subdirectories: common/ and payload_consumer/, and should not
depend on other update_engine files outside those two subdirectories.
The main difference between those two is that the common/ tools are more
generic and not tied to the payload consumer process, but otherwise they
are both compiled together.
There are still dependencies from the new libpayload_consumer library
into the main directory files and DBus generated files. Those will be
addressed in follow up CLs.
Bug: 25197634
Test: FEATURES=test emerge-link update_engine; `mm` on Brillo.
Change-Id: Id8d0204ea573627e6e26ca9ea17b9592ca95bc23
diff --git a/common/fake_prefs.h b/common/fake_prefs.h
new file mode 100644
index 0000000..d194060
--- /dev/null
+++ b/common/fake_prefs.h
@@ -0,0 +1,113 @@
+//
+// Copyright (C) 2012 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#ifndef UPDATE_ENGINE_COMMON_FAKE_PREFS_H_
+#define UPDATE_ENGINE_COMMON_FAKE_PREFS_H_
+
+#include <map>
+#include <string>
+#include <vector>
+
+#include <base/macros.h>
+
+#include "update_engine/common/prefs_interface.h"
+
+namespace chromeos_update_engine {
+
+// Implements a fake preference store by storing the value associated with
+// a key in a std::map, suitable for testing. It doesn't allow to set a value on
+// a key with a different type than the previously set type. This enforces the
+// type of a given key to be fixed. Also the class checks that the Get*()
+// methods aren't called on a key set with a different type.
+
+class FakePrefs : public PrefsInterface {
+ public:
+ FakePrefs() = default;
+ ~FakePrefs();
+
+ // PrefsInterface methods.
+ bool GetString(const std::string& key, std::string* value) const override;
+ bool SetString(const std::string& key, const std::string& value) override;
+ bool GetInt64(const std::string& key, int64_t* value) const override;
+ bool SetInt64(const std::string& key, const int64_t value) override;
+ bool GetBoolean(const std::string& key, bool* value) const override;
+ bool SetBoolean(const std::string& key, const bool value) override;
+
+ bool Exists(const std::string& key) const override;
+ bool Delete(const std::string& key) override;
+
+ void AddObserver(const std::string& key,
+ ObserverInterface* observer) override;
+ void RemoveObserver(const std::string& key,
+ ObserverInterface* observer) override;
+
+ private:
+ enum class PrefType {
+ kString,
+ kInt64,
+ kBool,
+ };
+ struct PrefValue {
+ std::string as_str;
+ int64_t as_int64;
+ bool as_bool;
+ };
+
+ struct PrefTypeValue {
+ PrefType type;
+ PrefValue value;
+ };
+
+ // Class to store compile-time type-dependent constants.
+ template<typename T>
+ class PrefConsts {
+ public:
+ // The PrefType associated with T.
+ static FakePrefs::PrefType const type;
+
+ // The data member pointer to PrefValue associated with T.
+ static T FakePrefs::PrefValue::* const member;
+ };
+
+ // Returns a string representation of the PrefType useful for logging.
+ static std::string GetTypeName(PrefType type);
+
+ // Checks that the |key| is either not present or has the given |type|.
+ void CheckKeyType(const std::string& key, PrefType type) const;
+
+ // Helper function to set a value of the passed |key|. It sets the type based
+ // on the template parameter T.
+ template<typename T>
+ void SetValue(const std::string& key, const T& value);
+
+ // Helper function to get a value from the map checking for invalid calls.
+ // The function fails the test if you attempt to read a value defined as a
+ // different type. Returns whether the get succeeded.
+ template<typename T>
+ bool GetValue(const std::string& key, T* value) const;
+
+ // Container for all the key/value pairs.
+ std::map<std::string, PrefTypeValue> values_;
+
+ // The registered observers watching for changes.
+ std::map<std::string, std::vector<ObserverInterface*>> observers_;
+
+ DISALLOW_COPY_AND_ASSIGN(FakePrefs);
+};
+
+} // namespace chromeos_update_engine
+
+#endif // UPDATE_ENGINE_COMMON_FAKE_PREFS_H_