All files / modules/75-cd/components/PipelineSteps/K8sScale K8sScaleStep.tsx

92.86% Statements 78/84
73.11% Branches 174/238
80% Functions 12/15
92.86% Lines 78/84

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450              97x 97x                 97x 97x 97x 97x 97x           97x 97x 97x 97x 97x       97x   97x 97x 97x 97x   97x   97x                                                             10x 10x 10x 10x       5x     6x                               24x 24x 24x                                                                                                                                                                                                                                               97x 6x 6x 6x 6x                                                                                                                         97x 1x     97x 97x   111x 111x 111x                           17x   17x 6x                     11x 1x               10x       5x         6x         111x 111x   111x 111x 111x     5x       1x   5x       2x     5x                 2x   2x 2x 1x 1x 1x   1x       1x 1x     1x 1x   1x       2x               2x                     2x 2x                     2x 2x   2x   111x                        
/*
 * Copyright 2021 Harness Inc. All rights reserved.
 * Use of this source code is governed by the PolyForm Shield 1.0.0 license
 * that can be found in the licenses directory at the root of this repository, also available at
 * https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt.
 */
 
import React from 'react'
import {
  IconName,
  Formik,
  FormInput,
  getMultiTypeFromValue,
  MultiTypeInputType,
  SelectOption,
  MultiSelectOption
} from '@wings-software/uicore'
import cx from 'classnames'
import * as Yup from 'yup'
import { FormikErrors, FormikProps, yupToFormErrors } from 'formik'
import { defaultTo, get, has, isEmpty } from 'lodash-es'
import { StepViewType, StepProps, ValidateInputSetProps, setFormikRef } from '@pipeline/components/AbstractSteps/Step'
import type { StepFormikFowardRef } from '@pipeline/components/AbstractSteps/Step'
 
import type { CountInstanceSelection, K8sScaleStepInfo, StepElementConfig } from 'services/cd-ng'
 
import type { VariableMergeServiceResponse } from 'services/pipeline-ng'
import { VariablesListTable } from '@pipeline/components/VariablesListTable/VariablesListTable'
import { getNameAndIdentifierSchema } from '@pipeline/components/PipelineSteps/Steps/StepsValidateUtils'
import { FormInstanceDropdown, FormMultiTypeCheckboxField } from '@common/components'
import { InstanceTypes } from '@common/constants/InstanceTypes'
import {
  FormMultiTypeDurationField,
  getDurationValidationSchema
} from '@common/components/MultiTypeDuration/MultiTypeDuration'
import { ConfigureOptions } from '@common/components/ConfigureOptions/ConfigureOptions'
 
import { useStrings } from 'framework/strings'
import { getInstanceDropdownSchema } from '@common/components/InstanceDropdownField/InstanceDropdownField'
import { StepType } from '@pipeline/components/PipelineSteps/PipelineStepInterface'
import { PipelineStep } from '@pipeline/components/PipelineSteps/PipelineStep'
 
import { useVariablesExpression } from '@pipeline/components/PipelineStudio/PiplineHooks/useVariablesExpression'
import type { StringsMap } from 'stringTypes'
import stepCss from '@pipeline/components/PipelineSteps/Steps/Steps.module.scss'
 
export interface K8sScaleData extends StepElementConfig {
  spec: Omit<K8sScaleStepInfo, 'skipSteadyStateCheck'> & { skipSteadyStateCheck: boolean }
  identifier: string
}
export interface PercentageInstanceSelectionK8 {
  percentage: string | boolean | SelectOption | MultiSelectOption[] | undefined
}
 
export interface K8sScaleVariableStepProps {
  initialValues: K8sScaleData
  stageIdentifier: string
  onUpdate?(data: K8sScaleData): void
  metadataMap: Required<VariableMergeServiceResponse>['metadataMap']
  variablesData: K8sScaleData
}
 
interface K8sScaleProps {
  initialValues: K8sScaleData
  onUpdate?: (data: K8sScaleData) => void
  onChange?: (data: K8sScaleData) => void
  allowableTypes: MultiTypeInputType[]
  stepViewType?: StepViewType
  isNewStep?: boolean
  template?: K8sScaleData
  readonly?: boolean
  path?: string
}
 
