1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_POLICY_TEST_SUPPORT_REMOTE_COMMANDS_STATE_H_
#define COMPONENTS_POLICY_TEST_SUPPORT_REMOTE_COMMANDS_STATE_H_
#include <cstdint>
#include "base/containers/flat_map.h"
#include "base/observer_list_threadsafe.h"
#include "base/synchronization/lock.h"
#include "components/policy/proto/device_management_backend.pb.h"
namespace em = enterprise_management;
namespace policy {
// Stores information about current pending remote commands, and contains
// execution results of sent remote commands.
class RemoteCommandsState {
public:
// Interface for classes who would like to monitor remote command result.
class Observer {
public:
// Called when a remote command result is available.
virtual void OnRemoteCommandResultAvailable(int64_t command_id) = 0;
// Called when a remote command is acknowledged.
virtual void OnRemoteCommandAcked(int64_t command_id) = 0;
protected:
virtual ~Observer() = default;
};
RemoteCommandsState();
RemoteCommandsState(RemoteCommandsState&& state) = delete;
RemoteCommandsState& operator=(RemoteCommandsState&& state) = delete;
~RemoteCommandsState();
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
// Removes all pending remote commands and available results.
// Gets called on fake_dmserver construction.
void ResetState();
// Adds a remote command to the queue of pending remote commands.
// Expected to be called by tests to set up the environment.
// The command ids are incrementally increasing by 1.
// This function assigns a `command_id` and discards any `command_id` that is
// present in the passed `command`. If a specific `command_id` is required
// then use `SetCurrentIdForTesting()` to set the initial id. Returns the
// assigned `command_id`.
int64_t AddPendingRemoteCommand(const em::RemoteCommand& command);
// Stores an execution result of a remote command.
// Intended to store command results when the server receives them from the
// client.
void AddRemoteCommandResult(const em::RemoteCommandResult& result);
// Adds the id to the list of aknowledged remote commands.
void AddRemoteCommandAcked(const int64_t command_id);
// Returns all pending remote commands and deletes them from the state.
std::vector<em::RemoteCommand> ExtractPendingRemoteCommands();
// Returns in |result| an execution result for a command with
// a command ID == |id|.
// If no result is available, returns false.
// Expected to be called by tests to poll the remote command results.
bool GetRemoteCommandResult(int64_t id, em::RemoteCommandResult* result);
// Returns true if the remote command result is available.
bool IsRemoteCommandResultAvailable(int64_t id);
// Returns true if the remote command is acknowledged.
bool IsRemoteCommandAcked(int64_t id);
// Sets the initial command id with the given id, the next commands ids will
// be incrementally increasing by 1.
// Note fake_dmserver's implementation of "acknowledging" remote commands
// relies on the id strictly increasing, if this is called with an id which is
// lower than a previously issued remote command, fake_dmserver will miss some
// ack messages.
void SetCurrentIdForTesting(int64_t id);
private:
base::Lock lock_;
// Maps a command ID to an execution result of that command on the client.
base::flat_map<int64_t, em::RemoteCommandResult> command_results_
GUARDED_BY(lock_);
// Stores an id assigned to the last added remote command.
int64_t current_id_ GUARDED_BY(lock_);
// The last acknowledged command id, which implicitly ack all remote commands
// that were sent before this one.
int64_t g_last_acked_id_ GUARDED_BY(lock_);
// Queue of pending remote commands.
std::vector<em::RemoteCommand> pending_commands_ GUARDED_BY(lock_);
scoped_refptr<base::ObserverListThreadSafe<Observer>> observer_list_;
};
} // namespace policy
#endif // COMPONENTS_POLICY_TEST_SUPPORT_REMOTE_COMMANDS_STATE_H_
|
