import { indent as _indent } from '@shell/utils/string'; import { addObject, findBy, removeObject, removeObjects } from '@shell/utils/array'; import jsyaml from 'js-yaml'; import { cleanUp } from '@shell/utils/object'; export const SIMPLE_TYPES = [ 'string', 'multiline', 'masked', 'password', 'float', 'int', 'date', 'blob', 'boolean', 'version' ]; const ALWAYS_ADD = [ 'apiVersion', 'kind', 'metadata', 'metadata.name', 'spec', 'spec.selector', 'spec.selector.matchLabels', 'spec.template', 'spec.template.metadata', 'spec.template.metadata.labels', 'spec.template.spec.containers.name', 'spec.template.spec.containers.image', ]; export const NEVER_ADD = [ 'metadata.clusterName', 'metadata.clusterName', 'metadata.creationTimestamp', 'metadata.deletionGracePeriodSeconds', 'metadata.deletionTimestamp', 'metadata.finalizers', 'metadata.generateName', 'metadata.generation', 'metadata.initializers', 'metadata.managedFields', 'metadata.ownerReferences', 'metadata.resourceVersion', 'metadata.relationships', 'metadata.selfLink', 'metadata.uid', // CRD -> Schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource. If we allow processing we fall into inf loop on openAPIV3Schema.allOf which contains a cyclical ref of allOf props. 'spec.versions.schema', 'status', 'stringData', ]; export const ACTIVELY_REMOVE = [ 'metadata.managedFields', 'metadata.relationships', 'metadata.state', 'status', 'links', 'type', 'id' ]; const INDENT = 2; export function createYaml(schemas, type, data, processAlwaysAdd = true, depth = 0, path = '', rootType = null) { const schema = findBy(schemas, 'id', type); if ( !rootType ) { rootType = type; } if ( !schema ) { return `Error loading schema for ${ type }`; } data = data || {}; if ( depth === 0 ) { const attr = schema.attributes || {}; // Default to data.apiVersion/kind to accommodate spoofed types that aggregate multiple types data.apiVersion = (attr.group ? `${ attr.group }/${ attr.version }` : attr.version) || data.apiVersion; data.kind = attr.kind || data.kind; } const regularFields = []; if (processAlwaysAdd) { // Add all the parents of each key so that spec.template.foo.blah // causes 'spec', 'template' and 'foo' keys to be created const always = ALWAYS_ADD.slice(); for ( let i = always.length - 1 ; i >= 0 ; i-- ) { let entry = always[i].split(/\./); while ( entry.length ) { addObject(always, entry.join('.')); entry = entry.slice(0, -1); } } // Mark always fields as regular so they're not commented out for ( const entry of always ) { const parts = entry.split(/\./); const key = parts[parts.length - 1]; const prefix = parts.slice(0, -1).join('.'); if ( prefix === path && schema.resourceFields && schema.resourceFields[key] ) { addObject(regularFields, key); } } } // Mark any fields that are passed in as data as regular so they're not commented out const commentFields = Object.keys(schema.resourceFields || {}); commentFields.forEach((key) => { if ( typeof data[key] !== 'undefined' || (depth === 0 && key === '_type') ) { addObject(regularFields, key); } }); for ( const key in data ) { if ( typeof data[key] !== 'undefined' ) { addObject(regularFields, key); } } for ( const entry of ACTIVELY_REMOVE ) { const parts = entry.split(/\./); const key = parts[parts.length - 1]; const prefix = parts.slice(0, -1).join('.'); if ( prefix === path) { removeObject(regularFields, key); } } for ( const entry of NEVER_ADD ) { const parts = entry.split(/\./); const key = parts[parts.length - 1]; const prefix = parts.slice(0, -1).join('.'); if ( prefix === path && schema.resourceFields && schema.resourceFields[key] ) { removeObject(commentFields, key); } } removeObjects(commentFields, regularFields); const regular = regularFields.map(k => stringifyField(k)); const comments = commentFields.map((k) => { // Don't add a namespace comment for types that aren't namespaced. if ( path === 'metadata' && k === 'namespace' ) { const rootSchema = findBy(schemas, 'id', rootType); if ( rootSchema && !rootSchema.attributes?.namespaced ) { return null; } } return comment(stringifyField(k)); }); const out = [...regular, ...comments] .filter(x => x !== null) .join('\n') .trim(); return out; // --------------- function stringifyField(key) { const field = schema.resourceFields?.[key]; let out = `${ key }:`; // '_type' in steve maps to kubernetes 'type' field; show 'type' field in yaml if (key === '_type') { out = 'type:'; } if ( !field ) { if (data[key]) { try { const cleaned = cleanUp(data); const parsedData = jsyaml.dump(cleaned[key]); if ( typeof data[key] === 'object' || Array.isArray(data[key]) ) { out += `\n${ indent(parsedData.trim()) }`; } else { out += ` ${ parsedData.trim() }`; } return out; } catch (e) { console.error(`Error: Unable to parse map data for yaml key: ${ key }`, e); // eslint-disable-line no-console } } return null; } const type = typeMunge(field.type); const mapOf = typeRef('map', type); const arrayOf = typeRef('array', type); const referenceTo = typeRef('reference', type); if ( mapOf ) { if (data[key]) { try { const cleaned = cleanUp(data); const parsedData = jsyaml.dump(cleaned[key]); out += `\n${ indent(parsedData.trim()) }`; } catch (e) { console.error(`Error: Unable to parse map data for yaml of type: ${ type }`, e); // eslint-disable-line no-console } } if ( SIMPLE_TYPES.includes(mapOf) ) { out += `\n# key: ${ mapOf }`; } else { const chunk = createYaml(schemas, mapOf, null, processAlwaysAdd, depth + 1, (path ? `${ path }.${ key }` : key), rootType); let indented = indent(chunk, 2); indented = indented.replace(/^(#)?\s\s\s\s/, '$1'); out += `\n ${ indented }`; } return out; } if ( arrayOf ) { if (data[key]) { try { const cleaned = cleanUp(data); if ( cleaned?.[key] ) { const parsedData = jsyaml.dump(cleaned[key]); out += `\n${ indent(parsedData.trim()) }`; } } catch (e) { console.error(`Error: Unale to parse array data for yaml of type: ${ type }`, e); // eslint-disable-line no-console } } if ( SIMPLE_TYPES.includes(arrayOf) ) { out += `\n# - ${ arrayOf }`; } else { const chunk = createYaml(schemas, arrayOf, null, false, depth + 1, (path ? `${ path }.${ key }` : key), rootType); let indented = indent(chunk, 2); indented = indented.replace(/^(#)?\s*\s\s([^\s])/, '$1 - $2'); out += `\n${ indented }`; } return out; } if ( referenceTo ) { out += ` #${ referenceTo }`; return out; } if ( SIMPLE_TYPES.includes(type) ) { if (key === '_type' && typeof data[key] === 'undefined' && typeof data['type'] !== 'undefined') { out += ` ${ serializeSimpleValue(data['type']) }`; } else if ( typeof data[key] === 'undefined' ) { out += ` #${ serializeSimpleValue(type) }`; } else { out += ` ${ serializeSimpleValue(data[key]) }`; } return out; } /** * .spec is the type used for the Logging chart Output and ClusterOutput resource spec. * Without this Output and ClusterOutput specs are empty. */ if ( type === 'json' || type === '.spec') { try { const parsedData = jsyaml.dump(data[key]); if (parsedData) { out += `\n${ indent(parsedData.trim()) }`; } else { out += ` #${ type }`; } return out; } catch (e) { } } const subDef = findBy(schemas, 'id', type); if ( subDef ) { const chunk = createYaml(schemas, type, data[key], processAlwaysAdd, depth + 1, (path ? `${ path }.${ key }` : key), rootType); out += `\n${ indent(chunk) }`; } else { out += ` #${ type }`; } return out; } } function comment(lines) { return (lines || '').split('\n').map(x => `#${ x.replace(/#/g, '') }`).join('\n'); } function indent(lines, depth = 1) { return _indent(lines, depth * INDENT, ' ', /^#/); } function serializeSimpleValue(data) { return jsyaml.dump(data).trim(); } export function typeRef(type, str) { const re = new RegExp(`^${ type }\\[(.*)\\]$`); const match = str.match(re); if ( match ) { return typeMunge(match[1]); } } export function typeMunge(type) { if ( type === 'integer' ) { return 'int'; } if ( type === 'io.k8s.apimachinery.pkg.api.resource.Quantity' ) { return 'string'; } return type; } export function saferDump(obj) { const out = jsyaml.dump(obj || {}); if ( out === '{}\n' ) { return ''; } return out; }