function K8ScaleDeployWidget(props: K8sScaleProps, formikRef: StepFormikFowardRef<K8sScaleData>): React.ReactElement {
  const { initialValues, onUpdate, isNewStep = true, readonly, allowableTypes, stepViewType, onChange } = props
  const { getString } = useStrings()
  const { expressions } = useVariablesExpression()
  return (
    <>
      <Formik<K8sScaleData>
        onSubmit={(values: K8sScaleData) => {
          onUpdate?.(values)
        }}
        validate={(values: K8sScaleData) => {
          onChange?.(values)
        }}
        formName="k8Scale"
        initialValues={initialValues}
        validationSchema={Yup.object().shape({
          ...getNameAndIdentifierSchema(getString, stepViewType),
          timeout: getDurationValidationSchema({ minimum: '10s' }).required(
            getString('validation.timeout10SecMinimum')
          ),
          spec: Yup.object().shape({
            instanceSelection: getInstanceDropdownSchema({ required: true }, getString),
            workload: Yup.string().required(getString('cd.workloadRequired'))
          })
        })}
      >
        {(formik: FormikProps<K8sScaleData>) => {
          const { values, setFieldValue } = formik
          setFormikRef(formikRef, formik)
          return (
            <>
              <>
                {stepViewType === StepViewType.Template ? null : (
                  <div className={cx(stepCss.formGroup, stepCss.lg)}>
                    <FormInput.InputWithIdentifier
                      inputLabel={getString('name')}
                      isIdentifierEditable={isNewStep}
                      inputGroupProps={{
                        placeholder: getString('pipeline.stepNamePlaceholder'),
                        disabled: readonly
                      }}
                    />
                  </div>
                )}
                <div className={cx(stepCss.formGroup, stepCss.sm)}>
                  <FormMultiTypeDurationField
                    name="timeout"
                    label={getString('pipelineSteps.timeoutLabel')}
                    className={stepCss.duration}
                    disabled={readonly}
                    multiTypeDurationProps={{
                      expressions,
                      enableConfigureOptions: false,
                      disabled: readonly,
                      allowableTypes
                    }}
                  />
                  {getMultiTypeFromValue(values.timeout) === MultiTypeInputType.RUNTIME && (
                    <ConfigureOptions
                      value={values.timeout as string}
                      type="String"
                      variableName="step.timeout"
                      showRequiredField={false}
                      showDefaultField={false}
                      showAdvanced={true}
                      onChange={value => {
                        setFieldValue('timeout', value)
                      }}
                      isReadonly={readonly}
                    />
                  )}
                </div>
 
                <div className={stepCss.divider} />
                <div className={cx(stepCss.formGroup, stepCss.md)}>
                  <FormInstanceDropdown
                    name={'spec.instanceSelection'}
                    label={getString('common.instanceLabel')}
                    readonly={readonly}
                    expressions={expressions}
                    allowableTypes={allowableTypes}
                  />
                  {(getMultiTypeFromValue(
                    (values?.spec?.instanceSelection?.spec as CountInstanceSelection | undefined)?.count as any
                  ) === MultiTypeInputType.RUNTIME ||
                    getMultiTypeFromValue(
                      (values?.spec?.instanceSelection?.spec as PercentageInstanceSelectionK8 | undefined)?.percentage
                    ) === MultiTypeInputType.RUNTIME) && (
                    <ConfigureOptions
                      value={
                        ((values?.spec?.instanceSelection?.spec as CountInstanceSelection | undefined)
                          ?.count as string) ||
                        ((values?.spec?.instanceSelection?.spec as PercentageInstanceSelectionK8 | undefined)
                          ?.percentage as string)
                      }
                      type="String"
                      variableName={getString('instanceFieldOptions.instances')}
                      showRequiredField={false}
                      showDefaultField={false}
                      showAdvanced={true}
                      onChange={value => {
                        setFieldValue('instances', value)
                      }}
                      isReadonly={readonly}
                    />
                  )}
                </div>
 
                <div className={cx(stepCss.formGroup, stepCss.md)}>
                  <FormInput.MultiTextInput
                    label={getString('pipelineSteps.workload')}
                    placeholder={getString('pipeline.kubernetesStep.workload')}
                    name={'spec.workload'}
                    disabled={readonly}
                    multiTextInputProps={{ expressions, disabled: readonly, allowableTypes }}
                  />
                  {getMultiTypeFromValue(values.spec.workload) === MultiTypeInputType.RUNTIME && (
                    <ConfigureOptions
                      value={values.spec.workload as string}
                      type="String"
                      variableName={getString('pipelineSteps.workload').toLowerCase()}
                      showRequiredField={false}
                      showDefaultField={false}
                      showAdvanced={true}
                      onChange={value => {
                        setFieldValue('spec.workload', value)
                      }}
                      isReadonly={readonly}
                    />
                  )}
                </div>
 
                <div className={cx(stepCss.formGroup, stepCss.md)}>
                  <FormMultiTypeCheckboxField
                    name="spec.skipSteadyStateCheck"
                    label={getString('pipelineSteps.skipSteadyStateCheck')}
                    multiTypeTextbox={{ expressions, disabled: readonly, allowableTypes }}
                    disabled={readonly}
                  />
                </div>
              </>
            </>
          )
        }}
      </Formik>
    </>
  )
}
 
