Add git packages as VCS repositories #79

mortenscheel · 2019-06-21T00:17:43Z

I've changed the way packager:git works.
In stead of cloning the repository directly to the /packages/myVendor/myPackage folder, it is added as a VCS repository in composer.json and installed like any other package to the /vendor folder. After installing, it is symlinked to the /packages folder.

If the package origin is only specified as vendor/package in stead of a complete URL, it is assumed that the repository is located at https://github.com/vendor/package.

The packager:list command now has an extra column showing the Git status of the package. If packages are version controlled, it will whether they're Up to date, Ahead {number of commits} or Behind {number of commits}. If not, they're displayed as Not initialized.

I've add a couple of tests to ensure the new features are working correctly. They both clone your Jeroen-G/testassist repository, but it doesn't really matter which repository they use, if you want to change it to something else.

Let me know if anything needs to be changed.

/Morten

mortenscheel · 2019-06-21T09:11:32Z

Sorry about that. I'll take a look at the failing test case. I'll probably have it fixed later this weekend.

Allow package-skeleton to be cached. Only test download of skeleton once.

mortenscheel · 2019-06-22T15:55:37Z

Okay, looks like the tests are green again.
Note that I've added "cache_skeleton" => false to the config file, which allows for faster installs (and tests).

Regarding style rules, I've tried a few different settings and plugins for PhpStorm, but nothing seems to match the StyleCI laravel preset. Do you have any tips you want to share?

Jeroen-G · 2019-06-22T17:57:53Z

Perhaps you can also use the skeleton for the tests, or perhaps a proper composer.json is required?

Regarding styleci, I use their standard Laravel preset as far as I know: https://styleci.readme.io/docs/presets

Reuse package created by first test. Ensure composer commands are run without Xdebug enabled.

mortenscheel · 2019-06-23T16:08:06Z

Yeah, I've just changed the packager:git test use packager-skeleton. I couldn't make it work earlier, but now it does.

So... quite a lot of changes. I've tried my best to make the tests run faster, but I can't speed up the composer require/remove calls. I've probably even made them a bit slower, by adding optimize-autoloader => true to Testbench's composer.json. Without that change, I couldn't be 100% sure that the installed ServiceProvider was registered correctly in the autoload files.

I did manage to save some time, by not repeating the entire packager:new installation multiple times. After the first test, the resulting package (and the autoload-files created by Composer) are stored and reused later, to quickly install a "fake" package.

The "cached skeleton" feature is not used in the tests any longer, since the other way is much faster. So you're welcome to remove the feature if you like, but I figure maybe some users would want that option.

I've also refactored a lot of code, so most of my changes have ended up in traits. The intention was to make it less messy, but I'm open to your input if you want it structured differently.

Besides that, the biggest change is probably in the way I test whether packages packages are installed/removed correctly. I trust the tests a lot more now. And I've added a few extra assertions where I thought they made sense.

Anyhoo, let me know what you think.

Jeroen-G · 2019-06-23T19:11:19Z

At this point, the speed of the tests don't really bother me. The fact that you trust the tests more now is much more appealing to me!

Jeroen-G · 2019-06-23T19:12:13Z

src/ComposerHandler.php

+
+    /**
+     * Determines the path to Composer executable
+     * @todo Might not work on Windows


I have a Windows machine, so I will test this.

Cool. I've removed the @todo

Jeroen-G · 2019-06-23T19:15:41Z

tests/IntegratedTest.php

    }

+    /**
+     * @depends test_new_package_is_created


I didn't know about @depends, looks very clever.

I don't normally like writing tests that rely on other tests, but sometimes it's super convenient.

Jeroen-G · 2019-06-23T19:23:38Z

config/packager.php

@@ -7,6 +7,7 @@
     * Default: http://github.com/Jeroen-G/packager-skeleton/archive/master.zip
     */
    'skeleton' => 'http://github.com/Jeroen-G/packager-skeleton/archive/master.zip',
+    'cache_skeleton' => false,


What would be a proper place to document this? I'm thinking a line in just the config file might be enough?

Now I wonder if it's even worth keeping. The only benefit is that you save about a second of download time (if even that). On the other hands, it adds a layer of complexity, and people might end up using an outdated skeleton without knowing it.

Jeroen-G · 2019-06-23T19:28:55Z

src/ComposerHandler.php

+     * @todo Might not work on Windows
+     * @return string
+     */
+    protected static function getComposerExecutable(): string


Why did you choose to make this (and the ones below) static?

Hmm. Mostly just for convenience and old habits.
The whole initial setup of the Testbench environment runs in a static context (setupBeforeClass), before Laravel has even been initialized. This is necessary because I can't switch the app's base_path once it's already up and running.
But honestly I should change it back to non-static, since I can just call the methods from the $instance variable. I just didn't notice earlier :)

