[terraform] IJPL-185785 Refactoring, simplified hcl psi util methods

GitOrigin-RevId: e555060970d33e11c7e293bc9574ff3ab765d5e0

Author: Nurullokhon Gulomkodirov

terraform/src/org/intellij/terraform/config/model/extensions.kt

@@ -1,4 +1,4 @@
-// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
 package org.intellij.terraform.config.model
 
 import com.fasterxml.jackson.databind.node.ArrayNode
@@ -16,13 +16,13 @@ import org.intellij.terraform.hil.psi.ILExpression
 import org.intellij.terraform.hil.psi.TypeCachedValueProvider
 import org.intellij.terraform.hil.psi.impl.getHCLHost
 
-fun HCLElement.getTerraformModule(): Module {
+internal fun HCLElement.getTerraformModule(): Module {
   val file = this.containingFile.originalFile
   assert(file is HCLFile)
   return Module.getModule(file)
 }
 
-fun PsiElement.getTerraformSearchScope(): GlobalSearchScope {
+internal fun PsiElement.getTerraformSearchScope(): GlobalSearchScope {
   val file = this.containingFile.originalFile
   var directory = file.containingDirectory
   if (directory == null) {
@@ -40,11 +40,7 @@ fun PsiElement.getTerraformSearchScope(): GlobalSearchScope {
   }
 }
 
-fun HCLProperty.toProperty(type: PropertyType): Property {
-  return Property(type, this.value)
-}
-
-fun HCLBlock.getProviderFQName(): String? {
+internal fun HCLBlock.getProviderFQName(): String? {
   val tp = this.getNameElementUnquoted(1) ?: return null
   val als = when (val value = this.`object`?.findProperty("alias")?.value) {
     is HCLStringLiteral -> value.value
@@ -58,42 +54,39 @@ fun HCLBlock.getProviderFQName(): String? {
   }
 }
 
-fun BaseExpression?.getType(): Type? {
+internal fun BaseExpression?.getType(): Type? {
   if (this == null) return null
   return TypeCachedValueProvider.getType(this)
 }
 
-fun BaseExpression.isInTerraformFile(): Boolean {
+internal fun BaseExpression.isInTerraformFile(): Boolean {
   return TfPsiPatterns.TerraformFile.accepts(this.getHCLHost()?.containingFile)
 }
 
-fun String.ensureHavePrefix(prefix: String) = if (this.startsWith(prefix)) this else (prefix + this)
-fun String.ensureHaveSuffix(suffix: String) = if (this.endsWith(suffix)) this else (this + suffix)
+internal fun String.ensureHavePrefix(prefix: String): String = if (this.startsWith(prefix)) this else (prefix + this)
 
-
-fun ObjectNode.isNotEmpty(): Boolean {
+internal fun ObjectNode.isNotEmpty(): Boolean {
   return size() > 0
 }
 
-fun ObjectNode.obj(name: String): ObjectNode? {
+internal fun ObjectNode.obj(name: String): ObjectNode? {
   return this.get(name) as? ObjectNode
 }
 
-fun ObjectNode.array(name: String): ArrayNode? {
+internal fun ObjectNode.array(name: String): ArrayNode? {
   return this.get(name) as? ArrayNode
 }
 
-fun ObjectNode.string(name: String): String? {
+internal fun ObjectNode.string(name: String): String? {
   return this.get(name)?.textValue()
 }
 
-fun ObjectNode.number(name: String): Number? {
+internal fun ObjectNode.number(name: String): Number? {
   return this.get(name)?.numberValue()
 }
 
-fun ObjectNode.boolean(name: String): Boolean? {
+internal fun ObjectNode.boolean(name: String): Boolean? {
   val node = this.get(name) ?: return null
   if (!node.isBoolean) return null
   return node.booleanValue()
 }
-

terraform/src/org/intellij/terraform/config/model/loader/loaders_v1.kt

@@ -1,10 +1,11 @@
-// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
 package org.intellij.terraform.config.model.loader
 
 import com.fasterxml.jackson.databind.node.ArrayNode
 import com.fasterxml.jackson.databind.node.ObjectNode
 import com.fasterxml.jackson.databind.node.TextNode
 import org.intellij.terraform.config.Constants
+import org.intellij.terraform.config.Constants.HCL_PROVISIONER_IDENTIFIER
 import org.intellij.terraform.config.model.*
 import org.intellij.terraform.config.model.loader.TfMetadataLoader.Companion.LOG
 
@@ -226,7 +227,7 @@ abstract class ProviderLoader(protected val base: BaseLoader) : VersionedMetadat
 }
 
 abstract class ProvisionerLoader(protected val base: BaseLoader) : VersionedMetadataLoader {
-  override fun isSupportedType(type: String): Boolean = type == "provisioner"
+  override fun isSupportedType(type: String): Boolean = type == HCL_PROVISIONER_IDENTIFIER
   override fun load(context: LoadContext, json: ObjectNode, fileName: String) {
     val model = context.model
     val provisioner_schema = json.obj("schemas") ?: json

terraform/src/org/intellij/terraform/hcl/psi/HCLPsiUtil.kt

@@ -7,11 +7,19 @@ import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiReference
 import com.intellij.psi.PsiWhiteSpace
 import com.intellij.psi.util.PsiTreeUtil
+import com.intellij.psi.util.parentOfType
 import com.intellij.psi.util.siblings
+import org.intellij.terraform.config.Constants.HCL_CONNECTION_IDENTIFIER
+import org.intellij.terraform.config.Constants.HCL_PROVISIONER_IDENTIFIER
+import org.intellij.terraform.config.model.Module
+import org.intellij.terraform.config.model.Variable
+import org.intellij.terraform.config.model.getTerraformModule
 import org.intellij.terraform.config.patterns.TfPsiPatterns
+import org.intellij.terraform.hcl.psi.common.BaseExpression
 import org.intellij.terraform.hcl.psi.common.Identifier
 import org.intellij.terraform.hcl.psi.common.IndexSelectExpression
 import org.intellij.terraform.hcl.psi.common.SelectExpression
+import org.intellij.terraform.hil.psi.impl.getHCLHost
 
 /**
  * Various helper methods for working with PSI of JSON language.
@@ -186,9 +194,9 @@ internal object HCLPsiUtil {
   }
 
   fun PsiElement.getRequiredProviderProperty(): HCLProperty? {
-    val providerProperty = when {
-      this is HCLProperty -> this
-      this is Identifier && this.parent is HCLProperty -> this.parent as HCLProperty
+    val providerProperty = when (this) {
+      is HCLProperty -> this
+      is Identifier if this.parent is HCLProperty -> this.parent as HCLProperty
       else -> return null
     }
 
@@ -208,3 +216,73 @@ internal object HCLPsiUtil {
   fun PsiElement.getNextSiblingNonWhiteSpace(): PsiElement? =
     this.siblings(forward = true, withSelf = false).firstOrNull { it !is PsiWhiteSpace }
 }
+
+internal fun getTerraformModule(element: BaseExpression): Module? {
+  val host = element.getHCLHost() ?: return null
+  return host.getTerraformModule()
+}
+
+internal fun getLocalDefinedVariables(element: BaseExpression): List<Variable> {
+  return getTerraformModule(element)?.getAllVariables() ?: emptyList()
+}
+
+internal fun getDefinedLocalsInModule(element: BaseExpression): List<String> {
+  return getTerraformModule(element)?.getAllLocals()?.map { it.first } ?: emptyList()
+}
+
+internal fun getHclBlockForSelfContext(position: BaseExpression): HCLBlock? {
+  val host = position.getHCLHost() ?: return null
+  return getProvisionerOfResource(host) ?: getConnectionOfResource(host)
+}
+
+internal fun getProvisionerOfResource(host: HCLElement): HCLBlock? {
+  val provisioner = host.parentOfType<HCLBlock>() ?: return null
+
+  return when (provisioner.getNameElementUnquoted(0)) {
+    HCL_CONNECTION_IDENTIFIER -> getProvisionerOfResource(provisioner)
+    HCL_PROVISIONER_IDENTIFIER -> getParentResourceBlock(provisioner)
+    else -> null
+  }
+}
+
+internal fun getConnectionOfResource(host: HCLElement): HCLBlock? {
+  val connection = host.parentOfType<HCLBlock>() ?: return null
+
+  return when (connection.getNameElementUnquoted(0)) {
+    HCL_CONNECTION_IDENTIFIER -> getParentResourceBlock(connection)
+    else -> null
+  }
+}
+
+internal fun getParentResourceBlock(element: HCLElement): HCLBlock? {
+  val resource = element.parentOfType<HCLBlock>()
+  return if (TfPsiPatterns.ResourceRootBlock.accepts(resource)) resource else null
+}
+
+internal fun getResource(position: BaseExpression): HCLBlock? {
+  val host = position.getHCLHost() ?: return null
+  return getParentResourceBlock(host)
+}
+
+internal fun getDataSource(position: BaseExpression): HCLBlock? {
+  val host = position.getHCLHost() ?: return null
+  val dataSource = host.parentOfType<HCLBlock>()
+  return if (TfPsiPatterns.DataSourceRootBlock.accepts(dataSource)) dataSource else null
+}
+
+internal fun getContainingResourceOrDataSource(element: HCLElement?): HCLBlock? {
+  if (element == null) return null
+  return PsiTreeUtil.findFirstParent(element, true) {
+    TfPsiPatterns.DataSourceRootBlock.accepts(it) ||
+    TfPsiPatterns.ResourceRootBlock.accepts(it)
+  } as? HCLBlock
+}
+
+internal fun getContainingResourceOrDataSourceOrModule(element: HCLElement?): HCLBlock? {
+  if (element == null) return null
+  return PsiTreeUtil.findFirstParent(element, true) {
+    TfPsiPatterns.DataSourceRootBlock.accepts(it) ||
+    TfPsiPatterns.ResourceRootBlock.accepts(it) ||
+    TfPsiPatterns.ModuleRootBlock.accepts(it)
+  } as? HCLBlock
+}

terraform/src/org/intellij/terraform/hil/codeinsight/HILCompletionContributor.kt

@@ -43,8 +43,11 @@ import org.intellij.terraform.hil.patterns.HILPatterns.IlseNotFromKnownScope
 import org.intellij.terraform.hil.patterns.HILPatterns.InsideForExpressionBody
 import org.intellij.terraform.hil.patterns.HILPatterns.MethodPosition
 import org.intellij.terraform.hil.patterns.HILPatterns.VariableTypePosition
-import org.intellij.terraform.hil.psi.*
+import org.intellij.terraform.hil.psi.FakeTypeProperty
+import org.intellij.terraform.hil.psi.ForVariableCompletion
+import org.intellij.terraform.hil.psi.getGoodLeftElement
 import org.intellij.terraform.hil.psi.impl.getHCLHost
+import org.intellij.terraform.hil.psi.resolve
 import org.intellij.terraform.opentofu.codeinsight.EncryptionMethodsCompletionProvider
 import org.intellij.terraform.opentofu.codeinsight.KeyProvidersCompletionProvider
 import org.intellij.terraform.opentofu.codeinsight.findEncryptionBlocksIdsByType
@@ -127,7 +130,7 @@ open class HILCompletionContributor : CompletionContributor(), DumbAware {
                                   result: CompletionResultSet) {
       // For now 'self' allowed only for provisioners inside resources
 
-      val resource = getProvisionerOrConnectionResource(variable) ?: return
+      val resource = getHclBlockForSelfContext(variable) ?: return
       val properties = TfModelHelper.getBlockProperties(resource)
       // TODO: Filter already defined or computed properties (?)
       // TODO: Add type filtration
@@ -175,7 +178,7 @@ open class HILCompletionContributor : CompletionContributor(), DumbAware {
                                   parameters: CompletionParameters,
                                   context: ProcessingContext,
                                   result: CompletionResultSet) {
-      val variables: List<String> = getLocalDefinedLocals(variable)
+      val variables: List<String> = getDefinedLocalsInModule(variable)
       for (v in variables) {
         result.addElement(create(v))
       }
@@ -270,7 +273,7 @@ open class HILCompletionContributor : CompletionContributor(), DumbAware {
       result.addAllElements(model.providerDefinedFunctions.map { createFunction(it) })
 
       result.addAllElements(GlobalScopes.map { createScope(it) })
-      if (getProvisionerOrConnectionResource(parent) != null) result.addElement(createScope("self"))
+      if (getHclBlockForSelfContext(parent) != null) result.addElement(createScope("self"))
 
       val host = parent.getHCLHost() ?: return
       val resourceOrDataSource = getContainingResourceOrDataSourceOrModule(host)

terraform/src/org/intellij/terraform/hil/inspection/HILMissingSelfInContextInspection.kt

@@ -1,4 +1,4 @@
-// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
 package org.intellij.terraform.hil.inspection
 
 import com.intellij.codeInspection.LocalInspectionTool
@@ -9,7 +9,11 @@ import com.intellij.openapi.progress.ProgressIndicatorProvider
 import com.intellij.psi.PsiElementVisitor
 import com.intellij.psi.PsiFile
 import org.intellij.terraform.hcl.HCLBundle
-import org.intellij.terraform.hil.psi.*
+import org.intellij.terraform.hcl.psi.getConnectionOfResource
+import org.intellij.terraform.hcl.psi.getProvisionerOfResource
+import org.intellij.terraform.hil.psi.ILElementVisitor
+import org.intellij.terraform.hil.psi.ILSelectExpression
+import org.intellij.terraform.hil.psi.ILVariable
 import org.intellij.terraform.hil.psi.impl.getHCLHost
 import org.intellij.terraform.isTerraformCompatiblePsiFile
 
@@ -34,8 +38,8 @@ class HILMissingSelfInContextInspection : LocalInspectionTool() {
       val parent = element.parent as? ILSelectExpression ?: return
       if (parent.from !== element) return
 
-      if (getProvisionerResource(host) != null) return
-      if (getConnectionResource(host) != null) return
+      if (getProvisionerOfResource(host) != null) return
+      if (getConnectionOfResource(host) != null) return
 
       holder.registerProblem(element, HCLBundle.message("hil.scope.not.available.in.context.inspection.illegal.self.use.message"), ProblemHighlightType.GENERIC_ERROR)
     }

terraform/src/org/intellij/terraform/hil/psi/ILScopeReferenceProvider.kt

@@ -1,4 +1,4 @@
-// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
 package org.intellij.terraform.hil.psi
 
 import com.intellij.psi.PsiElement
@@ -7,6 +7,9 @@ import com.intellij.psi.PsiReferenceProvider
 import com.intellij.util.ProcessingContext
 import org.intellij.terraform.hcl.psi.common.Identifier
 import org.intellij.terraform.hcl.psi.common.SelectExpression
+import org.intellij.terraform.hcl.psi.getDataSource
+import org.intellij.terraform.hcl.psi.getHclBlockForSelfContext
+import org.intellij.terraform.hcl.psi.getResource
 import org.intellij.terraform.hil.psi.impl.getHCLHost
 
 object ILScopeReferenceProvider : PsiReferenceProvider() {
@@ -26,7 +29,7 @@ object ILScopeReferenceProvider : PsiReferenceProvider() {
     when (element.name) {
       "self" -> {
         return arrayOf(HCLElementLazyReference(element, false) { _, _ ->
-          val resource = getProvisionerOrConnectionResource(this.element) ?: return@HCLElementLazyReference emptyList()
+          val resource = getHclBlockForSelfContext(this.element) ?: return@HCLElementLazyReference emptyList()
           listOf(resource)
         })
       }

terraform/src/org/intellij/terraform/hil/psi/ILSelectFromScopeReferenceProvider.kt

@@ -13,6 +13,7 @@ import org.intellij.terraform.config.model.getTerraformModule
 import org.intellij.terraform.hcl.psi.HCLElement
 import org.intellij.terraform.hcl.psi.common.Identifier
 import org.intellij.terraform.hcl.psi.common.SelectExpression
+import org.intellij.terraform.hcl.psi.getHclBlockForSelfContext
 import org.intellij.terraform.hil.codeinsight.AddVariableFix
 import org.intellij.terraform.hil.psi.impl.getHCLHost
 
@@ -68,7 +69,7 @@ object ILSelectFromScopeReferenceProvider : PsiReferenceProvider() {
   class SelfResourceReference(element: Identifier) : HCLElementLazyReferenceBase<Identifier>(element, false) {
     override fun resolve(incompleteCode: Boolean, includeFake: Boolean): List<HCLElement> {
       val name = this.element.name ?: return emptyList()
-      val resource = getProvisionerOrConnectionResource(this.element) ?: return emptyList()
+      val resource = getHclBlockForSelfContext(this.element) ?: return emptyList()
 
       val prop = resource.`object`?.findProperty(name)
       if (prop != null) return listOf(prop)

terraform/src/org/intellij/terraform/hil/psi/ResourceEachVariableReferenceProvider.kt

@@ -1,4 +1,4 @@
-// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
 package org.intellij.terraform.hil.psi
 
 import com.intellij.codeInsight.daemon.EmptyResolveMessageProvider
@@ -13,6 +13,7 @@ import org.intellij.terraform.hcl.psi.HCLElement
 import org.intellij.terraform.hcl.psi.common.BaseExpression
 import org.intellij.terraform.hcl.psi.common.Identifier
 import org.intellij.terraform.hcl.psi.common.SelectExpression
+import org.intellij.terraform.hcl.psi.getContainingResourceOrDataSourceOrModule
 import org.intellij.terraform.hil.psi.impl.getHCLHost
 
 object ResourceEachVariableReferenceProvider : PsiReferenceProvider() {