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

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		0.00%	0 / 1		25.00%	1 / 4	CRAP		58.46%	38 / 65
ExecutableCheck		0.00%	0 / 1		25.00%	1 / 4	19.67		58.46%	38 / 65
getDefaultGroupName()					100.00%	1 / 1	1		100.00%	1 / 1
getDefaultSettingGroupName()					0.00%	0 / 1	2.15		66.67%	2 / 3
run()					0.00%	0 / 1	3.06		81.40%	35 / 43
validExecutable($value)					0.00%	0 / 1	30		0.00%	0 / 18

1	<?php
2
3	namespace Environaut\Checks;
4
5	use Environaut\Checks\Check;
6
7	/**
8	* Check to get absolute paths to executable files that
9	* may be used within an application. As even paths to
10	* simple tools like "ls", "find" or "grep" may not be
11	* accessible in e.g. crontabs due to non-configured
12	* default PATH environment variables they can be searched
13	* and configured prior running the application (and thus
14	* always use the validated absolute executable paths).
15	*
16	* Supported parameters are:
17	* - "command": name of executable/command to check
18	* - "setting": name of setting to use for absolute path storage (for export)
19	* - "setting_group": name of settings group to use (for export; defaults to "config")
20	* - "question": question to ask the user (defaults to "Path to the executable [command]")
21	* - "default": default command or executable path to try (defaults to "/usr/bin/[command]")
22	* - "validator": validator callable to use (defaults to one, that uses "which" to find the path of the command)
23	* - "max_attempts": maximum number of attempts a user is allowed to have for correct input of a path
24	*/
25	class ExecutableCheck extends Check
26	{
27	/**
28	* Default group of settings that this check stores in the result.
29	*/
30	const DEFAULT_SETTING_GROUP_NAME = 'config';
31
32	/**
33	* Default group name used in messages of the report.
34	* By default also used as default setting group name if not customized.
35	*/
36	const DEFAULT_CUSTOM_GROUP_NAME = 'Executables';
37
38	/**
39	* Returns the default group name this check uses when none is specified.
40	*
41	* @return string default group name of the check
42	*/
43	public function getDefaultGroupName()
44	{
45	return self::DEFAULT_CUSTOM_GROUP_NAME;
46	}
47
48	/**
49	* Returns the default group name this check uses for settings when none is specified.
50	*
51	* @return string default group name of settings of this check
52	*/
53	public function getDefaultSettingGroupName()
54	{
55	if ($this->group !== self::DEFAULT_CUSTOM_GROUP_NAME) {
56	return $this->group;
57	}
58
59	return self::DEFAULT_SETTING_GROUP_NAME;
60	}
61
62	/**
63	* Ask user for an absolute path to the given executable or try to determine it
64	* by itself using the default value (on confirmation).
65	*
66	* @return boolean true
67	*
68	* @throws \InvalidArgumentException on setup errors like "choices" can't be interpreted or parameters being wrong
69	* @throws \RuntimeException if there is no data to read in the input stream
70	* @throws \Exception when the maximum number of attempts has been reached and no valid response has been given
71	*/
72	public function run()
73	{
74	$output = $this->getOutputStream();
75	$dialog = $this->getDialogHelper();
76
77	$command = $this->parameters->get('command', $this->getName());
78	$setting = $this->parameters->get('setting', 'cmd.' . $command);
79	$setting_group = $this->parameters->get('setting_group');
80	$default = $this->parameters->get('default', '/usr/bin/' . $command);
81	$choices = $this->parameters->get(
82	'choices',
83	array(
84	'/bin/',
85	'/usr/bin/',
86	'/usr/sbin/',
87	'/usr/local/bin/',
88	'/usr/local/sbin/',
89	)
90	);
91	$validator = $this->parameters->get('validator', array($this, 'validExecutable'));
92	$max_attempts = $this->parameters->get('max_attempts', false);
93
94	if ($this->cache->has($setting, $setting_group)) {
95	$cached_setting = $this->cache->get($setting, $setting_group);
96	$this->addInfo(
97	"Setting [" . $cached_setting->getGroup() . "][$setting] already configured. Using " .
98	'value: ' . var_export($cached_setting->getValue(), true)
99	);
100	$this->result->addSetting($cached_setting);
101	return true;
102	}
103
104	$question = '<question>' . $this->parameters->get(
105	'question',
106	'Path to the executable "' . $command . '"'
107	);
108
109	// add default value to question if specified
110	if (null !== $default) {
111	$question .= "</question> (Default: which $default)";
112	} else {
113	$question .= '</question>';
114	}
115	$question .= ': ';
116
117	// ask for path to executable with validation and autocomplete of common executable directories like /usr/bin
118	$absolute_executable_path = $dialog->askAndValidate(
119	$output,
120	$question,
121	$validator,
122	$max_attempts,
123	$default,
124	$choices
125	);
126
127	$this->addCachableSetting($setting, $absolute_executable_path, $setting_group);
128	$this->addInfo('Got path to executable "' . $command . '": ' . $absolute_executable_path);
129
130	return true;
131	}
132
133	/**
134	* Checks whether the given input value leads to an executable that
135	* matches the configured version_mask parameter.
136	*
137	* @param string $value path to an executable
138	*
139	* @return string absolute path to executable
140	*
141	* @throws \InvalidArgumentException in case of non-existing executable at the given path or version mismatch
142	*/
143	public function validExecutable($value)
144	{
145	$val = trim($value);
146
147	if (empty($val)) {
148	throw new \InvalidArgumentException(
149	'Not a valid executable path. Please specify a command (like "ls") or a path (like "/usr/bin/ls").'
150	);
151	}
152
153	$executable = trim(shell_exec('which ' . $val));
154	if (!$executable) {
155	throw new \InvalidArgumentException('Could not find executable: ' . $val);
156	}
157
158	$command = $this->parameters->get('command', $this->getName());
159	$cli_option = $this->parameters->get('version_parameter', '--version');
160	$version_mask = $this->parameters->get('version_mask', '/Version/');
161
162	if ($version_mask) {
163	$version_info_raw = trim(shell_exec('cat /dev/null \| ' . $executable . ' ' . $cli_option . ' 2>&1'));
164	if (!preg_match($version_mask, $version_info_raw, $matches, PREG_OFFSET_CAPTURE)) {
165	throw new \InvalidArgumentException(
166	'Could not get version information for "' . $command . '" using "' . $executable . '".'
167	);
168	}
169	}
170
171	return $executable;
172	}
173	}