Jeroen-G · 2019-06-23T19:30:54Z

src/ProcessRunner.php

+
+namespace JeroenG\Packager;
+
+trait ProcessRunner


Nice refactor 👍

Glad you like it. I considered calling the other one ComposerCommander or something like that, but decided to keep it boring...

mortenscheel · 2019-06-23T20:15:39Z

WTF. One of the tests fail now, but only in PHP 7.2.
I'll have to install 7.2 and figure out why. I may not have time to fix it tonight though.

Edit: Super weird. All tests are green when i run them on 7.2. But Travis is unhappy.

Jeroen-G · 2019-06-26T12:38:29Z

Have you tried installing a package with tests? So far I can't get those tests to work :/

Default timeout is 60 seconds, which is usually enough. Sometimes running composer require takes longer, especially when resolving a package version, which exists in multiple repositories

mortenscheel · 2019-07-06T14:10:59Z

The failing unit test was caused by a simple timeout, which is fixed now.

Have you tried installing a package with tests? So far I can't get those tests to work :/

Nope, I hadn't tried that until now, and I've been pulling my hair for a couple of hours without finding a good solution.
The root issue is that when you ´composer require´ a package, the package's dev-dependencies are ignored. Those are only installed if you run composer install in the package's root folder.

I tried using a composer merge-plugin which merges multiple composer.json files, but that only works if all the installed packages are compatible and don't have conflicting dependencies.

The way I see it, there's only one way to run package tests right now:

cd projects/vendor/name
composer install
./vendor/bin/phpunit

I tried writing a new Command to automate that workflow, but for some reason it won't work.

I'm afraid I'm all out of ideas here.

mortenscheel and others added 5 commits June 9, 2019 17:44

Install git packages through composer

2665e3c

Add git status column to packager:list output

88da7a3

Add test

0600850

Merge master

4cfe420

Update readme

3a2bd4a

mortenscheel added 2 commits June 22, 2019 17:22

Fix detection of git repository.

f642f7d

Allow package-skeleton to be cached. Only test download of skeleton once.

Use static cache folder regardless of environment

eb9c99d

mortenscheel added 3 commits June 23, 2019 16:54

Refactor helper methods to traits.

09e173a

Reuse package created by first test. Ensure composer commands are run without Xdebug enabled.

Fix trait collision.

3d6b2e5

Use packager-skeleton for git test

7b0f6bd

Jeroen-G reviewed Jun 23, 2019

View reviewed changes

Refactor static methods

e434f1b

Run process without timeout.

42261ac

Default timeout is 60 seconds, which is usually enough. Sometimes running composer require takes longer, especially when resolving a package version, which exists in multiple repositories

Jeroen-G force-pushed the master branch from c58c016 to cd577e3 Compare March 5, 2020 08:03

Jeroen-G added help wanted needs work labels Oct 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add git packages as VCS repositories #79

Add git packages as VCS repositories #79

mortenscheel commented Jun 21, 2019

mortenscheel commented Jun 21, 2019

mortenscheel commented Jun 22, 2019

Jeroen-G commented Jun 22, 2019

mortenscheel commented Jun 23, 2019

Jeroen-G commented Jun 23, 2019

Jeroen-G Jun 23, 2019

mortenscheel Jun 23, 2019

Jeroen-G Jun 23, 2019

mortenscheel Jun 23, 2019

Jeroen-G Jun 23, 2019

mortenscheel Jun 23, 2019

Jeroen-G Jun 23, 2019 •

edited

mortenscheel Jun 23, 2019

Jeroen-G Jun 23, 2019

mortenscheel Jun 23, 2019

mortenscheel commented Jun 23, 2019 •

edited

Jeroen-G commented Jun 26, 2019

mortenscheel commented Jul 6, 2019 •

edited

Add git packages as VCS repositories #79

Are you sure you want to change the base?

Add git packages as VCS repositories #79

Conversation

mortenscheel commented Jun 21, 2019

mortenscheel commented Jun 21, 2019

mortenscheel commented Jun 22, 2019

Jeroen-G commented Jun 22, 2019

mortenscheel commented Jun 23, 2019

Jeroen-G commented Jun 23, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jeroen-G Jun 23, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mortenscheel commented Jun 23, 2019 • edited

Jeroen-G commented Jun 26, 2019

mortenscheel commented Jul 6, 2019 • edited

Jeroen-G Jun 23, 2019 •

edited

mortenscheel commented Jun 23, 2019 •

edited

mortenscheel commented Jul 6, 2019 •

edited