Merge pull request #170 from rabbitmq/rabbitmq-dotnet-client-169

move code generation, build and test to FAKE

Author: michaelklishin

.gitignore

@@ -10,6 +10,14 @@ gensrc/
 docs/pyle.log
 docs/pyle.pid
 docs/api-guide.pdf
+.DS_Store
+TestResults.xml
+TestResult.xml
+/packages
+/.fake
+.paket/paket.exe
+/NuGet
+rabbit-mock.snk
 
 #################
 ## Visual Studio
@@ -93,7 +101,6 @@ projects/client/Unit*/TestResult.xml
 
 # Development scripts
 
-*.fsx
 *.pcap
 
 # Vim

.paket/paket.bootstrapper.exe

@@ -12,24 +12,28 @@ It is possible to use [Visual Studio Community edition](https://www.visualstudio
 
 ## Building
 
-### Copy `Local.props.example` and Edit
+On Windows run:
 
-First copy `Local.props.example` to `Local.props` and edit it if needed, specifying whether
-you intend to build the client on Mono and what .NET version should be targeted.
+    build.bat
 
-### Build
+On osx/linux run:
 
-Then, build in Visual Studio or build from the command line. To do the latter,
-simply run
+    build.sh
 
-    msbuild.exe
+This will complete the code AMQP spec generation and build all projects. After this open the solution in Visual Studio.
 
 
 ## Running Tests
 
 Tests can be run from Visual Studio using [NUnit Test Adapter](https://visualstudiogallery.msdn.microsoft.com/6ab922d0-21c0-4f06-ab5f-4ecd1fe7175d).
 Note that it may take some time for the adapter to discover tests in the assemblies.
 
-Running the tests from the command line is also straightforward: use
+Running the tests from the command line is also straightforward you don't need to build first to do this: use
 
-    msbuild.exe /t:RunUnitTests projects/client/Unit/RabbitMQ.Client.Unit.csproj
+On Windows run:
+
+    run-test.bat
+
+On osx/linux run:
+
+    run-test.sh

Local.props.example

@@ -0,0 +1,9 @@
+<Properties StartupItem="projects/client/Apigen/RabbitMQ.Client.Apigen.csproj">
+  <MonoDevelop.Ide.ItemProperties.projects.client.RabbitMQ.Client.Apigen PreferredExecutionTarget="MonoDevelop.Default" />
+  <MonoDevelop.Ide.Workbench />
+  <MonoDevelop.Ide.Workspace ActiveConfiguration="Debug" />
+  <MonoDevelop.Ide.DebuggingService.Breakpoints>
+    <BreakpointStore />
+  </MonoDevelop.Ide.DebuggingService.Breakpoints>
+  <MonoDevelop.Ide.DebuggingService.PinnedWatches />
+</Properties>

RUNNING_TESTS.md

@@ -29,15 +29,10 @@ install:
       $env:RABBITMQ_RABBITMQCTL_PATH = "$path\rabbitmq_server-$version\sbin\rabbitmqctl.bat"
 
 before_build:
-  - copy "appveyor.props.in" "Local.props"
 
-build:
-  parallel: false
-  project: RabbitMQDotNetClient.sln
-  publish_nuget: false
-  publish_nuget_symbols: false
-  include_nuget_references: false
-  verbosity: minimal
+build_script: fake.bat AppVeyor
+
+test: off
 
 after_build:
   - ps: |
@@ -46,15 +41,7 @@ after_build:
       nuget pack RabbitMQ.Client.nuspec -version $semver -symbols
       nuget pack RabbitMQ.ServiceModel.nuspec -version $semver -symbols
 
-test:
-  assemblies:
-    - '**\build\bin\unit-tests.dll'
-  categories:
-    except:
-      - RequireSMP
-      - LongRunning
-
 artifacts:
-  - path: '**\*.nupkg'
+  - path: '*.nupkg'
 
 deploy: off

RabbitMQDotNetClient.userprefs

@@ -0,0 +1,4 @@
+@ECHO OFF
+.paket\paket.bootstrapper.exe
+.paket\paket.exe restore
+packages\FAKE\tools\FAKE.exe build.fsx

appveyor.props.in

@@ -0,0 +1,179 @@
+#!/usr/bin/env fsharpi --exec
+#r "./packages/FAKE/tools/FakeLib.dll"
+#r "System.Xml.Linq"
+open Fake
+open System
+open System.Xml.Linq
+open System.Diagnostics
+
+
+let (|IsWin8OrHigher|_|) (ov: OperatingSystem) =
+    if ov.Platform = PlatformID.Win32NT && ov.Version > Version("6.2") then
+        Some ()
+    else None
+
+type BuildEnv =
+    | AppVeyor 
+    | Mono
+    | Windows
+    | Windows8Plus
+
+let getEnv = Environment.GetEnvironmentVariable
+
+Environment.CurrentDirectory <- __SOURCE_DIRECTORY__
+
+let targetFramework = "v4.5"
+
+let context =
+    let osVersion = Environment.OSVersion
+    match getEnv "APPVEYOR_BUILD_VERSION" with
+    | null -> 
+        let buildEnv =
+            match osVersion with
+            | IsWin8OrHigher _ -> Windows8Plus
+            | _ when isMono -> Mono
+            | _ -> Windows
+        match getEnv "RABBIT_VSN" with
+        | null -> 
+            tracefn "warn: no version environment variable specificed -defaulting to 0.0.0.0" 
+            buildEnv, "0.0.0.0"
+        | v -> buildEnv, v
+    | v ->
+        AppVeyor, v
+
+
+tracefn "Fake: context %A" context
+
+let buildEnv, version = context
+
+let (</>) a b = IO.Path.Combine(a, b)
+
+let localPropsFile = "./Local.props"
+let projects =
+    [ "RabbitMQ.Client" ; "RabbitMQ.Client.WinRT" ]
+let apiGenExe = "./gensrc/rabbitmq-dotnet-apigen.exe"
+let specsDir = "./docs/specs"
+let amqpSpec0_9_1BaseName = "amqp0-9-1.stripped.xml"
+let amqpSpec0_9BaseName = "amqp0-9.stripped.xml"
+let amqpSpec0_9_1i = specsDir </> amqpSpec0_9_1BaseName
+let autogeneratedApi0_9_1BaseName = "autogenerated-api-0-9-1.cs"
+
+let createGensrcDirs () =
+    projects
+    |> List.map (fun p -> "./gensrc" </> p)
+    |> List.map IO.Directory.CreateDirectory 
+    |> ignore
+
+let deleteGensrcDirs () =
+    projects
+    |> List.map (fun p -> "./gensrc" </> p)
+    |> List.map (fun p ->
+        if IO.Directory.Exists p then IO.Directory.Delete(p, true))
+    |> ignore
+
+let generateApi () = 
+    projects
+    |> List.map (fun p -> "./gensrc/" </> p)
+    |> List.iter (fun p ->
+        let autogeneratedApi0_9_1 = p </> autogeneratedApi0_9_1BaseName
+        ExecProcess 
+            (fun si -> 
+                    si.FileName <- apiGenExe
+                    si.Arguments <-  "/apiName:AMQP_0_9_1 " + amqpSpec0_9_1i + " " + autogeneratedApi0_9_1) 
+            (TimeSpan.FromMinutes 1.)
+        |> fun res -> if res <> 0 then failwith "generateApi process failed")
+    
+let assemblyInfos = !!(@"./projects/**/AssemblyInfo.cs") 
+                       --(@"**\*Scripts*\**")
+
+let appRefs = 
+    let main =
+        !! "./projects/client/RabbitMQ.Client/**/*.csproj" 
+        ++ "./projects/client/Unit/**/*.csproj" 
+        ++ "./projects/wcf/**/*.csproj" 
+    match buildEnv with
+    | Windows8Plus | AppVeyor -> 
+        !! "./projects/**/*.csproj" 
+    | _ -> main
+
+let appGenRef = [ "./projects/client/Apigen/RabbitMQ.Client.Apigen.csproj" ] 
+
+Target "BuildApigen" (fun _ ->
+    MSBuildRelease "./gensrc" "Build" appGenRef
+    |> Log "Build: ")
+
+Target "BuildClient" (fun _ ->
+    MSBuild null "Build" ["Configuration", "Release"; "Platform", "AnyCPU" ] appRefs 
+    |> Log "Build: ")
+
+Target "Clean" (fun _ ->
+    deleteGensrcDirs()
+    MSBuild null "Clean" ["Configuration", "Release"; "Platform", "AnyCPU" ] appRefs 
+    |> Log "Clean: ")
+
+Target "UpdateAssemblyInfos"
+    (fun _ ->
+        trace (sprintf "Updating assembly infos to: %s" version)
+        ReplaceAssemblyInfoVersionsBulk assemblyInfos (fun f -> 
+            { f with AssemblyVersion = version }))    
+
+let test excludes =
+    !! ("./projects/client/**/build/**/unit-tests.dll")
+    |> NUnit (fun p -> 
+        { p with
+            TimeOut = TimeSpan.FromMinutes 30.
+            ExcludeCategory = excludes
+            DisableShadowCopy = true; 
+            OutputFile = "./TestResults.xml"})
+        
+Target "Test" (fun _ ->  
+    match buildEnv with
+    | Mono -> "MonoBug"
+    | _ -> "" 
+    |> test)
+
+Target "TestQuick" (fun _ ->  
+    let excludes =
+        match buildEnv with
+        | Mono -> "RequireSMP,LongRunning,MonoBug"
+        | _ -> "RequireSMP,LongRunning"
+    !! ("./projects/client/Unit/build/**/unit-tests.dll")
+    |> NUnit (fun p -> 
+        { p with
+            TimeOut = TimeSpan.FromMinutes 30.
+            ExcludeCategory = excludes
+            DisableShadowCopy = true; 
+            OutputFile = "./TestResults.xml"}))
+    
+Target "AppVeyorTest" (fun _ ->  
+    test "RequireSMP,LongRunning,GCTest")
+
+Target "CreateGensrcDir" createGensrcDirs
+
+Target "GenerateApi" generateApi 
+Target "Default" id
+Target "AppVeyor" id
+
+Target "Pack" (fun _ ->
+    IO.Directory.CreateDirectory "NuGet" |> ignore
+    NuGetPack (fun p -> { p with Version = version; WorkingDir = __SOURCE_DIRECTORY__ }) "./RabbitMQ.Client.nuspec")
+
+"Clean"
+    ==> "CreateGensrcDir"
+    ==> "BuildApigen"
+    ==> "GenerateApi"
+    ==> "UpdateAssemblyInfos"
+    ==> "BuildClient"
+    ==> "Default"
+
+"BuildClient"
+    ==> "Test"
+
+"BuildClient"
+    ==> "TestQuick"
+
+"BuildClient"
+    ==> "AppVeyorTest"
+    ==> "AppVeyor"
+
+RunTargetOrDefault "Default"

appveyor.yml

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+
+mono .paket/paket.bootstrapper.exe
+mono .paket/paket.exe restore
+mono ./packages/FAKE/tools/FAKE.exe build.fsx