update_engine: Implement Excluder Class + Tests
Excluder persists the exclusion state for excluding certain names. This
will be used to exclude update Payloads which are contiuously faulty.
BUG=chromium:928805
TEST=FEATURES=test emerge-$B update_engine
TEST=USE="${USE} -dlc" FEATURES=test emerge-$B update_engine
Change-Id: I780a9cf2ad979833382a832e01833211ec2ccf7d
Reviewed-on: https://chromium-review.googlesource.com/c/aosp/platform/system/update_engine/+/2172074
Tested-by: Jae Hoon Kim <kimjae@chromium.org>
Commit-Queue: Jae Hoon Kim <kimjae@chromium.org>
Auto-Submit: Jae Hoon Kim <kimjae@chromium.org>
Reviewed-by: Amin Hassani <ahassani@chromium.org>
diff --git a/common/excluder_interface.h b/common/excluder_interface.h
new file mode 100644
index 0000000..3985bba
--- /dev/null
+++ b/common/excluder_interface.h
@@ -0,0 +1,60 @@
+//
+// Copyright (C) 2020 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_EXCLUDER_INTERFACE_H_
+#define UPDATE_ENGINE_COMMON_EXCLUDER_INTERFACE_H_
+
+#include <memory>
+#include <string>
+
+#include <base/macros.h>
+
+namespace chromeos_update_engine {
+
+class PrefsInterface;
+
+class ExcluderInterface {
+ public:
+ virtual ~ExcluderInterface() = default;
+
+ // Returns true on successfuly excluding |name|, otherwise false. On a
+ // successful |Exclude()| the passed in |name| will be considered excluded
+ // and calls to |IsExcluded()| will return true. The exclusions are persisted.
+ virtual bool Exclude(const std::string& name) = 0;
+
+ // Returns true if |name| reached the exclusion limit, otherwise false.
+ virtual bool IsExcluded(const std::string& name) = 0;
+
+ // Returns true on sucessfully reseting the entire exclusion state, otherwise
+ // false. On a successful |Reset()| there will be no excluded |name| in the
+ // exclusion state.
+ virtual bool Reset() = 0;
+
+ // Not copyable or movable
+ ExcluderInterface(const ExcluderInterface&) = delete;
+ ExcluderInterface& operator=(const ExcluderInterface&) = delete;
+ ExcluderInterface(ExcluderInterface&&) = delete;
+ ExcluderInterface& operator=(ExcluderInterface&&) = delete;
+
+ protected:
+ ExcluderInterface() = default;
+};
+
+std::unique_ptr<ExcluderInterface> CreateExcluder(PrefsInterface* prefs);
+
+} // namespace chromeos_update_engine
+
+#endif // UPDATE_ENGINE_COMMON_EXCLUDER_INTERFACE_H_