Skip to content

MC-5465: Refactoring to use marketing edition labels in docs and options #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

MC-5465: Refactoring to use marketing edition labels in docs and options #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Any contributions that do not meet these requirements will not be accepted.

### Composer compatibility

Maintaining compatibility with the Composer versions listed in the [composer.json](composer.json) file is important for this project. Due to the way Composer works with plugins, the version that is used when the plugin runs is the local `composer.phar` executable version (as reported by `composer --version`) and not the version installed in the project's `vendor` folder or `composer.lock` file This means that in order to properly verify Composer compatibility, tests must be run against the local `composer.phar` executable, not just the installed `composer/composer` dependency.
Maintaining compatibility with the Composer versions listed in the [composer.json](composer.json) file is important for this project. Due to the way Composer works with plugins, the version that is used when the plugin runs is the local `composer.phar` executable version (as reported by `composer --version`) and not the version installed in the project's `vendor` folder or `composer.lock` file. This means that in order to properly verify Composer compatibility, tests must be run against the local `composer.phar` executable, not just the installed `composer/composer` dependency.

Additionally, because of the way the plugin interacts with the native `composer require` command, some parts of the Composer library sometimes need to be re-implemented in an accessible manner if the original code is in private methods or part of larger functions. Such implementations should be located in the [Magento\ComposerRootUpdatePlugin\ComposerReimplementation](src/Magento/ComposerRootUpdatePlugin/ComposerReimplementation) namespace and documented with the reason for re-implementation and a link to the original method.

Expand Down
34 changes: 17 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ If the local Magento installation has previously been updated from a previous Ma

In this case, run the following command with the appropriate values to correct the existing `composer.json` file before proceeding with the expected `composer require` command for the target Magento product.

composer require <current_Magento_package> <current_version> --base-magento-edition <community|enterprise> --base-magento-version <original_Magento_version>
composer require <current_Magento_package> <current_version> --base-magento-edition '<Open Source|Commerce>' --base-magento-version <original_Magento_version>

## Conflicting custom values

Expand All @@ -57,7 +57,7 @@ To reinstall the plugin in `var`, run the following command in the Magento root

### Without `magento/composer-root-update-plugin`:

In the project directory for a Magento Community Edition 2.2.8 installation, a user tries to run the `composer require` and `composer update` commands for Magento Community Edition 2.3.1 with these results:
In the project directory for a Magento Open Source 2.2.8 installation, a user tries to run the `composer require` and `composer update` commands for Magento Open Source 2.3.1 with these results:

```
$ composer require magento/product-community-edition 2.3.1 --no-update
Expand Down Expand Up @@ -88,7 +88,7 @@ This is only one of the changes to the root project `composer.json` file between

The changes to the root project `composer.json` files can be done manually by the user without the plugin, but the values that need to change can differ depending on the Magento versions involved and user-customized values may already override the Magento defaults. This means the exact upgrade steps necessary can be different for every user and determining the correct changes to make manually for a given user's configuration may be error-prone.

For reference, these are the `"require"` and `"require-dev"` sections for default installations (no user customizations) of Magento Community Edition versions 2.2.8 and 2.3.1. It is important to note that these sections of `composer.json` are not the only ones that can change between versions. The `"autoload"` and `"conflict"` sections, for example, can also affect Magento functionality and need to be kept up-to-date with the installed Magento versions.
For reference, these are the `"require"` and `"require-dev"` sections for default installations (no user customizations) of Magento Open Source versions 2.2.8 and 2.3.1. It is important to note that these sections of `composer.json` are not the only ones that can change between versions. The `"autoload"` and `"conflict"` sections, for example, can also affect Magento functionality and need to be kept up-to-date with the installed Magento versions.

- **2.2.8**
```
Expand Down Expand Up @@ -128,7 +128,7 @@ For reference, these are the `"require"` and `"require-dev"` sections for defaul

### With `magento/composer-root-update-plugin`:

