FilesExpand file tree

 master

/

ExecuteCommandTrait.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

114 lines (99 loc) · 3.25 KB

 master

/

ExecuteCommandTrait.php

Copy path

Top

File metadata and controls

• Code
• Blame

114 lines (99 loc) · 3.25 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

<?php

/**

* Copyright 2016 Google Inc.

*

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

*

* http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

*/

namespace Google\Cloud\TestUtils;

use Symfony\Component\Process\Process;

trait ExecuteCommandTrait

{

private static $workingDirectory;

private static $logger;

public static function setWorkingDirectory($workingDirectory)

{

self::$workingDirectory = $workingDirectory;

}

/**

* run a command

*

* @param $cmd

* @throws \Exception

*/

public static function execute($cmd, $timeout = false)

{

$process = self::createProcess($cmd, $timeout);

self::executeProcess($process);

return $process->getOutput();

}

/**

* Executes a Process and throws an exception

*

* @param Process $process

* @param bool $throwExceptionOnFailure

* @throws \Exception

*/

private static function executeProcess(Process $process, $throwExceptionOnFailure = true)

{

if (self::$logger) {

self::$logger->debug(sprintf('Executing: %s', $process->getCommandLine()));

}

$process->run(self::getCallback());

if (!$process->isSuccessful() && $throwExceptionOnFailure) {

$output = $process->getErrorOutput() ? $process->getErrorOutput() : $process->getOutput();

$msg = sprintf('Error executing "%s": %s', $process->getCommandLine(), $output);

throw new \Exception($msg);

}

return $process->isSuccessful();

}

/**

* @return Process

*/

private static function createProcess($cmd, $timeout = false)

{

$process = new Process($cmd);

$process->setWorkingDirectory(self::$workingDirectory);

if (false !== $timeout) {

$process->setTimeout($timeout);

}

return $process;

}

private static function getCallback()

{

if (self::$logger) {

$logger = self::$logger;

return function ($type, $line) use ($logger) {

if ($type === 'err') {

$logger->error($line);

} else {

$logger->debug($line);

}

};

}

}

protected static function executeWithRetry($cmd, $timeout = false, $retries = 3)

{

$process = self::createProcess($cmd, $timeout);

for ($i = 0; $i <= $retries; $i++) {

// only allow throwing exceptions on final attempt

$throwExceptionOnFailure = $i == $retries;

if (self::executeProcess($process, $throwExceptionOnFailure)) {

return true;

}

if (self::$logger && $i < $retries) {

self::$logger->debug('Retrying the command: ' . $cmd);

}

}

return false;

}

}