Builder::pty() - Code Metrics - Inspection of "Native ssh tty option feature" - deployphp/deployer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#953)

unknown

created 2017-01-13 07:38 UTC

Builder::pty() A

↳ Parent: Builder

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1
ccs	0
cts	3
cp	0
crap	2
rs	9.4285

<?php
/* (c) Anton Medvedev <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Deployer\Server;

use Deployer\Builder\BuilderInterface;
use Deployer\Server\Password\AskPasswordGetter;
use Deployer\Server\Password\PasswordGetterInterface;

/**
 * Build server configuration
 */
class Builder implements BuilderInterface
{
    /**
     * @var Configuration
     */
    private $config;

    /**
     * @var Environment
     */
    protected $env;

    /**
     * Construct
     *
     * @param Configuration $config
     * @param Environment   $env
     */
    public function __construct(Configuration $config, Environment $env)
    {
        $this->config = $config;
        $this->env = $env;

        $env->setAsProtected('server', [
            'name' => $config->getName(),
            'host' => $config->getHost(),
            'port' => $config->getPort(),
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function user($name)
    {
        $this->config->setUser($name);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function password($password = null)
    {
        $password = $this->checkPassword($password);

        $this->config->setAuthenticationMethod(Configuration::AUTH_BY_PASSWORD);
        $this->config->setPassword($password);

        return $this;
    }

    /**
     * Define server host
     *
     * @param string $host
     *
     * @return BuilderInterface
     */
    public function host($host)
    {
        $this->config->setHost($host);

        return $this;
    }

    /**
     * Define server port
     *
     * @param int $port
     *
     * @return BuilderInterface
     */
    public function port($port)
    {
        $this->config->setPort($port);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function configFile($file = '~/.ssh/config')
    {
        $this->config->setAuthenticationMethod(Configuration::AUTH_BY_CONFIG);
        $this->config->setConfigFile($file);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function identityFile($publicKeyFile = '~/.ssh/id_rsa.pub', $privateKeyFile = '~/.ssh/id_rsa', $passPhrase = '')
    {
        $passPhrase = $this->checkPassword($passPhrase);

        if (is_null($publicKeyFile)) {
            // Use default value
            $publicKeyFile = '~/.ssh/id_rsa.pub';
        }

        if (is_null($privateKeyFile)) {
            // Use default value
            $privateKeyFile = '~/.ssh/id_rsa';
        }

        if (is_null($passPhrase)) {
            // Ask pass phrase before connection
            $passPhrase = AskPasswordGetter::createLazyGetter();
        }

        $this->config->setAuthenticationMethod(Configuration::AUTH_BY_IDENTITY_FILE);
        $this->config->setPublicKey($publicKeyFile);
        $this->config->setPrivateKey($privateKeyFile);
        $this->config->setPassPhrase($passPhrase);

        return $this;
    }

    /**
     * Authenticate with public key + password (2-factor)
     *
     * @param string $publicKeyFile
     * @param string $privateKeyFile
     * @param string $passPhrase
     * @param string $password
     *
     * @return BuilderInterface
     */
    public function identityFileAndPassword($publicKeyFile = '~/.ssh/id_rsa.pub', $privateKeyFile = '~/.ssh/id_rsa', $passPhrase = '', $password = null)
    {
        $this->identityFile($publicKeyFile, $privateKeyFile, $passPhrase);
        $this->password($password);
        $this->config->setAuthenticationMethod(Configuration::AUTH_BY_IDENTITY_FILE_AND_PASSWORD);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function pemFile($pemFile)
    {
        $this->config->setAuthenticationMethod(Configuration::AUTH_BY_PEM_FILE);
        $this->config->setPemFile($pemFile);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function forwardAgent()
    {
        $this->config->setAuthenticationMethod(Configuration::AUTH_BY_AGENT);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function set($name, $value)
    {
        $this->env->set($name, $value);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function stage($stages)
    {
        $this->env->set('stages', (array) $stages);

        return $this;
    }

    /**
     * Check password valid
     *
     * @param mixed $password
     *
     * @return mixed
     */
    private function checkPassword($password)
    {
        if (is_null($password)) {
            return AskPasswordGetter::createLazyGetter();
        }

        if (is_scalar($password)) {
            return $password;
        }

        if (is_object($password) && $password instanceof PasswordGetterInterface) {
            return $password;
        }

        // Invalid password
        throw new \InvalidArgumentException(sprintf(
            'The password should be a string or PasswordGetterInterface instances, but "%s" given.',
            is_object($password) ? get_class($password) : gettype($password)
        ));
    }

    /**
     * Use pty connection
     *
     * @param $pty
     * @return BuilderInterface
     */
    public function pty($pty)
    {
        $this->config->setPty($pty);

        return $this;
    }

    /**
     * Use pty in ssh2 connection
     *
     * @param $ssh2Pty
     * @deprecated
     * @return BuilderInterface
     */
    public function ssh2Pty($ssh2Pty)
    {
        $this->config->setSsh2Pty($ssh2Pty);


        return $this;
    }
}


1		<?php
2		/* (c) Anton Medvedev <[email protected]>
3		*
4		* For the full copyright and license information, please view the LICENSE
5		* file that was distributed with this source code.
6		*/
7
8		namespace Deployer\Server;
9
10		use Deployer\Builder\BuilderInterface;
11		use Deployer\Server\Password\AskPasswordGetter;
12		use Deployer\Server\Password\PasswordGetterInterface;
13
14		/**
15		* Build server configuration
16		*/
17		class Builder implements BuilderInterface
18		{
19		/**
20		* @var Configuration
21		*/
22		private $config;
23
24		/**
25		* @var Environment
26		*/
27		protected $env;
28
29		/**
30		* Construct
31		*
32		* @param Configuration $config
33		* @param Environment $env
34		*/
35	33	public function __construct(Configuration $config, Environment $env)
36		{
37	33	$this->config = $config;
38	33	$this->env = $env;
39
40	33	$env->setAsProtected('server', [
41	33	'name' => $config->getName(),
42	33	'host' => $config->getHost(),
43	33	'port' => $config->getPort(),
44	33	]);
45	33	}
46
47		/**
48		* {@inheritdoc}
49		*/
50	16	public function user($name)
51	16	{
52	2	$this->config->setUser($name);
53
54	2	return $this;
55		}
56
57		/**
58		* {@inheritdoc}
59		*/
60	6	public function password($password = null)
61		{
62	6	$password = $this->checkPassword($password);
63
64	4	$this->config->setAuthenticationMethod(Configuration::AUTH_BY_PASSWORD);
65	4	$this->config->setPassword($password);
66
67	4	return $this;
68		}
69
70		/**
71		* Define server host
72		*
73		* @param string $host
74		*
75		* @return BuilderInterface
76		*/
77	1	public function host($host)
78		{
79	1	$this->config->setHost($host);
80
81	1	return $this;
82		}
83
84		/**
85		* Define server port
86		*
87		* @param int $port
88		*
89		* @return BuilderInterface
90		*/
91	1	public function port($port)
92		{
93	1	$this->config->setPort($port);
94
95	1	return $this;
96		}
97
98		/**
99		* {@inheritdoc}
100		*/
101	1	public function configFile($file = '~/.ssh/config')
102		{
103	1	$this->config->setAuthenticationMethod(Configuration::AUTH_BY_CONFIG);
104	1	$this->config->setConfigFile($file);
105
106	1	return $this;
107		}
108
109		/**
110		* {@inheritdoc}
111		*/
112	3	public function identityFile($publicKeyFile = '~/.ssh/id_rsa.pub', $privateKeyFile = '~/.ssh/id_rsa', $passPhrase = '')
113		{
114	3	$passPhrase = $this->checkPassword($passPhrase);
115
116	3	if (is_null($publicKeyFile)) {
117		// Use default value
118	2	$publicKeyFile = '~/.ssh/id_rsa.pub';
119	2	}
120
121	3	if (is_null($privateKeyFile)) {
122		// Use default value
123	2	$privateKeyFile = '~/.ssh/id_rsa';
124	2	}
125
126	3	if (is_null($passPhrase)) {
127		// Ask pass phrase before connection
128		$passPhrase = AskPasswordGetter::createLazyGetter();
129		}
130
131	3	$this->config->setAuthenticationMethod(Configuration::AUTH_BY_IDENTITY_FILE);
132	3	$this->config->setPublicKey($publicKeyFile);
133	3	$this->config->setPrivateKey($privateKeyFile);
134	3	$this->config->setPassPhrase($passPhrase);
135
136	3	return $this;
137		}
138
139		/**
140		* Authenticate with public key + password (2-factor)
141		*
142		* @param string $publicKeyFile
143		* @param string $privateKeyFile
144		* @param string $passPhrase
145		* @param string $password
146		*
147		* @return BuilderInterface
148		*/
149		public function identityFileAndPassword($publicKeyFile = '~/.ssh/id_rsa.pub', $privateKeyFile = '~/.ssh/id_rsa', $passPhrase = '', $password = null)
150		{
151		$this->identityFile($publicKeyFile, $privateKeyFile, $passPhrase);
152		$this->password($password);
153		$this->config->setAuthenticationMethod(Configuration::AUTH_BY_IDENTITY_FILE_AND_PASSWORD);
154
155		return $this;
156		}
157
158		/**
159		* {@inheritdoc}
160		*/
161	1	public function pemFile($pemFile)
162		{
163	1	$this->config->setAuthenticationMethod(Configuration::AUTH_BY_PEM_FILE);
164	1	$this->config->setPemFile($pemFile);
165
166	1	return $this;
167		}
168
169		/**
170		* {@inheritdoc}
171		*/
172	2	public function forwardAgent()
173		{
174	2	$this->config->setAuthenticationMethod(Configuration::AUTH_BY_AGENT);
175
176	2	return $this;
177		}
178
179		/**
180		* {@inheritdoc}
181		*/
182	17	public function set($name, $value)
183		{
184	17	$this->env->set($name, $value);
185
186	17	return $this;
187		}
188
189		/**
190		* {@inheritdoc}
191		*/
192	3	public function stage($stages)
193		{
194	3	$this->env->set('stages', (array) $stages);
195
196	3	return $this;
197		}
198
199		/**
200		* Check password valid
201		*
202		* @param mixed $password
203		*
204		* @return mixed
205		*/
206	8	private function checkPassword($password)
207		{
208	8	if (is_null($password)) {
209	2	return AskPasswordGetter::createLazyGetter();
210		}
211
212	6	if (is_scalar($password)) {
213	3	return $password;
214		}
215
216	3	if (is_object($password) && $password instanceof PasswordGetterInterface) {
217	1	return $password;
218		}
219
220		// Invalid password
221	2	throw new \InvalidArgumentException(sprintf(
222	2	'The password should be a string or PasswordGetterInterface instances, but "%s" given.',
223	2	is_object($password) ? get_class($password) : gettype($password)
224	2	));
225		}
226
227		/**
228		* Use pty connection
229		*
230		* @param $pty
231		* @return BuilderInterface
232		*/
233		public function pty($pty)
234		{
235		$this->config->setPty($pty);
236
237		return $this;
238		}
239
240		/**
241		* Use pty in ssh2 connection
242		*
243		* @param $ssh2Pty
244		* @deprecated
245		* @return BuilderInterface
246		*/
247		public function ssh2Pty($ssh2Pty)
248		{
249		$this->config->setSsh2Pty($ssh2Pty);
		0 ignored issues – show Deprecated Code introduced 2017-01-13 07:40 UTC by Report Bug Copy Issue Report The method `Deployer\Server\Configuration::setSsh2Pty()` has been deprecated. This method has been deprecated. Loading history...
250
251		return $this;
252		}
253		}
254

deployphp / deployer

GitHub Access Token became invalid

Pull Request — master (#953)

Builder::pty() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like