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 451 452 453 454 455 456 457 458 459 460 461 462 463 | 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 17x 17x 17x 17x 17x 17x 17x 13x 3x 17x 17x 8x 17x 17x 8x 7x 7x 7x 7x 17x 17x 17x 1x 1x 1x 1x 1x 1x 1x 1x 1x 17x 24x 17x 8x 8x 8x 8x 17x 17x 17x 17x 15x 15x 17x 8x 17x 7x 7x 7x 7x 7x 7x 17x 8x 8x 7x 7x 7x 17x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 17x 9x 9x 9x 9x 1x 1x 1x 1x 8x 17x 1x 1x 17x 1x 1x 1x 1x 1x 1x 17x 1x 1x 1x | /*
* 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, { useEffect, useState } from 'react'
import YAML from 'yaml'
import { Card, Accordion, Container, Text, RUNTIME_INPUT_VALUE } from '@wings-software/uicore'
import { get, isEmpty, isNil, omit, debounce, set } from 'lodash-es'
import produce from 'immer'
import { StepViewType } from '@pipeline/components/AbstractSteps/Step'
import {
getProvisionerExecutionStrategyYamlPromise,
Infrastructure,
K8SDirectInfrastructure,
K8sGcpInfrastructure,
PipelineInfrastructure,
StageElementConfig
} from 'services/cd-ng'
import StringWithTooltip from '@common/components/StringWithTooltip/StringWithTooltip'
import factory from '@pipeline/components/PipelineSteps/PipelineStepFactory'
import { StepType } from '@pipeline/components/PipelineSteps/PipelineStepInterface'
import type { InfraProvisioningData } from '@cd/components/PipelineSteps/InfraProvisioning/InfraProvisioning'
import type { GcpInfrastructureSpec } from '@cd/components/PipelineSteps/GcpInfrastructureSpec/GcpInfrastructureSpec'
import { useStrings } from 'framework/strings'
import { usePipelineContext } from '@pipeline/components/PipelineStudio/PipelineContext/PipelineContext'
import { StepWidget } from '@pipeline/components/AbstractSteps/StepWidget'
import DeployServiceErrors from '@cd/components/PipelineStudio/DeployServiceSpecifications/DeployServiceErrors'
import { DeployTabs } from '@cd/components/PipelineStudio/DeployStageSetupShell/DeployStageSetupShellUtils'
import { StageErrorContext } from '@pipeline/context/StageErrorContext'
import { useValidationErrors } from '@pipeline/components/PipelineStudio/PiplineHooks/useValidationErrors'
import type { DeploymentStageElementConfig, StageElementWrapper } from '@pipeline/utils/pipelineTypes'
import SelectDeploymentType from '@cd/components/PipelineStudio/DeployInfraSpecifications/SelectInfrastructureType/SelectInfrastructureType'
import { Scope } from '@common/interfaces/SecretsInterface'
import { StageType } from '@pipeline/utils/stageHelpers'
import stageCss from '../DeployStageSetupShell/DeployStage.module.scss'
const DEFAULT_RELEASE_NAME = 'release-<+INFRA_KEY>'
export default function DeployInfraSpecifications(props: React.PropsWithChildren<unknown>): JSX.Element {
const [initialInfrastructureDefinitionValues, setInitialInfrastructureDefinitionValues] =
React.useState<Infrastructure>({})
const [selectedDeploymentType, setSelectedDeploymentType] = React.useState<string | undefined>()
const scrollRef = React.useRef<HTMLDivElement | null>(null)
const { getString } = useStrings()
const { submitFormsForTab } = React.useContext(StageErrorContext)
const { errorMap } = useValidationErrors()
React.useEffect(() => {
if (errorMap.size > 0) {
submitFormsForTab(DeployTabs.INFRASTRUCTURE)
}
}, [errorMap])
const {
state: {
originalPipeline,
selectionState: { selectedStageId }
},
allowableTypes,
isReadonly,
scope,
getStageFromPipeline,
updateStage
} = usePipelineContext()
// eslint-disable-next-line react-hooks/exhaustive-deps
const debounceUpdateStage = React.useCallback(
debounce(
(changedStage?: StageElementConfig) =>
changedStage ? updateStage(changedStage) : /* instanbul ignore next */ Promise.resolve(),
100
),
[updateStage]
)
const { stage } = getStageFromPipeline<DeploymentStageElementConfig>(selectedStageId || '')
useEffect(() => {
if (isEmpty(stage?.stage?.spec?.infrastructure) && stage?.stage?.type === StageType.DEPLOY) {
const stageData = produce(stage, draft => {
Eif (draft) {
set(draft, 'stage.spec', {
...stage?.stage?.spec,
infrastructure: {
environmentRef: getScopeBasedDefaultEnvironmentRef(),
infrastructureDefinition: {},
allowSimultaneousDeployments: false
}
})
}
})
debounceUpdateStage(stageData?.stage)
}
}, [stage?.stage])
const stageRef = React.useRef(stage)
stageRef.current = stage
const resetInfrastructureDefinition = (type?: string): void => {
const stageData = produce(stage, draft => {
const spec = get(draft, 'stage.spec', {})
spec.infrastructure = {
...spec.infrastructure,
infrastructureDefinition: {}
}
Eif (type) {
spec.infrastructure.infrastructureDefinition.type = type
}
})
const initialInfraDefValues = getInfrastructureDefaultValue(stageData, type)
setInitialInfrastructureDefinitionValues(initialInfraDefValues)
debounceUpdateStage(stageData?.stage)
setProvisionerEnabled(false)
}
const getScopeBasedDefaultEnvironmentRef = React.useCallback(() => {
return scope === Scope.PROJECT ? '' : RUNTIME_INPUT_VALUE
}, [scope])
React.useEffect(() => {
const type = stage?.stage?.spec?.infrastructure?.infrastructureDefinition?.type
setSelectedDeploymentType(type)
const initialInfraDefValues = getInfrastructureDefaultValue(stage, type)
setInitialInfrastructureDefinitionValues(initialInfraDefValues)
}, [stage])
const onUpdateInfrastructureDefinition = (
extendedSpec: K8SDirectInfrastructure | K8sGcpInfrastructure,
type: string
): void => {
if (get(stageRef.current, 'stage.spec.infrastructure', null)) {
const stageData = produce(stageRef.current, draft => {
const infrastructure = get(draft, 'stage.spec.infrastructure', null)
infrastructure.infrastructureDefinition = {
...infrastructure.infrastructureDefinition,
type,
spec: omit(extendedSpec, 'allowSimultaneousDeployments')
}
infrastructure.allowSimultaneousDeployments = extendedSpec.allowSimultaneousDeployments ?? false
})
debounceUpdateStage(stageData?.stage)
}
}
const [provisionerEnabled, setProvisionerEnabled] = useState<boolean>(false)
const [provisionerSnippetLoading, setProvisionerSnippetLoading] = useState<boolean>(false)
const isProvisionerEmpty = (stageData: StageElementWrapper): boolean => {
const provisionerData = get(stageData, 'stage.spec.infrastructure.infrastructureDefinition.provisioner')
return isEmpty(provisionerData?.steps) && isEmpty(provisionerData?.rollbackSteps)
}
// load and apply provisioner snippet to the stage
useEffect(() => {
Iif (stage && isProvisionerEmpty(stage) && provisionerEnabled) {
setProvisionerSnippetLoading(true)
getProvisionerExecutionStrategyYamlPromise({ queryParams: { provisionerType: 'TERRAFORM' } }).then(res => {
const provisionerSnippet = YAML.parse(res?.data || '')
if (stage && isProvisionerEmpty(stage) && provisionerSnippet) {
const stageData = produce(stage, draft => {
set(draft, 'stage.spec.infrastructure.infrastructureDefinition.provisioner', provisionerSnippet.provisioner)
})
if (stageData.stage) {
updateStage(stageData.stage).then(() => {
setProvisionerSnippetLoading(false)
})
}
}
})
}
}, [provisionerEnabled])
const cleanUpEmptyProvisioner = (
stageData: StageElementWrapper<DeploymentStageElementConfig> | undefined
): boolean => {
const provisioner = stageData?.stage?.spec?.infrastructure?.infrastructureDefinition?.provisioner
let isChanged = false
Iif (!isNil(provisioner?.steps) && provisioner?.steps.length === 0) {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
delete provisioner.steps
isChanged = true
}
Iif (!isNil(provisioner?.rollbackSteps) && provisioner?.rollbackSteps.length === 0) {
delete provisioner.rollbackSteps
isChanged = true
}
Iif (
!provisioner?.steps &&
!provisioner?.rollbackSteps &&
stageData?.stage?.spec?.infrastructure?.infrastructureDefinition?.provisioner
) {
delete stageData.stage.spec.infrastructure.infrastructureDefinition.provisioner
isChanged = true
}
return isChanged
}
useEffect(() => {
setProvisionerEnabled(!isProvisionerEmpty(stage || ({} as StageElementWrapper)))
return () => {
let isChanged
const stageData = produce(stage, draft => {
isChanged = cleanUpEmptyProvisioner(draft)
})
Iif (stageData?.stage && isChanged) {
updateStage(stageData?.stage)
}
}
}, [])
const getProvisionerData = (stageData: StageElementWrapper): InfraProvisioningData => {
let provisioner = get(stageData, 'stage.spec.infrastructure.infrastructureDefinition.provisioner')
let originalProvisioner: InfraProvisioningData['originalProvisioner'] = undefined
Eif (selectedStageId) {
const originalStage = getStageFromPipeline(selectedStageId, originalPipeline).stage
originalProvisioner = get(originalStage, 'stage.spec.infrastructure.infrastructureDefinition.provisioner')
}
provisioner = isNil(provisioner) ? {} : { ...provisioner }
Eif (isNil(provisioner.steps)) {
provisioner.steps = []
}
Eif (isNil(provisioner.rollbackSteps)) {
provisioner.rollbackSteps = []
}
return {
provisioner: { ...provisioner },
provisionerEnabled,
provisionerSnippetLoading,
originalProvisioner: { ...originalProvisioner }
}
}
const getInfrastructureDefaultValue = (
stageData: StageElementWrapper | undefined,
deploymentType: string | undefined
): Infrastructure => {
const infrastructure = get(stageData, 'stage.spec.infrastructure.infrastructureDefinition', null)
const type = infrastructure?.type || deploymentType
const allowSimultaneousDeployments = get(stageData, 'stage.spec.infrastructure.allowSimultaneousDeployments', false)
switch (type) {
case 'KubernetesDirect': {
const connectorRef = infrastructure?.spec?.connectorRef
const namespace = infrastructure?.spec?.namespace
const releaseName = infrastructure?.spec?.releaseName ?? DEFAULT_RELEASE_NAME
return {
connectorRef,
namespace,
releaseName,
allowSimultaneousDeployments
}
}
case 'KubernetesGcp': {
const connectorRef = infrastructure?.spec?.connectorRef
const namespace = infrastructure?.spec?.namespace
const releaseName = infrastructure?.spec?.releaseName ?? DEFAULT_RELEASE_NAME
const cluster = infrastructure?.spec?.cluster
return {
connectorRef,
namespace,
releaseName,
cluster,
allowSimultaneousDeployments
}
}
default: {
return {}
}
}
}
const getClusterConfigurationStep = (type: string): React.ReactElement => {
switch (type) {
case 'KubernetesDirect': {
return (
<StepWidget<K8SDirectInfrastructure>
factory={factory}
key={stage?.stage?.identifier}
readonly={isReadonly}
initialValues={initialInfrastructureDefinitionValues as K8SDirectInfrastructure}
type={StepType.KubernetesDirect}
stepViewType={StepViewType.Edit}
allowableTypes={allowableTypes}
onUpdate={value =>
onUpdateInfrastructureDefinition(
{
connectorRef: value.connectorRef,
namespace: value.namespace,
releaseName: value.releaseName,
allowSimultaneousDeployments: value.allowSimultaneousDeployments
},
'KubernetesDirect'
)
}
/>
)
}
case 'KubernetesGcp': {
return (
<StepWidget<GcpInfrastructureSpec>
factory={factory}
key={stage?.stage?.identifier}
readonly={isReadonly}
initialValues={initialInfrastructureDefinitionValues as GcpInfrastructureSpec}
type={StepType.KubernetesGcp}
stepViewType={StepViewType.Edit}
allowableTypes={allowableTypes}
onUpdate={value =>
onUpdateInfrastructureDefinition(
{
connectorRef: value.connectorRef,
cluster: value.cluster,
namespace: value.namespace,
releaseName: value.releaseName,
allowSimultaneousDeployments: value.allowSimultaneousDeployments
},
'KubernetesGcp'
)
}
/>
)
}
default: {
return <div>Undefined deployment type</div>
}
}
}
const updateEnvStep = React.useCallback(
(value: PipelineInfrastructure) => {
const stageData = produce(stage, draft => {
const infraObj: PipelineInfrastructure = get(draft, 'stage.spec.infrastructure', {})
Iif (value.environment?.identifier) {
infraObj.environment = value.environment
delete infraObj.environmentRef
} else {
infraObj.environmentRef = value.environmentRef
delete infraObj.environment
}
})
debounceUpdateStage(stageData?.stage)
},
[stage, debounceUpdateStage, stage?.stage?.spec?.infrastructure?.infrastructureDefinition]
)
return (
<div className={stageCss.serviceOverrides} key="1">
<DeployServiceErrors domRef={scrollRef as React.MutableRefObject<HTMLElement | undefined>} />
<div className={stageCss.contentSection} ref={scrollRef}>
<div className={stageCss.tabHeading} id="environment">
{getString('environment')}
</div>
<Card className={stageCss.sectionCard}>
<StepWidget
type={StepType.DeployEnvironment}
readonly={isReadonly || scope === Scope.ORG || scope === Scope.ACCOUNT}
initialValues={{
environment: get(stage, 'stage.spec.infrastructure.environment', {}),
environmentRef: get(
stage,
'stage.spec.infrastructure.environmentRef',
getScopeBasedDefaultEnvironmentRef()
)
}}
allowableTypes={allowableTypes}
onUpdate={val => updateEnvStep(val)}
factory={factory}
stepViewType={StepViewType.Edit}
/>
</Card>
<div className={stageCss.tabHeading} id="infrastructureDefinition">
<StringWithTooltip
tooltipId="pipelineStep.infrastructureDefinition"
stringId="pipelineSteps.deploy.infrastructure.infraDefinition"
/>
</div>
<Card className={stageCss.sectionCard}>
<Text margin={{ bottom: 'medium' }} className={stageCss.info}>
<StringWithTooltip
tooltipId="pipelineStep.infrastructureDefinitionMethod"
stringId="pipelineSteps.deploy.infrastructure.selectMethod"
/>
</Text>
<SelectDeploymentType
isReadonly={isReadonly}
selectedInfrastructureType={selectedDeploymentType}
onChange={deploymentType => {
setSelectedDeploymentType(deploymentType)
resetInfrastructureDefinition(deploymentType)
}}
/>
</Card>
{selectedDeploymentType ? (
<Accordion className={stageCss.accordion} activeId="dynamicProvisioning">
<Accordion.Panel
id="dynamicProvisioning"
addDomId={true}
summary={<div className={stageCss.tabHeading}>{getString('cd.dynamicProvisioning')}</div>}
details={
<Card className={stageCss.sectionCard}>
<StepWidget<InfraProvisioningData>
factory={factory}
allowableTypes={allowableTypes}
readonly={isReadonly}
key={stage?.stage?.identifier}
initialValues={getProvisionerData(stage || ({} as StageElementWrapper))}
type={StepType.InfraProvisioning}
stepViewType={StepViewType.Edit}
onUpdate={(value: InfraProvisioningData) => {
if (stage) {
const stageData = produce(stage, draft => {
set(
draft,
'stage.spec.infrastructure.infrastructureDefinition.provisioner',
value.provisioner
)
cleanUpEmptyProvisioner(draft)
})
if (stageData.stage) {
updateStage(stageData.stage).then(() => {
setProvisionerEnabled(value.provisionerEnabled)
})
}
} else {
setProvisionerEnabled(value.provisionerEnabled)
}
}}
/>
</Card>
}
/>
</Accordion>
) : null}
{selectedDeploymentType && (
<>
<div className={stageCss.tabHeading} id="clusterDetails">
{getString('cd.steps.common.clusterDetails')}
</div>
<Card className={stageCss.sectionCard}>{getClusterConfigurationStep(selectedDeploymentType)}</Card>
</>
)}
<Container margin={{ top: 'xxlarge' }}>{props.children}</Container>
</div>
</div>
)
}
|