ensureInstalled() public method

Ensure that the Git CLI is installed.
public ensureInstalled ( )
コード例 #1
0
 /**
  * Test GitHelper::ensureInstalled().
  */
 public function testEnsureInstalled()
 {
     try {
         $this->gitHelper->ensureInstalled();
     } catch (\Exception $e) {
         $this->fail();
     }
 }
コード例 #2
0
 /**
  * @param string $dir
  *
  * @throws \RuntimeException
  *   If the directory is not a clone of a Platform.sh Git repository.
  *
  * @return string|false
  *   The project ID, or false if it cannot be determined.
  */
 protected function getProjectIdFromGit($dir)
 {
     if (!file_exists("{$dir}/.git")) {
         throw new \RuntimeException('The directory is not a Git repository');
     }
     $gitHelper = new GitHelper();
     $gitHelper->ensureInstalled();
     $originUrl = $gitHelper->getConfig("remote.origin.url", $dir);
     if (!$originUrl) {
         throw new \RuntimeException("Git remote 'origin' not found");
     }
     if (!preg_match('/^([a-z][a-z0-9]{12})@git\\.[a-z\\-]+\\.platform\\.sh:\\1\\.git$/', $originUrl, $matches)) {
         throw new \RuntimeException("The Git remote 'origin' is not a Platform.sh URL");
     }
     return $matches[1];
 }
コード例 #3
0
 /**
  * Ensure there are appropriate Git remotes in the repository.
  *
  * @param string $dir
  * @param string $url
  */
 public function ensureGitRemote($dir, $url)
 {
     if (!file_exists($dir . '/.git')) {
         throw new \InvalidArgumentException('The directory is not a Git repository');
     }
     $gitHelper = new GitHelper();
     $gitHelper->ensureInstalled();
     $gitHelper->setDefaultRepositoryDir($dir);
     $currentUrl = $gitHelper->getConfig("remote." . $this->config->get('detection.git_remote_name') . ".url", $dir);
     if (!$currentUrl) {
         $gitHelper->execute(['remote', 'add', $this->config->get('detection.git_remote_name'), $url], $dir, true);
     } elseif ($currentUrl != $url) {
         $gitHelper->execute(['remote', 'set-url', $this->config->get('detection.git_remote_name'), $url], $dir, true);
     }
     // Add an origin remote too.
     if ($this->config->get('detection.git_remote_name') !== 'origin' && !$gitHelper->getConfig("remote.origin.url", $dir)) {
         $gitHelper->execute(['remote', 'add', 'origin', $url]);
     }
 }
