@wordpress/env 6.0.0 → 8.0.0

package/lib/config/test/__snapshots__/config-integration.js.snap

@@ -0,0 +1,295 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Config Integration should load local and override configuration files 1`] = `
+{
+  "configDirectoryPath": "/test/gutenberg",
+  "detectedLocalConfig": true,
+  "dockerComposeConfigPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/docker-compose.yml",
+  "env": {
+    "development": {
+      "config": {
+        "FS_METHOD": "direct",
+        "SCRIPT_DEBUG": true,
+        "WP_DEBUG": true,
+        "WP_ENVIRONMENT_TYPE": "local",
+        "WP_HOME": "http://localhost:999",
+        "WP_PHP_BINARY": "php",
+        "WP_SITEURL": "http://localhost:999",
+        "WP_TESTS_DOMAIN": "localhost:999",
+        "WP_TESTS_EMAIL": "admin@example.org",
+        "WP_TESTS_TITLE": "Test Blog",
+      },
+      "coreSource": {
+        "basename": "WordPress",
+        "clonePath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "path": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "ref": "trunk",
+        "testsPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/tests-WordPress",
+        "type": "git",
+        "url": "https://github.com/WordPress/WordPress.git",
+      },
+      "mappings": {},
+      "phpVersion": null,
+      "pluginSources": [],
+      "port": 999,
+      "themeSources": [],
+    },
+    "tests": {
+      "config": {
+        "FS_METHOD": "direct",
+        "SCRIPT_DEBUG": false,
+        "WP_DEBUG": false,
+        "WP_ENVIRONMENT_TYPE": "local",
+        "WP_HOME": "http://localhost:456",
+        "WP_PHP_BINARY": "php",
+        "WP_SITEURL": "http://localhost:456",
+        "WP_TESTS_DOMAIN": "localhost:456",
+        "WP_TESTS_EMAIL": "admin@example.org",
+        "WP_TESTS_TITLE": "Test Blog",
+      },
+      "coreSource": {
+        "basename": "WordPress",
+        "clonePath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "path": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "ref": "trunk",
+        "testsPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/tests-WordPress",
+        "type": "git",
+        "url": "https://github.com/WordPress/WordPress.git",
+      },
+      "mappings": {},
+      "phpVersion": null,
+      "pluginSources": [],
+      "port": 456,
+      "themeSources": [],
+    },
+  },
+  "lifecycleScripts": {
+    "afterClean": null,
+    "afterDestroy": "test",
+    "afterStart": null,
+  },
+  "name": "gutenberg",
+  "workDirectoryPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338",
+}
+`;
+
+exports[`Config Integration should load local configuration file 1`] = `
+{
+  "configDirectoryPath": "/test/gutenberg",
+  "detectedLocalConfig": true,
+  "dockerComposeConfigPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/docker-compose.yml",
+  "env": {
+    "development": {
+      "config": {
+        "FS_METHOD": "direct",
+        "SCRIPT_DEBUG": true,
+        "WP_DEBUG": true,
+        "WP_ENVIRONMENT_TYPE": "local",
+        "WP_HOME": "http://localhost:123",
+        "WP_PHP_BINARY": "php",
+        "WP_SITEURL": "http://localhost:123",
+        "WP_TESTS_DOMAIN": "localhost:123",
+        "WP_TESTS_EMAIL": "admin@example.org",
+        "WP_TESTS_TITLE": "Test Blog",
+      },
+      "coreSource": {
+        "basename": "WordPress",
+        "clonePath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "path": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "ref": "trunk",
+        "testsPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/tests-WordPress",
+        "type": "git",
+        "url": "https://github.com/WordPress/WordPress.git",
+      },
+      "mappings": {},
+      "phpVersion": null,
+      "pluginSources": [],
+      "port": 123,
+      "themeSources": [],
+    },
+    "tests": {
+      "config": {
+        "FS_METHOD": "direct",
+        "SCRIPT_DEBUG": false,
+        "WP_DEBUG": false,
+        "WP_ENVIRONMENT_TYPE": "local",
+        "WP_HOME": "http://localhost:8889",
+        "WP_PHP_BINARY": "php",
+        "WP_SITEURL": "http://localhost:8889",
+        "WP_TESTS_DOMAIN": "localhost:8889",
+        "WP_TESTS_EMAIL": "admin@example.org",
+        "WP_TESTS_TITLE": "Test Blog",
+      },
+      "coreSource": {
+        "basename": "WordPress",
+        "clonePath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "path": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "ref": "trunk",
+        "testsPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/tests-WordPress",
+        "type": "git",
+        "url": "https://github.com/WordPress/WordPress.git",
+      },
+      "mappings": {},
+      "phpVersion": null,
+      "pluginSources": [],
+      "port": 8889,
+      "themeSources": [],
+    },
+  },
+  "lifecycleScripts": {
+    "afterClean": null,
+    "afterDestroy": null,
+    "afterStart": "test",
+  },
+  "name": "gutenberg",
+  "workDirectoryPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338",
+}
+`;
+
+exports[`Config Integration should use default configuration 1`] = `
+{
+  "configDirectoryPath": "/test/gutenberg",
+  "detectedLocalConfig": true,
+  "dockerComposeConfigPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/docker-compose.yml",
+  "env": {
+    "development": {
+      "config": {
+        "FS_METHOD": "direct",
+        "SCRIPT_DEBUG": true,
+        "WP_DEBUG": true,
+        "WP_ENVIRONMENT_TYPE": "local",
+        "WP_HOME": "http://localhost:8888",
+        "WP_PHP_BINARY": "php",
+        "WP_SITEURL": "http://localhost:8888",
+        "WP_TESTS_DOMAIN": "localhost:8888",
+        "WP_TESTS_EMAIL": "admin@example.org",
+        "WP_TESTS_TITLE": "Test Blog",
+      },
+      "coreSource": {
+        "basename": "WordPress",
+        "clonePath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "path": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "ref": "100.0.0",
+        "testsPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/tests-WordPress",
+        "type": "git",
+        "url": "https://github.com/WordPress/WordPress.git",
+      },
+      "mappings": {},
+      "phpVersion": null,
+      "pluginSources": [],
+      "port": 8888,
+      "themeSources": [],
+    },
+    "tests": {
+      "config": {
+        "FS_METHOD": "direct",
+        "SCRIPT_DEBUG": false,
+        "WP_DEBUG": false,
+        "WP_ENVIRONMENT_TYPE": "local",
+        "WP_HOME": "http://localhost:8889",
+        "WP_PHP_BINARY": "php",
+        "WP_SITEURL": "http://localhost:8889",
+        "WP_TESTS_DOMAIN": "localhost:8889",
+        "WP_TESTS_EMAIL": "admin@example.org",
+        "WP_TESTS_TITLE": "Test Blog",
+      },
+      "coreSource": {
+        "basename": "WordPress",
+        "clonePath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "path": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "ref": "100.0.0",
+        "testsPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/tests-WordPress",
+        "type": "git",
+        "url": "https://github.com/WordPress/WordPress.git",
+      },
+      "mappings": {},
+      "phpVersion": null,
+      "pluginSources": [],
+      "port": 8889,
+      "themeSources": [],
+    },
+  },
+  "lifecycleScripts": {
+    "afterClean": null,
+    "afterDestroy": null,
+    "afterStart": null,
+  },
+  "name": "gutenberg",
+  "workDirectoryPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338",
+}
+`;
+
+exports[`Config Integration should use environment variables over local and override configuration files 1`] = `
+{
+  "configDirectoryPath": "/test/gutenberg",
+  "detectedLocalConfig": true,
+  "dockerComposeConfigPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/docker-compose.yml",
+  "env": {
+    "development": {
+      "config": {
+        "FS_METHOD": "direct",
+        "SCRIPT_DEBUG": true,
+        "WP_DEBUG": true,
+        "WP_ENVIRONMENT_TYPE": "local",
+        "WP_HOME": "http://localhost:12345",
+        "WP_PHP_BINARY": "php",
+        "WP_SITEURL": "http://localhost:12345",
+        "WP_TESTS_DOMAIN": "localhost:12345",
+        "WP_TESTS_EMAIL": "admin@example.org",
+        "WP_TESTS_TITLE": "Test Blog",
+      },
+      "coreSource": {
+        "basename": "WordPress",
+        "clonePath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "path": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "ref": "trunk",
+        "testsPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/tests-WordPress",
+        "type": "git",
+        "url": "https://github.com/WordPress/WordPress.git",
+      },
+      "mappings": {},
+      "phpVersion": null,
+      "pluginSources": [],
+      "port": 12345,
+      "testsPort": 61234,
+      "themeSources": [],
+    },
+    "tests": {
+      "config": {
+        "FS_METHOD": "direct",
+        "SCRIPT_DEBUG": false,
+        "WP_DEBUG": false,
+        "WP_ENVIRONMENT_TYPE": "local",
+        "WP_HOME": "http://localhost:61234",
+        "WP_PHP_BINARY": "php",
+        "WP_SITEURL": "http://localhost:61234",
+        "WP_TESTS_DOMAIN": "localhost:61234",
+        "WP_TESTS_EMAIL": "admin@example.org",
+        "WP_TESTS_TITLE": "Test Blog",
+      },
+      "coreSource": {
+        "basename": "WordPress",
+        "clonePath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "path": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/WordPress",
+        "ref": "trunk",
+        "testsPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338/tests-WordPress",
+        "type": "git",
+        "url": "https://github.com/WordPress/WordPress.git",
+      },
+      "mappings": {},
+      "phpVersion": null,
+      "pluginSources": [],
+      "port": 61234,
+      "testsPort": 61234,
+      "themeSources": [],
+    },
+  },
+  "lifecycleScripts": {
+    "afterClean": null,
+    "afterDestroy": null,
+    "afterStart": "test",
+  },
+  "name": "gutenberg",
+  "workDirectoryPath": "/cache/5fea4c5689ef6cc4a4e6eaaa39323338",
+}
+`;

package/lib/config/test/add-or-replace-port.js

@@ -1,10 +1,11 @@
+'use strict';
 /**
  * Internal dependencies
  */
 const addOrReplacePort = require( '../add-or-replace-port.js' );
 
 describe( 'addOrReplacePort', () => {
-	beforeEach( () => {
+	afterEach( () => {
 		jest.clearAllMocks();
 	} );
 
@@ -39,6 +40,33 @@ describe( 'addOrReplacePort', () => {
 		}
 	} );
 
+	it( 'should support number ports', () => {
+		const testMap = [ { in: 'test', expect: 'test:104' } ];
+
+		for ( const test of testMap ) {
+			const result = addOrReplacePort( test.in, 104, false );
+			expect( result ).toEqual( test.expect );
+		}
+	} );
+
+	it( 'should not add default HTTP port', () => {
+		const testMap = [ { in: 'test', expect: 'test' } ];
+
+		for ( const test of testMap ) {
+			const result = addOrReplacePort( test.in, 80, false );
+			expect( result ).toEqual( test.expect );
+		}
+	} );
+
+	it( 'should not add default HTTPS port', () => {
+		const testMap = [ { in: 'test', expect: 'test' } ];
+
+		for ( const test of testMap ) {
+			const result = addOrReplacePort( test.in, 443, false );
+			expect( result ).toEqual( test.expect );
+		}
+	} );
+
 	it( 'should do nothing if port is present but replacement is not requested', () => {
 		const testMap = [
 			{ in: 'test', expect: 'test:103' },

package/lib/config/test/config-integration.js

@@ -0,0 +1,164 @@
+'use strict';
+/* eslint-disable jest/no-conditional-expect */
+/**
+ * External dependencies
+ */
+const { readFile } = require( 'fs' ).promises;
+
+/**
+ * Internal dependencies
+ */
+const loadConfig = require( '../load-config' );
+const detectDirectoryType = require( '../detect-directory-type' );
+
+jest.mock( 'fs', () => ( {
+	promises: {
+		readFile: jest.fn(),
+		stat: jest.fn().mockResolvedValue( true ),
+	},
+} ) );
+
+// This mocks a small response with a format matching the stable-check API.
+// It makes getLatestWordPressVersion resolve to "100.0.0".
+jest.mock( 'got', () =>
+	jest.fn( ( url ) => ( {
+		json: () => {
+			if ( url === 'https://api.wordpress.org/core/stable-check/1.0/' ) {
+				return Promise.resolve( {
+					'1.0': 'insecure',
+					'99.1.1': 'outdated',
+					'100.0.0': 'latest',
+					'100.0.1': 'fancy',
+				} );
+			}
+		},
+	} ) )
+);
+
+jest.mock( '../detect-directory-type', () => jest.fn() );
+
+describe( 'Config Integration', () => {
+	beforeEach( () => {
+		process.env.WP_ENV_HOME = '/cache';
+		detectDirectoryType.mockResolvedValue( null );
+	} );
+
+	afterEach( () => {
+		delete process.env.WP_ENV_HOME;
+		delete process.env.WP_ENV_PORT;
+		delete process.env.WP_ENV_TESTS_PORT;
+		delete process.env.WP_ENV_LIFECYCLE_SCRIPT_AFTER_START;
+	} );
+
+	it( 'should use default configuration', async () => {
+		readFile.mockImplementation( async () => {
+			throw { code: 'ENOENT' };
+		} );
+
+		const config = await loadConfig( '/test/gutenberg' );
+
+		expect( config.env.development.port ).toEqual( 8888 );
+		expect( config.env.tests.port ).toEqual( 8889 );
+		expect( config ).toMatchSnapshot();
+	} );
+
+	it( 'should load local configuration file', async () => {
+		readFile.mockImplementation( async ( fileName ) => {
+			if ( fileName === '/test/gutenberg/.wp-env.json' ) {
+				return JSON.stringify( {
+					core: 'WordPress/WordPress#trunk',
+					port: 123,
+					lifecycleScripts: {
+						afterStart: 'test',
+						afterClean: null,
+						afterDestroy: null,
+					},
+				} );
+			}
+
+			throw { code: 'ENOENT' };
+		} );
+
+		const config = await loadConfig( '/test/gutenberg' );
+
+		expect( config.env.development.port ).toEqual( 123 );
+		expect( config.env.tests.port ).toEqual( 8889 );
+		expect( config ).toMatchSnapshot();
+	} );
+
+	it( 'should load local and override configuration files', async () => {
+		readFile.mockImplementation( async ( fileName ) => {
+			if ( fileName === '/test/gutenberg/.wp-env.json' ) {
+				return JSON.stringify( {
+					core: 'WordPress/WordPress#trunk',
+					port: 123,
+					testsPort: 456,
+					lifecycleScripts: {
+						afterStart: 'test',
+						afterClean: null,
+						afterDestroy: null,
+					},
+				} );
+			}
+
+			if ( fileName === '/test/gutenberg/.wp-env.override.json' ) {
+				return JSON.stringify( {
+					port: 999,
+					lifecycleScripts: {
+						afterStart: null,
+						afterClean: null,
+						afterDestroy: 'test',
+					},
+				} );
+			}
+
+			throw { code: 'ENOENT' };
+		} );
+
+		const config = await loadConfig( '/test/gutenberg' );
+
+		expect( config.env.development.port ).toEqual( 999 );
+		expect( config.env.tests.port ).toEqual( 456 );
+		expect( config ).toMatchSnapshot();
+	} );
+
+	it( 'should use environment variables over local and override configuration files', async () => {
+		process.env.WP_ENV_PORT = 12345;
+		process.env.WP_ENV_TESTS_PORT = 61234;
+		process.env.WP_ENV_LIFECYCLE_SCRIPT_AFTER_START = 'test';
+
+		readFile.mockImplementation( async ( fileName ) => {
+			if ( fileName === '/test/gutenberg/.wp-env.json' ) {
+				return JSON.stringify( {
+					core: 'WordPress/WordPress#trunk',
+					port: 123,
+					testsPort: 456,
+					lifecycleScripts: {
+						afterStart: 'local',
+						afterClean: null,
+						afterDestroy: null,
+					},
+				} );
+			}
+
+			if ( fileName === '/test/gutenberg/.wp-env.override.json' ) {
+				return JSON.stringify( {
+					port: 999,
+				} );
+			}
+
+			throw { code: 'ENOENT' };
+		} );
+
+		const config = await loadConfig( '/test/gutenberg' );
+
+		expect( config.env.development.port ).toEqual( 12345 );
+		expect( config.env.tests.port ).toEqual( 61234 );
+		expect( config.lifecycleScripts ).toHaveProperty(
+			'afterStart',
+			'test'
+		);
+		expect( config ).toMatchSnapshot();
+	} );
+} );
+/* eslint-enable jest/no-conditional-expect */

package/lib/config/test/get-cache-directory.js

@@ -0,0 +1,57 @@
+'use strict';
+/* eslint-disable jest/no-conditional-expect */
+/**
+ * External dependencies
+ */
+const { stat } = require( 'fs' ).promises;
+const { homedir } = require( 'os' );
+
+/**
+ * Internal dependencies
+ */
+const getCacheDirectory = require( '../get-cache-directory' );
+
+jest.mock( 'fs', () => ( {
+	promises: {
+		stat: jest.fn(),
+	},
+} ) );
+jest.mock( 'os', () => ( {
+	homedir: jest.fn(),
+} ) );
+
+describe( 'getCacheDirectory', () => {
+	afterEach( () => {
+		delete process.env.WP_ENV_HOME;
+	} );
+
+	it( 'uses WP_ENV_HOME for cache directory when set', async () => {
+		process.env.WP_ENV_HOME = '/test';
+
+		const parsed = await getCacheDirectory();
+
+		expect( homedir ).not.toHaveBeenCalled();
+		expect( parsed ).toEqual( '/test' );
+	} );
+
+	it( 'uses hidden home directory for cache', async () => {
+		stat.mockRejectedValue( false );
+		homedir.mockReturnValue( '/home/test' );
+
+		const parsed = await getCacheDirectory();
+
+		expect( homedir ).toHaveBeenCalled();
+		expect( parsed ).toEqual( '/home/test/.wp-env' );
+	} );
+
+	it( 'uses non-hidden cache directory when using Snap-installed Docker', async () => {
+		stat.mockResolvedValue( true );
+		homedir.mockReturnValue( '/home/test' );
+
+		const parsed = await getCacheDirectory();
+
+		expect( homedir ).toHaveBeenCalled();
+		expect( parsed ).toEqual( '/home/test/wp-env' );
+	} );
+} );
+/* eslint-enable jest/no-conditional-expect */

package/lib/config/test/merge-configs.js

@@ -0,0 +1,121 @@
+'use strict';
+/**
+ * Internal dependencies
+ */
+const mergeConfigs = require( '../merge-configs' );
+
+describe( 'mergeConfigs', () => {
+	it( 'should merge configs without environments', () => {
+		const merged = mergeConfigs(
+			{
+				port: 8888,
+				coreSource: {
+					type: 'local',
+					path: '/home/test',
+				},
+				config: {
+					WP_TEST: 'test',
+				},
+				lifecycleScripts: {
+					afterStart: 'test',
+				},
+			},
+			{
+				port: 8889,
+				config: {
+					WP_TEST_2: 'test-2',
+				},
+				lifecycleScripts: {
+					afterDestroy: 'test-2',
+				},
+			}
+		);
+
+		expect( merged ).toEqual( {
+			port: 8889,
+			coreSource: {
+				type: 'local',
+				path: '/home/test',
+			},
+			config: {
+				WP_TEST: 'test',
+				WP_TEST_2: 'test-2',
+			},
+			lifecycleScripts: {
+				afterStart: 'test',
+				afterDestroy: 'test-2',
+			},
+		} );
+	} );
+
+	it( 'should merge configs with environments', () => {
+		const merged = mergeConfigs(
+			{
+				port: 8888,
+				coreSource: {
+					type: 'local',
+					path: '/home/test',
+				},
+				config: {
+					WP_TEST: 'test',
+				},
+				env: {
+					development: {
+						config: {
+							WP_TEST_3: 'test-3',
+						},
+					},
+					tests: {
+						config: {
+							WP_TEST_4: 'test-4',
+						},
+					},
+				},
+			},
+			{
+				port: 8889,
+				config: {
+					WP_TEST_2: 'test-2',
+				},
+				env: {
+					development: {
+						config: {
+							WP_TEST_5: 'test-5',
+						},
+					},
+					tests: {
+						config: {
+							WP_TEST_6: 'test-6',
+						},
+					},
+				},
+			}
+		);
+
+		expect( merged ).toEqual( {
+			port: 8889,
+			coreSource: {
+				type: 'local',
+				path: '/home/test',
+			},
+			config: {
+				WP_TEST: 'test',
+				WP_TEST_2: 'test-2',
+			},
+			env: {
+				development: {
+					config: {
+						WP_TEST_3: 'test-3',
+						WP_TEST_5: 'test-5',
+					},
+				},
+				tests: {
+					config: {
+						WP_TEST_4: 'test-4',
+						WP_TEST_6: 'test-6',
+					},
+				},
+			},
+		} );
+	} );
+} );