Merge PR #73 from realmarv/addIsExecutableFunctionToFileConventions

knocte · web-flow · commit a096b4772854 · 2023-08-08T22:12:38.000+08:00
New executableConvention fsx script that flags when an .fsx
file doesn't have the executable +x flag.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -169,6 +169,8 @@ jobs:
         run: dotnet fsi scripts/eofConvention.fsx
       - name: Check all .fsx scripts have shebang
         run: dotnet fsi scripts/shebangConvention.fsx
+      - name: Check all F# scripts have execute permission
+        run: dotnet fsi scripts/executableConvention.fsx
       - name: Check there are no mixed line-endings in any files
         run: dotnet fsi scripts/mixedLineEndings.fsx
       - name: Check there are no unpinned GitHubActions image versions
diff --git a/ReadMe.md b/ReadMe.md
@@ -6,6 +6,7 @@ This is a repository that contains several useful things that other `nblockchain
 - [Workflow guidelines](docs/WorkflowGuidelines.md).
 - Scripts that aid maintainability:
     * [Detection of .fsx scripts without shebang](scripts/shebangConvention.fsx).
+    * [Detection of .fsx files without +x attrib](scripts/executableConvention.fsx).
     * [F# scripts compilation](scripts/compileFSharpScripts.fsx).
     * [EOF without EOL detection](scripts/eofConvention.fsx).
     * [Mixed line-endings detection](scripts/mixedLineEndings.fsx).
@@ -23,6 +24,5 @@ This is a repository that contains several useful things that other `nblockchain
 All in all, this is mainly documentation, and some tooling to detect bad practices.
 
 More things to come:
-- Detect .fsx files without +x attrib.
 - Detect old versions of FSharpLint and fantomas/fantomless being used.
 - Detect old versions of .editorconfig or Directory.Build.props being used.
diff --git a/scripts/checkCommits1by1.fsx b/scripts/checkCommits1by1.fsx
diff --git a/scripts/compileFSharpScripts.fsx b/scripts/compileFSharpScripts.fsx
diff --git a/scripts/eofConvention.fsx b/scripts/eofConvention.fsx
@@ -3,6 +3,8 @@
 open System.IO
 open System
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Helpers.fs"
 #load "../src/FileConventions/Library.fs"
 
diff --git a/scripts/executableConvention.fsx b/scripts/executableConvention.fsx
@@ -0,0 +1,20 @@
+#!/usr/bin/env -S dotnet fsi
+
+open System
+open System.IO
+
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#load "../src/FileConventions/Library.fs"
+#load "../src/FileConventions/Helpers.fs"
+
+let rootDir = Path.Combine(__SOURCE_DIRECTORY__, "..") |> DirectoryInfo
+
+let invalidFiles =
+    Helpers.GetInvalidFiles
+        rootDir
+        "*.fsx"
+        (fun fileInfo -> not(FileConventions.IsExecutable fileInfo))
+
+Helpers.AssertNoInvalidFiles
+    invalidFiles
+    "The following files don't have execute permission:"
diff --git a/scripts/inconsistentVersionsInFSharpScripts.fsx b/scripts/inconsistentVersionsInFSharpScripts.fsx
@@ -3,6 +3,8 @@
 open System.IO
 open System.Linq
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 
diff --git a/scripts/inconsistentVersionsInGitHubCI.fsx b/scripts/inconsistentVersionsInGitHubCI.fsx
@@ -2,6 +2,8 @@
 
 open System.IO
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 
diff --git a/scripts/mixedLineEndings.fsx b/scripts/mixedLineEndings.fsx
@@ -3,6 +3,8 @@
 open System
 open System.IO
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 
diff --git a/scripts/nonVerboseFlagsInGitHubCIAndScripts.fsx b/scripts/nonVerboseFlagsInGitHubCIAndScripts.fsx
@@ -3,6 +3,8 @@
 open System
 open System.IO
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 
diff --git a/scripts/shebangConvention.fsx b/scripts/shebangConvention.fsx
@@ -3,6 +3,8 @@
 open System
 open System.IO
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 
diff --git a/scripts/unpinnedDotnetPackageVersions.fsx b/scripts/unpinnedDotnetPackageVersions.fsx
@@ -3,6 +3,8 @@
 open System
 open System.IO
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 
diff --git a/scripts/unpinnedDotnetToolInstallVersions.fsx b/scripts/unpinnedDotnetToolInstallVersions.fsx
@@ -3,6 +3,8 @@
 open System
 open System.IO
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 
diff --git a/scripts/unpinnedGitHubActionsImageVersions.fsx b/scripts/unpinnedGitHubActionsImageVersions.fsx
@@ -3,6 +3,8 @@
 open System
 open System.IO
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 
diff --git a/scripts/unpinnedNugetPackageReferenceVersions.fsx b/scripts/unpinnedNugetPackageReferenceVersions.fsx
@@ -3,6 +3,8 @@
 open System
 open System.IO
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 
diff --git a/scripts/wrapLatestCommitMsg.fsx b/scripts/wrapLatestCommitMsg.fsx
@@ -4,6 +4,8 @@ open System.IO
 open System
 open System.Text.RegularExpressions
 
