platformsh / legacy-cli Goto Github PK

Feedback from a customer: the command "platform build" should not depend on the tool successfully connecting to platform.sh to run.

Currently, if I want my local files and database to be in sync with what's on the server I have to take three steps:

Get the database:
drush sql-sync @XXX.master > database.sql
mysql < database.sql

Get the files:
rsync -zvr [project]-[branch]@ssh.eu.platform.sh:/app/public/sites/default/files/ ./www/sites/default/files/

But with the shared/settings.local.php file we should be able to do the SQL sync for the user. We should also be making a shared/files directory that gets symlinked into the local build (if we're not already).

As a convenience to the user, a command "platform ssh" which generates the ssh connection string needed to access the webserver.

eg:
ssh [email protected]

Open questions on behavior: Is it enough to print the string - can the user then hit return and initiate the ssh connection? Should we skip printing the command and just execute it?

This is from our documentation, but it's specific to if you've made your own Drush aliases: http://docs.commerceguys.com/platform/platform-quick-start-guide/001-mastering-the-basics.html

Copy the database using drush
Need to get a copy of your site’s database locally? The easiest way to do that is to use Drush and the sql-sync command. You’ll need to have Drush aliases setup for both your Platform site and your local site. If you are using the Platform CLI and you’ve run platform get [platform_id] for a project, then your Platform aliases have already been setup.

$ drush @sql-sync @platform.master @platform.local

^^ What's the best way to do something like that with the CLI (important to Augustin and Rusty for documentation)

$homeDir = shell_exec('cd ~ && pwd');

This function doesn't work on Windows.

Multi command shell needs to be in the form 'cd ~; pwd'

However this is multi line in the form

Path
----
C:\Users\dwkitchen

I probably had an old invalid token in ~/.platform anyway got a scary red error with no "next steps". deleting the file and logging back worked.

Welcome to Commerce Platform!

  [Guzzle\Http\Exception\ClientErrorResponseException]
  Client error response
  [status code] 401
  [reason phrase] Unauthorized
  [url] https://marketplace.commerceguys.com/api/platform/me``à

Since I have started using Platform I've been running into an issue that has caused frustration and I wanted to get feedback from the Platform team, or anyone that has run into this, as to how we handle this issue. The issue has to do with the way Platform creates a new folder in the 'builds' directory then uses a symlink for the www directory to actually display the site. This is causing a number of issues in my IDE (PHPStorm) and I have yet to find a good way to resolve it. By having so many items in the builds folder it makes things like object search and jumping to a declaration a bit trickier because I end up getting presented with a dialog asking me which object or declaration I'd like to look at, this list continues to grow as more builds are created. This adds a bit of extra time and adds the possibility I might click on the wrong one and be looking at out of date information. The number of builds also increases index time which can sometimes bog down the IDE/machine.

I've tried marking the builds folder as excluded in my PHPStorm project but when I do that it makes debugging more complex. Each time a request is made to index.php it throws an error because that is now outside the scope of the project. I can configure PHPStorm to map the symlink properly but the next time I do a build I have to recreate that mapping in the IDE.

I'd just like to know if there are any suggestions on how to work around this. So far I've just accepted it but I'm afraid this is the sort of thing that might push people off when they try Platform.

eg:
ln -s builds/2014-05-17--13-41-13--master www

This way, when I run Platform in a VM, but there's a shared directory with the host OS, I can run sites off the codebase in the host OS. Otherwise, the symlink is absolute within the VM, and doesn't exist on the host OS; eg:

www -> /vagrant/src/dxbeehq4vvf7q/builds/2014-05-17--13-41-13--master

^^ doesn't exist on my MacOSX, but it's perfectaly valid within the Vagrant Box.

For consideration (I'm not 100% sold on this): platform documentation %{search terms}
or maybe
platform search %{search terms}

This would less the plaintext version of the online documentation.

Basically, I want a command in the CLI that does this:

php5 -r 'print_r(json_decode(base64_decode(getenv("PLATFORM_RELATIONSHIPS"))));'

From Dave Pullen: "Currently when creating a new platform project I have to manually add .gitignore to the .gitignore file, would be nice if that was just there by default."

The 'platform' application is not recognised as an application on Windows, I must run 'php platform' at the command line.

I will investigate and propose a patch.

Working (fresh) composer installation
~/workspace/playground(frega-test) $ composer -V
Composer version ac497feabaa0d247c441178b7b4aaa4c61b07399 2014-06-10 14:13:12

Other globally installed composer packages

  d11wtq/boris              v1.0.8             
  drupal/coder              7.2.2              Coder is a library and a module to review Drupal code.
  drush/drush               dev-master f13c248 Drush is a command line shell and scripting interface for Drupal, a veritable Swiss Army knife designed to make life easier for those of us who spend some of our w...
  pear/console_table        1.1.5              Class that makes it easy to build console style tables.
  squizlabs/php_codesniffer 1.5.2              PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.
  symfony/yaml              v2.2.1             Symfony Yaml Component

Drush-dev pins symfony/yaml on v2.2.1 (https://github.com/drush-ops/drush/blob/master/composer.json#L30) and installing platform-cli thus runs into this (dependency) issue:
~/workspace/playground(frega-test) $ composer global require "commerceguys/platform-cli=1.0.*"
Changed current directory to /home/frega/.composer
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

Problem 1
- Installation request for commerceguys/platform-cli 1.0.* -> satisfiable by commerceguys/platform-cli[v1.0.0].
- Conclusion: remove symfony/yaml v2.2.1
- commerceguys/platform-cli v1.0.0 requires symfony/yaml ~2.4 -> satisfiable by symfony/yaml[v2.4.0, v2.4.1, v2.4.2, v2.4.3, v2.4.4, v2.4.5, v2.4.6, v2.5.0].
- Can only install one of: symfony/yaml[v2.4.0, v2.2.1].
- Can only install one of: symfony/yaml[v2.4.1, v2.2.1].
- Can only install one of: symfony/yaml[v2.4.2, v2.2.1].
- Can only install one of: symfony/yaml[v2.4.3, v2.2.1].
- Can only install one of: symfony/yaml[v2.4.4, v2.2.1].
- Can only install one of: symfony/yaml[v2.4.5, v2.2.1].
- Can only install one of: symfony/yaml[v2.4.6, v2.2.1].
- Can only install one of: symfony/yaml[v2.5.0, v2.2.1].
- Installation request for symfony/yaml == 2.2.1.0 -> satisfiable by symfony/yaml[v2.2.1].

Is there a simple work-around?

It seems that Platform is missing a flag to specify what public key to use? Or is it an undocumented feature?

When deleting an environment with the CLI, it currently reports success, but doesn't actually delete the environment. The Platform API now supports this, but the CLI just needs to be updated.

I find 'init' and 'list' to be surprising. I would prefer "login" instead if init. and "list" should be reserved to list stuff like enviromenents or projects. "help" is there to list commands.

Also if possible: change the order of commands so project is before environement.

currently succesful build is silent

It would be nice to be able to clean old builds using platform project:build:clean.

Hi,

I did a:

$ composer global update

which resulted in:

Changed current directory to /Users/augustin/.composer
Loading composer repositories with package information
Updating dependencies (including require-dev)
Nothing to install or update
Writing lock file
Generating autoload files

And now, I'm getting errors when running any platform command:

Fatal error: Class 'CommerceGuys\Platform\Cli\Input\ArgvInput' not found in /Users/augustin/.composer/vendor/commerceguys/platform-cli/platform on line 21

Not sure how to debug this...

CLI should name the aliases based on the folder which has been set up during the get.

if everything I do gets merges... this is how the list command looks like.

Too many first level commands too many aliases shown and naming is incosistent.

I believe:

1. Anything that might be a plural should be a plural: so

domains
domain
  domain:add    
  domain:delete

should be

domains
  domains:add    
  domains:delete
  domains:list (or this could be simply domains which saves us a line!)

the same goes for ssh-keys

I wonder what we should do with project(s) and environement(s)

We might want less aliases (or not show them by default with platform list)

oh yeah and we need to hide _completion

Using the --no-interaction option while running environment:synchronize needs to have the ability to specify Code and Database synchronization options. It currently responds with 'You must synchronize at least code or data.', since you can't specify what gets synchronized without interaction.

We should probably move to a plugin model with hooky hooks for detect / get, build and such... and only expose commands that are available in the context (no drush for symfony)

When running a command, the CLI should check the return status, and throw an exception if needed.

This should be implemented in a wrapper function.

The currently generated aliases look like this:

$aliases['master'] = array (
  'parent' => '@parent',
  'site' => 'example',
  'env' => 'master',
  'remote-host' => 'ssh.eu.platform.sh',
  'remote-user' => 'example-master',
);

However, the web root is not actually in the home folder of the user. By default it is in /app/public, but this is configurable in the .platform.app.yaml. I added 'root' => '/app/public' manually, but this should be happening by default, otherwise all drush commands won't work.

This waits for the operation to complete or time-out after a while (10 minutes?).

As a Platform CLI user, I want a Platform environment:status command that lets me know when an environment is done building.

An extra flag -f, should specify the return output format (JSON, XML, default=plaintext)

Statuses should be: Building, Ready, Unavailable, Active, Inactive.

It should ask couple of questions like: "toolstack"...

In README possibly prefer something like:

You should add platform directory to the PATH in ~/.bashrc, ~/.zshrc, ~/.profile or your shell's equivalent configuration file. You can do so by running the following command in the directory to which you cloned platform-cli

echo "export PATH=$PATH:${PWD}">>~/.bashrc;source ~/.bashrc

As mentioned by Rob in another issue about syncing

"We should also be making a shared/files directory that gets symlinked into the local build"

We should do this regardless of whether its building a profile or not.

1. We should probably test this on multiple platforms.
2. We should clarify in docs if this works on windows, fully or partially. (Note that since vista there is the mklink utility to create symlinks.)

I've often run into a situation where I do a "platform get [projectid]" and it fails (let's say I don't have my key uploaded). I then fix the problem (generate and upload a key), and then try to do the platform get. It fails again, however, because of this:

platform get [projectid]
The project directory '[projectid]' already exists.

It would be nice if the CLI were smart enough to clean up, or somehow not see this as a reason for failure.

Implement a platform command that copies an entire project from projectA to projectB, including branches Master (default) plus any of the comma separated branches, with an optional flag --all to move all branches.

The use case would be if you want to do a project with a set of custom modules as well as one or more contrib modules that you want to work on. Right now, the only repo you get is what platform puts in /repository. It would be good if platform build could be told to do drush make --working-copy so that contrib modules get made as actual repos that we can work on.

platform get dxbeehq4vvf7q
Enter a number to choose which environment to checkout:
[0] : Master
0

^^ Preferred behavior would be to just grab Master, as it is the only branch, and to tell me that it is grabbing Master.

'which' command does not exist on windows as used in checkRequirements()

could use 'git version' and 'drush version'

We need some commands to handle domains via the CLI (domain, domain:add, domain:delete).

Adding the output of platform list to the .md file gives users a better chance to evaluate whether they want to use the tool:

platform list
Platform CLI version 0.1

Usage:
[options] command [arguments]

Options:
--help -h Display this help message.
--quiet -q Do not output any message.
--verbose -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
--version -V Display this application version.
--no-interaction -n Do not ask any interactive question.
--shell -s Launch the shell.

Available commands:
branch Branch an environment.
build Builds the current project.
checkout Checkout an environment.
drush Invoke a drush command using the site alias for the current environment.
environments Get a list of all environments.
get Does a git clone of the referenced project.
help Displays help for a command
list Lists commands
projects Get a list of all active projects.
ssh-keys Get a list of all added SSH keys.
environment
environment:backup Backup an environment.
environment:branch Branch an environment.
environment:checkout Checkout an environment.
environment:delete Delete an environment.
environment:merge Merge an environment.
environment:synchronize Synchronize an environment.
project
project:build Builds the current project.
project:delete Delete a project.
project:get Does a git clone of the referenced project.
ssh-key
ssh-key:add Add a new SSH key.
ssh-key:delete Delete an SSH key.

When I run:
drush @ed5tphi3zgcdy.dev-chil1 uli

I get:
A Drupal installation directory could not be found [error]

The aliases should point to the public folder of Platform instead of the root.

Synopsis:

platform get pxbzj2d3rq6rc
Cloning into 'pxbzj2d3rq6rc/repository'...
Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.```

... correct ssh key problem...

```platform get pxbzj2d3rq6rc
The project directory 'pxbzj2d3rq6rc' already exists.```

And therfor we need an ssh command that does not depend on drush.

This probably has wider ranging implications (how do we integrate, generically "buildpack" specific functionalities)

CLI should allow you to upload your own certificate to serve SSL requests on a custom domain (it's not available from the UI yet).

It would take 3 parameters:

• A private key
• A certificate signing this private key matching the custom domain (either in its Common Name or via the Subject Alternative Name extension)
• The authority chain of the certificate, i.e. the chain of certificates linking this certificate to a root certification authority.

When running platform get, if the repo can't be cloned (my case SSH key), the folder is still created.
After correcting issue I could not run platform get again as the folder already existed.

Right now I can't log out of my CLI session, but I'd like to be able to.

When running platform get on a new project with an empty rep

Cloning into 'ccywdbkeldadm/repository'...
warning: You appear to have cloned an empty repository.
Checking connectivity... done
PHP Warning:  copy(builds/2014-04-04--11-55-23--master/sites/default/settings.php): failed to open stream: No such file or directory in /home/dwkitchen/Git/platform-cli/src/Command/ProjectBuildCommand.php on line 103
PHP Warning:  unlink(builds/2014-04-04--11-55-23--master/sites/default/default.settings.php): No such file or directory in /home/dwkitchen/Git/platform-cli/src/Command/ProjectBuildCommand.php on line 104
PHP Warning:  mkdir(): No such file or directory in /home/dwkitchen/Git/platform-cli/src/Command/ProjectBuildCommand.php on line 141
PHP Warning:  symlink(): No such file or directory in /home/dwkitchen/Git/platform-cli/src/Command/ProjectBuildCommand.php on line 150