const K8ScaleInputStep: React.FC<K8sScaleProps> = ({ template, readonly, path, allowableTypes }) => {
  const { getString } = useStrings()
  const prefix = isEmpty(path) ? '' : `${path}.`
  const { expressions } = useVariablesExpression()
  return (
    <>
      {getMultiTypeFromValue(template?.spec?.workload) === MultiTypeInputType.RUNTIME && (
        <div className={cx(stepCss.formGroup, stepCss.md)}>
          <FormInput.MultiTextInput
            name="spec.workload"
            placeholder={getString('pipeline.kubernetesStep.workload')}
            label={getString('pipelineSteps.workload')}
            disabled={readonly}
            multiTextInputProps={{
              expressions,
              disabled: readonly,
              allowableTypes
            }}
          />
        </div>
      )}
      {getMultiTypeFromValue(template?.timeout) === MultiTypeInputType.RUNTIME ? (
        <div className={cx(stepCss.formGroup, stepCss.sm)}>
          <FormMultiTypeDurationField
            multiTypeDurationProps={{
              enableConfigureOptions: false,
              allowableTypes,
              expressions,
              disabled: readonly
            }}
            label={getString('pipelineSteps.timeoutLabel')}
            name={`${prefix}timeout`}
            disabled={readonly}
          />
        </div>
      ) : null}
      {(getMultiTypeFromValue(
        (template?.spec?.instanceSelection?.spec as CountInstanceSelection | undefined)?.count as any
      ) === MultiTypeInputType.RUNTIME ||
        getMultiTypeFromValue(
          (template?.spec?.instanceSelection?.spec as PercentageInstanceSelectionK8 | undefined)?.percentage
        ) === MultiTypeInputType.RUNTIME) && (
        <div className={cx(stepCss.formGroup, stepCss.md)}>
          <FormInstanceDropdown
            label={getString('common.instanceLabel')}
            name={`${prefix}spec.instanceSelection`}
            expressions={expressions}
            allowableTypes={allowableTypes}
            disabledType
            readonly={readonly}
          />
        </div>
      )}
      {getMultiTypeFromValue(template?.spec?.skipSteadyStateCheck) === MultiTypeInputType.RUNTIME && (
        <FormInput.CheckBox
          name={`${prefix}spec.skipSteadyStateCheck`}
          className={stepCss.checkbox}
          label={getString('pipelineSteps.skipSteadyStateCheck')}
          disabled={readonly}
        />
      )}
    </>
  )
}
 
const K8sScaleVariableStep: React.FC<K8sScaleVariableStepProps> = ({ variablesData, metadataMap, initialValues }) => {
  return <VariablesListTable data={variablesData.spec} originalData={initialValues.spec} metadataMap={metadataMap} />
}
 
