refactor registryCompatibilityOCI to iterate over several registries

Author: joshspicer

src/spec-configuration/httpOCIRegistry.ts

@@ -136,8 +136,8 @@ export async function requestEnsureAuthenticated(params: CommonParams, httpOptio
 // This credential is used to offer the registry in exchange for a Bearer token.
 // These may be:
 //   - parsed out of a special DEVCONTAINERS_OCI_AUTH environment variable
-//   - Read from a docker config file
 //   - Read from a docker credential helper (https://docs.docker.com/engine/reference/commandline/login/#credentials-store)
+//   - Read from a docker config file
 //   - Crafted from the GITHUB_TOKEN environment variable
 //  Returns:
 //   - undefined: No credential was found.
@@ -219,13 +219,15 @@ async function getCredentialFromDockerConfigOrCredentialHelper(params: CommonPar
 			const dockerConfig: DockerConfigFile = jsonc.parse((await readLocalFile(dockerConfigFilePath)).toString());
 
 			configContainsAuth = Object.keys(dockerConfig.credHelpers || {}).length > 0 || !!dockerConfig.credsStore || Object.keys(dockerConfig.auths || {}).length > 0;
+			// https://docs.docker.com/engine/reference/commandline/login/#credential-helpers
 			if (dockerConfig.credHelpers && dockerConfig.credHelpers[registry]) {
 				const credHelper = dockerConfig.credHelpers[registry];
 				output.write(`[httpOci] Found credential helper '${credHelper}' in '${dockerConfigFilePath}' registry '${registry}'`, LogLevel.Trace);
 				const auth = await getCredentialFromHelper(params, registry, credHelper);
 				if (auth) {
 					return auth;
 				}
+			// https://docs.docker.com/engine/reference/commandline/login/#credentials-store
 			} else if (dockerConfig.credsStore) {
 				output.write(`[httpOci] Invoking credsStore credential helper '${dockerConfig.credsStore}'`, LogLevel.Trace);
 				const auth = await getCredentialFromHelper(params, registry, dockerConfig.credsStore);
@@ -280,7 +282,7 @@ async function getCredentialFromDockerConfigOrCredentialHelper(params: CommonPar
 		}
 	}
 
-	// No auth found.
+	// No auth found from docker config or credential helper.
 	return;
 }
 

src/test/container-features/configs/azure-container-registry/.devcontainer.json

@@ -9,9 +9,34 @@ import { devContainerDown, devContainerUp, shellExec } from '../testUtils';
 
 const pkg = require('../../../package.json');
 
-describe('Registry Compatibility', function () {
-	this.timeout('120s');
+interface TestPlan {
+	name: string;
+	configName: string;
+	testFeatureId: string;
+	testCommand?: string;
+	testCommandResult?: RegExp;
+}
+
+const defaultTestPlan = {
+	testCommand: 'color',
+	testCommandResult: /my favorite color is pink/,
+};
 
+const registryCompatibilityTestPlan: TestPlan[] = [
+	{
+		name: 'Anonymous access of Azure Container Registry',
+		configName: 'azure-anonymous',
+		testFeatureId: 'devcontainercli.azurecr.io/features/color',
+	},
+	{
+		name: 'Anonymous access of GHCR',
+		configName: 'github-anonymous',
+		testFeatureId: 'ghcr.io/devcontainers/feature-starter/color',
+	}
+];
+
+describe('Registry Compatibility', function () {
+	this.timeout('1200s');
 	const tmp = path.relative(process.cwd(), path.join(__dirname, 'tmp'));
 	const cli = `npx --prefix ${tmp} devcontainer`;
 
@@ -21,41 +46,43 @@ describe('Registry Compatibility', function () {
 		await shellExec(`npm --prefix ${tmp} install devcontainers-cli-${pkg.version}.tgz`);
 	});
 
-	// TODO: Matrix this test against all tested registries
-	describe('Azure Container Registry', () => {
+	registryCompatibilityTestPlan.forEach(({ name, configName, testFeatureId, testCommand, testCommandResult }) => {
+		this.timeout('120s');
+		describe(name, () => {
+			describe('devcontainer up', () => {
+				let containerId: string | null = null;
+				const testFolder = `${__dirname}/configs/registry-compatibility/${configName}`;
 
-		describe(`'devcontainer up' with a Feature anonymously pulled from ACR`, () => {
-			let containerId: string | null = null;
-			const testFolder = `${__dirname}/configs/azure-container-registry`;
+				before(async () => containerId = (await devContainerUp(cli, testFolder, { 'logLevel': 'trace' })).containerId);
+				after(async () => await devContainerDown({ containerId }));
 
-			before(async () => containerId = (await devContainerUp(cli, testFolder, { 'logLevel': 'trace' })).containerId);
-			after(async () => await devContainerDown({ containerId }));
+				const cmd = testCommand ?? defaultTestPlan.testCommand;
+				const expected = testCommandResult ?? defaultTestPlan.testCommandResult;
 
-			it('should exec the color command', async () => {
-				const res = await shellExec(`${cli} exec --workspace-folder ${testFolder} color`);
-				assert.strictEqual(res.error, null);
-				assert.match(res.stdout, /my favorite color is pink/);
+				it(`should exec the ${cmd} command`, async () => {
+					const res = await shellExec(`${cli} exec --workspace-folder ${testFolder} ${cmd} `);
+					assert.strictEqual(res.error, null);
+					assert.match(res.stdout, expected);
+				});
 			});
-		});
-
-		describe(`devcontainer features info manifest`, async () => {
-
-			it('fetches manifest anonymously from ACR', async () => {
 
-				let infoManifestResult: { stdout: string; stderr: string } | null = null;
-				let success = false;
-				try {
-					infoManifestResult = await shellExec(`${cli} features info manifest devcontainercli.azurecr.io/features/hello --log-level trace`);
-					success = true;
-				} catch (error) {
-					assert.fail('features info tags sub-command should not throw');
-				}
+			describe(`devcontainer features info manifest`, async () => {
+				it('fetches manifest', async () => {
+					let infoManifestResult: { stdout: string; stderr: string } | null = null;
+					let success = false;
+					try {
+						infoManifestResult = await shellExec(`${cli} features info manifest ${testFeatureId} --log-level trace`);
+						success = true;
+					} catch (error) {
+						assert.fail('features info tags sub-command should not throw');
+					}
 
-				assert.isTrue(success);
-				assert.isDefined(infoManifestResult);
-				const manifest = infoManifestResult.stdout;
-				const regex = /application\/vnd\.devcontainers\.layer\.v1\+tar/;
-				assert.match(manifest, regex);
+					assert.isTrue(success);
+					assert.isDefined(infoManifestResult);
+					const manifest = infoManifestResult.stdout;
+					const regex = /application\/vnd\.devcontainers\.layer\.v1\+tar/;
+					assert.match(manifest, regex);
+				});
 			});
 		});
 	});