コード例 #4
0
 protected function execute(InputInterface $input, OutputInterface $output)
 {
     $projectId = $input->getArgument('id');
     $environmentOption = $input->getOption('environment');
     $hostOption = $input->getOption('host');
     if (empty($projectId)) {
         if ($input->isInteractive() && ($projects = $this->getProjects(true))) {
             $projectId = $this->offerProjectChoice($projects, $input);
         } else {
             $this->stdErr->writeln("<error>You must specify a project.</error>");
             return 1;
         }
     } else {
         $result = $this->parseProjectId($projectId);
         $projectId = $result['projectId'];
         $hostOption = $hostOption ?: $result['host'];
         $environmentOption = $environmentOption ?: $result['environmentId'];
     }
     $project = $this->getProject($projectId, $hostOption, true);
     if (!$project) {
         $this->stdErr->writeln("<error>Project not found: {$projectId}</error>");
         return 1;
     }
     $environments = $this->getEnvironments($project);
     if ($environmentOption) {
         if (!isset($environments[$environmentOption])) {
             // Reload the environments list.
             $environments = $this->getEnvironments($project, true);
             if (!isset($environments[$environmentOption])) {
                 $this->stdErr->writeln("Environment not found: <error>{$environmentOption}</error>");
             }
             return 1;
         }
         $environment = $environmentOption;
     } elseif (count($environments) === 1) {
         $environment = key($environments);
     } else {
         $environment = 'master';
     }
     /** @var \Platformsh\Cli\Helper\PlatformQuestionHelper $questionHelper */
     $questionHelper = $this->getHelper('question');
     $directory = $input->getArgument('directory');
     if (empty($directory)) {
         $slugify = new Slugify();
         $directory = $project->title ? $slugify->slugify($project->title) : $project->id;
         $directory = $questionHelper->askInput('Directory', $input, $this->stdErr, $directory);
     }
     if ($projectRoot = $this->getProjectRoot()) {
         if (strpos(realpath(dirname($directory)), $projectRoot) === 0) {
             $this->stdErr->writeln("<error>A project cannot be cloned inside another project.</error>");
             return 1;
         }
     }
     /** @var \Platformsh\Cli\Helper\FilesystemHelper $fsHelper */
     $fsHelper = $this->getHelper('fs');
     // Create the directory structure.
     $existed = false;
     if (file_exists($directory)) {
         $existed = true;
         $this->stdErr->writeln("The directory <error>{$directory}</error> already exists");
         if (file_exists($directory . '/' . LocalProject::PROJECT_CONFIG) && $questionHelper->confirm("Overwrite?", $input, $this->stdErr, false)) {
             $fsHelper->remove($directory);
         } else {
             return 1;
         }
     }
     mkdir($directory);
     $projectRoot = realpath($directory);
     if (!$projectRoot) {
         throw new \Exception("Failed to create project directory: {$directory}");
     }
     if ($existed) {
         $this->stdErr->writeln("Re-created project directory: {$directory}");
     } else {
         $this->stdErr->writeln("Created new project directory: {$directory}");
     }
     $cleanUp = function () use($projectRoot, $fsHelper) {
         $fsHelper->remove($projectRoot);
     };
     $local = new LocalProject();
     $hostname = parse_url($project->getUri(), PHP_URL_HOST) ?: null;
     $local->createProjectFiles($projectRoot, $project->id, $hostname);
     // Prepare to talk to the Platform.sh repository.
     $gitUrl = $project->getGitUrl();
     $repositoryDir = $projectRoot . '/' . LocalProject::REPOSITORY_DIR;
     $gitHelper = new GitHelper(new ShellHelper($this->stdErr));
     $gitHelper->ensureInstalled();
     // First check if the repo actually exists.
     $repoHead = $gitHelper->execute(['ls-remote', $gitUrl, 'HEAD'], false);
     if ($repoHead === false) {
         // The ls-remote command failed.
         $cleanUp();
         $this->stdErr->writeln('<error>Failed to connect to the Platform.sh Git server</error>');
         // Suggest SSH key commands.
         $sshKeys = [];
         try {
             $sshKeys = $this->getClient(false)->getSshKeys();
         } catch (\Exception $e) {
             // Ignore exceptions.
         }
         if (!empty($sshKeys)) {
             $this->stdErr->writeln('');
             $this->stdErr->writeln('Please check your SSH credentials');
             $this->stdErr->writeln('You can list your keys with: <comment>platform ssh-keys</comment>');
         } else {
             $this->stdErr->writeln('You probably need to add an SSH key, with: <comment>platform ssh-key:add</comment>');
         }
         return 1;
     } elseif (is_bool($repoHead)) {
         // The repository doesn't have a HEAD, which means it is empty.
         // We need to create the folder, run git init, and attach the remote.
         mkdir($repositoryDir);
         // Initialize the repo and attach our remotes.
         $this->stdErr->writeln("Initializing empty project repository");
         $gitHelper->execute(['init'], $repositoryDir, true);
         $this->stdErr->writeln("Adding Platform.sh Git remote");
         $local->ensureGitRemote($repositoryDir, $gitUrl);
         $this->stdErr->writeln("Your repository has been initialized and connected to <info>Platform.sh</info>!");
         $this->stdErr->writeln("Commit and push to the <info>{$environment}</info> branch and Platform.sh will build your project automatically");
         return 0;
     }
     // We have a repo! Yay. Clone it.
     $cloneArgs = ['--branch', $environment, '--origin', 'platform'];
     $cloned = $gitHelper->cloneRepo($gitUrl, $repositoryDir, $cloneArgs);
     if (!$cloned) {
         // The clone wasn't successful. Clean up the folders we created
         // and then bow out with a message.
         $cleanUp();
         $this->stdErr->writeln('<error>Failed to clone Git repository</error>');
         $this->stdErr->writeln('Please check your SSH credentials or contact Platform.sh support');
         return 1;
     }
     $gitHelper->updateSubmodules(true, $repositoryDir);
     $local->ensureGitRemote($repositoryDir, $gitUrl);
     $this->setProjectRoot($projectRoot);
     $this->stdErr->writeln("\nThe project <info>{$project->title}</info> was successfully downloaded to: <info>{$directory}</info>");
     // Return early if there is no code in the repository.
     if (!glob($repositoryDir . '/*')) {
         return 0;
     }
     // Ensure that Drush aliases are created.
     if (Drupal::isDrupal($projectRoot . '/' . LocalProject::REPOSITORY_DIR)) {
         $this->stdErr->writeln('');
         $this->runOtherCommand('local:drush-aliases', ['--group' => basename($directory)]);
     }
     // Launch the first build.
     $success = true;
     if ($input->getOption('build')) {
         // Launch the first build.
         $this->stdErr->writeln('');
         $this->stdErr->writeln('Building the project locally for the first time. Run <info>platform build</info> to repeat this.');
         $options = ['environmentId' => $environment, 'noClean' => true];
         $builder = new LocalBuild($options, $output);
         $success = $builder->buildProject($projectRoot);
     } else {
         $this->stdErr->writeln("\nYou can build the project with: " . "\n    cd {$directory}" . "\n    platform build");
     }
     return $success ? 0 : 1;
 }