In the project directory for a Magento Community Edition 2.2.8 installation, a user runs `composer require magento/composer-root-update-plugin ~1.0 --no-update` and `composer update` before the Magento Community Edition 2.3.1 upgrade commands.
In the project directory for a Magento Open Source 2.2.8 installation, a user runs `composer require magento/composer-root-update-plugin ~1.0 --no-update` and `composer update` before the Magento Open Source 2.3.1 upgrade commands.

```
$ composer require magento/composer-root-update-plugin ~1.0 --no-update
Expand All @@ -153,25 +153,25 @@ Generating autoload files

As is normal for `composer require`, `magento/composer-root-update-plugin` is added to the `composer.json` file. The plugin also installs itself in the directory used by the Magento Web Setup Wizard during dependency validation.

With the plugin installed, the user proceeds with the `composer require` command for Magento Community Edition 2.3.1 (`--verbose` mode used here for demonstration).
With the plugin installed, the user proceeds with the `composer require` command for Magento Open Source 2.3.1 (`--verbose` mode used here for demonstration).

```
$ composer require magento/product-community-edition 2.3.1 --no-update --verbose
[Magento Community Edition 2.3.1] Base Magento project package version: magento/project-community-edition 2.2.8
[Magento Community Edition 2.3.1] Removing require entries: composer/composer
[Magento Community Edition 2.3.1] Adding require-dev constraints: allure-framework/allure-phpunit=~1.2.0
[Magento Community Edition 2.3.1] Updating require-dev constraints: magento/magento2-functional-testing-framework=~2.3.13, phpunit/phpunit=~6.5.0, squizlabs/php_codesniffer=3.3.1, friendsofphp/php-cs-fixer=~2.13.0, sebastian/phpcpd=~3.0.0
[Magento Community Edition 2.3.1] Adding conflict constraints: gene/bluefoot=*
[Magento Community Edition 2.3.1] Updating autoload.psr-4.Zend\Mvc\Controller\ entry: "setup/src/Zend/Mvc/Controller/"
Updating composer.json for Magento Community Edition 2.3.1 ...
[Magento Community Edition 2.3.1] Writing changes to the root composer.json...
[Magento Community Edition 2.3.1] <path>/composer.json has been updated
[Magento Open Source 2.3.1] Base Magento project package version: magento/project-community-edition 2.2.8
[Magento Open Source 2.3.1] Removing require entries: composer/composer
[Magento Open Source 2.3.1] Adding require-dev constraints: allure-framework/allure-phpunit=~1.2.0
[Magento Open Source 2.3.1] Updating require-dev constraints: magento/magento2-functional-testing-framework=~2.3.13, phpunit/phpunit=~6.5.0, squizlabs/php_codesniffer=3.3.1, friendsofphp/php-cs-fixer=~2.13.0, sebastian/phpcpd=~3.0.0
[Magento Open Source 2.3.1] Adding conflict constraints: gene/bluefoot=*
[Magento Open Source 2.3.1] Updating autoload.psr-4.Zend\Mvc\Controller\ entry: "setup/src/Zend/Mvc/Controller/"
Updating composer.json for Magento Open Source 2.3.1 ...
[Magento Open Source 2.3.1] Writing changes to the root composer.json...
[Magento Open Source 2.3.1] <path>/composer.json has been updated
./composer.json has been updated
```

The plugin detects the user's request for the 2.3.1 version of `magento/product-community-edition` and looks up the `composer.json` file for the corresponding `magento/project-community-edition` 2.3.1 root project package. It finds the values that are different between 2.2.8 and 2.3.1 and updates the local `composer.json` file accordingly, then lets Composer proceed with the normal `composer require` functionality.

With the root `composer.json` file updated for Magento Community Edition 2.3.1, the user proceeds with the `composer update` command:
With the root `composer.json` file updated for Magento Open Source 2.3.1, the user proceeds with the `composer update` command:

```
$ composer update
Expand All @@ -184,9 +184,9 @@ Writing lock file
Generating autoload files
```

With the updated values from Magento Community Edition 2.3.1, the `symfony/console` conflict no longer exists and the update occurs as expected.
With the updated values from Magento Open Source 2.3.1, the `symfony/console` conflict no longer exists and the update occurs as expected.

For reference, these are the `"require"` and `"require-dev"` sections from the `composer.json` file after `composer require magento/product-community-edition 2.3.1 --no-update` runs with the plugin on a Magento Community Edition 2.2.8 installation. They contain exactly the same entries as the default Magento Community Edition 2.3.1 root `composer.json` file (with the addition of the `magento/composer-root-update-plugin` requirement).
For reference, these are the `"require"` and `"require-dev"` sections from the `composer.json` file after `composer require magento/product-community-edition 2.3.1 --no-update` runs with the plugin on a Magento Open Source 2.2.8 installation. They contain exactly the same entries as the default Magento Open Source 2.3.1 root `composer.json` file (with the addition of the `magento/composer-root-update-plugin` requirement).

```
"require": {
Expand Down
2 changes: 1 addition & 1 deletion docs/class_descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ Common package-related utility functions.
- **`getMagentoPackageType()`**
- Extracts the package type (`product` or `project`) from a Magento package name
- **`getMagentoProductEdition()`**
- Extracts the edition (`community` or `enterprise`) from a Magento product package name
- Extracts the package edition from a Magento product package name
- **`findRequire()`**
- Searches the `"require"` section of a [Composer](https://getcomposer.org/apidoc/master/Composer/Composer.html) object for a package link that fits the supplied name or matcher
- **`isConstraintStrict()`**
Expand Down
11 changes: 7 additions & 4 deletions src/Magento/ComposerRootUpdatePlugin/Plugin/Commands/MageRootRequireCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public function configure()
null,
InputOption::VALUE_REQUIRED,
'Edition of the initially-installed Magento product to use as the base for composer.json updates. ' .
'Valid values: community, enterprise'
'Valid values: \'Open Source\', \'Commerce\''
)
->addOption(
static::BASE_VERSION_OPT,
Expand Down Expand Up @@ -174,7 +174,8 @@ public function execute(InputInterface $input, OutputInterface $output)
$updater = new MagentoRootUpdater($this->console, $this->getComposer());
$didUpdate = $this->runUpdate($updater, $input, $edition, $constraint);
} catch (\Exception $e) {
$label = 'Magento ' . ucfirst($edition) . " Edition $constraint";
$editionLabel = $edition == PackageUtils::COMMERCE_PKG_EDITION ? 'Commerce' : 'Open Source';
$label = "Magento $editionLabel $constraint";
$this->revertMageComposerFile("Update of composer.json with $label changes failed");
$this->console->log($e->getMessage());
$didUpdate = false;
Expand Down Expand Up @@ -241,10 +242,12 @@ protected function runUpdate($updater, $input, $targetEdition, $targetConstraint
$overrideOriginalVersion = $input->getOption(static::BASE_VERSION_OPT);
if ($overrideOriginalEdition) {
$overrideOriginalEdition = strtolower($overrideOriginalEdition);
if ($overrideOriginalEdition !== 'community' && $overrideOriginalEdition !== 'enterprise') {
if ($overrideOriginalEdition !== 'open source' && $overrideOriginalEdition !== 'commerce') {
$opt = '--' . static::BASE_EDITION_OPT;
throw new InvalidOptionException("'$opt' accepts only 'community' or 'enterprise'");
throw new InvalidOptionException("'$opt' accepts only 'Open Source' or 'Commerce'");
Copy link

@paliarush paliarush Apr 30, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upper case and lower case seems to matter here.

Copy link
Contributor Author

@pdohogne-magento pdohogne-magento Apr 30, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't; three lines up:

$overrideOriginalEdition = strtolower($overrideOriginalEdition);

}
$overrideOriginalEdition = $overrideOriginalEdition = 'open source' ?
PackageUtils::OPEN_SOURCE_PKG_EDITION : PackageUtils::COMMERCE_PKG_EDITION;
}

$this->retriever = new RootPackageRetriever(
Expand Down
Loading