DrushDriver::decodeJsonOutput() - Code Metrics - Inspection of "Remove cruft (that can happen with remote aliases)..." - jhedstrom/DrupalDriver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#91)

unknown

created 2016-06-09 12:07 UTC

DrushDriver::decodeJsonOutput() A

↳ Parent: DrushDriver

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php

namespace Drupal\Driver;

use Drupal\Component\Utility\Random;
use Drupal\Driver\Exception\BootstrapException;

use Symfony\Component\Process\Process;

/**
 * Implements DriverInterface.
 */
class DrushDriver extends BaseDriver {
  /**
   * Store a drush alias for tests requiring shell access.
   *
   * @var string
   */
  public $alias;

  /**
   * Stores the root path to a Drupal installation.
   *
   * This is an alternative to using drush aliases.
   *
   * @var string
   */
  public $root;

  /**
   * Store the path to drush binary.
   *
   * @var string
   */
  public $binary;

  /**
   * Track bootstrapping.
   */
  private $bootstrapped = FALSE;

  /**
   * Random generator.
   *
   * @var \Drupal\Component\Utility\Random
   */
  private $random;

  /**
   * Global arguments or options for drush commands.
   *
   * @var string
   */
  private $arguments = '';

  /**
   * Set drush alias or root path.
   *
   * @param string $alias
   *   A drush alias.
   * @param string $root_path
   *   The root path of the Drupal install. This is an alternative to using
   *   aliases.
   * @param string $binary
   *   The path to the drush binary.
   * @param \Drupal\Component\Utility\Random $random
   *   Random generator.
   *
   * @throws \Drupal\Driver\Exception\BootstrapException
   *   Thrown when a required parameter is missing.
   */
  public function __construct($alias = NULL, $root_path = NULL, $binary = 'drush', Random $random = NULL) {
    if (!empty($alias)) {
      // Trim off the '@' symbol if it has been added.
      $alias = ltrim($alias, '@');

      $this->alias = $alias;
    }
    elseif (!empty($root_path)) {
      $this->root = realpath($root_path);
    }
    else {
      throw new BootstrapException('A drush alias or root path is required.');
    }

    $this->binary = $binary;

    if (!isset($random)) {
      $random = new Random();
    }
    $this->random = $random;
  }

  /**
   * {@inheritdoc}
   */
  public function getRandom() {
    return $this->random;
  }

