|
| 1 | +/** ******************************************************************* |
| 2 | + * copyright (c) 2024 Red Hat, Inc. |
| 3 | + * |
| 4 | + * This program and the accompanying materials are made |
| 5 | + * available under the terms of the Eclipse Public License 2.0 |
| 6 | + * which is available at https://www.eclipse.org/legal/epl-2.0/ |
| 7 | + * |
| 8 | + * SPDX-License-Identifier: EPL-2.0 |
| 9 | + **********************************************************************/ |
| 10 | +import { BASE_TEST_CONSTANTS } from '../../constants/BASE_TEST_CONSTANTS'; |
| 11 | +import { e2eContainer } from '../../configs/inversify.config'; |
| 12 | +import { CLASSES } from '../../configs/inversify.types'; |
| 13 | +import { DevfilesHelper } from '../../utils/DevfilesHelper'; |
| 14 | +import { ContainerTerminal, KubernetesCommandLineToolsExecutor } from '../../utils/KubernetesCommandLineToolsExecutor'; |
| 15 | +import { DevWorkspaceConfigurationHelper } from '../../utils/DevWorkspaceConfigurationHelper'; |
| 16 | +import { DevfileContext } from '@eclipse-che/che-devworkspace-generator/lib/api/devfile-context'; |
| 17 | +import { ShellString } from 'shelljs'; |
| 18 | +import { expect } from 'chai'; |
| 19 | +import { API_TEST_CONSTANTS } from '../../constants/API_TEST_CONSTANTS'; |
| 20 | +import YAML from 'yaml'; |
| 21 | +import { Logger } from '../../utils/Logger'; |
| 22 | +import crypto from 'crypto'; |
| 23 | + |
| 24 | +suite('NodeJS Express devfile API test', function (): void { |
| 25 | + const devfilesRegistryHelper: DevfilesHelper = e2eContainer.get(CLASSES.DevfilesRegistryHelper); |
| 26 | + const kubernetesCommandLineToolsExecutor: KubernetesCommandLineToolsExecutor = e2eContainer.get( |
| 27 | + CLASSES.KubernetesCommandLineToolsExecutor |
| 28 | + ); |
| 29 | + const devfileID: string = 'nodejs-express'; |
| 30 | + const containerTerminal: ContainerTerminal = e2eContainer.get(CLASSES.ContainerTerminal); |
| 31 | + let devWorkspaceConfigurationHelper: DevWorkspaceConfigurationHelper; |
| 32 | + let devfileContext: DevfileContext; |
| 33 | + let devfileContent: string = ''; |
| 34 | + let devfileName: string = ''; |
| 35 | + |
| 36 | + suiteSetup(`Prepare login ${BASE_TEST_CONSTANTS.TEST_ENVIRONMENT}`, function (): void { |
| 37 | + kubernetesCommandLineToolsExecutor.loginToOcp(); |
| 38 | + }); |
| 39 | + |
| 40 | + test(`Create ${devfileID} workspace`, async function (): Promise<void> { |
| 41 | + const randomPref: string = crypto.randomBytes(4).toString('hex'); |
| 42 | + kubernetesCommandLineToolsExecutor.namespace = API_TEST_CONSTANTS.TS_API_TEST_NAMESPACE || 'admin-devspaces'; |
| 43 | + devfileContent = devfilesRegistryHelper.getDevfileContent(devfileID); |
| 44 | + const editorDevfileContent: string = devfilesRegistryHelper.obtainCheDevFileEditorFromCheConfigMap('editors-definitions'); |
| 45 | + devfileName = YAML.parse(devfileContent).metadata.name; |
| 46 | + const uniqueName: string = YAML.parse(devfileContent).metadata.name + randomPref; |
| 47 | + kubernetesCommandLineToolsExecutor.workspaceName = uniqueName; |
| 48 | + |
| 49 | + devWorkspaceConfigurationHelper = new DevWorkspaceConfigurationHelper({ |
| 50 | + editorContent: editorDevfileContent, |
| 51 | + devfileContent: devfileContent |
| 52 | + }); |
| 53 | + devfileContext = await devWorkspaceConfigurationHelper.generateDevfileContext(); |
| 54 | + if (devfileContext.devWorkspace.metadata) { |
| 55 | + devfileContext.devWorkspace.metadata.name = uniqueName; |
| 56 | + } |
| 57 | + const devWorkspaceConfigurationYamlString: string = |
| 58 | + devWorkspaceConfigurationHelper.getDevWorkspaceConfigurationYamlAsString(devfileContext); |
| 59 | + const output: ShellString = kubernetesCommandLineToolsExecutor.applyAndWaitDevWorkspace(devWorkspaceConfigurationYamlString); |
| 60 | + expect(output.stdout).contains('condition met'); |
| 61 | + }); |
| 62 | + |
| 63 | + test('Check packaging application', function (): void { |
| 64 | + const containerName: string = YAML.parse(devfileContent).commands[0].exec.component; |
| 65 | + |
| 66 | + if (BASE_TEST_CONSTANTS.IS_CLUSTER_DISCONNECTED()) { |
| 67 | + Logger.info('Test cluster is disconnected. Ignore Self-Signed Certificate error.'); |
| 68 | + const ignoreSelfSignedCertificateErrorCommand: string = 'npm config set strict-ssl false'; |
| 69 | + const output: ShellString = containerTerminal.execInContainerCommand(ignoreSelfSignedCertificateErrorCommand, containerName); |
| 70 | + expect(output.code).eqls(0); |
| 71 | + } |
| 72 | + |
| 73 | + const workdir: string = YAML.parse(devfileContent).commands[0].exec.workingDir; |
| 74 | + const commandLine: string = YAML.parse(devfileContent).commands[0].exec.commandLine; |
| 75 | + Logger.info(`workdir from exec section of DevWorkspace file: ${workdir}`); |
| 76 | + Logger.info(`commandLine from exec section of DevWorkspace file: ${commandLine}`); |
| 77 | + |
| 78 | + let runCommandInBash: string = commandLine.replaceAll('$', '\\$'); // don't wipe out env. vars like "${PROJECTS_ROOT}" |
| 79 | + if (workdir !== undefined && workdir !== '') { |
| 80 | + runCommandInBash = `cd ${workdir} && ` + runCommandInBash; |
| 81 | + } |
| 82 | + |
| 83 | + const output: ShellString = containerTerminal.execInContainerCommand(runCommandInBash, containerName); |
| 84 | + expect(output.code).eqls(0); |
| 85 | + |
| 86 | + const outputText: string = output.stdout.trim(); |
| 87 | + expect(outputText).contains('packages in'); |
| 88 | + }); |
| 89 | + |
| 90 | + test('Check "run the web app" command', function (): void { |
| 91 | + const containerName: string = YAML.parse(devfileContent).commands[0].exec.component; |
| 92 | + const workdir: string = YAML.parse(devfileContent).commands[1].exec.workingDir; |
| 93 | + const commandLine: string = YAML.parse(devfileContent).commands[1].exec.commandLine; |
| 94 | + Logger.info(`workdir from exec section of DevWorkspace file: ${workdir}`); |
| 95 | + Logger.info(`commandLine from exec section of DevWorkspace file: ${commandLine}`); |
| 96 | + |
| 97 | + let runCommandInBash: string = commandLine.replaceAll('$', '\\$'); // don't wipe out env. vars like "${PROJECTS_ROOT}" |
| 98 | + if (workdir !== undefined && workdir !== '') { |
| 99 | + runCommandInBash = `cd ${workdir} && ` + runCommandInBash; |
| 100 | + } |
| 101 | + |
| 102 | + const output: ShellString = containerTerminal.execInContainerCommandWithTimeout(runCommandInBash, containerName); |
| 103 | + expect(output.code).eqls(124); |
| 104 | + |
| 105 | + const outputText: string = output.stdout.trim(); |
| 106 | + expect(outputText).contains('Example app listening on port 3000!'); |
| 107 | + }); |
| 108 | + |
| 109 | + test('Check "stop the web app" command', function (): void { |
| 110 | + const containerName: string = YAML.parse(devfileContent).commands[0].exec.component; |
| 111 | + const workdir: string = YAML.parse(devfileContent).commands[4].exec.workingDir; |
| 112 | + const commandLine: string = YAML.parse(devfileContent).commands[4].exec.commandLine; |
| 113 | + Logger.info(`workdir from exec section of DevWorkspace file: ${workdir}`); |
| 114 | + Logger.info(`commandLine from exec section of DevWorkspace file: ${commandLine}`); |
| 115 | + |
| 116 | + // stop app command has single and double quotes in the command line, so it should be escaped properly to run by oc exec command in bash |
| 117 | + // stop command -> `node_server_pids=$(pgrep -fx '.*nodemon (--inspect )?app.js' | tr "\\n" " ") && echo "Stopping node server with PIDs: ${node_server_pids}" && kill -15 ${node_server_pids} &>/dev/null && echo 'Done.''` |
| 118 | + |
| 119 | + // prettier changes next line to `replaceAll("'", "'\"'\"'")` that throws an error from eslint. |
| 120 | + // prettier-ignore |
| 121 | + let runCommandInBash: string = commandLine.replaceAll('\'', '\'\"\'\"\''); |
| 122 | + |
| 123 | + if (workdir !== undefined && workdir !== '') { |
| 124 | + runCommandInBash = `cd ${workdir} && ` + runCommandInBash; |
| 125 | + } |
| 126 | + |
| 127 | + const output: ShellString = containerTerminal.execInContainerCommand(runCommandInBash, containerName); |
| 128 | + expect(output.code).eqls(0); |
| 129 | + |
| 130 | + const outputText: string = output.stdout.trim(); |
| 131 | + expect(outputText).contains('Done.'); |
| 132 | + }); |
| 133 | + |
| 134 | + test('Check "Run the web app (debugging enabled)" command', function (): void { |
| 135 | + const containerName: string = YAML.parse(devfileContent).commands[0].exec.component; |
| 136 | + |
| 137 | + const workdir: string = YAML.parse(devfileContent).commands[3].exec.workingDir; |
| 138 | + const commandLine: string = YAML.parse(devfileContent).commands[3].exec.commandLine; |
| 139 | + Logger.info(`workdir from exec section of DevWorkspace file: ${workdir}`); |
| 140 | + Logger.info(`commandLine from exec section of DevWorkspace file: ${commandLine}`); |
| 141 | + |
| 142 | + let runCommandInBash: string = commandLine.replaceAll('$', '\\$'); // don't wipe out env. vars like "${PROJECTS_ROOT}" |
| 143 | + if (workdir !== undefined && workdir !== '') { |
| 144 | + runCommandInBash = `cd ${workdir} && ` + runCommandInBash; |
| 145 | + } |
| 146 | + |
| 147 | + const output: ShellString = containerTerminal.execInContainerCommandWithTimeout(runCommandInBash, containerName); |
| 148 | + expect(output.code).eqls(124); |
| 149 | + |
| 150 | + const outputText: string = output.stdout.trim(); |
| 151 | + expect(outputText).contains('Example app listening on port 3000!'); |
| 152 | + }); |
| 153 | + |
| 154 | + suiteTeardown('Delete workspace', function (): void { |
| 155 | + kubernetesCommandLineToolsExecutor.deleteDevWorkspace(devfileName); |
| 156 | + }); |
| 157 | +}); |
0 commit comments