Implement a new kubectl transport

src/Factory/KubectlTransportFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Consolidation\SiteProcess\Factory;
+
+use Consolidation\SiteAlias\SiteAliasInterface;
+use Consolidation\SiteProcess\Transport\KubectlTransport;
+
+/**
+ * KubectlTransportFactory will create an KubectlTransport for applicable site aliases.
+ */
+class KubectlTransportFactory implements TransportFactoryInterface
+{
+ /**
+ * @inheritdoc
+ */
+ public function check(SiteAliasInterface $siteAlias)
+ {
+ return $siteAlias->has('kubectl');
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function create(SiteAliasInterface $siteAlias)
+ {
+ return new KubectlTransport($siteAlias);
+ }
+}

src/ProcessManager.php

@@ -2,6 +2,7 @@
 
 namespace Consolidation\SiteProcess;
 
+use Consolidation\SiteProcess\Factory\KubectlTransportFactory;
 use Consolidation\SiteProcess\Factory\VagrantTransportFactory;
 use Psr\Log\LoggerInterface;
 use Consolidation\SiteAlias\SiteAliasInterface;
@@ -68,6 +69,7 @@ public static function createDefault()
  public static function addTransports(ProcessManager $processManager)
  {
  $processManager->add(new SshTransportFactory());
+ $processManager->add(new KubectlTransportFactory());
  $processManager->add(new DockerComposeTransportFactory());
  $processManager->add(new VagrantTransportFactory());
 

src/Transport/KubectlTransport.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Consolidation\SiteProcess\Transport;
+
+use Consolidation\SiteProcess\SiteProcess;
+use Consolidation\SiteProcess\Util\Escape;
+use Consolidation\SiteAlias\SiteAliasInterface;
+use Consolidation\SiteProcess\Util\Shell;
+
+/**
+ * KubectlTransport knows how to wrap a command such that it runs in a container
+ * on Kubernetes via kubectl.
+ */
+class KubectlTransport implements TransportInterface
+{
+ /** @var bool */
+ protected $tty;
+
+ /** @var \Consolidation\SiteAlias\SiteAliasInterface */
+ protected $siteAlias;
+
+ public function __construct(SiteAliasInterface $siteAlias)
+ {
+ $this->siteAlias = $siteAlias;
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function configure(SiteProcess $process)
+ {
+ $this->tty = $process->isTty();
+ }
+
+ /**
+ * inheritdoc
+ */
+ public function wrap($args)
+ {
+ # TODO: How/where do we complain if a required argument is not available?
+ $namespace = $this->siteAlias->get('kubectl.namespace');
+ $tty = $this->tty && $this->siteAlias->get('kubectl.tty', false) ? "true" : "false";
+ $interactive = $this->tty && $this->siteAlias->get('kubectl.interactive', false) ? "true" : "false";
+ $resource = $this->siteAlias->get('kubectl.resource');
+ $container = $this->siteAlias->get('kubectl.container');
+
+ $transport = [
+ 'kubectl',
+ "--namespace=$namespace",
+ 'exec',
+ "--tty=$tty",
+ "--stdin=$interactive",
+ $resource,
+ ];
+ if ($container) {
+ $transport[] = "--container=$container";
+ }
+ $transport[] = "--";
+
+ return array_merge(
+ $transport,
+ Escape::argsForSite($this->siteAlias, $args)
+ );
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function addChdir($cd_remote, $args)
+ {
+ return array_merge(
+ [
+ 'cd',
+ $cd_remote,
+ Shell::op('&&'),
+ ],
+ $args
+ );
+ }
+
+}

src/Transport/TransportInterface.php

@@ -5,8 +5,8 @@
 use Consolidation\SiteProcess\SiteProcess;
 
 /**
- * SshTransport knows how to wrap a command such that it runs on a remote
- * system via the ssh cli.
+ * Transports know how to wrap a command such that it runs on a remote system
+ * via some other command.
  *
  * There is always a transport for every factory, and visa-versa.
  *

tests/Transport/KubectlTransportTest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Consolidation\SiteProcess;
+
+use Consolidation\SiteProcess\Transport\KubectlTransport;
+use PHPUnit\Framework\TestCase;
+use Consolidation\SiteAlias\SiteAlias;
+
+class KubectlTransportTest extends TestCase
+{
+ /**
+ * Data provider for testWrap.
+ */
+ public function wrapTestValues()
+ {
+ return [
+ // Everything explicit.
+ [
+ 'kubectl --namespace=vv exec --tty=false --stdin=false deploy/drupal --container=drupal -- ls',
+ [
+ 'kubectl' => [
+ 'tty' => false,
+ 'interactive' => false,
+ 'namespace' => 'vv',
+ 'resource' => 'deploy/drupal',
+ 'container' => 'drupal',
+ ]
+ ],
+ ],
+
+ // Minimal. Kubectl will pick a container.
+ [
+ 'kubectl --namespace=vv exec --tty=false --stdin=false deploy/drupal -- ls',
+ [
+ 'kubectl' => [
+ 'namespace' => 'vv',
+ 'resource' => 'deploy/drupal',
+ ]
+ ],
+ ],
+ ];
+ }
+
+ /**
+ * @dataProvider wrapTestValues
+ */
+ public function testWrap($expected, $siteAliasData)
+ {
+ $siteAlias = new SiteAlias($siteAliasData, '@alias.dev');
+ $dockerTransport = new KubectlTransport($siteAlias);
+ $actual = $dockerTransport->wrap(['ls']);
+ $this->assertEquals($expected, implode(' ', $actual));
+ }
+}