+#r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+
 #load "../src/FileConventions/Library.fs"
 
 #r "nuget: Fsdk, Version=0.6.0--date20230214-0422.git-1ea6f62"
diff --git a/src/FileConventions.Test/DummyFiles/DummyExecutable.fsx b/src/FileConventions.Test/DummyFiles/DummyExecutable.fsx
diff --git a/src/FileConventions.Test/DummyFiles/DummyNotExecutable.fs b/src/FileConventions.Test/DummyFiles/DummyNotExecutable.fs
diff --git a/src/FileConventions.Test/FileConventions.Test.fs b/src/FileConventions.Test/FileConventions.Test.fs
@@ -5,6 +5,8 @@ open System.IO
 
 open NUnit.Framework
 open NUnit.Framework.Constraints
+open Fsdk
+open Fsdk.Process
 
 open FileConventions
 
@@ -549,3 +551,38 @@ let NonVerboseFlagsInGitHubCI6() =
         ))
 
     Assert.That(NonVerboseFlags fileInfo, Is.EqualTo false)
+
+
+[<Test>]
+let IsExecutableTest1() =
+    let filePath =
+        Path.Combine(__SOURCE_DIRECTORY__, "DummyFiles", "DummyExecutable.fsx")
+
+    Fsdk
+        .Process
+        .Execute(
+            {
+                Command = "chmod"
+                Arguments = sprintf "+x %s" filePath
+            },
+            Echo.All
+        )
+        .UnwrapDefault()
+    |> ignore<string>
+
+    let fileInfo = (FileInfo filePath)
+    Assert.That(IsExecutable fileInfo, Is.EqualTo true)
+
+
+[<Test>]
+let IsExecutableTest2() =
+    let fileInfo =
+        (FileInfo(
+            Path.Combine(
+                __SOURCE_DIRECTORY__,
+                "DummyFiles",
+                "DummyNotExecutable.fs"
+            )
+        ))
+
+    Assert.That(IsExecutable fileInfo, Is.EqualTo false)
diff --git a/src/FileConventions.Test/FileConventions.Test.fsproj b/src/FileConventions.Test/FileConventions.Test.fsproj
@@ -19,6 +19,7 @@
     <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
     <PackageReference Include="NUnit.Analyzers" Version="3.3.0" />
     <PackageReference Include="coverlet.collector" Version="3.1.2" />
+    <PackageReference Include="Fsdk" Version="0.6.0--date20230214-0422.git-1ea6f62" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/FileConventions/FileConventions.fsproj b/src/FileConventions/FileConventions.fsproj
@@ -10,4 +10,9 @@
     <Compile Include="Helpers.fs" />
   </ItemGroup>
 
+  <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" />
+  </ItemGroup>
+
 </Project>
diff --git a/src/FileConventions/Library.fs b/src/FileConventions/Library.fs
@@ -5,6 +5,9 @@ open System.IO
 open System.Linq
 open System.Text.RegularExpressions
 
+open Mono
+open Mono.Unix.Native
+
 let HasCorrectShebang(fileInfo: FileInfo) =
     let fileText = File.ReadLines fileInfo.FullName
 
@@ -383,3 +386,7 @@ let NonVerboseFlags(fileInfo: FileInfo) =
         |> Seq.length
 
     numInvalidFlags > 0
+
+let IsExecutable(fileInfo: FileInfo) =
+    let hasExecuteAccess = Syscall.access(fileInfo.FullName, AccessModes.X_OK)
+    hasExecuteAccess = 0
