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 | 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 124x 124x 124x 124x 124x 124x 124x 124x 124x 124x 124x 2x 2x 2x 2x 2x 2x 1x 3x 1x 1x 1x 2x 2x 2x 1x 2x 1x 2x 1x 1x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 4x 16x 16x 9x 7x 1x 1x 6x 14x 2x | /*
* 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 * as Yup from 'yup'
import { parse } from 'yaml'
import { isEmpty, get, compact } from 'lodash-es'
import { CompletionItemKind } from 'vscode-languageserver-types'
import { connect, FormikErrors, yupToFormErrors } from 'formik'
import { getMultiTypeFromValue, IconName, MultiTypeInputType } from '@wings-software/uicore'
import { Color } from '@harness/design-system'
import { StepProps, StepViewType, ValidateInputSetProps } from '@pipeline/components/AbstractSteps/Step'
import { getUserGroupListPromise } from 'services/cd-ng'
import { loggerFor } from 'framework/logging/logging'
import { ModuleName } from 'framework/types/ModuleName'
import type { CompletionItemInterface } from '@common/interfaces/YAMLBuilderProps'
import { getDurationValidationSchema } from '@common/components/MultiTypeDuration/MultiTypeDuration'
import { VariablesListTable } from '@pipeline/components/VariablesListTable/VariablesListTable'
import type { StringsMap } from 'stringTypes'
import { PipelineStep } from '../../PipelineStep'
import { StepType } from '../../PipelineStepInterface'
import { flatObject } from '../Common/ApprovalCommons'
import { processFormData, processForInitialValues } from './helper'
import HarnessApprovalDeploymentMode from './HarnessApprovalDeploymentMode'
import HarnessApprovalStepModeWithRef from './HarnessApprovalStepMode'
import type { HarnessApprovalData, HarnessApprovalVariableListModeProps } from './types'
import pipelineVariablesCss from '../../../PipelineStudio/PipelineVariables/PipelineVariables.module.scss'
const UserGroupRegex = /^.+step\.spec\.approvers\.userGroups$/
const logger = loggerFor(ModuleName.CD)
const HarnessApprovalDeploymentModeWithFormik = connect(HarnessApprovalDeploymentMode)
export class HarnessApproval extends PipelineStep<HarnessApprovalData> {
protected invocationMap: Map<
RegExp,
(path: string, yaml: string, params: Record<string, unknown>) => Promise<CompletionItemInterface[]>
> = new Map()
constructor() {
super()
this._hasStepVariables = true
this.invocationMap.set(UserGroupRegex, this.getUgListForYaml.bind(this))
}
protected isHarnessSpecific = true
protected type = StepType.HarnessApproval
protected stepName = 'Manual Approval'
protected stepIcon: IconName = 'harness-with-color'
protected stepIconColor: string = Color.PRIMARY_4
protected stepDescription: keyof StringsMap = 'pipeline.stepDescription.HarnessApproval'
// initialValues on mount
protected defaultValues: HarnessApprovalData = {
identifier: '',
name: '',
type: StepType.HarnessApproval,
timeout: '1d',
spec: {
approvalMessage: 'Please review the following information and approve the pipeline progression',
includePipelineExecutionHistory: true,
approvers: {
userGroups: [],
minimumCount: 1,
disallowPipelineExecutor: false
},
approverInputs: [
{
name: '',
defaultValue: ''
}
]
}
}
protected getUgListForYaml(
path: string,
yaml: string,
params: Record<string, unknown>
): Promise<CompletionItemInterface[]> {
let pipelineObj
try {
pipelineObj = parse(yaml)
} catch (err) {
logger.error('Error while parsing the yaml', err)
}
const { accountId, projectIdentifier, orgIdentifier } = params as {
accountId: string
orgIdentifier: string
projectIdentifier: string
}
Eif (pipelineObj) {
const obj = get(pipelineObj, path.replace('.spec.approvers.userGroups', ''))
if (obj?.type === StepType.HarnessApproval) {
return getUserGroupListPromise({
queryParams: {
accountIdentifier: accountId,
orgIdentifier,
projectIdentifier
}
}).then(response => {
const data =
response?.data?.content?.map(service => ({
label: service.name || '',
insertText: service.identifier || '',
kind: CompletionItemKind.Field
})) || []
return data
})
}
}
return new Promise(resolve => {
resolve([])
})
}
validateInputSet({
data,
template,
getString,
viewType
}: ValidateInputSetProps<HarnessApprovalData>): FormikErrors<HarnessApprovalData> {
const errors: FormikErrors<HarnessApprovalData> = {}
const isRequired = viewType === StepViewType.DeploymentForm || viewType === StepViewType.TriggerForm
if (
typeof template?.spec?.approvalMessage === 'string' &&
isRequired &&
getMultiTypeFromValue(template?.spec?.approvalMessage) === MultiTypeInputType.RUNTIME &&
isEmpty(data?.spec?.approvalMessage?.trim())
) {
errors.spec = {
...errors.spec,
approvalMessage: getString?.('pipeline.approvalStep.validation.approvalMessage')
}
}
if (
typeof template?.spec?.approvers?.userGroups === 'string' &&
isRequired &&
getMultiTypeFromValue(template?.spec?.approvers.userGroups) === MultiTypeInputType.RUNTIME &&
isEmpty(compact(data?.spec?.approvers.userGroups as string[]))
) {
errors.spec = {
...errors.spec,
approvers: {
...errors.spec?.approvers,
userGroups: getString?.('pipeline.approvalStep.validation.userGroups')
}
}
}
if (
typeof template?.spec?.approvers?.minimumCount === 'string' &&
isRequired &&
getMultiTypeFromValue(template?.spec?.approvers.minimumCount) === MultiTypeInputType.RUNTIME
) {
Eif (!data?.spec?.approvers.minimumCount) {
errors.spec = {
...errors.spec,
approvers: {
...errors.spec?.approvers,
minimumCount: getString?.('pipeline.approvalStep.validation.minimumCountRequired')
}
}
} else if (data?.spec?.approvers.minimumCount < 1) {
errors.spec = {
...errors.spec,
approvers: {
...errors.spec?.approvers,
minimumCount: getString?.('pipeline.approvalStep.validation.minimumCountOne')
}
}
}
}
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)
}
}
}
return errors
}
processFormData(values: HarnessApprovalData): HarnessApprovalData {
return processFormData(values)
}
renderStep(this: HarnessApproval, props: StepProps<HarnessApprovalData>): JSX.Element {
const {
initialValues,
onUpdate,
stepViewType,
inputSetData,
formikRef,
customStepProps,
isNewStep,
readonly,
allowableTypes,
onChange
} = props
if (stepViewType === StepViewType.InputSet || stepViewType === StepViewType.DeploymentForm) {
return (
<HarnessApprovalDeploymentModeWithFormik
stepViewType={stepViewType}
initialValues={processForInitialValues(initialValues)}
onUpdate={values => onUpdate?.(processFormData(values))}
allowableTypes={allowableTypes}
inputSetData={inputSetData}
readonly={readonly}
/>
)
} else if (stepViewType === StepViewType.InputVariable) {
const customStepPropsTyped = customStepProps as HarnessApprovalVariableListModeProps
return (
<VariablesListTable
data={flatObject(customStepPropsTyped.variablesData)}
originalData={initialValues as Record<string, any>}
metadataMap={customStepPropsTyped.metadataMap}
className={pipelineVariablesCss.variablePaddingL3}
/>
)
}
return (
<HarnessApprovalStepModeWithRef
ref={formikRef}
isNewStep={isNewStep}
stepViewType={stepViewType || StepViewType.Edit}
allowableTypes={allowableTypes}
onChange={values => onChange?.(this.processFormData(values))}
initialValues={processForInitialValues(initialValues)}
onUpdate={values => onUpdate?.(this.processFormData(values))}
readonly={readonly}
/>
)
}
}
|