@openshift-assisted/ui-lib 2.17.0-cim → 2.17.3-cim

package/lib/common/validationSchemas/addressValidation.tsx

@@ -0,0 +1,349 @@
+import * as Yup from 'yup';
+import { Address4, Address6 } from 'ip-address';
+import isCIDR from 'is-cidr';
+import { isInSubnet } from 'is-in-subnet';
+
+import { getAddress } from '../components/ui/formik/utils';
+import { getSubnet } from '../components/clusterConfiguration/utils';
+import { HostSubnets, NetworkConfigurationValues } from '../types';
+import { IP_V4_ZERO, IP_V6_ZERO, MAC_REGEX } from './regexes';
+import {
+  alwaysRequired,
+  getArrayIndexFromPath,
+  isIPorDN,
+  isIPv4Address,
+  isIPv6Address,
+} from './utils';
+import { NO_SUBNET_SET } from '../config';
+import { overlap } from 'cidr-tools';
+import parseUrl from 'parse-url';
+import { TFunction } from 'i18next';
+
+export const ipValidationSchema = (t: TFunction) =>
+  Yup.string().test(
+    'ip-validation',
+    t('ai:Not a valid IP address'),
+    (value?: string) => Address4.isValid(value || '') || Address6.isValid(value || ''),
+  );
+
+export const ipNoSuffixValidationSchema = (t: TFunction) =>
+  Yup.string().test('ip-validation-no-suffix', t('ai:Not a valid IP address'), (value?: string) => {
+    const address = getAddress(value || '');
+    return !!address && address.address === address.addressMinusSuffix;
+  });
+
+export const macAddressValidationSchema = (t: TFunction) =>
+  Yup.string().matches(MAC_REGEX, {
+    message: (value) => t('ai:Value "{{value}}" is not valid MAC address.', { value }),
+    excludeEmptyString: true,
+  });
+
+export const vipRangeValidationSchema = (
+  hostSubnets: HostSubnets,
+  { machineNetworks }: NetworkConfigurationValues,
+  allowSuffix: boolean,
+  t: TFunction,
+) =>
+  Yup.string().test('vip-validation', t('ai:IP Address is outside of selected subnet'), (value) => {
+    if (!value) {
+      return true;
+    }
+
+    try {
+      const validator = allowSuffix ? ipValidationSchema : ipNoSuffixValidationSchema;
+      validator(t).validateSync(value);
+    } catch (err) {
+      return true;
+    }
+    // Find host subnets that match the selected machine networks
+    const cidrs = machineNetworks?.map((network) => network.cidr) ?? [];
+    const matchingSubnets = hostSubnets.filter((hostSubnet) => cidrs.includes(hostSubnet.subnet));
+
+    for (const hostSubnet of matchingSubnets) {
+      if (hostSubnet?.subnet) {
+        // Workaround for bug in CIM backend. hostIDs are empty
+        if (!hostSubnet.hostIDs.length) {
+          return true;
+        } else if (isInSubnet(value, hostSubnet.subnet)) {
+          return true;
+        }
+      }
+    }
+    return false;
+  });
+
+const vipBroadcastValidationSchema = (
+  { machineNetworks }: NetworkConfigurationValues,
+  t: TFunction,
+) =>
+  Yup.string().test(
+    'vip-no-broadcast',
+    t('ai:The IP address cannot be a network or broadcast address'),
+    function (value?: string) {
+      if (!value) {
+        return true;
+      }
+
+      const vipAddress = getAddress(value)?.address;
+      if (!vipAddress) {
+        return true;
+      }
+
+      const index = getArrayIndexFromPath(this.path || '');
+      const machineNetworkCidr = machineNetworks?.[index]?.cidr ?? machineNetworks?.[0]?.cidr ?? '';
+      if (!machineNetworkCidr) {
+        return true;
+      }
+
+      const machineNetwork = getAddress(machineNetworkCidr);
+      if (!machineNetwork) {
+        return true;
+      }
+
+      const machineNetworkBroadcast = machineNetwork.endAddress().address;
+      const machineNetworkAddress = machineNetwork.startAddress().address;
+
+      return vipAddress !== machineNetworkBroadcast && vipAddress !== machineNetworkAddress;
+    },
+  );
+
+export const hostSubnetValidationSchema = Yup.string().when(['managedNetworkingType'], {
+  is: (managedNetworkingType: NetworkConfigurationValues['managedNetworkingType']) =>
+    managedNetworkingType === 'clusterManaged',
+  then: () => Yup.string().notOneOf([NO_SUBNET_SET], 'Host subnet must be selected.'),
+});
+
+export const vipNoSuffixValidationSchema = (
+  hostSubnets: HostSubnets,
+  values: NetworkConfigurationValues,
+  t: TFunction,
+) =>
+  Yup.mixed().when(['vipDhcpAllocation', 'managedNetworkingType'], {
+    is: (
+      vipDhcpAllocation: NetworkConfigurationValues['vipDhcpAllocation'],
+      managedNetworkingType: NetworkConfigurationValues['managedNetworkingType'],
+    ) => !vipDhcpAllocation && managedNetworkingType !== 'userManaged',
+    then: () => {
+      // Per-item schema for VIPs (apiVips[*].ip / ingressVips[*].ip)
+      // 1) Require value once set
+      // 2) Validate IP without suffix
+      // 3) Ensure VIP family matches machineNetworks[idx] family
+      // 4) Validate range vs selected subnets
+      // 5) No broadcast/network address
+      // 6) Uniqueness across API/Ingress
+      const vipFamilyMatchSchema = Yup.string().test(
+        'vip-family-match-machine-network',
+        t('ai:IP family must match the corresponding machine network family.'),
+        function (value?: string) {
+          if (!value) {
+            return true;
+          }
+          const index = getArrayIndexFromPath(this.path || '');
+          if (Number.isNaN(index)) {
+            return true;
+          }
+          const cidr = values.machineNetworks?.[index]?.cidr || '';
+          const mnIsV4 = isCIDR.v4(cidr);
+          const mnIsV6 = isCIDR.v6(cidr);
+          // If machine network at index is not selected/valid, don't block validation here
+          if (!mnIsV4 && !mnIsV6) {
+            return true;
+          }
+          const ipIsV4 = isIPv4Address(value);
+          const ipIsV6 = isIPv6Address(value);
+          if (!ipIsV4 && !ipIsV6) {
+            return true;
+          }
+          return mnIsV4 ? ipIsV4 : ipIsV6;
+        },
+      );
+      // Ensure API and Ingress VIPs at the same index are not the same
+      const vipUniqueSchema = Yup.string().test('vip-uniqueness', function (value?: string) {
+        if (!value) {
+          return true;
+        }
+        const index = getArrayIndexFromPath(this.path || '');
+        if (Number.isNaN(index)) {
+          return true;
+        }
+        const apiVip = values.apiVips?.[index]?.ip;
+        const ingressVip = values.ingressVips?.[index]?.ip;
+        if (!apiVip || !ingressVip) {
+          return true;
+        }
+        if (apiVip === ingressVip) {
+          return this.createError({
+            message: t('ai:The {{label}} Ingress and API IP addresses cannot be the same.', {
+              label: index === 0 ? t('ai:primary') : t('ai:secondary'),
+            }),
+          });
+        }
+        return true;
+      });
+
+      return alwaysRequired(t('ai:Required field'))
+        .concat(ipNoSuffixValidationSchema(t))
+        .concat(vipFamilyMatchSchema)
+        .concat(vipRangeValidationSchema(hostSubnets, values, false, t))
+        .concat(vipBroadcastValidationSchema(values, t))
+        .concat(vipUniqueSchema);
+    },
+  });
+
+export const vipArrayValidationSchema = <T extends Yup.Maybe<Yup.AnyObject>>(
+  hostSubnets: HostSubnets,
+  values: NetworkConfigurationValues,
+  t: TFunction,
+) =>
+  values.managedNetworkingType === 'clusterManaged'
+    ? Yup.array<T>().of(
+        Yup.object({
+          clusterId: Yup.string(),
+          ip: vipNoSuffixValidationSchema(hostSubnets, values, t),
+        }),
+      )
+    : Yup.array<T>();
+
+export const ipBlockValidationSchema = (
+  reservedCidrs: string | string[] | undefined,
+  t: TFunction,
+) =>
+  Yup.string()
+    .required('A value is required.')
+    .test(
+      'valid-ip-address',
+      t(
+        'ai:Invalid IP address block. Expected value is a network expressed in CIDR notation (IP/netmask). For example: 123.123.123.0/24, 2055:d7a::/116',
+      ),
+      (value?: string): boolean => !!value && (isCIDR.v4(value) || isCIDR.v6(value)),
+    )
+    .test(
+      'valid-netmask',
+      t(
+        'ai:IPv4 netmask must be between 1-25 and include at least 128 addresses.\nIPv6 netmask must be between 8-128 and include at least 256 addresses.',
+      ),
+      (value?: string) => {
+        const suffix = parseInt((value || '').split('/')[1]);
+
+        return (
+          (isCIDR.v4(value || '') && 0 < suffix && suffix < 26) ||
+          (isCIDR.v6(value || '') && 7 < suffix && suffix < 129)
+        );
+      },
+    )
+    .test(
+      'cidr-is-not-unspecified',
+      t(
+        'ai:The specified CIDR is invalid because its resulting routing prefix matches the unspecified address.',
+      ),
+      (cidr: string) => {
+        const ip = getSubnet(cidr);
+        if (ip === null) {
+          return false;
+        }
+
+        // The first address is used to represent the network
+        const startAddress = ip.startAddress().address;
+
+        return startAddress !== IP_V4_ZERO && startAddress !== IP_V6_ZERO;
+      },
+    )
+    .test(
+      'valid-cidr-base-address',
+      ({ value }) => t('ai:{{value}} is not a valid CIDR', { value: value as string }),
+      (cidr: string) => {
+        const ip = getSubnet(cidr);
+        if (ip === null) {
+          return false;
+        }
+
+        const networkAddress = ip.startAddress().parsedAddress;
+        const ipAddress = ip.parsedAddress;
+        const result = ipAddress.every((part, idx) => part === networkAddress[idx]);
+
+        return result;
+      },
+    )
+    .test('cidrs-can-not-overlap', t('ai:Provided CIDRs can not overlap.'), (cidr: string) => {
+      try {
+        if (cidr && reservedCidrs && reservedCidrs.length > 0) {
+          return !overlap(cidr, reservedCidrs);
+        }
+      } catch {
+        return false;
+      }
+      // passing by default
+      return true;
+    });
+
+export const hostPrefixValidationSchema = (
+  clusterNetworkCidr: NetworkConfigurationValues['clusterNetworkCidr'],
+  t: TFunction,
+) => {
+  const requiredText = t('ai:Required field');
+  const minMaxText = t(
+    'ai:The host prefix is a number between 1 and 32 for IPv4 and between 8 and 128 for IPv6.',
+  );
+  const netBlock = (clusterNetworkCidr || '').split('/')[1];
+  if (!netBlock) {
+    return Yup.number().required(requiredText).min(1, minMaxText).max(32, minMaxText);
+  }
+
+  let netBlockNumber = parseInt(netBlock);
+  if (isNaN(netBlockNumber)) {
+    netBlockNumber = 1;
+  }
+
+  const errorMsgPrefix = t(
+    'ai:The host prefix is a number between size of the cluster network CIDR range',
+  );
+  const errorMsgIPv4 = t('ai:{{errorMsgPrefix}} ({{netBlockNumber}}) and 25.', {
+    errorMsgPrefix,
+    netBlockNumber,
+  });
+  const errorMsgIPv6 = t('ai:{{errorMsgPrefix}} (8) and 128.', { errorMsgPrefix });
+
+  if (isCIDR.v6(clusterNetworkCidr || '')) {
+    return Yup.number().required(requiredText).min(8, errorMsgIPv6).max(128, errorMsgIPv6);
+  }
+
+  if (isCIDR.v4(clusterNetworkCidr || '')) {
+    return Yup.number()
+      .required(requiredText)
+      .min(netBlockNumber, errorMsgIPv4)
+      .max(25, errorMsgIPv4);
+  }
+
+  return Yup.number().required(requiredText);
+};
+
+export const day2ApiVipValidationSchema = (t: TFunction) =>
+  Yup.string().test(
+    'day2-api-vip',
+    t('ai:Provide a valid DNS name or IP Address'),
+    (value?: string) => {
+      if (!value) {
+        return true;
+      }
+      return isIPorDN(value);
+    },
+  );
+
+export const bmcAddressValidationSchema = (t: TFunction) => {
+  return Yup.string()
+    .required()
+    .test(
+      'valid-bmc-address',
+      t(
+        'ai:The Value is not valid BMC address, supported protocols are redfish-virtualmedia or idrac-virtualmedia.',
+      ),
+      (val) => {
+        try {
+          const url = parseUrl(val);
+          return ['redfish-virtualmedia', 'idrac-virtualmedia'].includes(url.protocol as string);
+        } catch (error) {
+          return false;
+        }
+      },
+    );
+};

