Fix Error: Could not process the 'wp-config.php' transformation #29800

ribaricplusplus · 2021-03-11T19:47:40Z

Description

This is an addition to #29770

#29770 Seems to fix the access denied error, but then a new error arises described in this comment #29770 (comment)

This PR fixes that error and it should close issue #29752

How has this been tested?

Running wp-env start from an empty directory

ockham · 2021-03-11T20:12:55Z

packages/env/lib/commands/start.js

+	await dockerCompose.exec( 'wordpress', 'chown www-data:www-data wp-config.php', {
+			config: dockerComposeConfigPath,
+			log: debug,
+	} )
+
+	await dockerCompose.exec( 'wordpress', 'chmod 777 wp-config.php', {
+			config: dockerComposeConfigPath,
+			log: debug,
+	} )
+
+	await dockerCompose.exec( 'tests-wordpress', 'chown www-data:www-data wp-config.php', {
+			config: dockerComposeConfigPath,
+			log: debug,
+	} )
+
+	await dockerCompose.exec( 'tests-wordpress', 'chmod 777 wp-config.php', {
+			config: dockerComposeConfigPath,
+			log: debug,
+	} )
+
+


I'm not sure that manually changing permissions for wp-config.php is the right fix, see discussion at #29770 😅

I think you have a good point that configuration should be set idiomatically via docker-compose configuration.

However, I think it would still make sense to fix wp-config.php permissions, because currently wp-config.php is owned by root and so any commands that need to use the config for any reason would fail.

Thoughts?

We've had to update permissions for some of these files to get them to work in wp-env before, so I'm not against it

I don't think we should use WORDPRESS_CONFIG_EXTRA because the wordpress image will only use that variable if wp-config.php doesn't already exist which isn't very flexible for developers. For example: you wouldn't be able to update WP_DEBUG in .wp-env.json, restart wp-env, and see WordPress running in debug mode.

I don't think we should use WORDPRESS_CONFIG_EXTRA because the wordpress image will only use that variable if wp-config.php doesn't already exist

I'm not totally sure, but I think that's no longer true per docker-library/wordpress#557, which has wp-config.php read those values dynamically from the docker env (using a getenv() helper); see e.g.

WORDPRESS_DEBUG: https://github.com/docker-library/wordpress/pull/557/files#diff-7f28a0f62019f2d8b061638e8c3aea207404c1499f1c9241db3216fadd8f4530R99 or

WORDPRESS_CONFIG_EXTRA: https://github.com/docker-library/wordpress/pull/557/files#diff-24f50e34cd95d8171662daf812269748e400594db64a7ee63ffd1fb3db5d9965R108-R110

packages/env/lib/wordpress.js

noahtallen

Note: I have not run wp-env in several weeks, so my docker image probably wasn't updated at first.

When running npx wp-env start, I first got this issue:

After running npx wp-env start --update, I get the following error:

~/source/gutenberg(fix/wp-env-docker-compose) » npx wp-env start --update                                                                                            noahtallen@Noah-MBP16
✖ Error while running docker-compose command.
Creating a86349ed83984e487ba92af16fae23af_cli_run ... done
mysqlcheck: Got error: 1045: Access denied for user 'root'@'172.18.0.6' (using password: YES) when trying to connect

ribaricplusplus · 2021-03-11T22:07:41Z

You get that error because the database wordpress that root is trying to connect to doesn't exist. And it doesn't exist because MariaDB image doesn't create a new database as specified in the environment variables if a volume is already mounted.

So if you delete volumes with wp-env destroy and then do wp-env start again, it's going to work.

I don't know if there's anything we can do about this.

noahtallen · 2021-03-11T22:10:28Z

Is this just a one-time problem?

ribaricplusplus · 2021-03-11T22:13:27Z

Because of changes by @youknowriad from #29770 (which this PR extends), the database is always going to be created properly in the future. So it should be a one time problem.

noahtallen · 2021-03-11T22:18:59Z

Login seems to be broken. using root instead of username doesn't work either:

It successfully starts, though!

Note that the PHPunit tests appear to be broken. Seems like we might have to debug the bootstrap file to get more helpful information

ribaricplusplus · 2021-03-11T22:23:02Z

Username: admin
Password: password
Works for me. Those don't work for you?

noahtallen · 2021-03-11T22:32:33Z

Ah, FML, not sure why that slipped my mind! Thanks :)

Looking into the PHPunit stuff now

noahtallen · 2021-03-11T22:36:30Z

Hm. npm run test-unit-php passes locally.

tmdk · 2021-03-11T22:56:59Z

The phpunit container is still missing the WORDPRESS_DB_* environment variables. Tests were failing for me because of this with "wpdie called" as the only output.

noahtallen · 2021-03-11T23:01:49Z

Interesting, I wonder why they passed locally for me in that case. It totally makes sense though.

