Merge pull request #18821 from hashicorp/td-linter-for-data-source-reads

linter: add rule to discourage data source referencing resource Read

.semgrep.yml

@@ -151,6 +151,24 @@ rules:
         - pattern: '*aws.Time($VALUE)'
     severity: WARNING
 
+  - id: data-source-with-resource-read
+    languages: [go]
+    message: Calling a resource's Read method from within a data-source is discouraged
+    paths:
+      include:
+        - aws/data_source_aws_*.go
+    patterns:
+      - pattern-regex: '(resource.+Read|flatten.+Resource)'
+      - pattern-inside: func $FUNCNAME(...) $RETURNTYPE { ... }
+      - pattern-not-inside: |
+          d.Set(..., []interface{}{ ... })
+      - pattern-not-inside: |
+          d.Set($ATTRIBUTE, $FUNC($APIOBJECT))
+      - metavariable-regex:
+          metavariable: "$FUNCNAME"
+          regex: "dataSource.+Read"
+    severity: WARNING
+
   - id: helper-acctest-RandInt-compiled
     languages: [go]
     message: Using `acctest.RandInt()` in constant or variable declaration will execute during compilation and not randomize, pass into string generating function instead
@@ -211,7 +229,6 @@ rules:
             expandStringList($LIST)
     severity: WARNING
 
-
   - id: helper-schema-ResourceData-GetOk-with-extraneous-conditional
     languages: [go]
     message: Zero value conditional check after `d.GetOk()` is extraneous