package/lib/common/validationSchemas/clusterDetailsValidation.tsx

@@ -0,0 +1,168 @@
+import { TFunction } from 'i18next';
+import * as Yup from 'yup';
+
+import {
+  CLUSTER_NAME_MAX_LENGTH,
+  clusterNameValidationMessages,
+  FORBIDDEN_HOSTNAMES,
+  hostnameValidationMessages,
+  locationValidationMessages,
+  nameValidationMessages,
+} from './constants';
+import { ClusterDetailsValues } from '../components';
+import {
+  ALPHANUMERIC_REGEX,
+  CLUSTER_NAME_START_END_REGEX,
+  CLUSTER_NAME_VALID_CHARS_REGEX,
+  DNS_NAME_REGEX,
+  HOST_NAME_REGEX,
+  LOCATION_CHARS_REGEX,
+  NAME_CHARS_REGEX,
+  NAME_START_END_REGEX,
+} from './regexes';
+
+export const nameValidationSchema = (
+  t: TFunction,
+  usedClusterNames: string[],
+  baseDnsDomain = '',
+  validateUniqueName?: boolean,
+  isOcm = false,
+) => {
+  const clusterNameValidationMessagesList = clusterNameValidationMessages(t);
+  return Yup.string()
+    .required(t('ai:Required field'))
+    .matches(CLUSTER_NAME_VALID_CHARS_REGEX, {
+      message: clusterNameValidationMessagesList.INVALID_VALUE,
+      excludeEmptyString: true,
+    })
+    .matches(CLUSTER_NAME_START_END_REGEX, {
+      message: clusterNameValidationMessagesList.INVALID_START_END,
+      excludeEmptyString: true,
+    })
+    .min(
+      isOcm ? 1 : 2,
+      isOcm
+        ? clusterNameValidationMessagesList.INVALID_LENGTH_OCM
+        : clusterNameValidationMessagesList.INVALID_LENGTH_ACM,
+    )
+    .max(
+      CLUSTER_NAME_MAX_LENGTH,
+      isOcm
+        ? clusterNameValidationMessagesList.INVALID_LENGTH_OCM
+        : clusterNameValidationMessagesList.INVALID_LENGTH_ACM,
+    )
+    .when('useRedHatDnsService', {
+      is: (useRedHatDnsService: ClusterDetailsValues['useRedHatDnsService']) =>
+        useRedHatDnsService === true,
+      then: (schema) =>
+        schema.test(
+          'is-name-unique',
+          clusterNameValidationMessagesList.NOT_UNIQUE,
+          (value?: string) => {
+            const clusterFullName = `${value || ''}.${baseDnsDomain}`;
+            return !value || !usedClusterNames.includes(clusterFullName);
+          },
+        ),
+      otherwise: (schema) =>
+        schema.test(
+          'is-name-unique',
+          clusterNameValidationMessagesList.NOT_UNIQUE,
+          (value?: string) => {
+            // in CIM cluster name is ClusterDeployment CR name which must be unique
+            return validateUniqueName ? !value || !usedClusterNames.includes(value) : true;
+          },
+        ),
+    });
+};
+
+export const richNameValidationSchema = (t: TFunction, usedNames: string[], origName?: string) => {
+  const nameValidationMessagesList = nameValidationMessages(t);
+  return Yup.string()
+    .min(1, nameValidationMessagesList.INVALID_LENGTH)
+    .max(253, nameValidationMessagesList.INVALID_LENGTH)
+    .test(
+      nameValidationMessagesList.INVALID_START_END,
+      nameValidationMessagesList.INVALID_START_END,
+      (value?: string) => {
+        const trimmed = value?.trim();
+        if (!trimmed) {
+          return true;
+        }
+        return (
+          !!trimmed[0].match(NAME_START_END_REGEX) &&
+          (trimmed[trimmed.length - 1]
+            ? !!trimmed[trimmed.length - 1].match(NAME_START_END_REGEX)
+            : true)
+        );
+      },
+    )
+    .matches(HOST_NAME_REGEX, nameValidationMessagesList.INVALID_FORMAT)
+    .matches(NAME_CHARS_REGEX, {
+      message: nameValidationMessagesList.INVALID_VALUE,
+      excludeEmptyString: true,
+    })
+    .test(nameValidationMessagesList.NOT_UNIQUE, nameValidationMessagesList.NOT_UNIQUE, (value) => {
+      if (!value || value === origName) {
+        return true;
+      }
+      return !usedNames.find((n) => n === value);
+    })
+    .notOneOf(FORBIDDEN_HOSTNAMES, hostnameValidationMessages(t).LOCALHOST_ERR);
+};
+
+export const dnsNameValidationSchema = (t: TFunction) =>
+  Yup.string()
+    .test(
+      'dns-name-label-length',
+      t('ai:Single label of the DNS name can not be longer than 63 characters.'),
+      (value?: string) => (value || '').split('.').every((label: string) => label.length <= 63),
+    )
+    .matches(DNS_NAME_REGEX, {
+      message: (value) =>
+        t('ai:Value "{{value}}" is not valid DNS name. Example: basedomain.example.com', { value }),
+      excludeEmptyString: true,
+    });
+
+export const baseDomainValidationSchema = (t: TFunction) =>
+  Yup.string().test(
+    'dns-name-label-length',
+    t(
+      'ai:Every single host component in the base domain name cannot contain more than 63 characters and must not contain spaces.',
+    ),
+    (value?: string) => {
+      // Check if the value contains any spaces
+      if (/\s/.test(value as string)) {
+        return false; // Value contains spaces, validation fails
+      }
+
+      // Check the label lengths
+      const labels = (value || '').split('.');
+      return labels.every((label: string) => label.length <= 63);
+    },
+  );
+
+export const locationValidationSchema = (t: TFunction) =>
+  Yup.string()
+    .min(1, locationValidationMessages(t).INVALID_LENGTH)
+    .max(63, locationValidationMessages(t).INVALID_LENGTH)
+    .test(
+      locationValidationMessages(t).INVALID_START_END,
+      locationValidationMessages(t).INVALID_START_END,
+      (value?: string) => {
+        const trimmed = value?.trim();
+        if (!trimmed) {
+          return true;
+        }
+        return (
+          !!trimmed[0].match(ALPHANUMERIC_REGEX) &&
+          (trimmed[trimmed.length - 1]
+            ? !!trimmed[trimmed.length - 1].match(ALPHANUMERIC_REGEX)
+            : true)
+        );
+      },
+    )
+    .matches(LOCATION_CHARS_REGEX, {
+      message: locationValidationMessages(t).INVALID_VALUE,
+      excludeEmptyString: true,
+    })
+    .required(t('ai:Location is a required field.'));

