All files / modules/75-ci/components/PipelineSteps/SaveCacheS3Step SaveCacheS3Step.tsx

93.33% Statements 28/30
76.92% Branches 20/26
75% Functions 3/4
93.33% Lines 28/30

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              97x       97x 97x 97x 97x 97x                   97x 97x 97x 97x                                                                                                     97x   97x 97x     97x 97x 97x 97x 97x   97x                                           1x 1x 1x                                   8x   8x 4x                       4x 1x                 3x                            
/*
 * 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 type { IconName, MultiTypeInputType } from '@wings-software/uicore'
import type { FormikErrors } from 'formik'
import type { StepProps, ValidateInputSetProps } from '@pipeline/components/AbstractSteps/Step'
import { StepViewType } from '@pipeline/components/AbstractSteps/Step'
import { StepType } from '@pipeline/components/PipelineSteps/PipelineStepInterface'
import { PipelineStep } from '@pipeline/components/PipelineSteps/PipelineStep'
import { validateInputSet } from '@pipeline/components/PipelineSteps/Steps/StepsValidateUtils'
import { getFormValuesInCorrectFormat } from '@pipeline/components/PipelineSteps/Steps/StepsTransformValuesUtils'
import type {
  MultiTypeListType,
  MultiTypeListUIType,
  MultiTypeConnectorRef,
  MultiTypeArchiveFormatOption,
  MultiTypeSelectOption,
  Resources
} from '@pipeline/components/PipelineSteps/Steps/StepsTypes'
import type { StringsMap } from 'stringTypes'
import { SaveCacheS3StepBaseWithRef } from './SaveCacheS3StepBase'
import { SaveCacheS3StepInputSet } from './SaveCacheS3StepInputSet'
import { SaveCacheS3StepVariables, SaveCacheS3StepVariablesProps } from './SaveCacheS3StepVariables'
import { getInputSetViewValidateFieldsConfig, transformValuesFieldsConfig } from './SaveCacheS3StepFunctionConfigs'
 
export interface SaveCacheS3StepSpec {
  connectorRef: string
  region: string
  bucket: string
  key: string
  sourcePaths: MultiTypeListType
  endpoint?: string
  archiveFormat?: MultiTypeArchiveFormatOption
  override?: boolean
  pathStyle?: boolean
  resources?: Resources
  runAsUser?: string
}
 
export interface SaveCacheS3StepData {
  identifier: string
  name?: string
  type: string
  timeout?: string
  spec: SaveCacheS3StepSpec
}
 
export interface SaveCacheS3StepSpecUI
  extends Omit<SaveCacheS3StepSpec, 'connectorRef' | 'sourcePaths' | 'archiveFormat' | 'resources'> {
  connectorRef: MultiTypeConnectorRef
  sourcePaths: MultiTypeListUIType
  archiveFormat?: MultiTypeSelectOption
  runAsUser?: string
  limitMemory?: string
  limitCPU?: string
}
 
// Interface for the form
export interface SaveCacheS3StepDataUI extends Omit<SaveCacheS3StepData, 'spec'> {
  spec: SaveCacheS3StepSpecUI
}
 
export interface SaveCacheS3StepProps {
  initialValues: SaveCacheS3StepData
  template?: SaveCacheS3StepData
  path?: string
  readonly?: boolean
  isNewStep?: boolean
  stepViewType: StepViewType
  onUpdate?: (data: SaveCacheS3StepData) => void
  onChange?: (data: SaveCacheS3StepData) => void
  allowableTypes: MultiTypeInputType[]
  formik?: any
}
export class SaveCacheS3Step extends PipelineStep<SaveCacheS3StepData> {
  constructor() {
    super()
    this._hasStepVariables = true
  }
 
  protected type = StepType.SaveCacheS3
  protected stepName = 'Save Cache to S3'
  protected stepIcon: IconName = 'save-cache-s3-step'
  protected stepDescription: keyof StringsMap = 'pipeline.stepDescription.SaveCacheS3'
  protected stepPaletteVisible = false
 
  protected defaultValues: SaveCacheS3StepData = {
    identifier: '',
    type: StepType.SaveCacheS3 as string,
    spec: {
      connectorRef: '',
      region: '',
      bucket: '',
      key: '',
      sourcePaths: []
    }
  }
 
  processFormData<T>(data: T): SaveCacheS3StepData {
    return getFormValuesInCorrectFormat<T, SaveCacheS3StepData>(data, transformValuesFieldsConfig)
  }
 
  validateInputSet({
    data,
    template,
    getString,
    viewType
  }: ValidateInputSetProps<SaveCacheS3StepData>): FormikErrors<SaveCacheS3StepData> {
    const isRequired = viewType === StepViewType.DeploymentForm || viewType === StepViewType.TriggerForm
    Eif (getString) {
      return validateInputSet(data, template, getInputSetViewValidateFieldsConfig(isRequired), { getString }, viewType)
    }
 
    return {}
  }
 
  renderStep(props: StepProps<SaveCacheS3StepData>): JSX.Element {
    const {
      initialValues,
      onUpdate,
      stepViewType,
      inputSetData,
      formikRef,
      customStepProps,
      isNewStep,
      readonly,
      onChange,
      allowableTypes
    } = props
 
    if (stepViewType === StepViewType.InputSet || stepViewType === StepViewType.DeploymentForm) {
      return (
        <SaveCacheS3StepInputSet
          initialValues={initialValues}
          template={inputSetData?.template}
          path={inputSetData?.path || ''}
          readonly={!!inputSetData?.readonly}
          stepViewType={stepViewType}
          onUpdate={onUpdate}
          onChange={onChange}
          allowableTypes={allowableTypes}
        />
      )
    } else if (stepViewType === StepViewType.InputVariable) {
      return (
        <SaveCacheS3StepVariables
          {...(customStepProps as SaveCacheS3StepVariablesProps)}
          initialValues={initialValues}
          onUpdate={onUpdate}
        />
      )
    }
 
    return (
      <SaveCacheS3StepBaseWithRef
        initialValues={initialValues}
        onUpdate={onUpdate}
        allowableTypes={allowableTypes}
        onChange={onChange}
        stepViewType={stepViewType || StepViewType.Edit}
        readonly={readonly}
        isNewStep={isNewStep}
        ref={formikRef}
      />
    )
  }
}