コード例 #5
0
 protected function execute(InputInterface $input, OutputInterface $output)
 {
     $projectId = $input->getArgument('id');
     if (empty($projectId)) {
         if ($input->isInteractive() && ($projects = $this->getProjects(true))) {
             $projectId = $this->offerProjectChoice($projects, $input);
         } else {
             $this->stdErr->writeln("<error>You must specify a project.</error>");
             return 1;
         }
     }
     $project = $this->getProject($projectId, $input->getOption('host'));
     if (!$project) {
         $this->stdErr->writeln("<error>Project not found: {$projectId}</error>");
         return 1;
     }
     $directoryName = $input->getArgument('directory-name');
     if (empty($directoryName)) {
         $directoryName = $projectId;
     }
     if (file_exists($directoryName)) {
         $this->stdErr->writeln("<error>The project directory '{$directoryName}' already exists.</error>");
         return 1;
     }
     if ($projectRoot = $this->getProjectRoot()) {
         if (strpos(realpath(dirname($directoryName)), $projectRoot) === 0) {
             $this->stdErr->writeln("<error>A project cannot be cloned inside another project.</error>");
             return 1;
         }
     }
     // Create the directory structure.
     mkdir($directoryName);
     $projectRoot = realpath($directoryName);
     if (!$projectRoot) {
         throw new \Exception("Failed to create project directory: {$directoryName}");
     }
     $this->stdErr->writeln("Created project directory: {$directoryName}");
     $local = new LocalProject();
     $hostname = parse_url($project->getUri(), PHP_URL_HOST) ?: null;
     $local->createProjectFiles($projectRoot, $projectId, $hostname);
     $environments = $this->getEnvironments($project, true);
     $environmentOption = $input->getOption('environment');
     if ($environmentOption) {
         if (!isset($environments[$environmentOption])) {
             $this->stdErr->writeln("<error>Environment not found: {$environmentOption}</error>");
             return 1;
         }
         $environment = $environmentOption;
     } elseif (count($environments) === 1) {
         $environment = key($environments);
     } elseif ($environments && $input->isInteractive()) {
         $environment = $this->offerEnvironmentChoice($environments, $input);
     } else {
         $environment = 'master';
     }
     /** @var \Platformsh\Cli\Helper\FilesystemHelper $fsHelper */
     $fsHelper = $this->getHelper('fs');
     // Prepare to talk to the Platform.sh repository.
     $gitUrl = $project->getGitUrl();
     $repositoryDir = $directoryName . '/' . LocalProject::REPOSITORY_DIR;
     $gitHelper = new GitHelper(new ShellHelper($this->stdErr));
     $gitHelper->ensureInstalled();
     // First check if the repo actually exists.
     $repoHead = $gitHelper->execute(array('ls-remote', $gitUrl, 'HEAD'), false);
     if ($repoHead === false) {
         // The ls-remote command failed.
         $fsHelper->rmdir($projectRoot);
         $this->stdErr->writeln('<error>Failed to connect to the Platform.sh Git server</error>');
         $this->stdErr->writeln('Please check your SSH credentials or contact Platform.sh support');
         return 1;
     } elseif (is_bool($repoHead)) {
         // The repository doesn't have a HEAD, which means it is empty.
         // We need to create the folder, run git init, and attach the remote.
         mkdir($repositoryDir);
         // Initialize the repo and attach our remotes.
         $this->stdErr->writeln("<info>Initializing empty project repository...</info>");
         $gitHelper->execute(array('init'), $repositoryDir, true);
         $this->stdErr->writeln("<info>Adding Platform.sh remote endpoint to Git...</info>");
         $local->ensureGitRemote($repositoryDir, $gitUrl);
         $this->stdErr->writeln("<info>Your repository has been initialized and connected to Platform.sh!</info>");
         $this->stdErr->writeln("<info>Commit and push to the {$environment} branch and Platform.sh will build your project automatically.</info>");
         return 0;
     }
     // We have a repo! Yay. Clone it.
     $cloneArgs = array('--branch', $environment, '--origin', 'platform');
     $cloned = $gitHelper->cloneRepo($gitUrl, $repositoryDir, $cloneArgs);
     if (!$cloned) {
         // The clone wasn't successful. Clean up the folders we created
         // and then bow out with a message.
         $fsHelper->rmdir($projectRoot);
         $this->stdErr->writeln('<error>Failed to clone Git repository</error>');
         $this->stdErr->writeln('Please check your SSH credentials or contact Platform.sh support');
         return 1;
     }
     $local->ensureGitRemote($repositoryDir, $gitUrl);
     $this->stdErr->writeln("The project <info>{$project->title}</info> was successfully downloaded to: <info>{$directoryName}</info>");
     // Ensure that Drush aliases are created.
     $this->setProjectRoot($projectRoot);
     $this->updateDrushAliases($project, $environments);
     // Allow the build to be skipped.
     if ($input->getOption('no-build')) {
         return 0;
     }
     // Always skip the build if the cloned repository is empty ('.', '..',
     // '.git' being the only found items)
     if (count(scandir($repositoryDir)) <= 3) {
         return 0;
     }
     // Launch the first build.
     $builder = new LocalBuild(array('environmentId' => $environment), $output);
     $success = $builder->buildProject($projectRoot);
     return $success ? 0 : 1;
 }
