Create POC of Fix dev spaces devfile api tests to avoid using an absolute devfile registry for PHP stack

tests/e2e/specs/api/EmptyWorkspaceAPI.spec.ts

@@ -34,9 +34,10 @@ suite('Empty workspace API test', function (): void {
 	suiteSetup(`Create empty workspace with OC client ${BASE_TEST_CONSTANTS.TEST_ENVIRONMENT}`, async function (): Promise<void> {
 		const workspaceName: string = 'empty-' + Math.floor(Math.random() * 1000);
 		const devfileContent: string = 'schemaVersion: 2.2.0\n' + 'metadata:\n' + `  name: ${workspaceName}\n`;
+		const editorContent:string='';
 
 		devWorkspaceConfigurationHelper = new DevWorkspaceConfigurationHelper({
-			devfileContent
+			devfileContent, editorContent
 		});
 		devfileContext = await devWorkspaceConfigurationHelper.generateDevfileContext();
 		devWorkspaceName = devfileContext?.devWorkspace?.metadata?.name;

tests/e2e/specs/api/PhpDevFileAPI.spec.ts

@@ -0,0 +1,70 @@
+/** *******************************************************************
+ * copyright (c) 2023 Red Hat, Inc.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+import { BASE_TEST_CONSTANTS } from '../../constants/BASE_TEST_CONSTANTS';
+import { e2eContainer } from '../../configs/inversify.config';
+import { CLASSES } from '../../configs/inversify.types';
+import {Logger} from "../../utils/Logger";
+import {DevfilesRegistryHelper} from "../../utils/DevfilesRegistryHelper";
+import {ContainerTerminal, KubernetesCommandLineToolsExecutor} from "../../utils/KubernetesCommandLineToolsExecutor";
+import {ShellExecutor} from "../../utils/ShellExecutor";
+import {DevWorkspaceConfigurationHelper} from "../../utils/DevWorkspaceConfigurationHelper";
+import {DevfileContext} from "@eclipse-che/che-devworkspace-generator/lib/api/devfile-context";
+import {ShellString} from "shelljs";
+import {expect} from "chai";
+import {API_TEST_CONSTANTS} from "../../constants/API_TEST_CONSTANTS";
+import YAML from "yaml";
+import {StringUtil} from "../../utils/StringUtil";
+import {string} from "yaml/dist/schema/common/string";
+
+
+suite('PHP devfile API test', function (): void {
+    const devfilesRegistryHelper: DevfilesRegistryHelper = e2eContainer.get(CLASSES.DevfilesRegistryHelper);
+    const kubernetesCommandLineToolsExecutor: KubernetesCommandLineToolsExecutor = e2eContainer.get(CLASSES.KubernetesCommandLineToolsExecutor);
+    let containerTerminal: ContainerTerminal = e2eContainer.get(CLASSES.ContainerTerminal);
+    let devWorkspaceConfigurationHelper: DevWorkspaceConfigurationHelper;
+    let devfileContext: DevfileContext;
+    let devfileContent: string ='';
+
+    suiteSetup(`Prepare login ${BASE_TEST_CONSTANTS.TEST_ENVIRONMENT}`, async function (): Promise<void> {
+        kubernetesCommandLineToolsExecutor.loginToOcp();
+    });
+
+    test('Create  PHP DevSpace', async function (): Promise<void> {
+        kubernetesCommandLineToolsExecutor.namespace = 'admin-devspaces';
+        devfileContent = devfilesRegistryHelper.getDevfileContent('php');
+        const editorDevfileContent: string = devfilesRegistryHelper.obtainCheDevFileEditorFromCheConfigMap('editors-definitions');
+        kubernetesCommandLineToolsExecutor.workspaceName = YAML.parse(devfileContent).metadata.name;
+
+        devWorkspaceConfigurationHelper = new DevWorkspaceConfigurationHelper({
+            editorContent: editorDevfileContent, devfileContent: devfileContent
+        });
+        devfileContext = await devWorkspaceConfigurationHelper.generateDevfileContext();
+
+        const devWorkspaceConfigurationYamlString: string =
+            devWorkspaceConfigurationHelper.getDevWorkspaceConfigurationYamlAsString(devfileContext);
+        const output: ShellString = kubernetesCommandLineToolsExecutor.applyAndWaitDevWorkspace(devWorkspaceConfigurationYamlString);
+        expect(output.stdout).contains('condition met');
+    });
+
+    test('Check running application', async function (): Promise<void> {
+        const workdir:string = YAML.parse(devfileContent).commands[0].exec.workingDir;
+        const commandLine:string = YAML.parse(devfileContent).commands[0].exec.commandLine;
+        const containerName:string = YAML.parse(devfileContent).commands[0].exec.component;
+        const runCommandInBash:string = `cd ${workdir} && ${commandLine}`;
+        const output: ShellString = containerTerminal.execInContainerCommand(runCommandInBash, containerName);
+        expect(output.code).eqls(0);
+        expect(output.stdout.trim()).contains('Hello, world!');
+
+    });
+
+    suiteTeardown('Delete workspace', function (): void {
+        kubernetesCommandLineToolsExecutor.deleteDevWorkspace();
+    });
+});

tests/e2e/utils/DevWorkspaceConfigurationHelper.ts

@@ -20,6 +20,7 @@ import { IContextParams } from './IContextParams';
 import { e2eContainer } from '../configs/inversify.config';
 import { CLASSES, EXTERNAL_CLASSES } from '../configs/inversify.types';
 import getDecorators from 'inversify-inject-decorators';
+import {DevfilesRegistryHelper} from "./DevfilesRegistryHelper";
 
 const { lazyInject } = getDecorators(e2eContainer);
 
@@ -98,6 +99,7 @@ export class DevWorkspaceConfigurationHelper {
 
 		return content;
 	}
+
 	patchDevWorkspaceConfigWithBuildContainerAttribute(devfileContextDevWorkspace: any): void {
 		Logger.debug();
 		devfileContextDevWorkspace.spec.template.attributes = YAML.parse(`

tests/e2e/utils/DevfilesRegistryHelper.ts

@@ -13,9 +13,20 @@ import YAML from 'yaml';
 import { API_TEST_CONSTANTS, SUPPORTED_DEVFILE_REGISTRIES } from '../constants/API_TEST_CONSTANTS';
 import { injectable } from 'inversify';
 import { BASE_TEST_CONSTANTS, Platform } from '../constants/BASE_TEST_CONSTANTS';
+import {ShellExecutor} from "./ShellExecutor";
+import {e2eContainer} from "../configs/inversify.config";
+import {CLASSES} from "../configs/inversify.types";
 
 @injectable()
 export class DevfilesRegistryHelper {
+
+	private getShellExecutor(): ShellExecutor {
+		return e2eContainer.get(CLASSES.ShellExecutor);
+	}
+	/**
+	 * @deprecated applicable only for inbuilt devfiles
+	 * @param sampleNamePatterns
+	 */
 	async getInbuiltDevfilesRegistryContent(sampleNamePatterns?: string[]): Promise<any[]> {
 		Logger.trace();
 
@@ -35,6 +46,12 @@ export class DevfilesRegistryHelper {
 		return await this.getContent(url);
 	}
 
+	/**
+	 *
+	 * @deprecated applicable only for inbuilt devfiles
+	 * @param isInbuilt
+	 * @param sampleNamePatterns
+	 */
 	async collectPathsToDevfilesFromRegistry(isInbuilt: boolean, sampleNamePatterns?: string[]): Promise<object[]> {
 		Logger.debug();
 
@@ -86,9 +103,6 @@ export class DevfilesRegistryHelper {
 		return devfileSamples;
 	}
 
-	async getEditorContent(entry: string): Promise<any> {
-		return await this.getContent(`${BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL}/${entry}`);
-	}
 
 	private filterSamples(sampleNamePatterns: string[] | undefined, content: any): Promise<any[]> {
 		if (sampleNamePatterns) {
@@ -120,4 +134,47 @@ export class DevfilesRegistryHelper {
 		}
 		return response?.data;
 	}
+
+	public getInternalClusterURLToDevFile(devFileName:string): string {
+		let devfileSampleURIPrefix:string = `/dashboard/api/airgap-sample/devfile/download?id=${devFileName}`;
+		let serviceClusterIp:string = ''
+		let servicePort:string = ''
+		serviceClusterIp = this.getShellExecutor().executeArbitraryShellScript(`oc get svc devspaces-dashboard -n  ${BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} -o=jsonpath='{.spec.clusterIP}'`);
+		servicePort = this.getShellExecutor().executeArbitraryShellScript(`oc get svc devspaces-dashboard -n  ${BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} -o=jsonpath='{.spec.ports[*].port}'`);
+		return `http://${serviceClusterIp}:${servicePort}${devfileSampleURIPrefix}`;
+	}
+
+	/**
+	 * grab devfile content from the Dashboard pod (currently, in the image of dashboard builds with devfile content and we use it for getting devfile description)
+	 * @param podName
+	 * @param containerName
+	 * @param devFileName
+	 */
+	public obtainDevFileContentUsingPod(podName:string, containerName:string, devFileName:string): string {
+		const clusterURL:string = this.getInternalClusterURLToDevFile(devFileName);
+		this.getShellExecutor().executeCommand(`oc exec -i ${podName} -n  ${BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} -c ${containerName} -- sh -c 'curl -o /tmp/${devFileName}-devfile.yaml ${clusterURL}'`);
+		return this.getShellExecutor().executeArbitraryShellScript(`oc exec -i ${podName} -n  ${BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} -c ${containerName} -- cat /tmp/${devFileName}-devfile.yaml`).toString();
+	}
+
+	/**
+	 *  use internal CHE config map for getting description of CHE editor
+	 * @param configMapName
+	 */
+	public obtainCheDevFileEditorFromCheConfigMap(configMapName: string): string {
+		return this.getShellExecutor().executeCommand(`oc get configmap ${configMapName} -o jsonpath="{.data.che-code\\.yaml}" -n ${BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()}`);
+	}
+
+	/**
+	 * find the Dashboard pod and container name and grab devfile content from it
+	 * @param devSample
+	 */
+	public getDevfileContent(devSample: string): string {
+		const command: string = `oc get pods -n ${BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()}`;
+		console.log(`command: ${command}`);
+		const podName: string = this.getShellExecutor().executeArbitraryShellScript(`oc get pods -n ${BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} | grep dashboard | awk \'{print $1}\'`).trim()
+		const containerName: string =  this.getShellExecutor().executeArbitraryShellScript(`oc get pod -n ${BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} ${podName} -o jsonpath=\'{.spec.containers[*].name}\'`)
+		const devfileContent: string = this.obtainDevFileContentUsingPod(podName, containerName, devSample);
+		return devfileContent;
+	}
+
 }