feat(gitlab): support GitLab CI/CD component references

lib/modules/manager/gitlabci-include/common.ts

@@ -1,6 +1,7 @@
 import is from '@sindresorhus/is';
 import type {
   GitlabInclude,
+  GitlabIncludeComponent,
   GitlabIncludeLocal,
   GitlabIncludeProject,
   GitlabPipeline,
@@ -32,3 +33,9 @@ export function isGitlabIncludeLocal(
 ): include is GitlabIncludeLocal {
   return !is.undefined((include as GitlabIncludeLocal).local);
 }
+
+export function isGitlabIncludeComponent(
+  include: GitlabInclude,
+): include is GitlabIncludeComponent {
+  return !is.undefined((include as GitlabIncludeComponent).component);
+}

lib/modules/manager/gitlabci-include/extract.spec.ts

@@ -1,3 +1,4 @@
+import { codeBlock } from 'common-tags';
 import { Fixtures } from '../../../../test/fixtures';
 import { GlobalConfig } from '../../../config/global';
 import { extractPackageFile } from '.';
@@ -56,6 +57,64 @@ describe('modules/manager/gitlabci-include/extract', () => {
       expect(res).toBeNull();
     });
 
+    it('extracts component references', () => {
+      GlobalConfig.set({
+        endpoint: 'https://gitlab.example.com',
+      });
+
+      const content = codeBlock`
+        include:
+          - component: gitlab.example.com/an-org/a-project/a-component@1.0
+            inputs:
+              stage: build
+          - component: gitlab.example.com/an-org/a-subgroup/a-project/a-component@e3262fdd0914fa823210cdb79a8c421e2cef79d8
+          - component: gitlab.example.com/an-org/a-subgroup/another-project/a-component@main
+          - component: gitlab.example.com/another-org/a-project/a-component@~latest
+            inputs:
+              stage: test
+          - component: gitlab.example.com/malformed-component-reference
+          - component:
+              malformed: true
+          - component: gitlab.example.com/an-org/a-component@1.0
+          - component: other-gitlab.example.com/an-org/a-project/a-component@1.0
+      `;
+      const res = extractPackageFile(content);
+      expect(res?.deps).toMatchObject([
+        {
+          currentValue: '1.0',
+          datasource: 'gitlab-tags',
+          depName: 'an-org/a-project',
+          depType: 'repository',
+        },
+        {
+          currentValue: 'e3262fdd0914fa823210cdb79a8c421e2cef79d8',
+          datasource: 'gitlab-tags',
+          depName: 'an-org/a-subgroup/a-project',
+          depType: 'repository',
+        },
+        {
+          currentValue: 'main',
+          datasource: 'gitlab-tags',
+          depName: 'an-org/a-subgroup/another-project',
+          depType: 'repository',
+        },
+        {
+          currentValue: '~latest',
+          datasource: 'gitlab-tags',
+          depName: 'another-org/a-project',
+          depType: 'repository',
+          skipReason: 'unsupported-version',
+        },
+        {
+          currentValue: '1.0',
+          datasource: 'gitlab-tags',
+          depName: 'an-org/a-project',
+          depType: 'repository',
+          skipReason: 'invalid-value',
+        },
+      ]);
+    });
+
     it('normalizes configured endpoints', () => {
       const endpoints = [
         'http://gitlab.test/api/v4',

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

@@ -2,21 +2,30 @@
 import { GlobalConfig } from '../../../config/global';
 import { logger } from '../../../logger';
 import { regEx } from '../../../util/regex';
+import { parseUrl } from '../../../util/url';
 import { parseSingleYaml } from '../../../util/yaml';
 import { GitlabTagsDatasource } from '../../datasource/gitlab-tags';
 import type {
   GitlabInclude,
+  GitlabIncludeComponent,
   GitlabIncludeProject,
   GitlabPipeline,
 } from '../gitlabci/types';
 import { replaceReferenceTags } from '../gitlabci/utils';
 import type { PackageDependency, PackageFileContent } from '../types';
 import {
   filterIncludeFromGitlabPipeline,
+  isGitlabIncludeComponent,
   isGitlabIncludeProject,
   isNonEmptyObject,
 } from './common';
 
+// See https://docs.gitlab.com/ee/ci/components/index.html#use-a-component
+const componentReferenceRegex = regEx(
+  /(?<fqdn>[^/]+)\/(?<projectPath>.+)\/(.+)@(?<specificVersion>.+)/,
+);
+const componentReferenceLatestVersion = '~latest';
+
 function extractDepFromIncludeFile(
   includeObj: GitlabIncludeProject,
 ): PackageDependency {
@@ -33,6 +42,57 @@
   return dep;
 }
 
+function extractDepFromIncludeComponent(
+  includeComponent: GitlabIncludeComponent,
+  endpoint: string | undefined,
+): PackageDependency | null {
+  const componentReferenceMatch = componentReferenceRegex.exec(
+    includeComponent.component,
+  );
+  if (!componentReferenceMatch?.groups) {
+    logger.debug(
+      { componentReference: includeComponent.component },
+      'Ignoring malformed component reference',
+    );
+    return null;
+  }
+  const projectPathParts =
+    componentReferenceMatch.groups.projectPath.split('/');
+  if (projectPathParts.length < 2) {
+    logger.debug(
+      { componentReference: includeComponent.component },
+      'Ignoring component reference with incomplete project path',
+    );
+    return null;
+  }
+
+  const dep: PackageDependency = {
+    datasource: GitlabTagsDatasource.id,
+    depName: componentReferenceMatch.groups.projectPath,
+    depType: 'repository',
+    currentValue: componentReferenceMatch.groups.specificVersion,
+  };
+  if (dep.currentValue === componentReferenceLatestVersion) {
+    logger.debug(
+      { componentVersion: dep.currentValue },
+      'Ignoring component version',
+    );
+    dep.skipReason = 'unsupported-version';
+  }
+  const endpointUrl = parseUrl(endpoint);
+  if (
+    endpointUrl &&
+    endpointUrl.hostname !== componentReferenceMatch.groups.fqdn
+  ) {
+    logger.debug(
+      { componentReference: includeComponent.component },
+      'Ignoring external component reference',
+    );
+    dep.skipReason = 'invalid-value';
+  }
+  return dep;
+}
+
 function getIncludeProjectsFromInclude(
   includeValue: GitlabInclude[] | GitlabInclude,
 ): GitlabIncludeProject[] {
@@ -63,6 +123,37 @@
   return childrenData;
 }
 
+function getIncludeComponentsFromInclude(
+  includeValue: GitlabInclude[] | GitlabInclude,
+): GitlabIncludeComponent[] {
+  const includes = is.array(includeValue) ? includeValue : [includeValue];
+
+  // Filter out includes that dont have a file & project.
+  return includes.filter(isGitlabIncludeComponent);
+}
+function getAllIncludeComponents(
+  data: GitlabPipeline,
+): GitlabIncludeComponent[] {
+  // If Array, search each element.
+  if (is.array(data)) {
+    return (data as GitlabPipeline[])
+      .filter(isNonEmptyObject)
+      .map(getAllIncludeComponents)
+      .flat();
+  }
+
+  const childrenData = Object.values(filterIncludeFromGitlabPipeline(data))
+    .filter(isNonEmptyObject)
+    .map(getAllIncludeComponents)
+    .flat();
+
+  // Process include key.
+  if (data.include) {
+    childrenData.push(...getIncludeComponentsFromInclude(data.include));
+  }
+  return childrenData;
+}
+
 export function extractPackageFile(
   content: string,
   packageFile?: string,
@@ -71,7 +162,7 @@
   const platform = GlobalConfig.get('platform');
   const endpoint = GlobalConfig.get('endpoint');
   try {
     const doc = parseSingleYaml(replaceReferenceTags(content), {
       json: true,
     }) as GitlabPipeline;
     const includes = getAllIncludeProjects(doc);
@@ -82,6 +173,13 @@
       }
       deps.push(dep);
     }
+    const includedComponents = getAllIncludeComponents(doc);
+    for (const includedComponent of includedComponents) {
+      const dep = extractDepFromIncludeComponent(includedComponent, endpoint);
+      if (dep) {
+        deps.push(dep);
+      }
+    }
   } catch (err) /* istanbul ignore next */ {
     if (err.stack?.startsWith('YAMLException:')) {
       logger.debug(

lib/modules/manager/gitlabci/types.ts

@@ -16,6 +16,10 @@ export interface GitlabIncludeTemplate {
   template: string;
 }
 
+export interface GitlabIncludeComponent {
+  component: string;
+}
+
 export interface GitlabPipeline {
   include?: GitlabInclude[] | GitlabInclude;
 }
@@ -39,4 +43,5 @@ export type GitlabInclude =
   | GitlabIncludeProject
   | GitlabIncludeRemote
   | GitlabIncludeTemplate
+  | GitlabIncludeComponent
   | string;