Rash thoughts about .NET, C#, F# and Dynamics NAV. » F-sharp Make

"Fake – F# Make" 1.40.5.0 released – Bugfixes for CruiseControl.NET

Steffen Forkmann — Wed, 14 Jul 2010 09:15:05 +0000

Today I released “FAKE – F# Make” version 1.40.5.0. This release fixes some issues with CruiseControl.NET compatibility and improves the MSBuild task.

Important links:

Changes for CruiseControl.NET

Daniel Nauck created a FAKE task for CC.Net. This task allows a much easier configuration of FAKE. Please download the latest CC.NET build if you want to use it.

Daniel also created a FAKE build project on his server which showed us some compatibility issues:

In FAKE:
- Race condition in FAKE’s trace functionality
- Better XML tracing if something fails
- The tracing buffer will be flushed after every build target
- Every task has a Timeout property (Default: 5 min.)
- Setting of environment variables fixed
- Showing labels in NUnit is now the default
In Docu:
- Unhandled exception in Docu.exe
In CC.NET:
- Implemented support for git submodules (CCNET-1922)

@Daniel: Thank you very much for helping me on this CruiseControl.NET stuff. I really appreciate this.

MSBuild task changes

The MSBuild task in FAKE gets a sequence of project files and compiles them in the given order. This might be slow if you have lots of dependent projects. Then MSBuild might analyze the dependencies over and over again. To fix this issue I currently see two possible solutions:

Generate a temporary solution file and use this for compilation.
Analyze the given projects and remove all dependent projects from the list.

FAKE 1.40.5.0 implements the second idea. If you have a better idea please contact me.

“Fake – F# Make” 1.33.0 released

Steffen Forkmann — Sun, 11 Jul 2010 15:11:49 +0000

Yesterday I released “FAKE – F# Make” version 1.33.0. This release has lots of small bug fixes and a couple of new features.

Important links:

Git helpers -Fake.Git.dll

Git is a distributed revision control system with an emphasis on speed. Git was initially designed and developed by Linus Torvalds for Linux kernel development. Every Git working directory is a full-fledged repository with complete history and full revision tracking capabilities, not dependent on network access or a central server.

[Wikipedia]

In the last couple of months I worked on small helper library for controlling Git. This library is now released as part of “FAKE – F# Make”. You can find the source code at http://github.com/forki/FAKE/tree/master/src/app/Fake.Git/.

Features:

Repository handling
- init, clone
Submodules
- init, clone, information about submodules
Branches
- checkout, create, delete, merge, rebase, tag, pull, push, reset, commit, …
SHA1 calculation

Documentation generation with James Gregory’s docu tool

What’s a docu? A documentation generator for .Net that isn’t complicated, awkward, or difficult to use. Given an assembly and the XML that’s generated by Visual Studio, docu can produce an entire website of documentation with a single command.

[docu website]

Fake comes bundled with James Gregory’s documentations generator “docu”, which converts XML-Documentation comments into HTML files. All you need to do is downloading a template and calling the docu task inside your build script:

!+ (buildDir + "*.dll")
     |> Scan
     |> Docu (fun p ->
         {p with
             ToolPath = docuPath + "docu.exe"
             TemplatesPath = templatesSrcDir
             OutputPath = docsDir })

Since FAKE builds its own documentation with docu I started to add more (and hopefully better) XML doc comments. My plan is to describe more and more of the internal FAKE functions in the next releases. An updated HTML-document (generated via a docu task) can be found at http://www.navision-blog.de/fake/.

Side by side specification

For Test-driven development (TDD) it’s sometimes nice to have the specifications next to the implementation files since the specs are considered as documentation.

