Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Commit

Permalink
Use Compatibility instead of PHP on reports
Browse files Browse the repository at this point in the history
  • Loading branch information
@loginesta
loginesta committed Nov 25, 2021
1 parent 930232d commit 7979520
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 33 deletions.
2 changes: 1 addition & 1 deletion src/upgrade-compatibility-tool/developer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ The {{site.data.var.uct}} calculates this score according to the complexity scor

### Complexity score formula

`Complexity Score = ({{site.data.var.ee}} core errors) * 4 + (Critical errors) * 4 + [(PHP errors)+(GraphQL errors)] * 2 + [(PHP warnings)+(GraphQL warnings)] * 1`
`Complexity Score = ({{site.data.var.ee}} core errors) * 4 + (Critical errors) * 4 + [(PHP and JS errors)+(GraphQL errors)] * 2 + [(PHP and JS warnings)+(GraphQL warnings)] * 1`

{:.bs-callout-warning}
These are absolute values.
68 changes: 36 additions & 32 deletions src/upgrade-compatibility-tool/run.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -242,26 +242,28 @@ bin/uct upgrade:check --schema1=https://domain1.com/graphql --schema2=https://do
File: /app/code/Custom/CatalogExtension/Controller/Index/Index.php
------------------------------------------------------------------
* [ERROR] Line 84: Used nonexistent or non Magento API interface 'Magento\Catalog\Model\ProductRepositoryInterface'
* [WARNING] Line 6: Importing Magento @deprecated class 'Magento\Catalog\Model\ProductRepository'
* [WARNING][1131] Line 23: Extending from class 'Magento\Framework\App\Action\Action' that is @deprecated on version '2.4.2'
* [ERROR][1429] Line 103: Call method 'Magento\Framework\Api\SearchCriteriaBuilder::addFilters' that is non API on version '2.4.2'
* [CRITICAL][1110] Line 60: Instantiating class/interface 'Magento\Catalog\Model\ProductRepository' that does not exist on version '2.4.2'
```

The report also includes a detailed summary:

* *Installed Version*: the version currently installed.
* *{{site.data.var.ee}} Version*: the version you want to upgrade to.
* *Running time*: amount of time the analysis took to build the report (mm:ss).
* *{{site.data.var.ee}} checked modules*: amount of checked modules.
* *{{site.data.var.ee}} core checked modules*: amount of core checked modules.
* *{{site.data.var.ee}} core modified files*: amount of core modified file.
* *{{site.data.var.ee}} % core modified files*: percentage of core modified files.
* *PHP errors found*: amount of PHP errors.
* *PHP warnings found*: amount of PHP warnings.
* *GraphQL errors found*: amount of GraphQL errors.
* *GraphQL warnings found*: amount of GraphQL warnings.
* *Total errors found*: total amount of errors found.
* *Total warnings found*: total amount of warnings found.
* *Complexity score*: a figure that indicates how difficult is to upgrade from the current version to the new one.
* *Installed Version*: the version currently installed.
* *{{site.data.var.ee}} Version*: the version you want to upgrade to.
* *Running time*: amount of time the analysis took to build the report (mm:ss).
* *{{site.data.var.ee}} core checked modules*: amount of core checked modules.
* *{{site.data.var.ee}} core modified files*: amount of core modified file.
* *{{site.data.var.ee}} % core modified files*: percentage of core modified files.
* *{{site.data.var.ee}} checked modules*: amount of checked modules.
* *Compatibility errors found*: amount of compatibility errors.
* *Compatibility warnings found*: amount of compatibility warnings.
* *Compatibility critical errors found*: amount of compatibility critical errors.
* *GraphQL critical errors found*: amount of GraphQL critical errors.
* *GraphQL warnings found*: amount of GraphQL warnings.
* *Total errors found*: total amount of errors found.
* *Total warnings found*: total amount of warnings found.
* *Complexity score*: a figure that indicates how difficult is to upgrade from the current version to the new one.

The lower this number is, the easier is to perform the upgrade.

Expand All @@ -270,22 +272,24 @@ See the [Error message reference]({{site.baseurl}}/upgrade-compatibility-tool/er
## Example of a general summary report

```terminal
------------------------ --------
Installed version 2.4.2
{{site.data.var.ee}} version 2.4.3
Running time 0m:48s
Checked modules 14
Core checked modules 0
Core modified files 0
% core modified files 0.00
PHP errors found 109
PHP warnings found 0
GraphQL errors found 0
GraphQL warnings found 0
Total errors found 109
Total warnings found 0
Complexity score 218
------------------------ --------
------------------------------------- -------
Installed version 2.4.2
{{site.data.var.ee}} version 2.4.3
Running time 0m:48s
Core files checked 0
Core files modified 0
% of files modified 0.00
Checked modules 14
Compatibility errors found 109
Compatibility warnings found 0
Compatibility critical errors found 0
GraphQL critical errors found 0
GraphQL warnings found 0
Total errors found 109
Total warnings found 0
Total critical errors found 0
Complexity score 218
------------------------------------- -------
```

Regarding the GraphQL schema compatibility comparison, the output would be very similar:
Expand Down

0 comments on commit 7979520

Please sign in to comment.