const K8ScaleDeployWidgetWithRef = React.forwardRef(K8ScaleDeployWidget)
export class K8sScaleStep extends PipelineStep<K8sScaleData> {
  constructor() {
    super()
    this._hasStepVariables = true
    this._hasDelegateSelectionVisible = true
  }
  renderStep(props: StepProps<K8sScaleData>): JSX.Element {
    const {
      initialValues,
      onUpdate,
      stepViewType,
      inputSetData,
      formikRef,
      customStepProps,
      isNewStep,
      readonly,
      allowableTypes,
      onChange
    } = props
 
    if (stepViewType === StepViewType.InputSet || stepViewType === StepViewType.DeploymentForm) {
      return (
        <K8ScaleInputStep
          initialValues={initialValues}
          onUpdate={onUpdate}
          stepViewType={stepViewType}
          template={inputSetData?.template}
          readonly={inputSetData?.readonly}
          path={inputSetData?.path}
          allowableTypes={allowableTypes}
        />
      )
    } else if (stepViewType === StepViewType.InputVariable) {
      return (
        <K8sScaleVariableStep
          {...(customStepProps as K8sScaleVariableStepProps)}
          initialValues={initialValues}
          onUpdate={onUpdate}
        />
      )
    }
    return (
      <K8ScaleDeployWidgetWithRef
        initialValues={initialValues}
        isNewStep={isNewStep}
        onUpdate={values => onUpdate?.(this.processFormData(values))}
        stepViewType={defaultTo(stepViewType, StepViewType.Edit)}
        ref={formikRef}
        readonly={readonly}
        allowableTypes={allowableTypes}
        onChange={values => onChange?.(this.processFormData(values))}
      />
    )
  }
 
  protected type = StepType.K8sScale
  protected stepName = 'K8s Scale'
 
  protected stepIcon: IconName = 'swap-vertical'
  protected stepDescription: keyof StringsMap = 'pipeline.stepDescription.K8sScale'
  protected isHarnessSpecific = true
 
  processFormData(values: K8sScaleData): K8sScaleData {
    if (
      get(values, 'spec.instanceSelection.type') === InstanceTypes.Instances &&
      has(values, 'spec.instanceSelection.spec.percentage')
    ) {
      delete values.spec.instanceSelection.spec.percentage
    }
    if (
      get(values, 'spec.instanceSelection.type') === InstanceTypes.Percentage &&
      has(values, 'spec.instanceSelection.spec.count')
    ) {
      delete values.spec.instanceSelection.spec.count
    }
 
    return values
  }
 
  validateInputSet({
    data,
    template,
    getString,
    viewType
  }: ValidateInputSetProps<K8sScaleData>): FormikErrors<K8sScaleData> {
    const isRequired = viewType === StepViewType.DeploymentForm || viewType === StepViewType.TriggerForm
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    const errors = { spec: {} } as any
    if (getMultiTypeFromValue(template?.timeout) === MultiTypeInputType.RUNTIME) {
      let timeoutSchema = getDurationValidationSchema({ minimum: '10s' })
      Eif (isRequired) {
        timeoutSchema = timeoutSchema.required(getString?.('validation.timeout10SecMinimum'))
      }
      const timeout = Yup.object().shape({
        timeout: timeoutSchema
      })
 
      try {
        timeout.validateSync(data)
      } catch (e) {
        /* istanbul ignore else */
        if (e instanceof Yup.ValidationError) {
          const err = yupToFormErrors(e)
 
          Object.assign(errors, err)
        }
      }
    }
    Eif (
      getMultiTypeFromValue(
        (template?.spec?.instanceSelection?.spec as CountInstanceSelection | undefined)?.count as any
      ) === MultiTypeInputType.RUNTIME ||
      getMultiTypeFromValue(
        (template?.spec?.instanceSelection?.spec as PercentageInstanceSelectionK8 | undefined)?.percentage
      ) === MultiTypeInputType.RUNTIME
    ) {
      const instanceSelection = Yup.object().shape({
        instanceSelection: getInstanceDropdownSchema(
          {
            required: isRequired,
            requiredErrorMessage: getString?.('fieldRequired', { field: 'Instance' })
          },
          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
          getString!
        )
      })
 
      try {
        instanceSelection.validateSync(data.spec)
      } catch (e) {
        /* istanbul ignore else */
        Iif (e instanceof Yup.ValidationError) {
          const err = yupToFormErrors(e)
 
          Object.assign(errors.spec, err)
        }
      }
    }
    /* istanbul ignore else */
    if (isEmpty(errors.spec)) {
      delete errors.spec
    }
    return errors
  }
  protected defaultValues: K8sScaleData = {
    identifier: '',
    timeout: '10m',
    name: '',
    type: StepType.K8sScale,
    spec: {
      workload: '',
      skipSteadyStateCheck: false,
      instanceSelection: { type: InstanceTypes.Instances, spec: { count: 1 } as any }
    }
  }
}