Feature test inflections

README.md

@@ -56,14 +56,23 @@ These packages will install when you install Terminus.
 
 ### Mac OS:
 
-`> brew tap *** TBD ***`
+`> brew install pantheon-systems/external/terminus` for stable version (currently 2.x)
 
-`> brew install *** TBD ***`
+`> brew install pantheon-systems/external/t3` for 3.x (currently alpha status)
 
 ### Ubuntu / WinWSL+Ubuntu:
 
 `*** TBD ***`
 
+## Testing
+
+To run the functional tests:
+
+1. If you need the basics (php, git, direnv, etc): `brew bundle install`
+2. For code coverage: `pecl install pcov`
+3. Prepare a new test site, e.g. make a new multidev in ci-terminus-composer
+4. Copy .env.dist to .env and make an .envrc to include it with `dotenv`, or copy .env.dist to .envrc and add `export` at the head of each line. Customize values as needed. Use `direnv allow` to enable automatic loading of environment variables needed for tests.
+5. Run `composer test:short` to run the short-running functional tests, `composer test:long` to run the ones that take a long time, or `coposer test:functional` to run all of them.
 
 
 | Command                   | Description                                                  | ⚖️ |

composer.json

@@ -13,7 +13,7 @@
   "minimum-stability": "stable",
   "prefer-stable": true,
   "require": {
-    "php": ">=7.4",
+    "php": ">=7.3",
     "ext-json": "*",
     "composer/composer": "^2",
     "composer/semver": "^3",
@@ -62,6 +62,7 @@
   "autoload-dev": {
     "psr-4": {
       "Pantheon\\Terminus\\Tests\\Functional\\": "tests/Functional/",
+      "Pantheon\\Terminus\\UnitTests\\": "tests/unit_tests/",
       "Pantheon\\Terminus\\FeatureTests\\": "tests/features/bootstrap/"
     },
     "classmap": [
@@ -74,6 +75,12 @@
   "scripts": {
     "build": "@phar:build",
     "test": "@test:functional",
+    "phar:install-tools": [
+      "gem install mime-types -v 2.6.2",
+      "curl -LSs https://box-project.github.io/box2/installer.php | php",
+      "mkdir -p tools",
+      "mv -f box.phar tools/box"
+    ],
     "phar:build": [
       "rm -Rf ./t3",
       "vendor/bin/phar-composer.phar build .",
@@ -135,6 +142,9 @@
     "cs": [
       "vendor/bin/phpcs --standard=tests/config/linting_ruleset.xml bin/t3 src tests/Functional"
     ],
+    "phpunit": [
+      "SHELL_INTERACTIVE=true phpunit --colors=always  -c tests/config/phpunit.xml.dist --debug"
+    ],
     "docs": [
       "vendor/bin/robo doc ./README.md",
       "git add README.md"

src/Collections/PaymentMethods.php

@@ -2,6 +2,7 @@
 
 namespace Pantheon\Terminus\Collections;
 
+use Pantheon\Terminus\Models\TerminusModel;
 use Pantheon\Terminus\Exceptions\TerminusException;
 use Pantheon\Terminus\Exceptions\TerminusNotFoundException;
 use Pantheon\Terminus\Models\PaymentMethod;
@@ -30,7 +31,7 @@ class PaymentMethods extends UserOwnedCollection
      * @throws TerminusException When there is more than one matching payment method
      * @throws TerminusNotFoundException When there are no matching payment methods
      */
-    public function get($id)
+    public function get($id): TerminusModel
     {
         $payment_methods = $this->all();
         if (isset($payment_methods[$id])) {

src/Collections/SavedTokens.php

@@ -44,13 +44,11 @@ public function add($model_data, array $options = [])
      */
     public function create($token_string)
     {
-        $token_nickname = "token-" . \uniqid();
-        $this->getContainer()->add($token_nickname, SavedToken::class)
-            ->addArguments([
-                (object)['token' => $token_string],
-                ['collection' => $this]
-            ]);
-        $token =  $this->getContainer()->get($token_nickname);
+        $token = new SavedToken(
+            (object)['token' => $token_string],
+            ['collection' => $this]
+        );
+        $this->getContainer()->inflect($token);
         $token->setDataStore($this->getDataStore());
         $user = $token->logIn();
         $user->fetch();

src/Collections/Sites.php

@@ -187,15 +187,11 @@ public function get($id): ?TerminusModel
             $uuid = $this->findUUIDByNameOrUUID($id);
             $site = $this->models[$uuid] ?? null;
             if (!$site instanceof Site) {
-                $nickname = 'site-' . $uuid;
-                $this->getContainer()->add($nickname, $this->collected_class)
-                    ->addArguments(
-                        [
-                            (object)['id' => $uuid],
-                            ['id' => $uuid, 'collection' => $this]
-                        ]
-                    );
-                $site = $this->getContainer()->get($nickname);
+                $site = new $this->collected_class(
+                    (object)['id' => $uuid],
+                    ['id' => $uuid, 'collection' => $this]
+                );
+                $this->getContainer()->inflect($site);
                 $site->fetch();
                 if (!$site->valid()) {
                     throw new TerminusException("Site is not valid!");

src/Collections/Tags.php

@@ -46,12 +46,11 @@ public function create($tag)
             "organizations/{$this->org_site_membership->getOrganization()->id}/tags",
             ['method' => 'put', 'form_params' => $params,]
         );
-        $this->getContainer()->add($this->collected_class)
-            ->addArguments([
-                (object)['id' => $tag],
-                ['collection' => $this],
-            ]);
-        $this->models[$tag] = $this->getContainer()->get($this->collected_class);
+        $this->models[$tag] = new $this->collected_class(
+            (object)['id' => $tag],
+            ['collection' => $this]
+        );
+        $this->getContainer()->inflect($this->models[$tag]);
         return $this->models[$tag];
     }
 

src/Collections/TerminusCollection.php

@@ -60,11 +60,8 @@ public function add($model_data, array $options = [])
             ['id' => $model_data->id, 'collection' => $this],
             $options
         );
-        $nickname = \uniqid($model_data->id);
-
-        $this->getContainer()->add($nickname, $this->collected_class)
-            ->addArguments([$model_data, $options]);
-        $model = $this->getContainer()->get($nickname);
+        $model = new $this->collected_class($model_data, $options);
+        $this->getContainer()->inflect($model);
         $this->models[$model_data->id] = $model;
         return $model;
     }

src/Collections/Workflows.php

@@ -91,7 +91,6 @@ function ($workflow) {
      */
     public function create($type, array $options = [])
     {
-
         $params = $options['params'] ?? [];
         $results = $this->request()->request(
             $this->getUrl(),
@@ -109,17 +108,15 @@ public function create($type, array $options = [])
                 ['error' => $results->getStatusCodeReason()]
             );
         }
-        $nickname = \uniqid(__CLASS__ . "-");
-        $this->getContainer()->add($nickname, $this->collected_class)
-            ->addArguments([
-                $results->getData(),
-                [
-                    'id' => $results->getData()->id,
-                    'collection' => $this,
-                    'owner' => $this->owner
-                ]
-            ]);
-        $model = $this->getContainer()->get($nickname);
+        $model = new $this->collected_class(
+            $results->getData(),
+            [
+                'id' => $results->getData()->id,
+                'collection' => $this,
+                'owner' => $this->owner
+            ]
+        );
+        $this->getContainer()->inflect($model);
         $this->add($model);
         return $model;
     }

src/Commands/AliasesCommand.php

@@ -93,22 +93,19 @@ protected function getAliasEmitters($options)
         $emitters = [];
 
         if ($this->emitterTypeMatches($emitterType, 'print', false)) {
-            $print_nickname = \uniqid(__METHOD__);
-            $this->getContainer()->add($print_nickname, PrintingEmitter::class)
-                ->addArguments([$this->output()]);
-            $emitters[] = $this->getContainer()->get($print_nickname);
+            $printingEmitter = new PrintingEmitter($this->output());
+            $this->getContainer()->inflect($printingEmitter);
+            $emitters[] = $printingEmitter;
         }
         if ($this->emitterTypeMatches($emitterType, 'php')) {
-            $php_nickname = \uniqid(__METHOD__);
-            $this->getContainer()->add($php_nickname, AliasesDrushRcEmitter::class)
-                ->addArguments([$location, $base_dir]);
-            $emitters[] = $this->getContainer()->get($php_nickname);
+            $drushRcEmitter = new AliasesDrushRcEmitter($location, $base_dir);
+            $this->getContainer()->inflect($drushRcEmitter);
+            $emitters[] = $drushRcEmitter;
         }
         if ($this->emitterTypeMatches($emitterType, 'yml')) {
-            $yml_nickname = \uniqid(__METHOD__);
-            $this->getContainer()->add($yml_nickname, DrushSitesYmlEmitter::class)
-                ->addArguments([$base_dir, $home, $target_name]);
-            $emitters[] = $this->getContainer()->get($yml_nickname);
+            $sitesYmlEmitter = new DrushSitesYmlEmitter($base_dir, $home, $target_name);
+            $this->getContainer()->inflect($sitesYmlEmitter);
+            $emitters[] = $sitesYmlEmitter;
         }
 
         return $emitters;

src/Commands/D9ify/ProcessCommand.php

@@ -85,9 +85,8 @@ public function process($sourceSite, $destinationSite = null, $options = [])
                 $sourceSiteObject = $this->getSite($sourceSite);
             }
             if (isset($sourceSiteObject) && $sourceSiteObject instanceof Site) {
-                $this->getContainer()->add("sourceDir", Directory::class)
-                    ->addArgument(['site' => $sourceSiteObject]);
-                $this->sourceDirectory = $this->getContainer()->get("sourceDir");
+                $this->sourceDirectory = new Directory(['site' => $sourceSiteObject]);
+                $this->getContainer()->inflect($this->sourceDirectory);
             }
 
             // Create destination Site if not exists or value is null.
@@ -115,8 +114,8 @@ public function process($sourceSite, $destinationSite = null, $options = [])
             }
 
             if (!isset($destinationSiteObject) || !$destinationSiteObject instanceof Site) {
-                $this->getContainer()->add(CreateCommand::class);
-                $createCommand = $this->getContainer()->get(CreateCommand::class);
+                $createCommand = new CreateCommand();
+                $this->getContainer()->inflect($createCommand);
                 $createCommand->create(
                     $destinationSite,
                     $destinationSite,
@@ -125,14 +124,12 @@ public function process($sourceSite, $destinationSite = null, $options = [])
                 );
                 $destinationSiteInfoCommand = $this->getContainer()->get(InfoCommand::class);
                 $destinationSiteInfo = $destinationSiteInfoCommand->info($destinationSite)->getArrayCopy();
-                $this->getContainer()->add('destinationSiteModel', Site::class)
-                    ->addArgument($destinationSiteInfo);
-                $destinationSiteObject = $this->getContainer()->get('destinationSiteModel');
+                $destinationSiteObject = new Site($destinationSiteInfo);
+                $this->getContainer()->inflect($destinationSiteObject);
             }
-            if (isset($destinationSiteObject) || $destinationSiteObject instanceof Site) {
-                $this->getContainer()->add('destinationDir', Directory::class)
-                    ->addArgument(['site' => $destinationSiteObject ]);
-                $this->destinationDirectory = $this->getContainer()->get('destinationDir');
+            if (isset($destinationSiteObject) && $destinationSiteObject instanceof Site) {
+                $this->destinationDirectory = new Directory(['site' => $destinationSiteObject ]);
+                $this->getContainer()->inflect($this->destinationDirectory);
             }
 
             if (!isset($this->sourceDirectory) || !isset($this->destinationDirectory)) {
@@ -643,8 +640,8 @@ protected function copyConfigFiles()
      */
     protected function downloadDatabase()
     {
-        $this->getContainer()->add(GetLiveDBCommand::class);
-        $downloadDbCommand = $this->getContainer()->get(GetLiveDBCommand::class);
+        $downloadDbCommand = new GetLiveDBCommand();
+        $this->getContainer()->inflect($downloadDbCommand);
         $downloadDbCommand->downloadLiveDbBackup($this->getSourceDirectory()->getSource());
     }
 
@@ -661,8 +658,8 @@ protected function downloadDatabase()
      */
     protected function downloadSourceSiteFilesDirectory()
     {
-        $this->getContainer()->add(GetLiveFilesCommand::class);
-        $downloadFilesCommand = $this->getContainer()->get(GetLiveFilesCommand::class);
+        $downloadFilesCommand = new GetLiveFilesCommand();
+        $this->getContainer()->inflect($downloadFilesCommand);
         $downloadFilesCommand->downloadLiveFilesBackup($this->getSourceDirectory()->getSource());
     }
 }

src/Commands/WorkflowProcessingTrait.php

@@ -18,10 +18,8 @@ trait WorkflowProcessingTrait
     public function processWorkflow(Workflow $workflow): ?Workflow
     {
         if ($this->input()->isInteractive()) {
-            $nickname = \uniqid(__METHOD__ . "-");
-            $this->getContainer()->add($nickname, WorkflowProgressBar::class)
-                ->addArguments([$this->output(), $workflow]);
-            $progressBar = $this->getContainer()->get($nickname);
+            $progressBar = new WorkflowProgressBar($this->output(), $workflow);
+            $this->getContainer()->inflect($progressBar);
             return $progressBar->cycle();
         }
         $retry_interval = $this->getConfig()->get('http_retry_delay_ms', 100);

src/Friends/OrganizationJoinTrait.php

@@ -29,11 +29,8 @@ public function getReferences()
     public function getOrganization()
     {
         if (empty($this->organization)) {
-            $nickname = \uniqid(__FUNCTION__ . "-");
-            $this->getContainer()
-                ->add($nickname, Organization::class)
-                ->addArgument($this->get('organization'));
-            $organization = $this->getContainer()->get($nickname);
+            $organization = new Organization($this->get('organization'));
+            $this->getContainer()->inflect($organization);
             $organization->memberships = [$this];
             $this->setOrganization($organization);
         }

src/Friends/ProfileTrait.php

@@ -21,10 +21,8 @@ trait ProfileTrait
     public function getProfile()
     {
         if (empty($this->profile)) {
-            $nickname = \uniqid(__FUNCTION__ . "-");
-            $this->getContainer()->add($nickname, Profile::class)
-                ->addArgument([$this->get('profile')]);
-            $profile = $this->getContainer()->get($nickname);
+            $profile = new Profile([$this->get('profile')]);
+            $this->getContainer()->inflect($profile);
             $this->setProfile($profile);
         }
         return $this->profile;

src/Friends/SiteJoinTrait.php

@@ -29,12 +29,7 @@ public function getReferences()
     public function getSite()
     {
         if (empty($this->site)) {
-            $nickname = \uniqid(__FUNCTION__ . "-");
-            $this->getContainer()
-                ->add($nickname, Site::class)
-                ->addArgument($this->get('site'));
-            $site = $this->getContainer()
-                ->get($nickname);
+            $site = new Site($this->get('site'));
             $site->memberships = [$this];
             $this->setSite($site);
         }

src/Friends/UserJoinTrait.php

@@ -29,11 +29,8 @@ public function getReferences()
     public function getUser()
     {
         if (empty($this->user)) {
-            $nickname = \uniqid(__FUNCTION__ . '-');
-            $this->getContainer()
-                ->add($nickname, User::class)
-                ->addArgument($this->get('user'));
-            $user = $this->getContainer()->get($nickname);
+            $user = new User($this->get('user'));
+            $this->getContainer()->inflect($user);
             $user->memberships = [$this];
             $this->setUser($user);
         }

src/Helpers/LocalMachineHelper.php

@@ -111,9 +111,8 @@ public function getFinder()
     public function getProgressBar(Process $process)
     {
         $process->start();
-        $nickname = \uniqid(__METHOD__ . "-");
-        $this->getContainer()->add($nickname, ProcessProgressBar::class)
-            ->addArguments([$this->output(), $process]);
+        $progressBar = new ProcessProgressBar($this->output(), $process);
+        $this->getContainer()->inflect($progressBar);
         return $this->getContainer()->get($nickname);
     }