Merge pull request #300 from smoothdeveloper/fake5

migrate to FAKE 5

Author: smoothdeveloper

build.cmd

@@ -10,8 +10,4 @@ if errorlevel 1 (
   exit /b %errorlevel%
 )
 
-IF NOT EXIST build.fsx (
-  .paket\paket.exe update
-  packages\build\FAKE\tools\FAKE.exe init.fsx
-)
-packages\build\FAKE\tools\FAKE.exe build.fsx %*
+packages\build\FAKE\tools\FAKE.exe --removeLegacyFakeWarning build.fsx %*

build.fsx

@@ -2,14 +2,18 @@
 // FAKE build script 
 // --------------------------------------------------------------------------------------
 
-#I @"packages/build/FAKE/tools"
 #r @"packages/build/FAKE/tools/FakeLib.dll"
+#load "tools/fakexunithelper.fsx" // helper for xunit 1 is gone, work around by having our own copy for now
 
 open System
 open System.IO
-open Fake 
-open Fake.AssemblyInfoFile
+open Fake.Core
 open Fake.Git
+open Fake.IO
+open Fake.IO.FileSystemOperators
+open Fake.IO.Globbing
+open Fake.IO.Globbing.Operators
+open Fake.DotNet
 
 Environment.CurrentDirectory <- __SOURCE_DIRECTORY__
 
@@ -31,7 +35,7 @@ let gitName = "FSharp.Data.SqlClient"
 // Read release notes & version info from RELEASE_NOTES.md
 let release = 
     File.ReadLines "RELEASE_NOTES.md" 
-    |> ReleaseNotesHelper.parseReleaseNotes
+    |> Fake.Core.ReleaseNotes.parse
 
 let version = release.AssemblyVersion
 let releaseNotes = release.Notes |> String.concat "\n"
@@ -40,33 +44,33 @@ let testDir = "bin"
 // --------------------------------------------------------------------------------------
 // Generate assembly info files with the right version & up-to-date information
 
-Target "AssemblyInfo" (fun _ ->
+Target.create "AssemblyInfo" (fun _ ->
     [ "src/SqlClient/AssemblyInfo.fs", "SqlClient", project, summary ]
     |> Seq.iter (fun (fileName, title, project, summary) ->
-        CreateFSharpAssemblyInfo fileName
-           [ Attribute.Title title
-             Attribute.Product project
-             Attribute.Description summary
-             Attribute.Version version
-             Attribute.FileVersion version
-             Attribute.InternalsVisibleTo "SqlClient.Tests" ] )
+        AssemblyInfoFile.createFSharp fileName
+           [ AssemblyInfo.Title              title
+             AssemblyInfo.Product            project
+             AssemblyInfo.Description        summary
+             AssemblyInfo.Version            version
+             AssemblyInfo.FileVersion        version
+             AssemblyInfo.InternalsVisibleTo "SqlClient.Tests" ] )
 )
 
