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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?php
namespace Icinga\Module\Director\Clicommands;
use Icinga\Module\Director\Cli\Command;
use Icinga\Module\Director\Objects\DirectorActivityLog;
use Icinga\Module\Director\Objects\IcingaObject;
use Icinga\Module\Director\Objects\SyncRule;
use RuntimeException;
/**
* Deal with Director Sync Rules
*
* Use this command to check or trigger your defined Sync Rules
*/
class SyncruleCommand extends Command
{
/**
* List defined Sync Rules
*
* This shows a table with your defined Sync Rules, their IDs and
* current state. As triggering a Sync requires an ID, this is where
* you can look up the desired ID.
*
* USAGE
*
* icingacli director syncrule list
*/
public function listAction()
{
$rules = SyncRule::loadAll($this->db());
if (empty($rules)) {
echo "No Sync Rule has been defined\n";
return;
}
printf("%4s | %s\n", 'ID', 'Sync Rule name');
printf("-----+%s\n", str_repeat('-', 64));
foreach ($rules as $rule) {
$state = $rule->get('sync_state');
printf("%4d | %s\n", $rule->get('id'), $rule->get('rule_name'));
printf(" | -> %s%s\n", $state, $state === 'failing' ? ': ' . $rule->get('last_error_message') : '');
}
}
/**
* Check a given Sync Rule for changes
*
* This command runs a complete Sync in memory but doesn't persist eventual changes.
*
* USAGE
*
* icingacli director syncrule check --id <id>
*
* OPTIONS
*
* --id <id> A Sync Rule ID. Use the list command to figure out
* --benchmark Show timing and memory usage details
*/
public function checkAction()
{
$rule = $this->getSyncRule();
$hasChanges = $rule->checkForChanges();
$this->showSyncStateDetails($rule);
if ($hasChanges) {
$mods = $this->getExpectedModificationCounts($rule);
printf(
"Expected modifications: %dx create, %dx modify, %dx delete\n",
$mods->modify,
$mods->create,
$mods->delete
);
}
exit($this->getSyncStateExitCode($rule));
}
protected function getExpectedModificationCounts(SyncRule $rule)
{
$modifications = $rule->getExpectedModifications();
$create = 0;
$modify = 0;
$delete = 0;
/** @var IcingaObject $object */
foreach ($modifications as $object) {
if ($object->hasBeenLoadedFromDb()) {
if ($object->shouldBeRemoved()) {
$delete++;
} else {
$modify++;
}
} else {
$create++;
}
}
return (object) [
DirectorActivityLog::ACTION_CREATE => $create,
DirectorActivityLog::ACTION_MODIFY => $modify,
DirectorActivityLog::ACTION_DELETE => $delete,
];
}
/**
* Trigger a Sync Run for a given Sync Rule
*
* This command builds new objects according your Sync Rule, compares them
* with existing ones and persists eventual changes.
*
* USAGE
*
* icingacli director syncrule run --id <id>
*
* OPTIONS
*
* --id <id> A Sync Rule ID. Use the list command to figure out
* --benchmark Show timing and memory usage details
*/
public function runAction()
{
$rule = $this->getSyncRule();
if ($rule->applyChanges()) {
print "New data has been imported\n";
$this->showSyncStateDetails($rule);
} else {
print "Nothing has been changed, imported data is still up to date\n";
}
}
/**
* @return SyncRule
*/
protected function getSyncRule()
{
return SyncRule::loadWithAutoIncId(
(int) $this->params->getRequired('id'),
$this->db()
);
}
/**
* @param SyncRule $rule
*/
protected function showSyncStateDetails(SyncRule $rule)
{
echo $this->getSyncStateDescription($rule) . "\n";
}
/**
* @param SyncRule $rule
* @return string
*/
protected function getSyncStateDescription(SyncRule $rule)
{
switch ($rule->get('sync_state')) {
case 'unknown':
return "It's currently unknown whether we are in sync with this rule."
. ' You should either check for changes or trigger a new Sync Run.';
case 'in-sync':
return 'This Sync Rule is in sync';
case 'pending-changes':
return 'There are pending changes for this Sync Rule. You should'
. ' trigger a new Sync Run.';
case 'failing':
return 'This Sync Rule failed: '. $rule->get('last_error_message');
default:
throw new RuntimeException('Invalid sync state: ' . $rule->get('sync_state'));
}
}
/**
* @param SyncRule $rule
* @return string
*/
protected function getSyncStateExitCode(SyncRule $rule)
{
switch ($rule->get('sync_state')) {
case 'unknown':
return 3;
case 'in-sync':
return 0;
case 'pending-changes':
return 1;
case 'failing':
return 2;
default:
throw new RuntimeException('Invalid sync state: ' . $rule->get('sync_state'));
}
}
}
|
