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

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

@@ -4,18 +4,18 @@ import { logger } from '../../../logger';
 import { regEx } from '../../../util/regex';
 import { parseSingleYaml } from '../../../util/yaml';
 import { GitlabTagsDatasource } from '../../datasource/gitlab-tags';
+import {
+  filterIncludeFromGitlabPipeline,
+  isGitlabIncludeProject,
+  isNonEmptyObject,
+} from '../gitlabci/common';
 import type {
   GitlabInclude,
   GitlabIncludeProject,
   GitlabPipeline,
 } from '../gitlabci/types';
 import { replaceReferenceTags } from '../gitlabci/utils';
 import type { PackageDependency, PackageFileContent } from '../types';
-import {
-  filterIncludeFromGitlabPipeline,
-  isGitlabIncludeProject,
-  isNonEmptyObject,
-} from './common';
 
 function extractDepFromIncludeFile(
   includeObj: GitlabIncludeProject,

lib/modules/manager/gitlabci/__fixtures__/include.2.yaml

@@ -0,0 +1,13 @@
+include:
+- project: mikebryant/include-source-example
+  file: /template.yaml
+  ref: 1.0.0
+-   project: mikebryant/include-source-example2
+    file: /template.yaml
+    ref: master
+- {"project":"mikebryant/include-source-example3", "file": "/template.yaml",}
+- {}
+
+script:
+- !reference [.setup, script]
+- !reference [arbitrary job name with space and no starting dot, nested1, nested2, nested3]

lib/modules/manager/gitlabci/common.spec.ts

@@ -1,9 +1,34 @@
-import { isGitlabIncludeLocal } from './common';
+import { Fixtures } from '../../../../test/fixtures';
+import { parseSingleYaml } from '../../../util/yaml';
+import type { GitlabPipeline } from '../gitlabci/types';
+import { replaceReferenceTags } from '../gitlabci/utils';
+import {
+  filterIncludeFromGitlabPipeline,
+  isGitlabIncludeLocal,
+  isGitlabIncludeProject,
+  isNonEmptyObject,
+} from './common';
 
+const yamlFileMultiConfig = Fixtures.get('include.2.yaml');
+// TODO: use schema (#9610)
+const pipeline = parseSingleYaml<GitlabPipeline>(
+  replaceReferenceTags(yamlFileMultiConfig),
+);
 const includeLocal = { local: 'something' };
 const includeProject = { project: 'something' };
 
 describe('modules/manager/gitlabci/common', () => {
+  describe('filterIncludeFromGitlabPipeline()', () => {
+    it('returns GitlabPipeline without top level include key', () => {
+      expect(pipeline).toHaveProperty('include');
+      const filtered_pipeline = filterIncludeFromGitlabPipeline(pipeline);
+      expect(filtered_pipeline).not.toHaveProperty('include');
+      expect(filtered_pipeline).toEqual({
+        script: [null, null],
+      });
+    });
+  });
+
   describe('isGitlabIncludeLocal()', () => {
     it('returns true if GitlabInclude is GitlabIncludeLocal', () => {
       expect(isGitlabIncludeLocal(includeLocal)).toBe(true);
@@ -13,4 +38,24 @@ describe('modules/manager/gitlabci/common', () => {
       expect(isGitlabIncludeLocal(includeProject)).toBe(false);
     });
   });
+
+  describe('isGitlabIncludeProject()', () => {
+    it('returns true if GitlabInclude is GitlabIncludeProject', () => {
+      expect(isGitlabIncludeProject(includeProject)).toBe(true);
+    });
+
+    it('returns false if GitlabInclude is not GitlabIncludeProject', () => {
+      expect(isGitlabIncludeProject(includeLocal)).toBe(false);
+    });
+  });
+
+  describe('isNonEmptyObject()', () => {
+    it('returns true if not empty', () => {
+      expect(isNonEmptyObject({ attribute1: 1 })).toBe(true);
+    });
+
+    it('returns false if empty', () => {
+      expect(isNonEmptyObject({})).toBe(false);
+    });
+  });
 });

lib/modules/manager/gitlabci/common.ts

@@ -1,8 +1,41 @@
 import is from '@sindresorhus/is';
-import type { GitlabInclude, GitlabIncludeLocal } from '../gitlabci/types';
+import type {
+  GitlabInclude,
+  GitlabIncludeComponent,
+  GitlabIncludeLocal,
+  GitlabIncludeProject,
+  GitlabPipeline,
+} from '../gitlabci/types';
+
+export function isNonEmptyObject(obj: any): boolean {
+  return is.object(obj) && Object.keys(obj).length !== 0;
+}
+
+export function filterIncludeFromGitlabPipeline(
+  pipeline: GitlabPipeline,
+): GitlabPipeline {
+  const pipeline_without_include: GitlabPipeline = {};
+  for (const key of Object.keys(pipeline).filter((key) => key !== 'include')) {
+    const pipeline_key = key as keyof typeof pipeline;
+    pipeline_without_include[pipeline_key] = pipeline[pipeline_key];
+  }
+  return pipeline_without_include;
+}
+
+export function isGitlabIncludeProject(
+  include: GitlabInclude,
+): include is GitlabIncludeProject {
+  return !is.undefined((include as GitlabIncludeProject).project);
+}
 
 export function isGitlabIncludeLocal(
   include: GitlabInclude,
 ): 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/extract.spec.ts

@@ -1,3 +1,4 @@
+import { codeBlock } from 'common-tags';
 import { logger } from '../../../../test/util';
 import { GlobalConfig } from '../../../config/global';
 import type { RepoGlobalConfig } from '../../../config/types';
@@ -347,5 +348,63 @@ describe('modules/manager/gitlabci/extract', () => {
       expect(extractFromJob(undefined)).toBeEmptyArray();
       expect(extractFromJob({ image: 'image:test' })).toEqual(expectedRes);
     });
+
+    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',
+          registryUrls: ['https://other-gitlab.example.com'],
+        },
+      ]);
+    });
   });
 });