Refactor Platform.sh deploy.py

[ehmatthes]

• [x] Refactor Platform.sh deploy.py, based on experience of refactoring fly and simple_deploy.py.
• [x] Use a more consistent style for docstrings. See PEP 257. See also _get_deployed_project_name() as an example.
• [x] Run black.
• [ ] Run tests.
  • [x] local
  • [ ] e2e
• [x] Quick look at documentation
• [x] Finish simple refactoring.
• [x] Update CLI messages.
• [x] Merge.
• [x] Move bigger tasks to separate issue about extending support to multiple projects.

Resources

• cli reference

[ehmatthes]

Methods

• [x] __init__()
• [x] deploy()
• [x] _confirm_preliminary()
• [x] _confirm_automate_all()
• [x] _validate_platform()
• [x] _add_platformsh_settings()
• [x] _get_platformsh_settings()
• [x] _generate_platform_app_yaml()
• [x] _add_requirements()
• [x] _check_allowed_hosts()
• [x] _make_platform_dir()
• [x] _generate_services_yaml()
• [x] _conclude_automate_all()
• [x] _show_success_message()
• [x] _prep_automate_all()
• [x] _validate_cli()
• [ ] _get_platformsh_project_name()
  • [x] Parse csv instead of table.
  • [x] e2e test
  • [ ] Make sure this works when a project already exists. #307
  • [ ] e2e test
• [ ] _get_org_name()
  • [x] Parse csv instead of table.
  • [x] e2e test
  • [ ] Make sure this works for more than one org. #308
  • [ ] e2e test
• [x] _confirm_use_org_name()

[ehmatthes]

Working notes

• [x] Group yaml generation steps together.
• [x] Order of methods should roughly match what's listed in deploy().
• [x] Remove # fmt: off directive.
• [ ] Does this work if I have more than one project on Platform.sh?
  • [ ] Create a project. Then create a separate blog project and a new platform.sh project. Run platform project:info. What does the output look like? How can we have the user select the project to use? Model after Fly.io?
• [x] Use csv for any command where it's available.
  • [x] _get_deployed_project_name()
  • [x] _get_org_name()
• [x] Is re still needed? (No.)
• [ ] Move as much helper code to small, testable utility functions.
• [ ] Start writing unit tests in this platform-specific folder.

[ehmatthes]

Parse csv instead of default table

Output of platform project:into --yes --format csv:

$  platform project:info --yes --format csv  
Property,Value
id,<project-id>
created_at,2024-04-28T04:56:53+00:00
updated_at,2024-04-28T04:58:27+00:00
attributes,{  }
title,my_blog_project
description,
owner,<owner-hash>
namespace,platformsh
organization,<org-id>
default_branch,main
status,"code: provisioned
message: ok"
timezone,America/Denver
region,us-3.platform.sh
repository,"url: '<id>@git.us-3.platform.sh:<id>.git'
client_ssh_key: <redacted>
default_domain,
subscription,"<redacted>
plan: development
environments: 3
storage: 5120
included_users: 1
subscription_management_uri: 'https://console.platform.sh/-/users/<id>/...
restricted: false
suspended: false
user_licenses: 1"
...

[ehmatthes]

More notes

• [x] Clean up all this path handling work. Define the path once at the beginning of the method. Report we're looking for that specific path. If this is too much work updating tests, maybe save it for later.

[ehmatthes]

Closed by #309.