Code Coverage for /home/graste/projects/environaut/src/Environaut/Checks/Check.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		0.00%	0 / 1		54.55%	12 / 22	CRAP		77.94%	53 / 68
Check		0.00%	0 / 1		54.55%	12 / 22	46.41		77.94%	53 / 68
__construct()					100.00%	1 / 1	1		100.00%	7 / 7
getResult()					100.00%	1 / 1	1		100.00%	1 / 1
setName($name = null)					0.00%	0 / 1	3.58		60.00%	3 / 5
getName()					100.00%	1 / 1	1		100.00%	1 / 1
setGroup($group = null)					100.00%	1 / 1	3		100.00%	5 / 5
getGroup()					100.00%	1 / 1	1		100.00%	1 / 1
setParameters(Parameters $parameters)					100.00%	1 / 1	1		100.00%	2 / 2
getParameters()					100.00%	1 / 1	1		100.00%	1 / 1
setCache(IReadOnlyCache $cache)					0.00%	0 / 1	2		0.00%	0 / 2
getDependencies()					0.00%	0 / 1	2		0.00%	0 / 1
getDefaultGroupName()					0.00%	0 / 1	2		0.00%	0 / 1
getDefaultSettingGroupName()					0.00%	0 / 1	2		0.00%	0 / 1
addSetting($name, $value, $group = null, $flag = ISetting::NORMAL, $cachable = false)					100.00%	1 / 1	3		100.00%	8 / 8
addCachableSetting($name, $value, $group = null, $flag = ISetting::NORMAL)					100.00%	1 / 1	1		100.00%	2 / 2
addInfo($text = '', $name = null, $group = null)					100.00%	1 / 1	3		100.00%	8 / 8
addNotice($text = '', $name = null, $group = null)					0.00%	0 / 1	3.14		75.00%	6 / 8
addError($text = '', $name = null, $group = null)					0.00%	0 / 1	3.14		75.00%	6 / 8
getDialogHelper()					0.00%	0 / 1	2		0.00%	0 / 1
getOutputStream()					0.00%	0 / 1	2		0.00%	0 / 1
setCommand(Command $command)					0.00%	0 / 1	2		0.00%	0 / 2
getCommand()					100.00%	1 / 1	1		100.00%	1 / 1
getRandomString($length = 8, $prefix = 'check_')					100.00%	1 / 1	1		100.00%	1 / 1

