Added DDEV command to install OM (incl. sample data)

[sreichel]

Description (*)

Adds ddev-command ddev install-openmage to install OM w/ or w/o sample data.

There a three optional flags ...

-d use default values for admin-user, db, ... w/o getting asked for
-s install sample data ...
-k keep sample data package (to avoid to download it again and again)
-q drop current install and re-install with default values

Run ddev install-openmage -d -s to install OM /w sample data.

Questions or comments

Install works only WITH sample data!

FAILED
ERROR: Error in file: "/var/www/html/app/code/core/Mage/Customer/sql/customer_setup/mysql4-data-upgrade-1.4.0.0.7-1.4.0.0.8.php" - Notice: Undefined offset: 0  in /var/www/html/app/code/core/Mage/Core/Model/App.php on line 1005

Updates welcome.

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All automated tests passed successfully (all builds are green)
• Add yourself to contributors list

[addison74]

I will test this PR these days, being a fan of DDEV on Windows + Docker + WSL2.

BTW, we have not yet determined what happens with the local.xml file which is automatically created by DDEV when we configure a new project and thus we cannot access to the Backend running the installation. Maybe we should also make an command to run a query for creating an admin account with a simple password. We had this conversion here #2648.

[addison74]

@sreichel - I see that you addressed in the script the issue of creating the administrator account for Backend.

[sreichel]

@addison74 in case of an existing local.xml the script stops. It just to (re-)install OM with default ddev values.

[addison74]

A few comments

1 - If the command ddev install-openmage is run and the question "OpenMage is already installed. Delete local.xml and drop database[y/N]:" is answered with no, the error 'Failed to run install-openmage : exit' is displayed status 1'. However it is not a failure of running the script, but it is coming from the install.php file. We cannot do more about it.

2 - DDEV provides support for SSL certificates. The arguments in the install script use_secure and use_secure_admin should be set to 'yes'.

3 - You can work a little on the phrases

"OpenMage is already installed. Delete local.xml and drop the database? [y/N] :". We keep the same format like in "Install sample data? [y/N]", it is a question.

"Install sample data? [y/N] :". You missed the colon.

Otherwise the script has no other issues and it is extremely useful. I recommend everyone who tests OpenMage to use (DDEV + Docker + WSL2), especially in Windows, if you do not work directly in a Linux distribution.

[addison74]

In all read lines we need a blank space at the end.

Before: read -r -p "Install sample data? [y/N]"
After: read -r -p "Install sample data? [y/N] "

In this way the input from the keyboard will be more visible.

[addison74]

The name of the command should start with openmage- prefix, so that we can add other commands related to OpenMage,that are easy to remember. e.g,

openmage-install = what you just created in this PR
openmage-admin = update/create admin account (will come)
...

[addison74]

The functionality is exactly what it needs. I made only a few proposals to improve the relationship with the user. Thank you @sreichel for this PR that improves OpenMage's testing mode and helps by reducing the time it takes to install a new instance.

[addison74]

Only 4 modifications I request :)

[sreichel]

@addison74 can you please test without sample data?

[addison74]

PHP 7.4.33 - I was able to install both variants. There were no errors when I used the variant without installing the sample data.
PHP 8.1.16 - The same here. SUCCESS.
PHP 8.2.3 - The same here too. SUCCESS.

[sreichel]

Strange. Does table-prefix work for you?

[addison74]

I was able to add a prefix to the tables, see the images below. PHP 8.2.3:

[sreichel]

When it works for you a default prefix should be added. (om_).

Will add some options later ... like session storage ...

[sreichel]

@addison74 why did you delete my comment about n98-magerun?

Most commands work ... just needs to get tested explicitly.

[addison74]

My request was off-topic to this PR and I deleted it, there were two messages. In the meantime I opened a PR that solves that situation differently from n98-magerun, where it is a lot of work to be brought to compatibility with PHP8.1. I deleted your answer because the question no longer exists.

[addison74]

Please approve this PR. I have been using it for some time and there are no issues. I made some changes in the displayed phrases and corrected the directory where they are copied from the downloaded archive /media and /skin directories.

[fballiano]

@addison74 what about your comment about table prefixes?

[addison74]

The command deals with two situations:

1. installation without Sample Data and here the table prefix must be used.

2. installation with Sample Data, here you can no longer use the prefix because the tables are already created.

I agree with Sven in the first case to cover the situation of the table prefix from the very beginning. I started from the idea that what is being worked on in DDEV can be put into production and that's why I didn't want a prefix. But it can be easily solved by exporting the database and executing a sed command to delete the prefix. I haven't analyzed it, but I think that a DDEV command can be created to do this automatically.

[fballiano]

approving because asked, not tested

[sreichel]

@fballiano you wrote you are not using ddev ... its just a shell script that should work w/o ddev too.