FileConventions: implement the function

Implement DetectNotUsingKebabCaseInGitHubCIJobs function.
nblockchain · Aug 8, 2023 · 50de519 · 50de519
1 parent 674d4f7
commit 50de519
Show file tree

Hide file tree

Showing 14 changed files with 61 additions and 11 deletions.
diff --git a/scripts/eofConvention.fsx b/scripts/eofConvention.fsx
@@ -4,7 +4,7 @@ open System.IO
 open System
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Helpers.fs"
 #load "../src/FileConventions/Library.fs"
 

diff --git a/scripts/executableConvention.fsx b/scripts/executableConvention.fsx
@@ -4,6 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/inconsistentVersionsInFSharpScripts.fsx b/scripts/inconsistentVersionsInFSharpScripts.fsx
@@ -4,7 +4,7 @@ open System.IO
 open System.Linq
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/inconsistentVersionsInGitHubCI.fsx b/scripts/inconsistentVersionsInGitHubCI.fsx
@@ -3,7 +3,7 @@
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/mixedLineEndings.fsx b/scripts/mixedLineEndings.fsx
@@ -4,7 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/nonVerboseFlagsInGitHubCIAndScripts.fsx b/scripts/nonVerboseFlagsInGitHubCIAndScripts.fsx
@@ -4,7 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/shebangConvention.fsx b/scripts/shebangConvention.fsx
@@ -4,7 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/unpinnedDotnetPackageVersions.fsx b/scripts/unpinnedDotnetPackageVersions.fsx
@@ -4,7 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/unpinnedDotnetToolInstallVersions.fsx b/scripts/unpinnedDotnetToolInstallVersions.fsx
@@ -4,7 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/unpinnedGitHubActionsImageVersions.fsx b/scripts/unpinnedGitHubActionsImageVersions.fsx
@@ -4,7 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/unpinnedNugetPackageReferenceVersions.fsx b/scripts/unpinnedNugetPackageReferenceVersions.fsx
@@ -4,7 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
-
+#r "nuget: YamlDotNet, Version=13.0.2"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/wrapLatestCommitMsg.fsx b/scripts/wrapLatestCommitMsg.fsx
@@ -5,6 +5,7 @@ open System
 open System.Text.RegularExpressions
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: YamlDotNet, Version=13.0.2"
 
 #load "../src/FileConventions/Library.fs"
 

diff --git a/src/FileConventions/FileConventions.fsproj b/src/FileConventions/FileConventions.fsproj
@@ -13,6 +13,7 @@
   <ItemGroup>
     <PackageReference Include="Mono.Posix" Version="7.1.0-final.1.21458.1" />
     <PackageReference Include="Mono.Unix" Version="7.1.0-final.1.21458.1" />
+    <PackageReference Include="YamlDotNet" Version="13.0.2" />
   </ItemGroup>
 
 </Project>
diff --git a/src/FileConventions/Library.fs b/src/FileConventions/Library.fs
@@ -7,6 +7,8 @@ open System.Text.RegularExpressions
 
 open Mono
 open Mono.Unix.Native
+open YamlDotNet
+open YamlDotNet.RepresentationModel
 
 let HasCorrectShebang(fileInfo: FileInfo) =
     let fileText = File.ReadLines fileInfo.FullName
@@ -398,4 +400,49 @@ let DetectNotUsingSnakeCaseInScriptName(fileInfo: FileInfo) =
 
 let DetectNotUsingKebabCaseInGitHubCIJobs(fileInfo: FileInfo) =
     assert (fileInfo.FullName.EndsWith ".yml")
-    false
+
+    let read yaml =
+        use reader = new StringReader(yaml)
+        let stream = YamlStream()
+        stream.Load(reader)
+        stream.Documents
+
+    let doc = read(File.ReadAllText fileInfo.FullName)
+
+    let ymlNode = doc.[0].RootNode
+
+    // Borrowed from https://stackoverflow.com/questions/46697298/whats-the-best-way-to-parse-yaml-in-f-on-net-core
+    let getMapping(ymlNode: YamlNode) =
+        let node = ymlNode :?> YamlMappingNode
+
+        let mapping =
+            node.Children
+            |> Seq.map(fun kvp ->
+                let keyNode = kvp.Key :?> YamlScalarNode
+                keyNode.Value, kvp.Value
+            )
+            |> Map.ofSeq
+
+        mapping
+
+    let jobNames =
+        match ymlNode.NodeType with
+        | YamlNodeType.Mapping ->
+            let mapping = getMapping ymlNode
+            let maybeJobs = mapping.TryFind "jobs"
+
+            match maybeJobs with
+            | Some jobs ->
+                let mapping = getMapping jobs
+                (mapping |> Map.toSeq |> Seq.map fst)
+            | None -> Seq.empty
+        | _ -> Seq.empty
+
+    jobNames
+    |> Seq.map(fun jobName ->
+        let isKebabCase =
+            jobName.ToLower() = jobName && not(jobName.Contains("_"))
+
+        isKebabCase
+    )
+    |> Seq.contains false