FileComventions(Test),scripts: acknowledge .env

Take .env file into account in
inconsistentVersionsInGitHubCI.fsx script when searching for
vars referenced in Github workflow files, when .env file is
present in the repository root. This is needed because
workflows in pulumi-deploy now load vars from .env file.

Author: webwarrior-ws

scripts/inconsistentVersionsInGitHubCI.fsx

@@ -33,7 +33,22 @@ let targetDir =
         |> fst
 
 let inconsistentVersionsInGitHubCI =
-    FileConventions.DetectInconsistentVersionsInGitHubCI targetDir
+    let repositoryRootDir = targetDir.Parent.Parent
+    let globalEnv =
+        let dotEnvFile = Path.Join(repositoryRootDir.FullName, ".env") |> FileInfo
+        if dotEnvFile.Exists then
+            let lines = File.ReadAllLines dotEnvFile.FullName
+            lines
+            |> Seq.filter (fun line -> not (System.String.IsNullOrWhiteSpace line || line.StartsWith '#'))
+            |> Seq.map 
+                (fun line -> 
+                    let [| key; value |] = line.Split('=', count = 2)
+                    key.Trim(), value.Trim())
+            |> Map.ofSeq
+        else
+            Map.empty
+
+    FileConventions.DetectInconsistentVersionsInGitHubCI targetDir globalEnv
 
 if inconsistentVersionsInGitHubCI then
     failwith

src/FileConventions.Test/FileConventions.Test.fs

@@ -289,7 +289,7 @@ let DetectInconsistentVersionsInGitHubCIWorkflow1() =
         ))
 
     Assert.That(
-        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo,
+        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo Map.empty,
         Is.EqualTo false
     )
 
@@ -307,7 +307,7 @@ let DetectInconsistentVersionsInGitHubCIWorkflow2() =
         ))
 
     Assert.That(
-        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo,
+        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo Map.empty,
         Is.EqualTo true
     )
 
@@ -325,7 +325,7 @@ let DetectInconsistentVersionsInGitHubCIWorkflow3() =
         ))
 
     Assert.That(
-        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo,
+        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo Map.empty,
         Is.EqualTo true
     )
 
@@ -343,7 +343,7 @@ let DetectInconsistentVersionsInGitHubCIWorkflow4() =
         ))
 
     Assert.That(
-        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo,
+        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo Map.empty,
         Is.EqualTo false
     )
 
@@ -370,7 +370,7 @@ let DetectInconsistentVersionsInGitHubCIWorkflow5() =
         })
 
     Assert.That(
-        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo,
+        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo Map.empty,
         Is.EqualTo true
     )
 
@@ -388,7 +388,7 @@ let DetectInconsistentVersionsInGitHubCIWorkflow6() =
         ))
 
     Assert.That(
-        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo,
+        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo Map.empty,
         Is.EqualTo true
     )
 
@@ -406,7 +406,7 @@ let DetectInconsistentVersionsInGitHubCIWorkflow7() =
         ))
 
     Assert.That(
-        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo,
+        DetectInconsistentVersionsInGitHubCIWorkflow fileInfo Map.empty,
         Is.EqualTo true
     )
 
@@ -418,7 +418,7 @@ let DetectInconsistentVersionsInGitHubCI1() =
             Path.Combine(dummyFilesDirectory.FullName, "DummyWorkflows")
         )
 
-    Assert.That(DetectInconsistentVersionsInGitHubCI fileInfo, Is.EqualTo true)
+    Assert.That(DetectInconsistentVersionsInGitHubCI fileInfo Map.empty, Is.EqualTo true)
 
 [<Test>]
 let DetectInconsistentVersionsInGitHubCI2() =
@@ -427,7 +427,7 @@ let DetectInconsistentVersionsInGitHubCI2() =
             Path.Combine(dummyFilesDirectory.FullName, "DummyWorkflowsWithEnv")
         )
 
-    Assert.That(DetectInconsistentVersionsInGitHubCI fileInfo, Is.EqualTo true)
+    Assert.That(DetectInconsistentVersionsInGitHubCI fileInfo Map.empty, Is.EqualTo true)
 
 [<Test>]
 let DetectInconsistentVersionsInGitHubCI3() =