-Target "Clean" (fun _ ->
-    CleanDirs ["bin"; "temp"]
+Target.create "Clean" (fun _ ->
+    Shell.cleanDirs ["bin"; "temp"]
 )
 
-Target "CleanDocs" (fun _ ->
-    CleanDirs ["docs/output"]
+Target.create "CleanDocs" (fun _ ->
+    Shell.cleanDirs ["docs/output"]
 )
 
 // --------------------------------------------------------------------------------------
 // Build library (builds Visual Studio solution, which builds multiple versions
 // of the runtime library & desktop + Silverlight version of design time library)
 
-Target "Build" (fun _ ->
+Target.create "Build" (fun _ ->
     files (["SqlClient.sln"])
-    |> MSBuildRelease "" "Rebuild"
+    |> MSBuild.runRelease id "" "Rebuild"
     |> ignore
 )
 
@@ -80,7 +84,7 @@ open System.Data.SqlClient
 open System.Configuration
 open System.IO.Compression
 
-Target "DeployTestDB" (fun() ->
+Target.create "DeployTestDB" (fun _ ->
     let testsSourceRoot = Path.GetFullPath(@"src\SqlClient.Tests")
     let map = ExeConfigurationFileMap()
     map.ExeConfigFilename <- testsSourceRoot @@ "app.config"
@@ -135,34 +139,35 @@ Target "DeployTestDB" (fun() ->
             cmd.ExecuteNonQuery() |> ignore
 )
 
-Target "BuildTests" (fun _ ->
+Target.create "BuildTests" (fun _ ->
     files ["Tests.sln"]
-    |> MSBuildReleaseExt "" ([]) "Rebuild"
+    |> MSBuild.runReleaseExt id "" ([]) "Rebuild"
     |> ignore
 )
 
 // --------------------------------------------------------------------------------------
 // Run the unit tests 
-Target "RunTests" (fun _ ->
+Target.create "RunTests" (fun _ ->
     !! (testDir + "/*.Tests.dll")
-        |> xUnit (fun p -> 
+        |> Fake.XUnitHelper.xUnit (fun p -> 
             {p with 
-                ShadowCopy = false;
-                HtmlOutput = true;
-                XmlOutput = true;
-                OutputDir = testDir})
+                ShadowCopy = false
+                HtmlOutput = true
+                XmlOutput = true
+                WorkingDir = testDir
+                })
 )
 
 // --------------------------------------------------------------------------------------
 // Build a NuGet package
 
-Target "NuGet" (fun _ ->
+Target.create "NuGet" (fun _ ->
 
     // Format the description to fit on a single line (remove \r\n and double-spaces)
     let description = description.Replace("\r", "").Replace("\n", "").Replace("  ", " ")
     let nugetPath = "packages/build/NuGet.CommandLine/tools/NuGet.exe"
-
-    NuGet (fun p -> 
+    
+    Fake.DotNet.NuGet.NuGet.NuGet (fun p -> 
         { p with   
             Authors = authors
             Project = project
@@ -173,35 +178,37 @@ Target "NuGet" (fun _ ->
             Tags = tags
             OutputPath = "nuget"
             ToolPath = nugetPath
-            AccessKey = getBuildParamOrDefault "nugetkey" ""
-            Publish = hasBuildParam "nugetkey"
+            AccessKey = Fake.Core.Environment.environVarOrDefault "nugetkey" ""
+            Publish = Fake.Core.Environment.hasEnvironVar "nugetkey"
             Dependencies = [] })
         "nuget/SqlClient.nuspec"
 )
 
 // --------------------------------------------------------------------------------------
 // Generate the documentation
 
-Target "GenerateDocs" (fun _ ->
-    executeFSIWithArgs "docs/tools" "generate.fsx" ["--define:RELEASE"] [] |> ignore
+Target.create "GenerateDocs" (fun _ ->
+    Fake.FSIHelper.executeFSIWithArgs "docs/tools" "generate.fsx" ["--define:RELEASE"] [] |> ignore
 )
 
-Target "ReleaseDocs" (fun _ ->
+Target.create "ReleaseDocs" (fun _ ->
     Repository.clone "" (gitHome + "/" + gitName + ".git") "temp/gh-pages"
     Branches.checkoutBranch "temp/gh-pages" "gh-pages"
-    CopyRecursive "docs/output" "temp/gh-pages" true |> printfn "%A"
+    Shell.copyRecursive "docs/output" "temp/gh-pages" true |> printfn "%A"
     CommandHelper.runSimpleGitCommand "temp/gh-pages" "add ." |> printfn "%s"
     let cmd = sprintf """commit -a -m "Update generated documentation for version %s""" release.NugetVersion
     CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
     Branches.push "temp/gh-pages"
 )
 
-Target "Release" DoNothing
+Target.create "Release" Target.DoNothing
 
 // --------------------------------------------------------------------------------------
 // Run all targets by default. Invoke 'build <Target>' to override
 
-Target "All" DoNothing
+Target.create "All" Target.DoNothing
+
+open Fake.Core.TargetOperators // for ==>
 
 "Clean"
   ==> "AssemblyInfo"
@@ -220,5 +227,5 @@ Target "All" DoNothing
   ==> "GenerateDocs"
   ==> "ReleaseDocs"
 
-RunTargetOrDefault "All"
+Target.runOrDefault "All"
 

build.sh

@@ -31,7 +31,5 @@ fi
 
 run .paket/paket.exe restore
 
-[ ! -e build.fsx ] && run .paket/paket.exe update
-[ ! -e build.fsx ] && run packages/build/FAKE/tools/FAKE.exe init.fsx
-run packages/build/FAKE/tools/FAKE.exe "$@" $FSIARGS build.fsx
+run packages/build/FAKE/tools/FAKE.exe --removeLegacyFakeWarning "$@" $FSIARGS build.fsx
 

paket.dependencies

@@ -15,7 +15,7 @@ group Build
 	redirects: force
 
 	nuget NuGet.CommandLine
-	nuget FAKE = 4.1.2
+	nuget FAKE = 5.0.0-rc014.167
 
 group Test
 	source https://www.nuget.org/api/v2/

paket.lock

@@ -102,7 +102,7 @@ REDIRECTS: FORCE
 RESTRICTION: >= net40
 NUGET
   remote: https://www.nuget.org/api/v2
-    FAKE (4.1.2)
+    FAKE (5.0.0-rc014.167)
     NuGet.CommandLine (4.6.2)
 
 GROUP Samples

tools/fakexunithelper.fsx

@@ -0,0 +1,140 @@
+// taken from https://github.com/fsharp/FAKE/blob/4.64.13/src/app/FakeLib/UnitTest/XUnit/XUnitHelper.fs
+// this is not in FAKE 5
+open Fake
+#nowarn "44"
+
+open System
+open System.IO
+open System.Text
+
+/// DEPRECATED.
+/// Option which allows to specify if an xUnit error should break the build.
+[<Obsolete("This type alias will be removed in a future version.")>]
+type XUnitErrorLevel = TestRunnerErrorLevel // a type alias to keep backwards compatibility
+
+/// DEPRECATED.
+/// The xUnit parameter type
+[<Obsolete("This type will be removed in a future version. See Fake.Testing.XUnit.XUnitParams")>]
+[<CLIMutable>]
+type XUnitParams =
+    { /// The path to the xunit.console.clr4.exe - FAKE will scan all subfolders to find it automatically.
+      ToolPath : string
+      /// The file name of the config file (optional).
+      ConfigFile : string
+      /// If set to true a HTML output file will be generated.
+      HtmlOutput : bool
+      /// If set to true a HTML output file will be generated in NUnit format.
+      NUnitXmlOutput : bool
+      /// If set to true XML output will be generated.
+      XmlOutput : bool
+      /// The working directory (optional).
+      WorkingDir : string
+      /// If set to true xUnit will run in ShadowCopy mode.
+      ShadowCopy : bool
+      /// If set to true xUnit will generate verbose output.
+      Verbose : bool
+      /// If the timeout is reached the xUnit task will be killed. Default is 5 minutes.
+      TimeOut : TimeSpan
+      /// The output directory. It's the current directoy if nothing else is specified.
+      OutputDir : string
+      /// Test runner error level. Option which allows to specify if an xUnit error should break the build.
+      ErrorLevel : XUnitErrorLevel
+      /// Include named traits with comma separated values
+      IncludeTraits : (string * string) option
+      /// Exclude named traits with comma separated values
+      ExcludeTraits : (string * string) option }
+
+/// DEPRECATED.
+/// The xUnit default parameters
+[<Obsolete("This value will be removed in a future version.")>]
+let emptyTrait : (string * string) option = None
+
+/// DEPRECATED.
+[<Obsolete("This value will be removed in a future version. See Fake.Testing.XUnit.XUnitDefaults")>]
+let XUnitDefaults =
+    { ToolPath = findToolInSubPath "xunit.console.clr4.exe" (currentDirectory @@ "tools" @@ "xUnit")
+      ConfigFile = null
+      HtmlOutput = false
+      NUnitXmlOutput = false
+      WorkingDir = null
+      ShadowCopy = true
+      Verbose = true
+      XmlOutput = false
+      TimeOut = TimeSpan.FromMinutes 5.
+      OutputDir = null
+      ErrorLevel = Error
+      IncludeTraits = emptyTrait
+      ExcludeTraits = emptyTrait }
+
+/// DEPRECATED.
+/// Builds the command line arguments from the given parameter record and the given assemblies.
+/// [omit]
+[<Obsolete("This function will be removed in a future version.")>]
+let buildXUnitArgs parameters assembly =
+    let fi = fileInfo assembly
+    let name = fi.Name
+
+    let dir =
+        if isNullOrEmpty parameters.OutputDir then String.Empty
+        else Path.GetFullPath parameters.OutputDir
+
+    let traits includeExclude (name, values : string) =
+        values.Split([| ',' |], System.StringSplitOptions.RemoveEmptyEntries)
+        |> Seq.collect (fun value ->
+               [| includeExclude
+                  sprintf "\"%s=%s\"" name value |])
+        |> String.concat " "
+
+    new StringBuilder()
+    |> appendFileNamesIfNotNull [ assembly ]
+    |> appendIfFalse parameters.ShadowCopy "/noshadow"
+    |> appendIfTrue (buildServer = TeamCity) "/teamcity"
+    |> appendIfFalse parameters.Verbose "/silent"
+    |> appendIfTrue parameters.XmlOutput (sprintf "/xml\" \"%s" (dir @@ (name + ".xml")))
+    |> appendIfTrue parameters.HtmlOutput (sprintf "/html\" \"%s" (dir @@ (name + ".html")))
+    |> appendIfTrue parameters.NUnitXmlOutput (sprintf "/nunit\" \"%s" (dir @@ (name + ".xml")))
+    |> appendIfSome parameters.IncludeTraits (traits "/trait")
+    |> appendIfSome parameters.ExcludeTraits (traits "/-trait")
+    |> toText
+
+/// DEPRECATED. See [`Fake.Testing.XUnit.xUnit`](fake-testing-xunit.html).
+///
+/// Runs xUnit unit tests in the given assemblies via the given xUnit runner.
+/// Will fail if the runner terminates with non-zero exit code for any of the assemblies.
+/// Offending assemblies will be listed in the error message.
+///
+/// The xUnit runner terminates with a non-zero exit code if any of the tests
+/// in the given assembly fail.
+/// ## Parameters
+///
+///  - `setParams` - Function used to manipulate the default XUnitParams value.
+///  - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests.
+///
+/// ## Sample usage
+///
+///     Target "Test" (fun _ ->
+///         !! (testDir + @"\xUnit.Test.*.dll")
+///           |> xUnit (fun p -> {p with OutputDir = testDir })
+///     )
+[<Obsolete("Deprecated. This task will be removed in a future version. Open Fake.Testing to use the latest xUnit task.")>]
+let xUnit setParams assemblies =
+    let details = separated ", " assemblies
+    use __ = traceStartTaskUsing "xUnit" details
+    let parameters = setParams XUnitDefaults
+
+    let runTests assembly =
+        let args = buildXUnitArgs parameters assembly
+        0 = ExecProcess (fun info ->
+                info.FileName <- parameters.ToolPath
+                info.WorkingDirectory <- parameters.WorkingDir
+                info.Arguments <- args) parameters.TimeOut
+
+    let failedTests =
+        [ for asm in List.ofSeq assemblies do
+                if runTests asm |> not then yield asm ]
+
+    if not (List.isEmpty failedTests) then
+        sprintf "xUnit failed for the following assemblies: %s" (separated ", " failedTests)
+        |> match parameters.ErrorLevel with
+            | Error | FailOnFirstError -> failwith
+            | DontFailBuild -> traceImportant