  /**
   * {@inheritdoc}
   */
  public function bootstrap() {
    // Check that the given alias works.
    // @todo check that this is a functioning alias.
    // See http://drupal.org/node/1615450
    if (!isset($this->alias) && !isset($this->root)) {
      throw new BootstrapException('A drush alias or root path is required.');
    }
    $this->bootstrapped = TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function isBootstrapped() {
    return $this->bootstrapped;
  }

  /**
   * {@inheritdoc}
   */
  public function userCreate(\stdClass $user) {
    $arguments = array(
      sprintf('"%s"', $user->name),
    );
    $options = array(
      'password' => $user->pass,
      'mail' => $user->mail,
    );
    $this->drush('user-create', $arguments, $options);
    if (isset($user->roles) && is_array($user->roles)) {
      foreach ($user->roles as $role) {
        $this->userAddRole($user, $role);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function userDelete(\stdClass $user) {
    $arguments = array(sprintf('"%s"', $user->name));
    $options = array(
      'yes' => NULL,
      'delete-content' => NULL,
    );
    $this->drush('user-cancel', $arguments, $options);
  }

  /**
   * {@inheritdoc}
   */
  public function userAddRole(\stdClass $user, $role) {
    $arguments = array(
      sprintf('"%s"', $role),
      sprintf('"%s"', $user->name),
    );
    $this->drush('user-add-role', $arguments);
  }

  /**
   * {@inheritdoc}
   */
  public function fetchWatchdog($count = 10, $type = NULL, $severity = NULL) {
    $options = array(
      'count' => $count,
      'type' => $type,
      'severity' => $severity,
    );
    return $this->drush('watchdog-show', array(), $options);
  }

  /**
   * {@inheritdoc}
   */
  public function clearCache($type = 'all') {
    $type = array($type);
    return $this->drush('cache-clear', $type, array());
  }

  /**
   * {@inheritdoc}
   */
  public function clearStaticCaches() {
    // The drush driver does each operation as a separate request;
    // therefore, 'clearStaticCaches' can be a no-op.
  }

  /**
   * Decodes JSON output returned by Drush.
   *
   * It will clean up any junk that may have appeared before the JSON.
   *
   * @param string $output
   *   The output from Drush.
   * @return object
   *   The decoded JSON object.
   */
  protected function decodeJsonOutput($output) {
    // Remove anything before the first '{'.
    $output = preg_replace('/^[^\{]*/', '', $output);
    return json_decode($output);
  }

  /**
   * {@inheritdoc}
   */
  public function createNode($node) {
    $result = $this->drush('behat', array('create-node', escapeshellarg(json_encode($node))), array());
    return $this->decodeJsonOutput($result);
  }

  /**
   * {@inheritdoc}
   */
  public function nodeDelete($node) {
    $this->drush('behat', array('delete-node', escapeshellarg(json_encode($node))), array());
  }

  /**
   * {@inheritdoc}
   */
  public function createTerm(\stdClass $term) {
    $result = $this->drush('behat', array('create-term', escapeshellarg(json_encode($term))), array());
    return $this->decodeJsonOutput($result);
  }

  /**
   * {@inheritdoc}
   */
  public function termDelete(\stdClass $term) {
    $this->drush('behat', array('delete-term', escapeshellarg(json_encode($term))), array());
  }

  /**
   * {@inheritdoc}
   */
  public function isField($entity_type, $field_name) {
    // If the Behat Drush Endpoint is not installed on the site-under-test,
    // then the drush() method will throw an exception. In this instance, we
    // want to treat all potential fields as non-fields.  This allows the
    // Drush Driver to work with certain built-in Drush capabilities (e.g.
    // creating users) even if the Behat Drush Endpoint is not available.
    try {
      $result = $this->drush('behat', array('is-field', escapeshellarg(json_encode(array($entity_type, $field_name)))), array());
      return $this->decodeJsonOutput($result);
    }
    catch (\Exception $e) {
      return FALSE;
    }
  }

  /**
   * Sets common drush arguments or options.
   *
   * @param string $arguments
   *   Global arguments to add to every drush command.
   */
  public function setArguments($arguments) {
    $this->arguments = $arguments;
  }

  /**
   * Get common drush arguments.
   */
  public function getArguments() {
    return $this->arguments;
  }

  /**
   * Parse arguments into a string.
   *
   * @param array $arguments
   *   An array of argument/option names to values.
   *
   * @return string
   *   The parsed arguments.
   */
  protected static function parseArguments(array $arguments) {
    $string = '';
    foreach ($arguments as $name => $value) {
      if (is_null($value)) {
        $string .= ' --' . $name;
      }
      else {
        $string .= ' --' . $name . '=' . $value;
      }
    }
    return $string;
  }

  /**
   * Execute a drush command.
   */
  public function drush($command, array $arguments = array(), array $options = array()) {
    $arguments = implode(' ', $arguments);

    // Disable colored output from drush.
    $options['nocolor'] = TRUE;
    $string_options = $this->parseArguments($options);

    $alias = isset($this->alias) ? "@{$this->alias}" : '--root=' . $this->root;

    // Add any global arguments.
    $global = $this->getArguments();

    $process = new Process("{$this->binary} {$alias} {$string_options} {$global} {$command} {$arguments}");
    $process->setTimeout(3600);
    $process->run();

    if (!$process->isSuccessful()) {
      throw new \RuntimeException($process->getErrorOutput());
    }

    // Some drush commands write to standard error output (for example enable
    // use drush_log which default to _drush_print_log) instead of returning a
    // string (drush status use drush_print_pipe).
    if (!$process->getOutput()) {
      return $process->getErrorOutput();
    }
    else {
      return $process->getOutput();
    }

  }

  /**
   * {@inheritdoc}
   */
  public function processBatch() {
    // Do nothing. Drush should internally handle any needs for processing
    // batch ops.
  }

  /**
   * {@inheritdoc}
   */
  public function runCron() {
    $this->drush('cron');
  }

  /**
   * Run Drush commands dynamically from a DrupalContext.
   */
  public function __call($name, $arguments) {
    return $this->drush($name, $arguments);
  }

}


1			<?php
2
3			namespace Drupal\Driver;
4
5			use Drupal\Component\Utility\Random;
6			use Drupal\Driver\Exception\BootstrapException;
7
8			use Symfony\Component\Process\Process;
9
10			/**
11			* Implements DriverInterface.
12			*/
13			class DrushDriver extends BaseDriver {
14			/**
15			* Store a drush alias for tests requiring shell access.
16			*
17			* @var string
18			*/
19			public $alias;
20
21			/**
22			* Stores the root path to a Drupal installation.
23			*
24			* This is an alternative to using drush aliases.
25			*
26			* @var string
27			*/
28			public $root;
29
30			/**
31			* Store the path to drush binary.
32			*
33			* @var string
34			*/
35			public $binary;
36
37			/**
38			* Track bootstrapping.
39			*/
40			private $bootstrapped = FALSE;
41
42			/**
43			* Random generator.
44			*
45			* @var \Drupal\Component\Utility\Random
46			*/
47			private $random;
48
49			/**
50			* Global arguments or options for drush commands.
51			*
52			* @var string
53			*/
54			private $arguments = '';
55
56			/**
57			* Set drush alias or root path.
58			*
59			* @param string $alias
60			* A drush alias.
61			* @param string $root_path
62			* The root path of the Drupal install. This is an alternative to using
63			* aliases.
64			* @param string $binary
65			* The path to the drush binary.
66			* @param \Drupal\Component\Utility\Random $random
67			* Random generator.
68			*
69			* @throws \Drupal\Driver\Exception\BootstrapException
70			* Thrown when a required parameter is missing.
71			*/
72			public function __construct($alias = NULL, $root_path = NULL, $binary = 'drush', Random $random = NULL) {
73			if (!empty($alias)) {
74			// Trim off the '@' symbol if it has been added.
75			$alias = ltrim($alias, '@');
76
77			$this->alias = $alias;
78			}
79			elseif (!empty($root_path)) {
80			$this->root = realpath($root_path);
81			}
82			else {
83			throw new BootstrapException('A drush alias or root path is required.');
84			}
85
86			$this->binary = $binary;
87
88			if (!isset($random)) {
89			$random = new Random();
90			}
91			$this->random = $random;
92			}
93
94			/**
95			* {@inheritdoc}
96			*/
97			public function getRandom() {
98			return $this->random;
99			}
100
101			/**
102			* {@inheritdoc}
103			*/
104			public function bootstrap() {
105			// Check that the given alias works.
106			// @todo check that this is a functioning alias.
107			// See http://drupal.org/node/1615450
108			if (!isset($this->alias) && !isset($this->root)) {
109			throw new BootstrapException('A drush alias or root path is required.');
110			}
111			$this->bootstrapped = TRUE;
112			}
113
114			/**
115			* {@inheritdoc}
116			*/
117			public function isBootstrapped() {
118			return $this->bootstrapped;
119			}
120
121			/**
122			* {@inheritdoc}
123			*/
124			public function userCreate(\stdClass $user) {
125			$arguments = array(
126			sprintf('"%s"', $user->name),
127			);
128			$options = array(
129			'password' => $user->pass,
130			'mail' => $user->mail,
131			);
132			$this->drush('user-create', $arguments, $options);
133			if (isset($user->roles) && is_array($user->roles)) {
134			foreach ($user->roles as $role) {
135			$this->userAddRole($user, $role);
136			}
137			}
138			}
139
140			/**
141			* {@inheritdoc}
142			*/
143			public function userDelete(\stdClass $user) {
144			$arguments = array(sprintf('"%s"', $user->name));
145			$options = array(
146			'yes' => NULL,
147			'delete-content' => NULL,
148			);
149			$this->drush('user-cancel', $arguments, $options);
150			}
151
152			/**
153			* {@inheritdoc}
154			*/
155			public function userAddRole(\stdClass $user, $role) {
156			$arguments = array(
157			sprintf('"%s"', $role),
158			sprintf('"%s"', $user->name),
159			);
160			$this->drush('user-add-role', $arguments);
161			}
162
163			/**
164			* {@inheritdoc}
165			*/
166			public function fetchWatchdog($count = 10, $type = NULL, $severity = NULL) {
167			$options = array(
168			'count' => $count,
169			'type' => $type,
170			'severity' => $severity,
171			);
172			return $this->drush('watchdog-show', array(), $options);
173			}
174
175			/**
176			* {@inheritdoc}
177			*/
178			public function clearCache($type = 'all') {
179			$type = array($type);
180			return $this->drush('cache-clear', $type, array());
181			}
182
183			/**
184			* {@inheritdoc}
185			*/
186			public function clearStaticCaches() {
187			// The drush driver does each operation as a separate request;
188			// therefore, 'clearStaticCaches' can be a no-op.
189			}
190
191			/**
192			* Decodes JSON output returned by Drush.
193			*
194			* It will clean up any junk that may have appeared before the JSON.
195			*
196			* @param string $output
197			* The output from Drush.
198			* @return object
199			* The decoded JSON object.
200			*/
201			protected function decodeJsonOutput($output) {
202			// Remove anything before the first '{'.
203			$output = preg_replace('/^[^\{]*/', '', $output);
204			return json_decode($output);
205			}
206
207			/**
208			* {@inheritdoc}
209			*/
210			public function createNode($node) {
211			$result = $this->drush('behat', array('create-node', escapeshellarg(json_encode($node))), array());
212			return $this->decodeJsonOutput($result);
213			}
214
215			/**
216			* {@inheritdoc}
217			*/
218			public function nodeDelete($node) {
219			$this->drush('behat', array('delete-node', escapeshellarg(json_encode($node))), array());
220			}
221
222			/**
223			* {@inheritdoc}
224			*/
225			public function createTerm(\stdClass $term) {
226			$result = $this->drush('behat', array('create-term', escapeshellarg(json_encode($term))), array());
227			return $this->decodeJsonOutput($result);
228			}
229
230			/**
231			* {@inheritdoc}
232			*/
233			public function termDelete(\stdClass $term) {
234			$this->drush('behat', array('delete-term', escapeshellarg(json_encode($term))), array());
235			}
236
237			/**
238			* {@inheritdoc}
239			*/
240			public function isField($entity_type, $field_name) {
241			// If the Behat Drush Endpoint is not installed on the site-under-test,
242			// then the drush() method will throw an exception. In this instance, we
243			// want to treat all potential fields as non-fields. This allows the
244			// Drush Driver to work with certain built-in Drush capabilities (e.g.
245			// creating users) even if the Behat Drush Endpoint is not available.
246			try {
247			$result = $this->drush('behat', array('is-field', escapeshellarg(json_encode(array($entity_type, $field_name)))), array());
248			return $this->decodeJsonOutput($result);
249			}
250			catch (\Exception $e) {
251			return FALSE;
252			}
253			}
254
255			/**
256			* Sets common drush arguments or options.
257			*
258			* @param string $arguments
259			* Global arguments to add to every drush command.
260			*/
261			public function setArguments($arguments) {
262			$this->arguments = $arguments;
263			}
264
265			/**
266			* Get common drush arguments.
267			*/
268			public function getArguments() {
269			return $this->arguments;
270			}
271
272			/**
273			* Parse arguments into a string.
274			*
275			* @param array $arguments
276			* An array of argument/option names to values.
277			*
278			* @return string
279			* The parsed arguments.
280			*/
281			protected static function parseArguments(array $arguments) {
282			$string = '';
283			foreach ($arguments as $name => $value) {
284			if (is_null($value)) {
285			$string .= ' --' . $name;
286			}
287			else {
288			$string .= ' --' . $name . '=' . $value;
289			}
290			}
291			return $string;
292			}
293
294			/**
295			* Execute a drush command.
296			*/
297			public function drush($command, array $arguments = array(), array $options = array()) {
298			$arguments = implode(' ', $arguments);
299
300			// Disable colored output from drush.
301			$options['nocolor'] = TRUE;
302			$string_options = $this->parseArguments($options);
303
304			$alias = isset($this->alias) ? "@{$this->alias}" : '--root=' . $this->root;
305
306			// Add any global arguments.
307			$global = $this->getArguments();
308
309			$process = new Process("{$this->binary} {$alias} {$string_options} {$global} {$command} {$arguments}");
310			$process->setTimeout(3600);
311			$process->run();
312
313			if (!$process->isSuccessful()) {
314			throw new \RuntimeException($process->getErrorOutput());
315			}
316
317			// Some drush commands write to standard error output (for example enable
318			// use drush_log which default to _drush_print_log) instead of returning a
319			// string (drush status use drush_print_pipe).
320			if (!$process->getOutput()) {
321			return $process->getErrorOutput();
322			}
323			else {
324			return $process->getOutput();
325			}
326
327			}
328
329			/**
330			* {@inheritdoc}
331			*/
332			public function processBatch() {
333			// Do nothing. Drush should internally handle any needs for processing
334			// batch ops.
335			}
336
337			/**
338			* {@inheritdoc}
339			*/
340			public function runCron() {
341			$this->drush('cron');
342			}
343
344			/**
345			* Run Drush commands dynamically from a DrupalContext.
346			*/
347			public function __call($name, $arguments) {
348			return $this->drush($name, $arguments);
349			}
350
351			}
352

jhedstrom / DrupalDriver

Pull Request — master (#91)

DrushDriver::decodeJsonOutput() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like