All files / modules/35-connectors/components/CreateConnector/GitlabConnector/StepAuth StepGitlabAuthentication.tsx

89.66% Statements 52/58
48.08% Branches 25/52
92.86% Functions 13/14
89.66% Lines 52/58

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              219x 219x 219x                         219x 219x   219x     219x 219x 219x 219x 219x 219x 219x 219x 219x                                                                   219x                               219x 4x 4x   4x                                                               219x 4x 4x   4x           219x 4x   4x             4x 1x     4x                                 219x 7x 6x 6x 6x   6x                               6x 4x 2x 2x 2x 2x 2x                 6x 2x     6x                             10x           10x         10x       10x                 8x                                                                                                                 219x  
/*
 * 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, { useState, useEffect } from 'react'
import cx from 'classnames'
import {
  Layout,
  Button,
  Formik,
  FormInput,
  Text,
  FormikForm as Form,
  StepProps,
  Container,
  SelectOption,
  ButtonVariation,
  PageSpinner
} from '@wings-software/uicore'
import * as Yup from 'yup'
import { FontVariation } from '@harness/design-system'
import type { FormikProps } from 'formik'
import { setupGithubFormData, GitConnectionType } from '@connectors/pages/connectors/utils/ConnectorUtils'
import type { SecretReferenceInterface } from '@secrets/utils/SecretField'
import type { ConnectorConfigDTO, ConnectorRequestBody, ConnectorInfoDTO } from 'services/cd-ng'
import SSHSecretInput from '@secrets/components/SSHSecretInput/SSHSecretInput'
import SecretInput from '@secrets/components/SecretInput/SecretInput'
import TextReference, { TextReferenceInterface, ValueType } from '@secrets/components/TextReference/TextReference'
import { useStrings } from 'framework/strings'
import { GitAuthTypes, GitAPIAuthTypes } from '@connectors/pages/connectors/utils/ConnectorHelper'
import { getCommonConnectorsValidationSchema } from '../../CreateConnectorUtils'
import commonStyles from '@connectors/components/CreateConnector/commonSteps/ConnectorCommonStyles.module.scss'
import css from './StepGitlabAuthentication.module.scss'
import commonCss from '../../commonSteps/ConnectorCommonStyles.module.scss'
 
interface StepGitlabAuthenticationProps extends ConnectorInfoDTO {
  name: string
  isEditMode?: boolean
}
 
interface GitlabAuthenticationProps {
  onConnectorCreated: (data?: ConnectorRequestBody) => void | Promise<void>
  isEditMode: boolean
  setIsEditMode: (val: boolean) => void
  setFormData?: (formData: ConnectorConfigDTO) => void
  connectorInfo: ConnectorInfoDTO | void
  accountId: string
  orgIdentifier: string
  projectIdentifier: string
}
 
interface GitlabFormInterface {
  connectionType: string
  authType: string
  username: TextReferenceInterface | void
  password: SecretReferenceInterface | void
  accessToken: SecretReferenceInterface | void
  installationId: string
  applicationId: string
  privateKey: SecretReferenceInterface | void
  sshKey: SecretReferenceInterface | void
  kerberosKey: SecretReferenceInterface | void
  apiAccessToken: SecretReferenceInterface | void
  enableAPIAccess: boolean
  apiAuthType: string
}
 
const defaultInitialFormData: GitlabFormInterface = {
  connectionType: GitConnectionType.HTTP,
  authType: GitAuthTypes.USER_PASSWORD,
  username: undefined,
  password: undefined,
  accessToken: undefined,
  installationId: '',
  applicationId: '',
  privateKey: undefined,
  sshKey: undefined,
  apiAccessToken: undefined,
  kerberosKey: undefined,
  enableAPIAccess: false,
  apiAuthType: GitAPIAuthTypes.TOKEN
}
 
const RenderGitlabAuthForm: React.FC<FormikProps<GitlabFormInterface>> = props => {
  const { getString } = useStrings()
  switch (props.values.authType) {
    case GitAuthTypes.USER_PASSWORD:
      return (
        <>
          <TextReference
            name="username"
            stringId="username"
            type={props.values.username ? props.values.username?.type : ValueType.TEXT}
          />
          <SecretInput name="password" label={getString('password')} />
        </>
      )
    case GitAuthTypes.USER_TOKEN:
      return (
        <>
          <TextReference
            name="username"
            stringId="username"
            type={props.values.username ? props.values.username?.type : ValueType.TEXT}
          />
          <SecretInput name="accessToken" label={getString('personalAccessToken')} />
        </>
      )
    case GitAuthTypes.KERBEROS:
      return (
        <>
          <SSHSecretInput name="kerberosKey" label={getString('kerberos')} />
        </>
      )
    default:
      return null
  }
}
 
const RenderAPIAccessForm: React.FC<FormikProps<GitlabFormInterface>> = props => {
  const { getString } = useStrings()
  switch (props.values.apiAuthType) {
    case GitAPIAuthTypes.TOKEN:
      return <SecretInput name="apiAccessToken" label={getString('personalAccessToken')} />
    default:
      return null
  }
}
 
const RenderAPIAccessFormWrapper: React.FC<FormikProps<GitlabFormInterface>> = formikProps => {
  const { getString } = useStrings()
 
  const apiAuthOptions: Array<SelectOption> = [
    {
      label: getString('personalAccessToken'),
      value: GitAPIAuthTypes.TOKEN
    }
  ]
 
  useEffect(() => {
    formikProps.setFieldValue('apiAuthType', GitAPIAuthTypes.TOKEN)
  }, [])
 
  return (
    <>
      <Container className={css.authHeaderRow}>
        <Text font={{ variation: FontVariation.H6 }}>{getString('common.git.APIAuthentication')}</Text>
        <FormInput.Select
          name="apiAuthType"
          items={apiAuthOptions}
          className={commonStyles.authTypeSelect}
          value={apiAuthOptions[0]}
        />
      </Container>
      <RenderAPIAccessForm {...formikProps} />
    </>
  )
}
 
const StepGitlabAuthentication: React.FC<StepProps<StepGitlabAuthenticationProps> & GitlabAuthenticationProps> =
  props => {
    const { getString } = useStrings()
    const { prevStepData, nextStep, accountId } = props
    const [initialValues, setInitialValues] = useState(defaultInitialFormData)
    const [loadingConnectorSecrets, setLoadingConnectorSecrets] = useState(true && props.isEditMode)
 
    const authOptions: Array<SelectOption> = [
      {
        label: getString('usernamePassword'),
        value: GitAuthTypes.USER_PASSWORD
      },
      {
        label: getString('usernameToken'),
        value: GitAuthTypes.USER_TOKEN
      }
      // Disabling temp:
      // {
      //   label: getString('kerberos'),
      //   value: GitAuthTypes.KERBEROS
      // }
    ]
 
    useEffect(() => {
      if (loadingConnectorSecrets) {
        Eif (props.isEditMode) {
          Eif (props.connectorInfo) {
            setupGithubFormData(props.connectorInfo, accountId).then(data => {
              setInitialValues(data as GitlabFormInterface)
              setLoadingConnectorSecrets(false)
            })
          } else {
            setLoadingConnectorSecrets(false)
          }
        }
      }
    }, [loadingConnectorSecrets])
 
    const handleSubmit = (formData: ConnectorConfigDTO) => {
      nextStep?.({ ...props.connectorInfo, ...prevStepData, ...formData } as StepGitlabAuthenticationProps)
    }
 
    return loadingConnectorSecrets ? (
      <PageSpinner />
    ) : (
      <Layout.Vertical width="60%" style={{ minHeight: 460 }} className={cx(css.secondStep, commonCss.stepContainer)}>
        <Text font={{ variation: FontVariation.H3 }}>{getString('credentials')}</Text>
 
        <Formik
          initialValues={{
            ...initialValues,
            ...prevStepData
          }}
          formName="stepGitlabAuth"
          validationSchema={getCommonConnectorsValidationSchema(getString).concat(
            Yup.object().shape({
              kerberosKey: Yup.object().when('authType', {
                is: val => val === GitAuthTypes.KERBEROS,
                then: Yup.object().required(getString('validation.kerberosKey')),
                otherwise: Yup.object().nullable()
              }),
              accessToken: Yup.object().when(['connectionType', 'authType'], {
                is: (connectionType, authType) =>
                  connectionType === GitConnectionType.HTTP && authType === GitAuthTypes.USER_TOKEN,
                then: Yup.object().required(getString('connectors.validation.personalAccessToken')),
                otherwise: Yup.object().nullable()
              }),
              apiAuthType: Yup.string().when('enableAPIAccess', {
                is: val => val,
                then: Yup.string().trim().required(getString('validation.authType'))
              }),
              apiAccessToken: Yup.object().when(['enableAPIAccess', 'apiAuthType'], {
                is: (enableAPIAccess, apiAuthType) => enableAPIAccess && apiAuthType === GitAPIAuthTypes.TOKEN,
                then: Yup.object().required(getString('connectors.validation.personalAccessToken')),
                otherwise: Yup.object().nullable()
              })
            })
          )}
          onSubmit={handleSubmit}
        >
          {formikProps => (
            <Form className={cx(commonCss.fullHeight, commonCss.fullHeightDivsWithFlex)}>
              <Container className={cx(css.stepFormWrapper, commonCss.paddingTop8)}>
                {formikProps.values.connectionType === GitConnectionType.SSH ? (
                  <Layout.Horizontal spacing="medium" flex={{ alignItems: 'baseline' }}>
                    <Text font={{ variation: FontVariation.H6 }}>{getString('authentication')}</Text>
                    <SSHSecretInput name="sshKey" label={getString('SSH_KEY')} />
                  </Layout.Horizontal>
                ) : (
                  <Container>
                    <Container className={css.authHeaderRow} flex={{ alignItems: 'baseline' }}>
                      <Text font={{ variation: FontVariation.H6 }}>{getString('authentication')}</Text>
                      <FormInput.Select
                        name="authType"
                        items={authOptions}
                        disabled={false}
                        className={commonStyles.authTypeSelect}
                      />
                    </Container>
 
                    <RenderGitlabAuthForm {...formikProps} />
                  </Container>
                )}
 
                <FormInput.CheckBox
                  name="enableAPIAccess"
                  label={getString('common.git.enableAPIAccess')}
                  padding={{ left: 'xxlarge' }}
                />
                <Text font="small" className={commonCss.bottomMargin4}>
                  {getString('common.git.APIAccessDescription')}
                </Text>
                {formikProps.values.enableAPIAccess ? <RenderAPIAccessFormWrapper {...formikProps} /> : null}
              </Container>
 
              <Layout.Horizontal padding={{ top: 'small' }} spacing="medium">
                <Button
                  text={getString('back')}
                  icon="chevron-left"
                  onClick={() => props?.previousStep?.(props?.prevStepData)}
                  data-name="gitlabBackButton"
                  variation={ButtonVariation.SECONDARY}
                />
                <Button
                  type="submit"
                  intent="primary"
                  text={getString('continue')}
                  rightIcon="chevron-right"
                  variation={ButtonVariation.PRIMARY}
                />
              </Layout.Horizontal>
            </Form>
          )}
        </Formik>
      </Layout.Vertical>
    )
  }
 
export default StepGitlabAuthentication