renovate/lib/manager/gitlabci-include/extract.ts

import is from '@sindresorhus/is';
import yaml from 'js-yaml';
import * as datasourceGitlabTags from '../../datasource/gitlab-tags';
import { logger } from '../../logger';
import { SkipReason } from '../../types';
import { readLocalFile } from '../../util/fs';
import { ExtractConfig, PackageDependency, PackageFile } from '../common';
import * as gitlabci from '../gitlabci/extract';

function extractDepFromIncludeFile(includeObj: {
  file: any;
  project: string;
  ref: string;
}): PackageDependency {
  const dep: PackageDependency = {
    datasource: datasourceGitlabTags.id,
    depName: includeObj.project,
    depType: 'repository',
  };
  if (!includeObj.ref) {
    dep.skipReason = SkipReason.UnknownVersion;
    return dep;
  }
  dep.currentValue = includeObj.ref;
  return dep;
}

async function extractDepsFromIncludeLocal(includeObj: {
  local: string;
}): Promise<PackageDependency[] | null> {
  const content = await readLocalFile(includeObj.local, 'utf8');
  const deps = gitlabci.extractPackageFile(content)?.deps;
  return deps;
}

export async function extractPackageFile(
  content: string,
  _packageFile: string,
  config: ExtractConfig
): Promise<PackageFile | null> {
  const deps: PackageDependency[] = [];
  try {
    // TODO: fix me
    const doc = yaml.safeLoad(content, { json: true }) as any;
    if (doc?.include && is.array(doc.include)) {
      for (const includeObj of doc.include) {
        if (includeObj.file && includeObj.project) {
          const dep = extractDepFromIncludeFile(includeObj);
          if (config.endpoint) {
            dep.registryUrls = [config.endpoint.replace(/\/api\/v4\/?/, '')];
          }
          deps.push(dep);
        } else if (includeObj.local) {
          const includedDeps = await extractDepsFromIncludeLocal(includeObj);
          if (includedDeps) {
            for (const includedDep of includedDeps) {
              deps.push(includedDep);
            }
          }
        }
      }
    }
  } catch (err) /* istanbul ignore next */ {
    if (err.stack?.startsWith('YAMLException:')) {
      logger.debug({ err });
      logger.debug('YAML exception extracting GitLab CI includes');
    } else {
      logger.warn({ err }, 'Error extracting GitLab CI includes');
    }
  }
  if (!deps.length) {
    return null;
  }
  return { deps };
}