ci: [sync] Push chectl @ main to devspaces-chectl @ devspaces-3-rhel-8

Signed-off-by: devstudio-release <[email protected]>

Author: devstudio-release

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsc",
-  "version": "3.6.0-CI-6d1f-redhat",
+  "version": "3.6.0-CI-redhat",
   "description": "Red Hat OpenShift Dev Spaces CLI",
   "keywords": [
     "oclif"

src/commands/server/deploy.ts

@@ -13,7 +13,7 @@
 import { Command, flags } from '@oclif/command'
 import { cli } from 'cli-ux'
 import { CertManagerInstaller } from '../../tasks/installers/cert-manager-installer'
-import {CheCtlContext, InfrastructureContext } from '../../context'
+import {CheCtlContext, InfrastructureContext} from '../../context'
 import { KubeClient } from '../../api/kube-client'
 import { DEFAULT_ANALYTIC_HOOK_NAME } from '../../constants'
 import { DexInstaller } from '../../tasks/installers/dex-installer'
@@ -92,6 +92,7 @@ import {
 import {CommonTasks} from '../../tasks/common-tasks'
 import {CheTasks} from '../../tasks/che-tasks'
 import {newListr} from '../../utils/utls'
+import {Che} from '../../utils/che'
 
 export default class Deploy extends Command {
   static description = `Deploy ${EclipseChe.PRODUCT_NAME} server`
@@ -143,6 +144,19 @@ export default class Deploy extends Command {
     }
 
     if (!ctx[InfrastructureContext.IS_OPENSHIFT]) {
+      // Ensure required CheCluster fields are set (k8s platforms)
+      if (flags[PLATFORM_FLAG] !== 'minikube') {
+        for (const field of [
+          'spec.networking.auth.identityProviderURL',
+          'spec.networking.auth.oAuthSecret',
+          'spec.networking.auth.oAuthClientName',
+        ]) {
+          if (!Che.getCheClusterFieldConfigured(field)) {
+            this.error(getMissedOIDCConfigClusterFieldErrorMsg())
+          }
+        }
+      }
+
       // Not OLM installer
       if (flags[STARTING_CSV_FLAG]) {
         this.error(`--${STARTING_CSV_FLAG} flag should be used only for OpenShift platform.`)
@@ -241,3 +255,19 @@ function getNamespaceLabels(flags: any): any {
   return {}
 }
 
+function getMissedOIDCConfigClusterFieldErrorMsg(): string {
+  return `Some required configuration is not specifed in order to deploy ${EclipseChe.PRODUCT_NAME}
+on a Kubernetes cluster with an OIDC provider configured. Use the flag '--${CHE_OPERATOR_CR_PATCH_YAML_FLAG} <PATH_TO_PATCH_FILE>' to
+provide a CheCluster Custom Resource patch with the needed configuration. Find an example of such a configuration below:
+
+kind: CheCluster
+apiVersion: org.eclipse.che/v2
+spec:
+  networking:
+    auth:
+      oAuthClientName: "<CLIENT_ID>"
+      oAuthSecret: "<CLIENT_SECRET>"
+      identityProviderURL: "<ISSUER_URL>"
+
+`
+}

src/utils/che.ts

@@ -47,6 +47,23 @@ export namespace Che {
     return EclipseChe.CHE_TLS_SECRET_NAME
   }
 
+  export function getCheClusterFieldConfigured(fieldPath: string): any | undefined {
+    const ctx = CheCtlContext.get()
+
+    const cheClusterPatch = ctx[EclipseCheContext.CR_PATCH]
+    const cheCluster = ctx[EclipseCheContext.CUSTOM_CR] || ctx[EclipseCheContext.DEFAULT_CR]
+
+    for (const cr of [cheClusterPatch, cheCluster]) {
+      const fieldValue = fieldPath.split('.').reduce((acc, prop) => {
+        return acc?.[prop]
+      }, cr)
+
+      if (fieldValue !== undefined) {
+        return fieldValue
+      }
+    }
+  }
+
   export async function getCheVersion(): Promise<string> {
     const kubeHelper = KubeClient.getInstance()
     const flags = CheCtlContext.getFlags()

test/other/util.test.ts

@@ -12,6 +12,8 @@
 
 import { expect, fancy } from 'fancy-test'
 import {getImageNameAndTag} from '../../src/utils/utls'
+import {Che} from '../../src/utils/che'
+import {CheCtlContext, EclipseCheContext} from '../../src/context'
 
 describe('Util tests', () => {
   describe('Test getImageNameAndTag', () => {
@@ -40,4 +42,27 @@ describe('Util tests', () => {
     })
   })
 
+  describe('Test getCheClusterFieldConfigured', () => {
+    // test data format: full image reference, image repository, tag
+    const data = [
+      [{spec: {networking: {auth: {identityProviderURL: 'url'}}}}, 'spec.networking.auth.identityProviderURL', 'url'],
+      [{spec: {networking: {auth: {identityProviderURL: ''}}}}, 'spec.networking.auth.identityProviderURL', ''],
+      [{spec: {networking: {auth: {}}}}, 'spec.networking.auth.identityProviderURL', undefined],
+    ]
+    fancy.it('Should get field value', async () => {
+      for (const testCaseData of data) {
+        const crPatch = testCaseData[0]
+        const fieldPath = testCaseData[1] as string
+        const expectedFieldValue = testCaseData[2]
+
+        const ctx = await CheCtlContext.get()
+        ctx[EclipseCheContext.CR_PATCH] = crPatch
+
+        const actualFieldValue = Che.getCheClusterFieldConfigured(fieldPath)
+
+        expect(actualFieldValue).to.equal(expectedFieldValue)
+      }
+    })
+  })
+
 })

yarn.lock

@@ -2456,7 +2456,7 @@ detect-newline@^3.0.0:
 
 "devspaces-operator@https://github.com/redhat-developer/devspaces-images#devspaces-3-rhel-8":
   version "0.0.0"
-  resolved "https://github.com/redhat-developer/devspaces-images#9139b4206a2c845dd805814f658ab9f0f66673d5"
+  resolved "https://github.com/redhat-developer/devspaces-images#dd0d403dacb9dd3f10559b7edc836c419e90f35f"
 
 "devworkspace-operator@https://github.com/devfile/devworkspace-operator#main":
   version "0.0.0"