1 //
2 // Copyright (C) 2011 The Android Open Source Project
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //      http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 //
16 
17 #ifndef UPDATE_ENGINE_OMAHA_RESPONSE_HANDLER_ACTION_H_
18 #define UPDATE_ENGINE_OMAHA_RESPONSE_HANDLER_ACTION_H_
19 
20 #include <string>
21 
22 #include <gtest/gtest_prod.h>  // for FRIEND_TEST
23 
24 #include "update_engine/common/action.h"
25 #include "update_engine/omaha_request_action.h"
26 #include "update_engine/payload_consumer/install_plan.h"
27 #include "update_engine/system_state.h"
28 
29 // This class reads in an Omaha response and converts what it sees into
30 // an install plan which is passed out.
31 
32 namespace chromeos_update_engine {
33 
34 class OmahaResponseHandlerAction;
35 
36 template <>
37 class ActionTraits<OmahaResponseHandlerAction> {
38  public:
39   typedef OmahaResponse InputObjectType;
40   typedef InstallPlan OutputObjectType;
41 };
42 
43 class OmahaResponseHandlerAction : public Action<OmahaResponseHandlerAction> {
44  public:
45   explicit OmahaResponseHandlerAction(SystemState* system_state);
46 
47   typedef ActionTraits<OmahaResponseHandlerAction>::InputObjectType
48       InputObjectType;
49   typedef ActionTraits<OmahaResponseHandlerAction>::OutputObjectType
50       OutputObjectType;
51   void PerformAction() override;
52 
53   // This is a synchronous action, and thus TerminateProcessing() should
54   // never be called
55   void TerminateProcessing() override { CHECK(false); }
56 
57   const InstallPlan& install_plan() const { return install_plan_; }
58 
59   // Debugging/logging
60   static std::string StaticType() { return "OmahaResponseHandlerAction"; }
61   std::string Type() const override { return StaticType(); }
62 
63  private:
64   // Returns true if payload hash checks are mandatory based on the state
65   // of the system and the contents of the Omaha response. False otherwise.
66   bool AreHashChecksMandatory(const OmahaResponse& response);
67 
68   // Global system context.
69   SystemState* system_state_;
70 
71   // The install plan, if we have an update.
72   InstallPlan install_plan_;
73 
74   // File used for communication deadline to Chrome.
75   std::string deadline_file_;
76 
77   friend class OmahaResponseHandlerActionTest;
78   friend class OmahaResponseHandlerActionProcessorDelegate;
79   FRIEND_TEST(UpdateAttempterTest, CreatePendingErrorEventResumedTest);
80   FRIEND_TEST(UpdateAttempterTest, RollbackMetricsNotRollbackFailure);
81   FRIEND_TEST(UpdateAttempterTest, RollbackMetricsNotRollbackSuccess);
82   FRIEND_TEST(UpdateAttempterTest, RollbackMetricsRollbackFailure);
83   FRIEND_TEST(UpdateAttempterTest, RollbackMetricsRollbackSuccess);
84   FRIEND_TEST(UpdateAttempterTest, SetRollbackHappenedNotRollback);
85   FRIEND_TEST(UpdateAttempterTest, SetRollbackHappenedRollback);
86   FRIEND_TEST(UpdateAttempterTest, UpdateDeferredByPolicyTest);
87 
88   DISALLOW_COPY_AND_ASSIGN(OmahaResponseHandlerAction);
89 };
90 
91 }  // namespace chromeos_update_engine
92 
93 #endif  // UPDATE_ENGINE_OMAHA_RESPONSE_HANDLER_ACTION_H_
94