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

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		0.00%	0 / 1		66.67%	2 / 3	CRAP		90.67%	68 / 75
Configurator		0.00%	0 / 1		66.67%	2 / 3	15.18		90.67%	68 / 75
getDefaultGroupName()					100.00%	1 / 1	1		100.00%	1 / 1
getDefaultSettingGroupName()					100.00%	1 / 1	2		100.00%	3 / 3
run()					0.00%	0 / 1	12.14		90.14%	64 / 71

1	<?php
2
3	namespace Environaut\Checks;
4
5	use Environaut\Checks\Check;
6
7	/**
8	* Basic check to ask the user for environment configuration settings.
9	*
10	* Supported parameters are:
11	* - "introduction": text to display before this check
12	* - "question": text to ask user for a value
13	* - "setting": name of setting variable
14	* - "setting_group": group the configured setting belongs to (for export; defaults to "config")
15	* - "choices": array of autocomplete values or choices for selection (depending on check configuration)
16	* - "default": default value if none is given by the user
17	* - "hidden": hidden question to user (e,g. for credentials)
18	* - "allow_fallback": allow fallback to visible input if hidden input does not work
19	* - "validator": class/method to use for validation of value - must return valid value or throw helpful exception
20	* - "max_attempts": maximum attempts if validator is specified
21	* - "confirm": simple yes/no confirmation question (only y/n are accepted answers)
22	* - "select": select value from the list of choices
23	*/
24	class Configurator extends Check
25	{
26	/**
27	* Default group of settings that this check stores in the result.
28	*/
29	const DEFAULT_SETTING_GROUP_NAME = 'config';
30
31	/**
32	* Default group name used in messages of the report.
33	* By default also used as default setting group name if not customized.
34	*/
35	const DEFAULT_CUSTOM_GROUP_NAME = 'Configuration';
36
37	/**
38	* Returns the default group name this check uses when none is specified.
39	*
40	* @return string default group name of the check
41	*/
42	public function getDefaultGroupName()
43	{
44	return self::DEFAULT_CUSTOM_GROUP_NAME;
45	}
46
47	/**
48	* Returns the default group name this check uses for settings when none is specified.
49	*
50	* @return string default group name of settings of this check
51	*/
52	public function getDefaultSettingGroupName()
53	{
54	if ($this->group !== self::DEFAULT_CUSTOM_GROUP_NAME) {
55	return $this->group;
56	}
57
58	return self::DEFAULT_SETTING_GROUP_NAME;
59	}
60
61	/**
62	* Asks the user a question and sets the answer as a setting on the result.
63	*
64	* @return boolean true if configuration could be added to the result; false otherwise
65	*
66	* @throws \InvalidArgumentException on setup errors like "choices" can't be interpreted
67	* @throws \RuntimeException in case "allow_fallback" is deactivated but the response can't be "hidden"
68	* @throws \RuntimeException if there is no data to read in the input stream
69	* @throws \Exception when the maximum number of attempts has been reached and no valid response has been given
70	*/
71	public function run()
72	{
73	$dialog = $this->getDialogHelper();
74	$output = $this->getOutputStream();
75
76	$output->writeln(PHP_EOL); // to get some margin to the progress bar
77
78	$introduction = $this->parameters->get('introduction', false);
79	if (false !== $introduction) {
80	$output->writeln($introduction);
81	$output->writeln('');
82	}
83
84	$name = $this->parameters->get('setting', $this->getName());
85	$setting_group = $this->parameters->get('setting_group');
86	$choices = $this->parameters->get('choices', array());
87	$default = $this->parameters->get('default', null);
88	$validator = $this->parameters->get('validator', false);
89	$hidden = (bool) $this->parameters->get('hidden', false);
90	$allow_fallback = (bool) $this->parameters->get('allow_fallback', false);
91	$max_attempts = $this->parameters->get('max_attempts', false);
92	$confirm = (bool) $this->parameters->get('confirm', false);
93	$select = (bool) $this->parameters->get('select', false);
94
95	if ($this->cache->has($name, $setting_group)) {
96	$cached_setting = $this->cache->get($name, $setting_group);
97	$this->addInfo(
98	"Setting [" . $cached_setting->getGroup() . "][$name] already configured. Using " .
99	'value: ' . var_export($cached_setting->getValue(), true)
100	);
101	// add cached value directly as cachable setting to the result of this check
102	$this->result->addSetting($cached_setting);
103
104	return true;
105	}
106
107	$question = '<question>' . $this->parameters->get('question', '"setting_question" is not set');
108
109	// a simple yes(no confirmation dialog
110	if ($confirm) {
111	$default = (bool) ($default === null ? true : $default);
112	$default_text = ($default ? 'y' : 'n');
113	$question .= "</question> (Type [y/n/<return>], default=$default_text): ";
114
115	$value = $dialog->askConfirmation($output, $question, $default);
116
117	$default_text = ($default ? 'enabled' : 'disabled');
118	$this->addInfo($name . ' is ' . $default_text);
119
120	$this->addCachableSetting($name, $value, $setting_group);
121
122	return true;
123	}
124
125	// add default value to question if specified
126	if (null !== $default) {
127	$question .= "</question> (Default: $default)";
128	} else {
129	$question .= '</question>';
130	}
131	$question .= ': ';
132
133	// selection dialog to choose values from a list of choices
134	if ($select) {
135	$value = $dialog->select($output, $question, $choices, $default, $max_attempts);
136	$this->addCachableSetting($name, $choices[$value], $setting_group);
137	$this->addInfo('Selected value for "' . $name . '" is "' . $choices[$value] . '".');
138
139	return true;
140	}
141
142	if (false !== $validator) { // use value validation?
143	if ($hidden) {
144	$value = $dialog->askHiddenResponseAndValidate(
145	$output,
146	$question,
147	$validator,
148	$max_attempts,
149	$allow_fallback
150	);
151	} else {
152	$value = $dialog->askAndValidate(
153	$output,
154	$question,
155	$validator,
156	$max_attempts,
157	$default,
158	$choices
159	);
160	}
161	} else { // do not use value validation
162	if ($hidden) {
163	$value = $dialog->askHiddenResponse($output, $question, $allow_fallback);
164	} else {
165	$value = $dialog->ask($output, $question, $default, $choices);
166	}
167	}
168
169	$this->addInfo('Successfully configured "' . $name . '".');
170	$this->addCachableSetting($name, $value, $setting_group);
171
172	$output->writeln('');
173
174	return true;
175	}
176	}