@ribaricplusplus it might make sense to pull out the wordpress constants into their own object so that we don't have to repeat them everywhere. e.g.:

const databaseEnvironment = {
	WORDPRESS_DB_NAME: 'tests-wordpress',
	WORDPRESS_DB_USER: 'root',
	WORDPRESS_DB_PASSWORD: 'password',
	WORDPRESS_DB_HOST: 'tests-mysql',
};

// later on, in the compose config:
environment: {
  ...databaseEnvironment,
}

noisysocks · 2021-03-11T23:32:59Z

packages/env/lib/build-docker-compose-config.js

 				},
 				volumes: [ 'mysql:/var/lib/mysql' ],
 			},
+			'tests-mysql': {
+				image: 'mariadb',
+				ports: [ '3306' ],


This port is already being used by the mysql container above.

I think those ports just denote which ports are exposed within a container. Ports are isolated within individual containers, so if I'm not mistaken there should be no conflict.

EDIT: According to compose specification this short notation means that the port 3306 inside the container is going to be assigned an ephemeral port on the host machine. Still, that means there should be no trouble.

noisysocks · 2021-03-11T23:34:37Z

packages/env/lib/build-docker-compose-config.js

 				},
 				volumes: [ 'mysql:/var/lib/mysql' ],
 			},
