✨ : add terraform blocs support

gaia-app · Apr 21, 2021 · d478ebb · d478ebb
1 parent 346497f
commit d478ebb
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 2 deletions.
diff --git a/src/main/antlr4/io/gaia_app/hcl/antlr/hcl.g4 b/src/main/antlr4/io/gaia_app/hcl/antlr/hcl.g4
@@ -6,6 +6,7 @@ file
 
 directive
   : providerDirective
+  | terraformDirective
   | resourceDirective
   | variableDirective
   | outputDirective
@@ -15,6 +16,10 @@ providerDirective
   : 'provider' STRING object
   ;
 
+terraformDirective
+  : 'terraform' object
+  ;
+
 resourceDirective
   : 'resource' STRING STRING object
   ;
@@ -64,7 +69,10 @@ object
   | '{' field+ '}'
   ;
 
-field: IDENTIFIER '=' expression;
+field
+  : IDENTIFIER '=' expression
+  | IDENTIFIER object // for dynamic blocks
+  ;
 
 variableDescription
   : 'description' '=' STRING

diff --git a/src/main/java/io/gaia_app/hcl/HclVisitor.kt b/src/main/java/io/gaia_app/hcl/HclVisitor.kt
@@ -1,8 +1,10 @@
 package io.gaia_app.hcl
 
+import io.gaia_app.hcl.antlr.hclParser
 import io.gaia_app.modules.bo.Output
 import io.gaia_app.modules.bo.Variable
 import java.util.*
+import kotlin.NoSuchElementException
 
 class HclVisitor : io.gaia_app.hcl.antlr.hclBaseVisitor<Unit>() {
 
@@ -72,4 +74,19 @@ class HclVisitor : io.gaia_app.hcl.antlr.hclBaseVisitor<Unit>() {
             provider = resourceProvider
         }
     }
+
+    override fun visitTerraformDirective(ctx: hclParser.TerraformDirectiveContext) {
+        try {
+            // find required providers field
+            val requiredProviders = ctx.`object`().field()
+                .first { it.IDENTIFIER().text == "required_providers" }
+            // find first required provider that should not be ignored
+            val firstValidProvider = requiredProviders.`object`().field()
+                .first { ! IGNORED_PROVIDERS.contains(it.IDENTIFIER().text) }
+            provider = firstValidProvider.IDENTIFIER().text
+        }
+        catch (_: NoSuchElementException){
+            // NoSuchElementException is raised when no provider is found in the terraform directive
+        }
+    }
 }
diff --git a/src/test/java/io/gaia_app/hcl/HCLParserTest.kt b/src/test/java/io/gaia_app/hcl/HCLParserTest.kt
@@ -132,7 +132,7 @@ class HCLParserTest {
 
         @Test
         @Throws(IOException::class)
-        fun parsing_provider_shouldIgnoreDummyProviders() {
+        fun parsing_provider_fromResources_shouldIgnoreDummyProviders() {
             // given
             val fileContent = """
                 resource "random_id" "id" {
@@ -149,6 +149,64 @@ class HCLParserTest {
             assertThat(provider).isEqualTo("google")
         }
 
+        @Test
+        @Throws(IOException::class)
+        fun parsing_provider_shouldAnalyseRequiredProvidersBlock() {
+            // given
+            val fileContent = """
+                terraform {
+                  required_version = ">= 0.14"
+                  required_providers {
+                    random = ">= 3.1.0"
+                    google = ">= 3.64.0"
+                  }
+                }
+            """.trimIndent()
+
+            // when
+            val provider: String = hclParser.parseProvider(fileContent)
+
+            // then
+            assertThat(provider).isEqualTo("google")
+        }
+
+        @Test
+        @Throws(IOException::class)
+        fun parsing_provider_shouldAnalyseRequiredProvidersBlock_withoutRelevantProvider() {
+            // given
+            val fileContent = """
+                terraform {
+                  required_version = ">= 0.14"
+                  required_providers {
+                    random = ">= 3.1.0"
+                  }
+                }
+            """.trimIndent()
+
+            // when
+            val provider: String = hclParser.parseProvider(fileContent)
+
+            // then
+            assertThat(provider).isEqualTo("unknown")
+        }
+
+        @Test
+        @Throws(IOException::class)
+        fun parsing_provider_shouldAnalyseRequiredProvidersBlock_withoutRequiredProviders() {
+            // given
+            val fileContent = """
+                terraform {
+                  required_version = ">= 0.14"
+                }
+            """.trimIndent()
+
+            // when
+            val provider: String = hclParser.parseProvider(fileContent)
+
+            // then
+            assertThat(provider).isEqualTo("unknown")
+        }
+
         @Test
         fun dummyProvidersShouldBeIgnored() {
             assertThat(hclParser.parseProvider("""provider "null" {} """)).isEqualTo("unknown")