@@ -439,7 +439,7 @@ let DetectInconsistentVersionsInGitHubCI3() =
             )
         )
 
-    Assert.That(DetectInconsistentVersionsInGitHubCI fileInfo, Is.EqualTo true)
+    Assert.That(DetectInconsistentVersionsInGitHubCI fileInfo Map.empty, Is.EqualTo true)
 
 [<Test>]
 let DetectInconsistentVersionsInNugetRefsInFSharpScripts1() =

src/FileConventions/Library.fs

@@ -362,6 +362,7 @@ let private GetVersionsMapFromFiles
 let private DetectInconsistentVersionsInYamlFiles
     (fileInfos: seq<FileInfo>)
     (extractVersionsFunction: YamlNode -> seq<string * string>)
+    (globalEnv: Map<string, string>)
     =
     let envVarRegex =
         Regex(@"\s*\$\{\{\s*([^\s\}]+)\s*\}\}\s*", RegexOptions.Compiled)
@@ -382,19 +383,25 @@ let private DetectInconsistentVersionsInYamlFiles
                 let matches =
                     Seq.collect extractVersionsFunction yamlDoc.AllNodes
 
+                let yamlDict = yamlDoc :?> YamlMappingNode
+                let localEnv = 
+                    match yamlDict.Children.TryGetValue "env" with
+                    | true, (:? YamlMappingNode as node) -> node
+                    | _ -> YamlMappingNode()
+
+                let envDict =
+                    localEnv.Children
+                    |> Seq.fold
+                        (fun acc pair -> acc |> Map.add (pair.Key :?> YamlScalarNode).Value (pair.Value:?> YamlScalarNode).Value)
+                        globalEnv
+                
                 matches
                 |> Seq.fold
                     (fun acc (key, value) ->
                         let actualValue =
                             let variableRegexMatch = envVarRegex.Match value
 
                             if variableRegexMatch.Success then
-                                let yamlDict = yamlDoc :?> YamlMappingNode
-
-                                let envDict =
-                                    yamlDict.Children.["env"]
-                                    :?> YamlMappingNode
-
                                 let referenceString =
                                     variableRegexMatch.Groups.[1].Value
 
@@ -404,10 +411,9 @@ let private DetectInconsistentVersionsInYamlFiles
                                     else
                                         referenceString
 
-                                match envDict.Children.TryGetValue envVarName
-                                    with
+                                match envDict.TryGetValue envVarName with
                                 | true, envVarValue ->
-                                    (envVarValue :?> YamlScalarNode).Value
+                                    envVarValue
                                 | false, _ ->
                                     failwithf "env. var %s not found" envVarName
                             else
@@ -427,7 +433,7 @@ let private DetectInconsistentVersionsInYamlFiles
     |> Seq.map(fun item -> Seq.length item.Value > 1)
     |> Seq.contains true
 
-let DetectInconsistentVersionsInGitHubCIWorkflow(fileInfos: seq<FileInfo>) =
+let DetectInconsistentVersionsInGitHubCIWorkflow (fileInfos: seq<FileInfo>) (globalEnv: Map<string, string>) =
     fileInfos
     |> Seq.iter(fun fileInfo -> assert (fileInfo.FullName.EndsWith ".yml"))
 
@@ -463,15 +469,15 @@ let DetectInconsistentVersionsInGitHubCIWorkflow(fileInfos: seq<FileInfo>) =
             )
         | _ -> Seq.empty
 
-    DetectInconsistentVersionsInYamlFiles fileInfos extractVersions
+    DetectInconsistentVersionsInYamlFiles fileInfos extractVersions globalEnv
 
-let DetectInconsistentVersionsInGitHubCI(dir: DirectoryInfo) =
+let DetectInconsistentVersionsInGitHubCI (dir: DirectoryInfo) (globalEnv: Map<string, string>) =
     let ymlFiles = dir.GetFiles("*.yml", SearchOption.AllDirectories)
 
     if Seq.isEmpty ymlFiles then
         false
     else
-        DetectInconsistentVersionsInGitHubCIWorkflow ymlFiles
+        DetectInconsistentVersionsInGitHubCIWorkflow ymlFiles globalEnv
 
 let GetVersionsMapForNugetRefsInFSharpScripts(fileInfos: seq<FileInfo>) =
     fileInfos