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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 1x 1x 1x | /*
* Copyright 2022 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 { FormikErrors } from 'formik'
import type { IconName } from '@wings-software/uicore'
import { parse } from 'yaml'
import { defaultTo, get } from 'lodash-es'
import { CompletionItemKind } from 'vscode-languageserver-types'
import { StepProps, StepViewType, ValidateInputSetProps } from '@pipeline/components/AbstractSteps/Step'
import { PipelineStep } from '@pipeline/components/PipelineSteps/PipelineStep'
import { StepType } from '@pipeline/components/PipelineSteps/PipelineStepInterface'
import TemplateInputSetStep from '@templates-library/components/PipelineSteps/TemplateStep/TemplateInputSetStep'
import type { CompletionItemInterface } from '@common/interfaces/YAMLBuilderProps'
import { loggerFor } from 'framework/logging/logging'
import { ModuleName } from 'framework/types/ModuleName'
import { Scope } from '@common/interfaces/SecretsInterface'
import { getTemplateListPromise, TemplateSummaryResponse } from 'services/template-ng'
import { TemplateListType } from '@templates-library/pages/TemplatesPage/TemplatesPageUtils'
import { TemplateType } from '@templates-library/utils/templatesUtils'
import stepFactory from '@pipeline/components/PipelineSteps/PipelineStepFactory'
import type { TemplateStepNode } from 'services/pipeline-ng'
import type { StepElementConfig } from 'services/cd-ng'
import { StepWidget } from '@pipeline/components/AbstractSteps/StepWidget'
import { TemplateStepWidgetWithRef } from './TemplateStepWidget/TemplateStepWidget'
const logger = loggerFor(ModuleName.TEMPLATES)
export const TemplateRegex = /^.+step\.template\.templateRef$/
export const VersionLabelRegex = /^.+step\.template\.versionLabel$/
const getTemplateValue = (template: TemplateSummaryResponse): string => {
if (template.projectIdentifier) {
return `${template.identifier}`
} else if (template.orgIdentifier) {
return `${Scope.ORG}.${template.identifier}`
} else {
return `${Scope.ACCOUNT}.${template.identifier}`
}
}
const getTemplateName = (template: TemplateSummaryResponse): string => {
const templateType = defaultTo(template.childType, '')
if (template.projectIdentifier) {
return `${templateType}: ${template.name}`
} else if (template.orgIdentifier) {
return `${templateType}['Org']: ${template.name}`
} else {
return `${templateType}['Account']: ${template.name}`
}
}
export class TemplateStep extends PipelineStep<TemplateStepNode> {
protected invocationMap: Map<
RegExp,
(path: string, yaml: string, params: Record<string, unknown>) => Promise<CompletionItemInterface[]>
> = new Map()
constructor() {
super()
this.invocationMap.set(TemplateRegex, this.getTemplatesListForYaml.bind(this))
this.invocationMap.set(VersionLabelRegex, this.getVersionsListForYaml.bind(this))
this._hasStepVariables = true
}
protected type = StepType.Template
protected stepName = 'Template step'
protected stepIcon: IconName = 'template-library'
protected defaultValues: TemplateStepNode = {
identifier: '',
name: '',
template: {} as any
}
protected getTemplatesListForYaml(
_path: string,
_yaml: string,
params: Record<string, unknown>
): Promise<CompletionItemInterface[]> {
const { accountId, projectIdentifier, orgIdentifier } = params as {
accountId: string
orgIdentifier: string
projectIdentifier: string
}
return getTemplateListPromise({
queryParams: {
accountIdentifier: accountId,
orgIdentifier,
projectIdentifier,
includeAllTemplatesAvailableAtScope: true,
templateListType: TemplateListType.Stable
},
body: { templateEntityTypes: [TemplateType.Step], filterType: 'Template' }
}).then(response => {
return defaultTo(
response?.data?.content?.map(template => ({
label: getTemplateName(template),
insertText: getTemplateValue(template),
kind: CompletionItemKind.Field
})),
[]
)
})
}
protected getVersionsListForYaml(
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
}
const templateIdentifier = get(pipelineObj, path.replace('versionLabel', 'templateRef'))
return getTemplateListPromise({
queryParams: {
accountIdentifier: accountId,
orgIdentifier,
projectIdentifier,
includeAllTemplatesAvailableAtScope: true,
templateListType: TemplateListType.All
},
body: {
templateEntityTypes: [TemplateType.Step],
filterType: 'Template',
templateIdentifiers: [templateIdentifier]
}
}).then(response => {
return defaultTo(
response?.data?.content?.map(template => ({
label: defaultTo(template.versionLabel, ''),
insertText: defaultTo(template.versionLabel, ''),
kind: CompletionItemKind.Field
})),
[]
)
})
}
validateInputSet({
data: data,
template: template,
getString: getString,
viewType: viewType
}: ValidateInputSetProps<TemplateStepNode>): FormikErrors<TemplateStepNode> {
const stepType = (data.template.templateInputs as StepElementConfig)?.type
const step = stepFactory.getStep(stepType)
if (step) {
return step.validateInputSet({
data: data.template.templateInputs,
template: template?.template.templateInputs,
getString,
viewType
})
}
return {}
}
processFormData(values: TemplateStepNode): TemplateStepNode {
return values //processFormData(values)
}
renderStep(this: TemplateStep, props: StepProps<TemplateStepNode>): JSX.Element {
const {
initialValues,
onUpdate,
stepViewType,
formikRef,
isNewStep,
readonly,
factory,
inputSetData,
allowableTypes,
customStepProps
} = props
if (stepViewType === StepViewType.InputSet || stepViewType === StepViewType.DeploymentForm) {
return (
<TemplateInputSetStep
initialValues={initialValues}
onUpdate={data => onUpdate?.(this.processFormData(data))}
stepViewType={stepViewType}
readonly={!!inputSetData?.readonly}
template={inputSetData?.template}
path={inputSetData?.path || ''}
allowableTypes={allowableTypes}
/>
)
} else Iif (stepViewType === StepViewType.InputVariable) {
return (
<StepWidget<StepElementConfig>
factory={factory}
initialValues={initialValues.template?.templateInputs as StepElementConfig}
allowableTypes={allowableTypes}
type={(initialValues.template?.templateInputs as StepElementConfig)?.type as StepType}
stepViewType={stepViewType}
onUpdate={onUpdate}
readonly={readonly}
customStepProps={customStepProps}
/>
)
}
return (
<TemplateStepWidgetWithRef
ref={formikRef}
stepViewType={stepViewType}
initialValues={initialValues}
onUpdate={data => onUpdate?.(this.processFormData(data))}
isNewStep={isNewStep}
readonly={readonly}
factory={factory}
allowableTypes={allowableTypes}
/>
)
}
}
|