1	<?php
2
3	namespace Environaut\Checks;
4
5	use Environaut\Cache\Cache;
6	use Environaut\Cache\IReadOnlyCache;
7	use Environaut\Command\Command;
8	use Environaut\Config\Parameters;
9	use Environaut\Report\Results\IResult;
10	use Environaut\Report\Results\Result;
11	use Environaut\Report\Results\Messages\Message;
12	use Environaut\Report\Results\Settings\ISetting;
13	use Environaut\Report\Results\Settings\Setting;
14
15	/**
16	* Class that custom Checks may extend to get access
17	* to the dialog helper from the command (and thus
18	* the input/output stream).
19	*/
20	abstract class Check implements ICheck
21	{
22	/**
23	* @var string
24	*/
25	protected $name;
26
27	/**
28	* @var string
29	*/
30	protected $group;
31
32	/**
33	* @var Parameters
34	*/
35	protected $parameters;
36
37	/**
38	* @var Command
39	*/
40	protected $command;
41
42	/**
43	* @var IResult
44	*/
45	protected $result;
46
47	/**
48	* @var IReadOnlyCache
49	*/
50	protected $cache;
51
52	/**
53	* Creates a new Check instance with a random name and the default group.
54	*/
55	public function __construct()
56	{
57	$this->name = self::getRandomString(8);
58	$this->group = $this->getDefaultGroupName();
59	$this->parameters = new Parameters(array());
60
61	$this->result = new Result();
62	$this->result->setCheck($this);
63
64	$this->cache = new Cache();
65	}
66
67	/**
68	* Returns the result of this check. This should be called after the run() method has been run.
69	*
70	* @return IResult result of this check
71	*/
72	public function getResult()
73	{
74	return $this->result;
75	}
76
77	/**
78	* Sets the name of the check. When null or a non-string value is given a random name is set.
79	*
80	* @param string $name name of the check
81	*
82	* @return Check this instance for fluent API support
83	*/
84	public function setName($name = null)
85	{
86	if (null === $name \|\| !is_string($name)) {
87	$this->name = self::getRandomString(8);
88	} else {
89	$this->name = $name;
90	}
91
92	return $this;
93	}
94
95	/**
96	* Returns the name of this check.
97	*
98	* @return string name of this check
99	*/
100	public function getName()
101	{
102	return $this->name;
103	}
104
105	/**
106	* Sets the group name of the check (for reports). Null or non-string values will set the default group name.
107	*
108	* @param string $group name of the group the check belongs to
109	*
110	* @return Check this instance for fluent API support
111	*/
112	public function setGroup($group = null)
113	{
114	if (null === $group \|\| !is_string($group)) {
115	$this->group = $this->getDefaultGroupName();
116	} else {
117	$this->group = $group;
118	}
119
120	return $this;
121	}
122
123	/**
124	* Returns the group name of this check that may be useful to group/namespace settings.
125	*
126	* @return string group name of this check
127	*/
128	public function getGroup()
129	{
130	return $this->group;
131	}
132
133	/**
134	* Sets the necessary runtime parameters of the check.
135	*
136	* @param Parameters $parameters runtime configuration parameters for this check
137	*
138	* @return Check this instance for fluent API support
139	*/
140	public function setParameters(Parameters $parameters)
141	{
142	$this->parameters = $parameters;
143
144	return $this;
145	}
146
147	/**
148	* Returns the runtime parameters that are used to run this check.
149	*
150	* @return Parameters runtime parameters of this check
151	*/
152	public function getParameters()
153	{
154	return $this->parameters;
155	}
156
157	/**
158	* Sets the cache instance a check may use to retrieve old values from the cache
159	* to prevent e.g. asking already configured settings.
160	*
161	* @param IReadOnlyCache $cache cache instance
162	*
163	* @return Check this instance for fluent API support
164	*/
165	public function setCache(IReadOnlyCache $cache)
166	{
167	$this->cache = $cache;
168
169	return $this;
170	}
171
172	/**
173	* Returns the tokens that should be available prior to running this check.
174	*
175	* @return array with token names
176	*/
177	public function getDependencies()
178	{
179	return array();
180	}
181
182	/**
183	* Returns the default group name this check uses when none is specified.
184	*
185	* @return string default group name of the check
186	*/
187	public function getDefaultGroupName()
188	{
189	return self::DEFAULT_GROUP_NAME;
190	}
191
192	/**
193	* Returns the default group name this check uses for settings when none is specified.
194	*
195	* @return string default group name of settings of this check
196	*/
197	public function getDefaultSettingGroupName()
198	{
199	return $this->getDefaultGroupName();
200	}
201
202	/**
203	* Adds the given value under the given key to the settings
204	* of the result. The setting may have a group name to more
205	* easily separate them on export. If no group name is specified
206	* the check's default setting group name is used as the default.
207	*
208	* @param string $name key for that setting
209	* @param mixed $value usually a string value
210	* @param string $group name of group this setting belongs to
211	* @param int $flag type of the setting (normal or sensitive)
212	* @param boolean $cachable whether that setting should also be stored in a cache. Default is false (NOT cached!).
213	*
214	* @return Check this instance for fluent API support
215	*
216	* @throws \InvalidArgumentException if no valid setting key was given
217	*/
218	protected function addSetting($name, $value, $group = null, $flag = ISetting::NORMAL, $cachable = false)
219	{
220	if (empty($name)) {
221	throw new \InvalidArgumentException('A setting must have a valid name.');
222	}
223
224	if (null === $group) {
225	$group = $this->getDefaultSettingGroupName();
226	}
227
228	$setting = new Setting($name, $value, $group, $flag);
229
230	$this->result->addSetting($setting, $cachable);
231
232	return $this;
233	}
234
235	/**
236	* Adds the given value under the given key to the settings
237	* of the result. The setting may have a group name to more
238	* easily separate them on export. If no group name is specified
239	* the check's default setting group name is used as the default.
240	* This setting may be written to a cache to be available on re-runs
241	* of the check.
242	*
243	* @param string $name key for that setting
244	* @param mixed $value usually a string value
245	* @param string $group name of group this setting belongs to
246	* @param int $flag type of the setting (ISetting::NORMAL by default)
247	*
248	* @return Check this instance for fluent API support
249	*
250	* @throws \InvalidArgumentException if no valid setting key was given
251	*/
252	protected function addCachableSetting($name, $value, $group = null, $flag = ISetting::NORMAL)
253	{
254	$this->addSetting($name, $value, $group, $flag, true);
255
256	return $this;
257	}
258
259	/**
260	* Convenience method to add an informational message to the
261	* result (message severity is Message::SEVERITY_INFO).
262	*
263	* @param string $text message text
264	* @param string $name message name
265	* @param string $group group name
266	*
267	* @return Check this instance for fluent API support
268	*/
269	protected function addInfo($text = '', $name = null, $group = null)
270	{
271	if (null === $name) {
272	$name = $this->name;
273	}
274
275	if (null === $group) {
276	$group = $this->getDefaultGroupName();
277	}
278
279	$this->result->addMessage(new Message($name, $text, $group, Message::SEVERITY_INFO));
280
281	return $this;
282	}
283
284	/**
285	* Convenience method to add notification to the result
286	* (message severity is Message::SEVERITY_NOTICE).
287	*
288	* @param string $text message text
289	* @param string $name message name
290	* @param string $group group name
291	*
292	* @return Check this instance for fluent API support
293	*/
294	protected function addNotice($text = '', $name = null, $group = null)
295	{
296	if (null === $name) {
297	$name = $this->name;
298	}
299
300	if (null === $group) {
301	$group = $this->getDefaultGroupName();
302	}
303
304	$this->result->addMessage(new Message($name, $text, $group, Message::SEVERITY_NOTICE));
305
306	return $this;
307	}
308
309	/**
310	* Convenience method to add an error message to the
311	* result (message severity is Message::SEVERITY_ERROR).
312	*
313	* @param string $text message text
314	* @param string $name message name
315	* @param string $group group name
316	*
317	* @return Check this instance for fluent API support
318	*/
319	protected function addError($text = '', $name = null, $group = null)
320	{
321	if (null === $name) {
322	$name = $this->name;
323	}
324
325	if (null === $group) {
326	$group = $this->getDefaultGroupName();
327	}
328
329	$this->result->addMessage(new Message($name, $text, $group, Message::SEVERITY_ERROR));
330
331	return $this;
332	}
333
334	/**
335	* @return \Symfony\Component\Console\Helper\DialogHelper
336	*/
337	public function getDialogHelper()
338	{
339	return $this->command->getDialogHelper();
340	}
341
342	/**
343	* @return \Symfony\Component\Console\Output\OutputInterface
344	*/
345	public function getOutputStream()
346	{
347	return $this->command->getOutput();
348	}
349
350	/**
351	* @param \Environaut\Command\Command $command
352	*
353	* @return Check this instance for fluent API support
354	*/
355	public function setCommand(Command $command)
356	{
357	$this->command = $command;
358	return $this;
359	}
360
361	/**
362	* @return \Environaut\Command\Command
363	*/
364	public function getCommand()
365	{
366	return $this->command;
367	}
368
369	/**
370	* Returns a random string with the specified length and prefix (prefix is not part of the length).
371	*
372	* @param int $length
373	* @param string $prefix
374	*
375	* @return string
376	*/
377	public static function getRandomString($length = 8, $prefix = 'check_')
378	{
379	return $prefix . bin2hex(openssl_random_pseudo_bytes($length));
380	}
381	}