+			'tests-mysql': {


Not a big fan of adding an extra MySQL container. It will mean there's a lot of extra memory usage and startup time.

How about we keep to a single container and create two databases ourselves using wp db create?

https://developer.wordpress.org/cli/commands/db/create/

Could that be a follow-up task? It seems higher effort than the current approach

Yep absolutely.

How about using one database, and different table prefixes for dev and tests, respectively? The wordpress docker image supports a WORDPRESS_TABLE_PREFIX env variable for that purpose.

This reverts commit a982f82.

ribaricplusplus · 2021-03-12T00:17:14Z

@noahtallen Did that with the last commit.

packages/env/lib/build-docker-compose-config.js

noahtallen

Alright, let's merge this now to get everything working. For follow up:

Figure out a better way to consume Docker (perhaps our own docker image, or one of the ones maintained by wordpress) so that we don't run into this issue again.
Move away from a separate tests-mysql, perhaps creating the test DB manually in the installer script.
Resolve anything else that might not be working (unsure if anything else is broken.)
Push this change to npm ASAP.

I'm stepping away soon, so passing the torch on to the next person :)

- Use separate tests database service - Configure database credentials in every service - Set wp-config.php to be writable Co-authored-by: Riad Benguella <benguella@gmail.com> Co-authored-by: Noah Allen <noahtallen@gmail.com>

gziolo · 2021-03-17T06:16:30Z

I cherry-picked commit with this PR to release/10.2 branch.

- Use separate tests database service - Configure database credentials in every service - Set wp-config.php to be writable Co-authored-by: Riad Benguella <benguella@gmail.com> Co-authored-by: Noah Allen <noahtallen@gmail.com>

youknowriad and others added 3 commits March 11, 2021 13:17

Fix wp-env docker-compose config with explicit users and passwords

2742537

try restoring mysql volumes

7d660da

Fix wp-config.php is not writable error

1f5efe7

ribaricplusplus changed the title ~~Fix/wp env docker compose~~ Fix Error: Could not process the 'wp-config.php' transformation Mar 11, 2021

ribaricplusplus mentioned this pull request Mar 11, 2021

Fix wp-env docker-compose config with explicit users and passwords #29770

Closed

ockham reviewed Mar 11, 2021

View reviewed changes

Cleaner fix implementation

42058f4

ribaricplusplus marked this pull request as ready for review March 11, 2021 20:43

ribaricplusplus requested a review from noahtallen as a code owner March 11, 2021 20:43

Export new function

3f2c8af

noahtallen reviewed Mar 11, 2021

View reviewed changes

packages/env/lib/wordpress.js Show resolved Hide resolved

noahtallen reviewed Mar 11, 2021

View reviewed changes

noisysocks reviewed Mar 11, 2021

View reviewed changes

ribaricplusplus added 3 commits March 12, 2021 00:59

Abstract db environment into constants

a982f82

Revert "Abstract db environment into constants"

d62f7b8

This reverts commit a982f82.

Abstract db environment into constants

0ca4422

noahtallen reviewed Mar 12, 2021

View reviewed changes

packages/env/lib/build-docker-compose-config.js Show resolved Hide resolved

Add db credentials to phpunit image

9a7f8c3

noahtallen approved these changes Mar 12, 2021

View reviewed changes

noahtallen merged commit f8052e1 into WordPress:trunk Mar 12, 2021

github-actions bot added this to the Gutenberg 10.3 milestone Mar 12, 2021

This was referenced Mar 12, 2021

Env: Access denied for user 'username_here'@'X.X.X.X' error running wp-env start. #29752

Closed

wp-env: Allow to set WordPress (Docker image) version #29798

Closed

This was referenced Mar 12, 2021

Bump gutenberg from f3ee192 to 27cb4f6 wordpress-mobile/gutenberg-mobile#3252

Closed

Bump gutenberg from e4eb4be to 27cb4f6 dcalhoun/gutenberg-mobile#181

Closed

Bump gutenberg from 7f7910f to 27cb4f6 fluiddot/gutenberg-mobile#119

Closed

tmdk mentioned this pull request Mar 12, 2021

env: chown: cannot access 'wp-config.php' when running wp-env start #29814

Closed

ckanitz mentioned this pull request Mar 12, 2021

Env: access denied for user 'root@x.x.x.x' #29829

Closed

noahtallen mentioned this pull request Mar 13, 2021

Update WordPress Monorepo Automattic/wp-calypso#50922

Merged

6 tasks

This was referenced Mar 13, 2021

Add missing hooked docs in content.php woocommerce/storefront#1628

Merged

wp-env: mysqlcheck: Got error: 1045: Access denied for user 'username_here'@'xxx.xx.x.x' (using password: YES) when trying to connect #29847

Closed

renatonascalves mentioned this pull request Mar 16, 2021

Support for Github Actions buddypress/BP-REST#383

Merged

dcalhoun mentioned this pull request Mar 16, 2021

Scope selector-class-pattern stylelint rule to web stylesheets #29881

Merged

7 tasks

adimoldovan mentioned this pull request Mar 16, 2021

Temporary fix for wp-env database issue Automattic/jetpack#19151

Merged

This was referenced Mar 16, 2021

New Page Layout Picker: refresh page pattern cache when site lang changes Automattic/wp-calypso#51087

Merged

New Page Layout Picker: refresh page pattern cache when site lang changes (round 2) Automattic/wp-calypso#51122

Merged

gziolo modified the milestones: Gutenberg 10.3, Gutenberg 10.2 Mar 17, 2021

talldan added [Tool] Env /packages/env [Type] Bug An existing feature does not function as intended labels Mar 22, 2021

carolinan mentioned this pull request Mar 22, 2021

Windows 10: Issues on npm run start WordPress/theme-directory-env#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Error: Could not process the 'wp-config.php' transformation #29800

Fix Error: Could not process the 'wp-config.php' transformation #29800

ribaricplusplus commented Mar 11, 2021

ockham Mar 11, 2021

ribaricplusplus Mar 11, 2021 •

edited

Loading

noahtallen Mar 11, 2021

noisysocks Mar 11, 2021

ockham Mar 12, 2021

noahtallen left a comment

ribaricplusplus commented Mar 11, 2021

noahtallen commented Mar 11, 2021

ribaricplusplus commented Mar 11, 2021

noahtallen commented Mar 11, 2021

ribaricplusplus commented Mar 11, 2021 •

edited

Loading

noahtallen commented Mar 11, 2021

noahtallen commented Mar 11, 2021

tmdk commented Mar 11, 2021 •

edited

Loading

noahtallen commented Mar 11, 2021

noisysocks Mar 11, 2021

ribaricplusplus Mar 11, 2021 •

edited

Loading

noisysocks Mar 11, 2021

noisysocks Mar 11, 2021

noahtallen Mar 12, 2021

noisysocks Mar 12, 2021

ockham Mar 12, 2021

ribaricplusplus commented Mar 12, 2021

noahtallen left a comment •

edited

Loading

gziolo commented Mar 17, 2021

Fix Error: Could not process the 'wp-config.php' transformation #29800

Fix Error: Could not process the 'wp-config.php' transformation #29800

Conversation

ribaricplusplus commented Mar 11, 2021

Description

How has this been tested?

Choose a reason for hiding this comment

ribaricplusplus Mar 11, 2021 • edited Loading

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

noahtallen left a comment

Choose a reason for hiding this comment

ribaricplusplus commented Mar 11, 2021

noahtallen commented Mar 11, 2021

ribaricplusplus commented Mar 11, 2021

noahtallen commented Mar 11, 2021

ribaricplusplus commented Mar 11, 2021 • edited Loading

noahtallen commented Mar 11, 2021

noahtallen commented Mar 11, 2021

tmdk commented Mar 11, 2021 • edited Loading

noahtallen commented Mar 11, 2021

Choose a reason for hiding this comment

ribaricplusplus Mar 11, 2021 • edited Loading

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

ribaricplusplus commented Mar 12, 2021

noahtallen left a comment • edited Loading

Choose a reason for hiding this comment

gziolo commented Mar 17, 2021

ribaricplusplus Mar 11, 2021 •

edited

Loading

ribaricplusplus commented Mar 11, 2021 •

edited

Loading

tmdk commented Mar 11, 2021 •

edited

Loading

ribaricplusplus Mar 11, 2021 •

edited

Loading

noahtallen left a comment •

edited

Loading