Merge pull request #2244 from Automattic/add/dev-env-overrides

feat(dev-env): overrides for the default configuration

Author: sjinks

__tests__/devenv-e2e/013-configuration-file.spec.js

@@ -1,5 +1,5 @@
 import { describe, expect, it, jest } from '@jest/globals';
-import { mkdtemp, rm, mkdir, realpath } from 'node:fs/promises';
+import { mkdtemp, rm, mkdir, realpath, readFile, stat } from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 import xdgBaseDir from 'xdg-basedir';
@@ -334,4 +334,80 @@ describe( 'vip dev-env configuration file', () => {
 			cron: ! expectedCron,
 		} );
 	} );
+
+	it( 'should create .lando.local.yml if overrides have been provided', async () => {
+		const slug = getProjectSlug();
+		const expectedOverrides = `services:\n  wordpress:\n    services:\n      pull_policy: never\n`;
+
+		expect( await checkEnvExists( slug ) ).toBe( false );
+
+		await writeConfigurationFile( tmpWorkingDirectoryPath, {
+			'configuration-version': '1',
+			slug,
+			overrides: expectedOverrides,
+		} );
+
+		const spawnOptions = {
+			env,
+			cwd: tmpWorkingDirectoryPath,
+		};
+
+		const result = await cliTest.spawn(
+			[ process.argv[ 0 ], vipDevEnvCreate ],
+			spawnOptions,
+			true
+		);
+		expect( result.rc ).toBe( 0 );
+		expect( result.stdout ).toContain( `Using environment ${ slug }` );
+		expect( result.stderr ).toBe( '' );
+
+		const data = readEnvironmentData( slug );
+		expect( data ).toMatchObject( {
+			siteSlug: slug,
+			overrides: expectedOverrides,
+		} );
+
+		const overrideFile = path.join( tmpPath, 'vip', 'dev-environment', slug, '.lando.local.yml' );
+		const overrideContent = await readFile( overrideFile, 'utf8' );
+		expect( overrideContent ).toBe( expectedOverrides );
+	} );
+
+	it( 'should remove .lando.local.yml if no overrides have been provided', async () => {
+		const slug = getProjectSlug();
+		const overrides = `services:\n  wordpress:\n    services:\n      pull_policy: never\n`;
+
+		expect( await checkEnvExists( slug ) ).toBe( false );
+
+		await writeConfigurationFile( tmpWorkingDirectoryPath, {
+			'configuration-version': '1',
+			slug,
+			overrides,
+		} );
+
+		const spawnOptions = {
+			env,
+			cwd: tmpWorkingDirectoryPath,
+		};
+
+		let result = await cliTest.spawn( [ process.argv[ 0 ], vipDevEnvCreate ], spawnOptions, true );
+		expect( result.rc ).toBe( 0 );
+		expect( result.stdout ).toContain( `Using environment ${ slug }` );
+		expect( result.stderr ).toBe( '' );
+
+		await writeConfigurationFile( tmpWorkingDirectoryPath, {
+			'configuration-version': '1',
+			slug,
+			overrides: '',
+		} );
+
+		result = await cliTest.spawn( [ process.argv[ 0 ], vipDevEnvUpdate ], spawnOptions, true );
+		expect( result.rc ).toBe( 0 );
+		expect( result.stderr ).toBe( '' );
+
+		const data = readEnvironmentData( slug );
+		expect( data.overrides ).toBeFalsy();
+
+		const overrideFile = path.join( tmpPath, 'vip', 'dev-environment', slug, '.lando.local.yml' );
+		return expect( stat( overrideFile ) ).rejects.toThrow();
+	} );
 } );

src/lib/dev-environment/dev-environment-cli.ts

@@ -309,6 +309,7 @@ export async function promptForArguments(
 		mailpit: false,
 		photon: false,
 		cron: false,
+		overrides: preselectedOptions.overrides,
 	};
 
 	const promptLabels = {

src/lib/dev-environment/dev-environment-configuration-file.ts

@@ -116,6 +116,7 @@ function sanitizeConfiguration(
 		'media-redirect-domain': configuration[ 'media-redirect-domain' ]?.toString(),
 		photon: stringToBooleanIfDefined( configuration.photon ),
 		cron: stringToBooleanIfDefined( configuration.cron ),
+		overrides: configuration.overrides?.toString(),
 		meta: configurationMeta,
 	};
 
@@ -174,6 +175,7 @@ export function mergeConfigurationFileOptions(
 		mediaRedirectDomain: configurationFileOptions[ 'media-redirect-domain' ],
 		photon: configurationFileOptions.photon,
 		cron: configurationFileOptions.cron,
+		overrides: configurationFileOptions.overrides,
 	};
 
 	const mergedOptions: InstanceOptions = {};

src/lib/dev-environment/dev-environment-core.ts

@@ -73,6 +73,7 @@ const nginxFileTemplatePath = path.join(
 	'dev-env.nginx.template.conf.ejs'
 );
 const landoFileName = '.lando.yml';
+const landoOverridesFileName = '.lando.local.yml';
 const landoBackupFileName = '.lando.backup.yml';
 const nginxFileName = 'extra.conf';
 const instanceDataFileName = 'instance_data.json';
@@ -257,6 +258,8 @@ function preProcessInstanceData( instanceData: InstanceData ): InstanceData {
 	newInstanceData.autologinKey = uuid();
 	newInstanceData.version = DEV_ENVIRONMENT_VERSION;
 
+	newInstanceData.overrides = instanceData.overrides ?? '';
+
 	return newInstanceData;
 }
 
@@ -557,6 +560,7 @@ async function prepareLandoEnv(
 	const instanceDataFile = JSON.stringify( instanceData );
 
 	const landoFileTargetPath = path.join( instancePath, landoFileName );
+	const landoOverridesFileTargetPath = path.join( instancePath, landoOverridesFileName );
 	const landoBackupFileTargetPath = path.join( instancePath, landoBackupFileName );
 	const nginxFolderPath = path.join( instancePath, nginxPathString );
 	const nginxFileTargetPath = path.join( nginxFolderPath, nginxFileName );
@@ -586,6 +590,12 @@ async function prepareLandoEnv(
 	debug( `Instance data file created in ${ instanceDataTargetPath }` );
 
 	await writeIntegrationsConfig( instancePath, integrationsConfig );
+
+	if ( instanceData.overrides ) {
+		await fs.promises.writeFile( landoOverridesFileTargetPath, instanceData.overrides );
+	} else {
+		await fs.promises.rm( landoOverridesFileTargetPath, { force: true } );
+	}
 }
 
 export function getAllEnvironmentNames(): string[] {

src/lib/dev-environment/types.ts

@@ -16,6 +16,7 @@ export interface InstanceOptions {
 	mailpit?: boolean;
 	photon?: boolean;
 	cron?: boolean;
+	overrides?: string;
 
 	[ index: string ]: unknown;
 }
@@ -86,6 +87,7 @@ export interface ConfigurationFileOptions {
 	'media-redirect-domain'?: string;
 	photon?: boolean;
 	cron?: boolean;
+	overrides?: string;
 
 	meta?: ConfigurationFileMeta;
 	[ index: string ]: unknown;
@@ -116,4 +118,5 @@ export interface InstanceData {
 	pullAfter?: number;
 	autologinKey?: string;
 	version?: string;
+	overrides?: string;
 }