コード例 #6
0
 protected function execute(InputInterface $input, OutputInterface $output)
 {
     $projectId = $input->getArgument('id');
     $environmentOption = $input->getOption('environment');
     $hostOption = $input->getOption('host');
     if (empty($projectId)) {
         if ($input->isInteractive() && ($projects = $this->api()->getProjects(true))) {
             $projectId = $this->offerProjectChoice($projects, $input);
         } else {
             $this->stdErr->writeln("<error>You must specify a project.</error>");
             return 1;
         }
     } else {
         $result = $this->parseProjectId($projectId);
         $projectId = $result['projectId'];
         $hostOption = $hostOption ?: $result['host'];
         $environmentOption = $environmentOption ?: $result['environmentId'];
     }
     $project = $this->api()->getProject($projectId, $hostOption, true);
     if (!$project) {
         $this->stdErr->writeln("<error>Project not found: {$projectId}</error>");
         return 1;
     }
     $environments = $this->api()->getEnvironments($project);
     if ($environmentOption) {
         if (!isset($environments[$environmentOption])) {
             // Reload the environments list.
             $environments = $this->api()->getEnvironments($project, true);
             if (!isset($environments[$environmentOption])) {
                 $this->stdErr->writeln("Environment not found: <error>{$environmentOption}</error>");
             }
             return 1;
         }
         $environmentId = $environmentOption;
     } elseif (count($environments) === 1) {
         $environmentId = key($environments);
     } else {
         $environmentId = 'master';
     }
     $directory = $input->getArgument('directory');
     if (empty($directory)) {
         $slugify = new Slugify();
         $directory = $project->title ? $slugify->slugify($project->title) : $project->id;
         /** @var \Platformsh\Cli\Helper\QuestionHelper $questionHelper */
         $questionHelper = $this->getHelper('question');
         $directory = $questionHelper->askInput('Directory', $directory);
     }
     if ($projectRoot = $this->getProjectRoot()) {
         if (strpos(realpath(dirname($directory)), $projectRoot) === 0) {
             $this->stdErr->writeln("<error>A project cannot be cloned inside another project.</error>");
             return 1;
         }
     }
     // Create the directory structure.
     if (file_exists($directory)) {
         $this->stdErr->writeln("The directory <error>{$directory}</error> already exists");
         return 1;
     }
     if (!($parent = realpath(dirname($directory)))) {
         throw new \Exception("Not a directory: " . dirname($directory));
     }
     $projectRoot = $parent . '/' . basename($directory);
     // Prepare to talk to the remote repository.
     $gitUrl = $project->getGitUrl();
     $gitHelper = new GitHelper(new ShellHelper($this->stdErr));
     $gitHelper->ensureInstalled();
     // First check if the repo actually exists.
     try {
         $exists = $gitHelper->remoteRepoExists($gitUrl);
     } catch (\Exception $e) {
         // The ls-remote command failed.
         $this->stdErr->writeln('<error>Failed to connect to the ' . self::$config->get('service.name') . ' Git server</error>');
         // Suggest SSH key commands.
         $sshKeys = [];
         try {
             $sshKeys = $this->api()->getClient(false)->getSshKeys();
         } catch (\Exception $e) {
             // Ignore exceptions.
         }
         if (!empty($sshKeys)) {
             $this->stdErr->writeln('');
             $this->stdErr->writeln('Please check your SSH credentials');
             $this->stdErr->writeln('You can list your keys with: <comment>' . self::$config->get('application.executable') . ' ssh-keys</comment>');
         } else {
             $this->stdErr->writeln('You probably need to add an SSH key, with: <comment>' . self::$config->get('application.executable') . ' ssh-key:add</comment>');
         }
         return 1;
     }
     $projectConfig = ['id' => $projectId];
     $host = parse_url($project->getUri(), PHP_URL_HOST);
     if ($host) {
         $projectConfig['host'] = $host;
     }
     // If the remote repository exists, then locally we need to create the
     // folder, run git init, and attach the remote.
     if (!$exists) {
         $this->stdErr->writeln('Creating project directory: <info>' . $directory . '</info>');
         if (mkdir($projectRoot) === false) {
             $this->stdErr->writeln('Failed to create the project directory.');
             return 1;
         }
         // Initialize the repo and attach our remotes.
         $this->debug('Initializing the repository');
         $gitHelper->init($projectRoot, true);
         // As soon as there is a Git repo present, add the project config file.
         $this->localProject->writeCurrentProjectConfig($projectConfig, $projectRoot);
         $this->debug('Adding Git remote(s)');
         $this->localProject->ensureGitRemote($projectRoot, $gitUrl);
         $this->stdErr->writeln('');
         $this->stdErr->writeln('Your project has been initialized and connected to <info>' . self::$config->get('service.name') . '</info>!');
         $this->stdErr->writeln('');
         $this->stdErr->writeln('Commit and push to the <info>master</info> branch of the <info>' . self::$config->get('detection.git_remote_name') . '</info> Git remote, and ' . self::$config->get('service.name') . ' will build your project automatically.');
         return 0;
     }
     // We have a repo! Yay. Clone it.
     $projectLabel = $this->api()->getProjectLabel($project);
     $this->stdErr->writeln('Downloading project ' . $projectLabel);
     $cloneArgs = ['--branch', $environmentId, '--origin', self::$config->get('detection.git_remote_name')];
     if ($output->isDecorated()) {
         $cloneArgs[] = '--progress';
     }
     $cloned = $gitHelper->cloneRepo($gitUrl, $projectRoot, $cloneArgs);
     if ($cloned === false) {
         // The clone wasn't successful. Clean up the folders we created
         // and then bow out with a message.
         $this->stdErr->writeln('<error>Failed to clone Git repository</error>');
         $this->stdErr->writeln('Please check your SSH credentials or contact ' . self::$config->get('service.name') . ' support');
         return 1;
     }
     $this->setProjectRoot($projectRoot);
     $this->localProject->writeCurrentProjectConfig($projectConfig, $projectRoot);
     $this->localProject->ensureGitRemote($projectRoot, $gitUrl);
     $gitHelper->updateSubmodules(true, $projectRoot);
     $this->stdErr->writeln("\nThe project <info>{$projectLabel}</info> was successfully downloaded to: <info>{$directory}</info>");
     // Return early if there is no code in the repository.
     if (!glob($projectRoot . '/*', GLOB_NOSORT)) {
         return 0;
     }
     // Ensure that Drush aliases are created.
     if (Drupal::isDrupal($projectRoot)) {
         $this->stdErr->writeln('');
         $this->runOtherCommand('local:drush-aliases', ['--group' => basename($directory)]);
     }
     // Launch the first build.
     $success = true;
     if ($input->getOption('build')) {
         // Launch the first build.
         $this->stdErr->writeln('');
         $this->stdErr->writeln('Building the project locally for the first time. Run <info>' . self::$config->get('application.executable') . ' build</info> to repeat this.');
         $options = ['no-clean' => true];
         $builder = new LocalBuild($options, self::$config, $output);
         $success = $builder->build($projectRoot);
     } else {
         $this->stdErr->writeln("\nYou can build the project with: " . "\n    cd {$directory}" . "\n    " . self::$config->get('application.executable') . " build");
     }
     return $success ? 0 : 1;
 }
コード例 #7
0
 /**
  * Test GitHelper::ensureInstalled().
  */
 public function testEnsureInstalled()
 {
     $this->gitHelper->ensureInstalled();
 }
コード例 #8
0
 /**
  * Ensure there are appropriate Git remotes in the repository.
  *
  * @param string $dir
  * @param string $url
  */
 public function ensureGitRemote($dir, $url)
 {
     if (!file_exists("{$dir}/.git")) {
         throw new \InvalidArgumentException('The directory is not a Git repository');
     }
     $gitHelper = new GitHelper();
     $gitHelper->ensureInstalled();
     $gitHelper->setDefaultRepositoryDir($dir);
     $platformUrl = $gitHelper->getConfig("remote.platform.url", $dir);
     if (!$platformUrl) {
         $gitHelper->execute(array('remote', 'add', 'platform', $url), $dir, true);
     } elseif ($platformUrl != $url) {
         $gitHelper->execute(array('remote', 'set-url', 'platform', $url), $dir, true);
     }
     // Add an origin remote too.
     if (!$gitHelper->getConfig("remote.origin.url", $dir)) {
         $gitHelper->execute(array('remote', 'add', 'origin', $url));
     }
 }