feat(terraform): add support for docker_registry_image data source (renovatebot#35537)

Co-authored-by: Rhys Arkins <rhys@arkins.net>

Author: interad-woergoetter

lib/modules/manager/terraform/__fixtures__/docker.tf

@@ -1,3 +1,8 @@
+# docker_registry_image data source
+data "docker_registry_image" "ubuntu" {
+  name = "ubuntu:precise"
+}
+
 # docker_image resources
 # https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs/resources/image
 resource "docker_image" "nginx" {
@@ -8,7 +13,7 @@ resource "docker_image" "invalid" {
 }
 
 resource "docker_image" "ignore_variable" {
-  name          = "${data.docker_registry_image.ubuntu.name}"
+  name          = data.docker_registry_image.ubuntu.name
   pull_triggers = ["${data.docker_registry_image.ubuntu.sha256_digest}"]
 }
 

lib/modules/manager/terraform/extract.spec.ts

@@ -455,7 +455,7 @@ describe('modules/manager/terraform/extract', () => {
       const res = await extractPackageFile(docker, 'docker.tf', {
         registryAliases: { 'hub.proxy.test': 'index.docker.io' },
       });
-      expect(res?.deps).toHaveLength(7);
+      expect(res?.deps).toHaveLength(8);
       expect(res?.deps.filter((dep) => dep.skipReason)).toHaveLength(3);
       expect(res?.deps).toMatchObject([
         {
@@ -512,6 +512,18 @@ describe('modules/manager/terraform/extract', () => {
           depType: 'docker_service',
           replaceString: 'repo.mycompany.com:8080/foo-service:v1',
         },
+        {
+          autoReplaceStringTemplate:
+            '{{depName}}{{#if newValue}}:{{newValue}}{{/if}}{{#if newDigest}}@{{newDigest}}{{/if}}',
+          currentDigest: undefined,
+          currentValue: 'precise',
+          datasource: 'docker',
+          depName: 'ubuntu',
+          depType: 'docker_registry_image',
+          packageName: 'ubuntu',
+          replaceString: 'ubuntu:precise',
+          versioning: 'ubuntu',
+        },
       ]);
     });
 

lib/modules/manager/terraform/extractors/resources/generic-docker-image-ref.ts

@@ -4,7 +4,8 @@ import type { ExtractConfig, PackageDependency } from '../../../types';
 import { DependencyExtractor } from '../../base';
 import type { TerraformDefinitionFile } from '../../hcl/types';
 import type { ProviderLock } from '../../lockfile/types';
-import { generic_image_resource } from './utils';
+import type { GenericImageResourceDef } from '../../types';
+import { generic_image_datasource, generic_image_resource } from './utils';
 
 export class GenericDockerImageRefExtractor extends DependencyExtractor {
   getCheckList(): string[] {
@@ -16,16 +17,33 @@ export class GenericDockerImageRefExtractor extends DependencyExtractor {
     _locks: ProviderLock[],
     config: ExtractConfig,
   ): PackageDependency[] {
-    const resourceTypMap = hclMap.resource;
-    if (is.nullOrUndefined(resourceTypMap)) {
+    const dependencies = [];
+
+    dependencies.push(
+      ...this.extractResources(hclMap.resource, generic_image_resource, config),
+    );
+
+    dependencies.push(
+      ...this.extractResources(hclMap.data, generic_image_datasource, config),
+    );
+
+    return dependencies;
+  }
+
+  private extractResources(
+    typeMap: Record<string, unknown> | undefined,
+    image_definitions: GenericImageResourceDef[],
+    config: ExtractConfig,
+  ): PackageDependency[] {
+    if (is.nullOrUndefined(typeMap)) {
       return [];
     }
 
     const dependencies = [];
 
-    for (const image_resource_def of generic_image_resource) {
+    for (const image_resource_def of image_definitions) {
       const { type, path } = image_resource_def;
-      const resourceInstancesMap = resourceTypMap[type];
+      const resourceInstancesMap = typeMap[type];
       // is there a resource with current looked at type ( `image_resource_def` )
       if (!is.nonEmptyObject(resourceInstancesMap)) {
         continue;
@@ -38,6 +56,7 @@ export class GenericDockerImageRefExtractor extends DependencyExtractor {
         );
       }
     }
+
     return dependencies;
   }
 

lib/modules/manager/terraform/extractors/resources/utils.ts

@@ -35,6 +35,10 @@ const KubernetesJobTemplateInit = [
   'image',
 ];
 
+export const generic_image_datasource: GenericImageResourceDef[] = [
+  { type: 'docker_registry_image', path: ['name'] },
+];
+
 export const generic_image_resource: GenericImageResourceDef[] = [
   // Docker provider: https://registry.terraform.io/providers/kreuzwerker/docker
   { type: 'docker_image', path: ['name'] },

lib/modules/manager/terraform/hcl/types.ts

@@ -2,6 +2,7 @@ export interface TerraformDefinitionFile {
   terraform?: TerraformBlock[];
   module?: Record<string, TerraformModule[]>;
   resource?: TerraformResources;
+  data?: Record<string, unknown>; // generic docker data sources
   provider?: Record<string, TerraformProvider[]>;
 }
 

lib/modules/manager/terraform/readme.md

@@ -120,4 +120,8 @@ You can use these `depTypes` for fine-grained control, for example to disable pa
 | Kubernetes StatefulSet               |       `kubernetes_stateful_set`        |                                                                            |
 | Kubernetes StatefulSet v1            |      `kubernetes_stateful_set_v1`      |                                                                            |
 
+| Data Source           |        `depType`        | Notes |
+| --------------------- | :---------------------: | :---: |
+| Docker registry image | `docker_registry_image` |       |
+
 If you need to change the versioning format, read the [versioning](../../versioning/index.md) documentation to learn more.