package/lib/common/{components/ui/formik → validationSchemas}/constants.tsx

@@ -57,12 +57,6 @@ export const locationValidationMessages = (t: TFunction) => ({
   INVALID_START_END: t('ai:Must start and end with an alphanumeric character'),
 });
 
-export const bmcAddressValidationMessages = (t: TFunction) => ({
-  INVALID_VALUE: t(
-    'ai:The Value is not valid BMC address, supported protocols are redfish-virtualmedia or idrac-virtualmedia.',
-  ),
-});
-
 export const FORBIDDEN_HOSTNAMES = [
   'localhost',
   'localhost.localdomain',
@@ -71,3 +65,6 @@ export const FORBIDDEN_HOSTNAMES = [
   'localhost6',
   'localhost6.localdomain6',
 ];
+
+export const getIncorrectFileTypeMessage = (t: TFunction) =>
+  t('ai:File type is not supported. File type must be yaml, yml, json, yaml.patch. or yml.patch.');

package/lib/common/validationSchemas/hostnameValidation.tsx

@@ -0,0 +1,46 @@
+import * as Yup from 'yup';
+import { TFunction } from 'i18next';
+import { FORBIDDEN_HOSTNAMES, hostnameValidationMessages } from './constants';
+import { NAME_START_END_REGEX, NAME_CHARS_REGEX } from './regexes';
+
+export const richHostnameValidationSchema = (
+  t: TFunction,
+  usedNames: string[],
+  origName?: string,
+) => {
+  const hostnameValidationMessagesList = hostnameValidationMessages(t);
+  return Yup.string()
+    .min(1, hostnameValidationMessagesList.INVALID_LENGTH)
+    .max(63, hostnameValidationMessagesList.INVALID_LENGTH)
+    .test(
+      hostnameValidationMessagesList.INVALID_START_END,
+      hostnameValidationMessagesList.INVALID_START_END,
+      (value?: string) => {
+        const trimmed = value?.trim();
+        if (!trimmed) {
+          return true;
+        }
+        return (
+          !!trimmed[0].match(NAME_START_END_REGEX) &&
+          (trimmed[trimmed.length - 1]
+            ? !!trimmed[trimmed.length - 1].match(NAME_START_END_REGEX)
+            : true)
+        );
+      },
+    )
+    .matches(NAME_CHARS_REGEX, {
+      message: hostnameValidationMessagesList.INVALID_VALUE,
+      excludeEmptyString: true,
+    })
+    .test(
+      hostnameValidationMessagesList.NOT_UNIQUE,
+      hostnameValidationMessagesList.NOT_UNIQUE,
+      (value) => {
+        if (!value || value === origName) {
+          return true;
+        }
+        return !usedNames.find((n) => n === value);
+      },
+    )
+    .notOneOf(FORBIDDEN_HOSTNAMES, hostnameValidationMessagesList.LOCALHOST_ERR);
+};

package/lib/common/validationSchemas/index.tsx

@@ -0,0 +1,11 @@
+export * from './addressValidation';
+export * from './clusterDetailsValidation';
+export * from './hostnameValidation';
+export * from './networkingValidation';
+export * from './ntpValidation';
+export * from './proxyValidation';
+export * from './pullSecretValidation';
+export * from './sshValidation';
+
+export * from './constants';
+export { ALPHANUMERIC_REGEX, LOCATION_CHARS_REGEX } from './regexes';