features resolve-dependencies and template apply test

Author: Mathiyarasy

src/test/container-features/featuresCLICommands.test.ts

@@ -425,6 +425,119 @@ describe('CLI features subcommands', async function () {
 		});
 	});
 
+	describe('features resolve-dependencies', function () {
+
+		it('should resolve dependencies when workspace-folder defaults to current directory', async function () {
+			// Create a test config with features that have dependencies
+			const testConfigPath = path.resolve(__dirname, 'configs/feature-dependencies/dependsOn/oci-ab');
+			const originalCwd = process.cwd();
+
+			try {
+				// Change to test config directory to test default workspace folder behavior
+				process.chdir(testConfigPath);
+
+				// Use absolute path to CLI to prevent npm ENOENT errors
+				const absoluteTmpPath = path.resolve(originalCwd, tmp);
+				const absoluteCliPath = `npx --prefix ${absoluteTmpPath} devcontainer`;
+
+				// First check if the config file exists
+				const configExists = require('fs').existsSync('.devcontainer/devcontainer.json') ||
+					require('fs').existsSync('.devcontainer.json');
+				assert.isTrue(configExists, 'Test config file should exist');
+
+				let result;
+				try {
+					result = await shellExec(`${absoluteCliPath} features resolve-dependencies --log-level trace`);
+				} catch (error: any) {
+					// If command fails, log details for debugging
+					console.error('Command failed:', error);
+					if (error.stderr) {
+						console.error('STDERR:', error.stderr);
+					}
+					if (error.stdout) {
+						console.error('STDOUT:', error.stdout);
+					}
+					throw error;
+				}
+
+				// Verify the command succeeded
+				assert.isDefined(result);
+				assert.isString(result.stdout);
+				assert.isNotEmpty(result.stdout.trim(), 'Command should produce output');
+
+				// Parse the JSON output to verify it contains expected structure
+				let jsonOutput;
+				try {
+					// Try parsing stdout directly first
+					jsonOutput = JSON.parse(result.stdout.trim());
+				} catch (parseError) {
+					// If direct parsing fails, try extracting JSON from mixed output
+					const lines = result.stdout.split('\n');
+
+					// Find the last occurrence of '{' that starts a complete JSON object
+					let jsonStartIndex = -1;
+					let jsonEndIndex = -1;
+					let braceCount = 0;
+
+					// Work backwards from the end to find the complete JSON
+					for (let i = lines.length - 1; i >= 0; i--) {
+						const line = lines[i].trim();
+						if (line === '}' && jsonEndIndex === -1) {
+							jsonEndIndex = i;
+							braceCount = 1;
+						} else if (jsonEndIndex !== -1) {
+							// Count braces to find matching opening
+							for (const char of line) {
+								if (char === '}') {
+									braceCount++;
+								} else if (char === '{') {
+									braceCount--;
+								}
+							}
+							if (braceCount === 0 && line === '{') {
+								jsonStartIndex = i;
+								break;
+							}
+						}
+					}
+
+					if (jsonStartIndex >= 0 && jsonEndIndex >= 0) {
+						// Extract just the JSON lines
+						const jsonLines = lines.slice(jsonStartIndex, jsonEndIndex + 1);
+						const jsonString = jsonLines.join('\n');
+						try {
+							jsonOutput = JSON.parse(jsonString);
+						} catch (innerError) {
+							console.error('Failed to parse extracted JSON:', jsonString.substring(0, 500) + '...');
+							throw new Error(`Failed to parse extracted JSON: ${innerError}`);
+						}
+					} else {
+						console.error('Could not find complete JSON in output');
+						console.error('Last 10 lines:', lines.slice(-10));
+						throw new Error(`Failed to find complete JSON in output: ${parseError}`);
+					}
+				}
+
+				assert.isDefined(jsonOutput, 'Should have valid JSON output');
+				assert.property(jsonOutput, 'installOrder');
+				assert.isArray(jsonOutput.installOrder);
+
+				// Verify the install order contains the expected features
+				const installOrder = jsonOutput.installOrder;
+				assert.isAbove(installOrder.length, 0, 'Install order should contain at least one feature');
+
+				// Each item should have id and options
+				installOrder.forEach((item: any) => {
+					assert.property(item, 'id');
+					assert.property(item, 'options');
+				});
+
+			} finally {
+				process.chdir(originalCwd);
+			}
+		});
+	});
+
 	describe('features package', function () {
 
 		it('features package subcommand by collection', async function () {

src/test/container-templates/templatesCLICommands.test.ts

@@ -62,6 +62,60 @@ describe('tests apply command', async function () {
 		// Assert that the Feature included in the command was added.
 		assert.match(file, /"ghcr.io\/devcontainers\/features\/azure-cli:1": {\n/);
 	});
+
+	it('templates apply subcommand with default workspace folder', async function () {
+		const testOutputPath = path.resolve(__dirname, 'tmp-default-workspace');
+		const originalCwd = process.cwd();
+
+		try {
+			// Create and change to test output directory to test default workspace folder behavior
+			await shellExec(`rm -rf ${testOutputPath}`);
+			await shellExec(`mkdir -p ${testOutputPath}`);
+			process.chdir(testOutputPath);
+
+			// Use absolute path to CLI to prevent npm ENOENT errors
+			const absoluteTmpPath = path.resolve(originalCwd, tmp);
+			const absoluteCliPath = `npx --prefix ${absoluteTmpPath} devcontainer`;
+
+			let success = false;
+			let result: ExecResult | undefined = undefined;
+
+			try {
+				// Run without --workspace-folder to test default behavior
+				result = await shellExec(`${absoluteCliPath} templates apply \
+				--template-id     ghcr.io/devcontainers/templates/docker-from-docker:latest \
+				--template-args   '{ "installZsh": "false", "upgradePackages": "true", "dockerVersion": "20.10", "moby": "true", "enableNonRootDocker": "true" }' \
+				--log-level trace`);
+				success = true;
+
+			} catch (error) {
+				assert.fail('templates apply sub-command should not throw when using default workspace folder');
+			}
+
+			assert.isTrue(success);
+			assert.isDefined(result);
+			assert.strictEqual(result.stdout.trim(), '{"files":["./.devcontainer/devcontainer.json"]}');
+
+			// Verify the file was created in the current working directory (default workspace folder)
+			const file = (await readLocalFile(path.join(testOutputPath, '.devcontainer', 'devcontainer.json'))).toString();
+
+			assert.match(file, /"name": "Docker from Docker"/);
+			assert.match(file, /"installZsh": "false"/);
+			assert.match(file, /"upgradePackages": "true"/);
+			assert.match(file, /"version": "20.10"/);
+			assert.match(file, /"moby": "true"/);
+			assert.match(file, /"enableNonRootDocker": "true"/);
+
+			// Assert that the Features included in the template were not removed.
+			assert.match(file, /"ghcr.io\/devcontainers\/features\/common-utils:1": {\n/);
+			assert.match(file, /"ghcr.io\/devcontainers\/features\/docker-from-docker:1": {\n/);
+
+		} finally {
+			process.chdir(originalCwd);
+			// Clean up test directory
+			await shellExec(`rm -rf ${testOutputPath}`);
+		}
+	});
 });
 
 describe('tests packageTemplates()', async function () {