By using a tool like VSCommands it is possible to group the implementation with the specs (see also http://gist.github.com/457248).

This “side by side specification” makes TDD a lot easier but of course we don’t want to deploy the specification classes and the test data.

==>

FAKE has a new feature which automatically removes all specification files and test framework references according to a given convention:

Target "BuildApp" (fun _ –>
      !+ @"src\app\**\*.csproj"
         |> Scan
         |> Seq.map (
             RemoveTestsFromProject
                 AllNUnitReferences      // a default references convention
                 AllSpecAndTestDataFiles // a default file convention
                 )
         |> MSBuildRelease buildDir "Build"
         |> Log "AppBuild-Output: "
)

The conventions are simple functions and can be customized e.g.:

/// All Spec.cs or Spec.fs files and all files containing TestData
let AllSpecAndTestDataFiles elementName (s:string) =
     s.EndsWith "Specs.cs" ||
       s.EndsWith "Specs.fs" ||
       (elementName = "Content" && s.Contains "TestData")

Miscellaneous

SQL Server helpers are moved to Fake.SQL.dll
- Additional functions for attaching and detaching databases.
FileHelper.CopyCached function was added
- Copies the files from a cache folder. If the files are not cached or the original files have a different write time the cache will be refreshed.
EnvironmentHelper.environVarOrDefault added
- Retrieves the environment variable or a given default.
Fixed Issue 3: toRelativePath calculates paths with ..\..\ if needed
Added a build time report to the build output.
XPathReplace and XMLPoke tasks added.
- Replaces text in an XML file at the location specified by an XPath expression.
ILMerge task added
Windows Installer XML (WiX) task added

“FAKE – F# Make” 1.20.0 released

Steffen Forkmann — Wed, 12 May 2010 12:26:43 +0000

Today I released a new bugfix release for “FAKE – F# Make”. We fixed some path and logging issues and as a new feature we introduced the @@ operator which allows to combine paths.

Using a MailboxProcessor to speedup “FAKE – F# MAKE”

Steffen Forkmann — Fri, 07 May 2010 11:37:28 +0000

Earlier today I released “FAKE – F# Make” version 1.10.0. This new release contains a lot path issue fixes for Mono and a new architecture for logging and tracing.

A guy named Joel Mueller had an awesome idea and sent me some patches. He noticed that TraceHelper.fs writes all messages synchronously to the console and/or a XML output file, which means the actual build operations must wait on the writing of hundreds of trace messages, slowing down the actual build.

His idea was to use a MailboxProcessor to buffer up the trace messages and write them out asynchronously, so that the actual build can proceed at full speed.

type Message = 
    { Text      : string
      Color     : ConsoleColor
      Newline   : bool
      Important : bool}
 
/// ….
 
let buffer = MailboxProcessor.Start (fun inbox ->
    let rec loop () = 
        async {
            let! (msg:Message) = inbox.Receive()
            match traceMode with
            | Console -> logMessageToConsole msg
            | Xml     -> appendXML msg.Text
 
            return! loop ()}
 
    loop ())      

Now all internal logging and tracing functions can post their their messages to the inbox of the MailboxProcessor:

/// Logs the specified string (via message buffer)
let logMessage important newLine message =
    match traceMode with
    | Console ->
        { Text = message; 
          Important = important; 
          Newline = newLine; 
          Color = ConsoleColor.White }
          |> buffer.Post
    | Xml     -> 
        { defaultMessage with 
            Text = sprintf "" 
                     message }
          |> buffer.Post 

This idea reduces the build time of FAKE’s self build from 3 min. to 2 min. Which is really amazing, since I didn’t have to change anything in the build script. This version is compatible to the last released version.

Please download “FAKE – F# Make” version 1.10.0 and tell me what you think.

“FAKE – F# Make” and NaturalSpec released

Steffen Forkmann — Tue, 13 Apr 2010 08:06:46 +0000

Yesterday Microsoft released the RTM versions of Visual Studio 2010, .NET Framework 4.0 and F# 2.0.0.0 and so it is time to announce the first official releases of “Fake – F# Make” and NaturalSpec. Both projects are now compatible with Visual Studio 2010 RC and RTM and the corresponding F# versions.

Fake – F# Make version 1.0.0

"FAKE – F# Make" is a build automation system, which is intended to provide a much better tooling support than XML-based build languages like MSBuild or NAnt. Due to its integration in F#, all benefits of the .NET Framework and functional programming can be used, including the extensive class library, powerful debuggers and integrated development environments like Visual Studio 2008, Visual Studio 2010 or SharpDevelop, which provide syntax highlighting and code completion.

Like F# itself the new build language was designed to be succinct, typed, declarative, extensible and easy to use.

Project page with samples and articles
Download page
Github repository

NaturalSpec version 1.0.0

NaturalSpec is a UnitTest framework based on NUnit and completely written in F# – but you don’t have to learn F# to use it. The idea is that you can write your spec mostly in a natural language like in the following sample:

[]
let “When removing an element from a list it should not contain the element“() =
  Given [1;2;3;4;5]                 // "Arrange" test context
    |> When removing 3              // "Act"
    |> It shouldn’t contain 3       // "Assert"
    |> It should contain 4          // another assertion
    |> It should have (Length 4)    // Assertion for length
    |> It shouldn’t have Duplicates // it contains duplicates ?
    |> Verify                       // Verify scenario

Project page with samples and articles
Download page
Github repository

If you have any questions about the projects feel free to contact me.

“FAKE – F# Make” 0.29 released – Ready for F# February 2010 CTP and .NET 4.0 RC

Steffen Forkmann — Sun, 14 Feb 2010 16:56:07 +0000

Last week I released version 0.29 of my build automation tool “FAKE – F# Make”. The new version comes along with a couple of changes which I will now describe.

F# February 2010 CTP and .NET 4.0 RC

“FAKE – F# Make” should be completely compatible with both, the F# February 2010 CTP and the F# version which is included in Visual Studio 2010 RC.

FAKE self build and binaries on teamcity.codebetter.com

Since “FAKE – F# Make” is a build automation tool, it was always used for it’s own build process. Now this build process could be moved to an open CI server at teamcity.codebetter.com. If you login as a guest you can download the latest “FAKE – F# Make” binaries from there.

FAKE on build servers without F#

With the new F# CTP there is no longer a need for installing F# on the build agents. In fact FAKE itself was built on build agents which don’t have a F# installation.

If you want to create such build scripts you have to do the following:

Download the standalone zip file of the F# CTP
Put the bin subfolder into your project tree
Modify the FSIPath value in the FAKE.exe.config file to match your FSharp bin folder
1. If you copy the contents the F# bin folder into ./tools/FSharp/ it should just work.

If you have F# projects you also need to modify your .fsproj files like this:

….
..\..\..\tools\FSharp\

…

This modifications should take care that MSBuild will use the F# compiler from your tools paths.

Generate your documentations with “docu”

“What’s a docu? A documentation generator for .Net that isn’t complicated, awkward, or difficult to use. Given an assembly and the XML that’s generated by Visual Studio, docu can produce an entire website of documentation with a single command.” [docu Homepage]

“FAKE – F# Make” 0.29 is bundled with this new documentation tool which can easily convert your xml-Documentation into some nice html pages. You can use the tool with the new Docu task like this:

Target? GenerateDocumentation <-
    fun _ ->
        Docu (fun p ->
            {p with
               ToolPath = @".\tools\FAKE\docu.exe"
               TemplatesPath = @".\tools\FAKE\templates"
               OutputPath = docDir })
            (buildDir + "MyAssembly.dll")

You will also need the docu templates, which you can download from the product homepage. I’m planning to bundle some basic templates with the next version of FAKE.

What’s next?

At the moment I’m working on ILMerge task for FAKE. I hope to release this with the next version. There are also some open issues with the Mono support but since teamcity.codebetter.com is getting a mono build agent I hope to make some progress here too.

If you have any questions or ideas for new features please contact me.

New syntactic sugar for “FAKE – F# Make” – Getting rid of magic strings

Steffen Forkmann — Mon, 08 Feb 2010 17:58:12 +0000

The new version 0.27 of “FAKE – F# Make” comes with new syntactic sugar for build targets and build dependencies. Don’t be afraid the old version is still supported – all scripts should still work with the new version.

The problem

Consider the following target definition:

let buildDir = "./build/"
 
Target "Clean" (fun _ ->
  CleanDir buildDir
)
 
Target "Default" (fun _ ->
  trace "Hello World from FAKE"
)
 
"Default" <== ["Clean"]
 
run "Default"

As you can see we are having a lot of “magic strings” for the target names and the dependency definitions. This was always a small shortcoming in FAKE, since this doesn’t allow refactoring and may result in runtime errors.

One of my goals for “FAKE – F# Make” is to remove these strings in future versions. Unfortunately this is not that easy, because it causes a lot of internal issues. In particular logging to the build server is much harder if you don’t have a target name.

The first step

As posted in a bitbucket comment by cipher we could use the “dynamic lookup operator” to remove some of the magic strings without breaking any internal code.

As a result we can rewrite the above sample as:

let buildDir = "./build/"
 
Target? Clean <-
    fun _ -> CleanDir buildDir
 
Target? Default <-
    fun _ -> trace "Hello World from FAKE"
 
For? Default <- Dependency? Clean
 
Run? Default

All magic strings suddenly disappeared. I think this syntax looks really nice, but unfortunately the strings are not really gone, since the token Default is only checked at runtime.

The idea for future versions

Since the new syntax is really just syntactic sugar I’m always interested in a better solution. Currently I’m working on a syntax using monads. The result could look like this:

let buildDir = "./build/"
 
let Clean = target { CleanDir buildDir }
let Default = 
  target { 
    trace "Hello World from FAKE" 
    trace "Another line"
  }
 
Default <== [Clean]

Run Default

This way the magic string are really gone, but my current problem is retrieving the target name from the let-binding name. Please leave a comment if you have an idea to solve this issue.

xUnit.net support in “FAKE – F# Make” 0.14

Steffen Forkmann — Sun, 18 Oct 2009 16:09:16 +0000

Yesterday I released “FAKE – F# Make” version 0.14 with xUnit.net support. The usage is very easy and similar to the usage of NUnit:

Target "xUnitTest" (fun () ->  
  let testAssemblies = 
    !+ (testDir + @"\Test.*.dll") 
      |> Scan
 
  xUnit 
    (fun p -> 
       {p with 
           ShadowCopy = false;
           HtmlPrefix = testDir}) 
    testAssemblies  
)

This sample works perfectly with TeamCity and creates a html-page per test project in addition:

If you want to publish the xUnit.net test results in CruiseControl.NET just modify the build script a little:

Target "xUnitTest" (fun () ->  
  let testAssemblies = 
    !+ (testDir + @"\Test.*.dll") 
      |> Scan
 
  xUnit 
    (fun p -> 
       {p with 
           ShadowCopy = false;
           HtmlPrefix = testDir;
           XmlPrefix = testDir }) 
    testAssemblies  
)

Now follow the steps in the CrusieControl.NET documentation. You will need to download the xUnitSummary.xsl file and save it to your webdashboard directory. If everything works correctly you should see something like this:

Integrating a “FAKE – F# Make” build script into CruiseControl.NET

Steffen Forkmann — Wed, 14 Oct 2009 08:38:55 +0000

Since version 0.12 the FAKE build system provides an easy way to setup build configurations for CruiseControl.NET.

“CruiseControl.NET is an Automated Continuous Integration server, implemented using the Microsoft .NET Framework.”

[thoughtworks.org]

In this article I will show you how you can set up a FAKE build script in CruiseControl.NET. We will use the CalculatorSample which you can download from the FAKE Download page.

If you want to know how this build script works and how you could create one for your own projects please read the “Getting started with FAKE”-tutorial.

If you want to set up “FAKE – F# Make” build configurations in TeamCity please read “Integrating a "FAKE – F# Make" build script into TeamCity”.

Installing CruiseControl.NET

You can download CruiseControl.NET from thoughtworks.org. After the installation process (further instructions) you should see an empty dashboard:

Installing Subversion

The CalculatorSample is using Subversion (SVN) for SourceControl, so we need to download SVN from subversion.tigris.org. I’m using the “Windows MSI installer with the basic win32 binaries” and installed them under “c:\Program Files (x86)\Subversion\”.

Installing FxCop

The CalculatorSample is using FxCop, so we need to download and install it next.

“FxCop is an application that analyzes managed code assemblies (code that targets the .NET Framework common language runtime) and reports information about the assemblies, such as possible design, localization, performance, and security improvements. Many of the issues concern violations of the programming and design rules set forth in the Design Guidelines for Class Library Developers, which are the Microsoft guidelines for writing robust and easily maintainable code by using the .NET Framework.”

[MSDN]

Creating a FAKE Project

Now create a new folder for the CalculatorSample sources. I’m using “d:\Calculator\” for the rest of the article.

The next step is to modify the CruiseControl.NET config file (“c:\Program Files (x86)\CruiseControl.NET\server\ccnet.config” on my machine):

<cruisecontrol>
  <project>
    <name>CalculatorExamplename>
    <triggers>
       <intervalTrigger name="continuous" seconds="30" initialSeconds="30"/>
    triggers>
    <sourcecontrol type="svn">
      <executable>c:\Program Files (x86)\Subversion\bin\svn.exeexecutable>
      <workingDirectory>d:\Calculator\workingDirectory>
      <trunkUrl>http://fake.googlecode.com/svn/trunk/Samples/Calculator/trunkUrl>
    sourcecontrol>    
    <tasks>
      <exec>
        <executable>d:\Calculator\tools\Fake\Fake.exeexecutable>
        <baseDirectory>d:\Calculator\baseDirectory>
        <buildArgs>completeBuild.fsxbuildArgs>
      exec>
    tasks>
    <publishers>
      <merge>
        <files>
          <file>d:\Calculator\test\FXCopResults.xmlfile>
          <file>d:\Calculator\test\TestResults.xmlfile>
          <file>d:\Calculator\output\Results.xmlfile>
        files>
      merge>
      <xmllogger />
    publishers>
  project>
cruisecontrol>

In this configuration I set up a trigger which checks every 30 sec. for changes in my CalculatorSample project.

If SVN finds changes FAKE.exe is called with my build script (completeBuild.fsx).

After the build I want to merge the FxCop and NUnit output files with my build results to create a build report.

Configuring the dashboard

In order to provide a nicer output on the dashboard we need to modify the BuildPlugins section in the dashboard.config file (“c:\Program Files (x86)\CruiseControl.NET\webdashboard\dashboard.config” on my machine):

<buildPlugins>
  <buildReportBuildPlugin>
    <xslFileNames>
      <xslFile>xsl\header.xslxslFile>
      <xslFile>xsl\modifications.xslxslFile>
      <xslFile>xsl\NCoverSummary.xslxslFile>
      <xslFile>xsl\fxcop-summary_1_36.xslxslFile>
      <xslFile>xsl\unittests.xslxslFile>
      <xslFile>xsl\nant.xslxslFile>
    xslFileNames>
  buildReportBuildPlugin>
  <buildLogBuildPlugin />
  <xslReportBuildPlugin 
     description="NCover Report" 
     actionName="NCoverBuildReport" 
     xslFileName="xsl\NCover.xsl">xslReportBuildPlugin>
  <xslReportBuildPlugin description="FxCop Report"
     actionName="FxCopBuildReport"
     xslFileName="xsl\fxcop-report_1_36.xsl" />
  <xslReportBuildPlugin description="NUnit Report"
     actionName="NUnitBuildReport"
     xslFileName="xsl\tests.xsl" />
buildPlugins>

As you can see we use the nant.xsl to transform the FAKE output to HTML.

Starting the build

Now if everything is configured correctly, you can tell CruiseControl.NET to run your build (press “Start” for your build project on the dashboard):

Now CruiseControl.NET should use SVN to checkout the CalculatorSample sources and run the build. The output on the project page for build 1 should look like this:

You can also inspect the NUnit and FxCop results:

Please feel free to give feedback if you have any problems with this article.

“FAKE – F# Make” Version 0.10 released

Steffen Forkmann — Tue, 06 Oct 2009 09:59:10 +0000

I just released a new version of my Open Source Build Automation Framework “FAKE – F# Make”. You can read more about FAKE on the project website or in the Getting started with "FAKE – F# Make"-article.

Although the new release contains many bugfixes, I only want to show the two major improvements here.

1. FAKE 0.10 uses FSI instead of FSC

From now on FAKE uses the “F# Interactive” (fsi.exe) instead of the F# Compiler (fsc.exe) to run the build scripts, which brings two major improvements.

No TempPath for compiled binaries needed

Due to the fact that FAKE scripts are no longer compiled at the beginning of the build process, we don’t need a temporary folder for the created binaries.

Loading modules at runtime

The #load command in F# scripts allows us to load modules at runtime. Now we are able to put reusable Targets or TargetTemplates (see below) into external build script files.

2. TargetTemplates

TargetTemplates provide an easy way to reuse common Targets. Let’s consider a (very) small sample:

Target "TraceHello" (fun () ->
  trace "Hello World from FAKE"
)

This Target “TraceHello” traces a “Hello World” string into our build log. Now we want it to be slightly more generic and to trace a custom string. We can do this by using a TargetTemplate:

/// createTraceTarget: string -> string -> Target
let createTraceTarget = TargetTemplate (fun s ->
  trace s
)

Now we have a template (or a function which generates targets) that gets a string for the target name and a string for the trace text and generates a usable target:

createTraceTarget "TraceHello" "Hello World from FAKE"
createTraceTarget "Trace2" "Trace another text"

Of course the TargetTemplate function is generic and can be used with any tuple as parameter:

/// createTraceTarget: string -> string*int -> Target
let createTraceTarget = TargetTemplate (fun (s,d) ->
  trace s
  trace <| sprintf "my int: %d" d
)
 
createTraceTarget "TraceHello" ("Hello World from FAKE",2)
createTraceTarget "Trace2" ("Trace another text",42)