Allow to opt in to BindingRedirects - references #415

docs/content/dependencies-file.md

@@ -56,3 +56,12 @@ This option disables the installation of any content files.
 
     nuget jQuery >= 0 // we don't install jQuery content files
     nuget UnionArgParser ~> 0.7
+
+## Redirects option
+
+This option tells paket to create AssemblyBindingRedirects for all referenced libraries.
+
+    redirects on
+    source https://nuget.org/api/v2
+
+    nuget UnionArgParser ~> 0.7

docs/content/paket-install.md

@@ -3,10 +3,12 @@
 Ensures that all dependencies in your [`paket.dependencies` file](dependencies-file.html) are present in the `packages` directory and referenced correctly in all projects.
 
     [lang=batchfile]
-    $ paket install [--force] [--hard]
+    $ paket install [--force] [--hard] [--redirects]
 
 Options:
 
   `--force`: Forces the download and reinstallation of all packages.
 
   `--hard`: Replaces package references within project files even if they are not yet adhering to Paket's conventions (and hence considered manually managed). See [convert from NuGet](convert-from-nuget.html).
+
+    `--redirects`: Creates binding redirects for the NuGet packages.

docs/content/paket-update.md

@@ -3,14 +3,16 @@
 Recomputes the dependency resolution, updates the [`paket.lock` file](lock-file.html) and propagates any resulting package changes into all project files referencing updated packages.
 
     [lang=batchfile]
-    $ paket update [--force] [--hard]	
+    $ paket update [--force] [--hard] [--redirects]
 
 Options:
 
   `--force`: Forces the download and reinstallation of all packages.
 
   `--hard`: Replaces package references within project files even if they are not yet adhering to to Paket's conventions (and hence considered manually managed). See [convert from NuGet](convert-from-nuget.html).
 
+  `--redirects`: Creates binding redirects for the NuGet packages.
+
 ## Updating a single package
 
 It's also possible to update only a single package and to keep all other dependencies fixed:

src/Paket.Core/AddProcess.fs

@@ -38,7 +38,7 @@ let Add(dependenciesFileName, package, version, force, hard, interactive, instal
 
     if installAfter then
         let sources = dependenciesFile.GetAllPackageSources()
-        InstallProcess.Install(sources, force, hard, lockFile)
+        InstallProcess.Install(sources, force, hard, false, lockFile)
 
     if changed then
         dependenciesFile.Save()

src/Paket.Core/DependenciesFile.fs

@@ -13,9 +13,10 @@ open Paket.PackageSources
 /// [omit]
 type InstallOptions = 
     { Strict : bool 
+      Redirects : bool 
       OmitContent : bool }
 
-    static member Default = { Strict = false; OmitContent = false}
+    static member Default = { Strict = false; OmitContent = false; Redirects = false}
 
 /// [omit]
 module DependenciesFileParser = 
@@ -128,7 +129,12 @@ module DependenciesFileParser =
         | [| _; projectSpec; fileSpec |] -> getParts projectSpec fileSpec
         | _ -> failwithf "invalid http-reference specification:%s     %s" Environment.NewLine trimmed
 
-    let private (|Remote|Package|Blank|ReferencesMode|OmitContent|SourceFile|) (line:string) =
+    type private ParserOption =
+    | ReferencesMode of bool
+    | OmitContent of bool
+    | Redirects of bool
+
+    let private (|Remote|Package|Blank|ParserOptions|SourceFile|) (line:string) =
         match line.Trim() with
         | _ when String.IsNullOrWhiteSpace line -> Blank
         | String.StartsWith "source" _ as trimmed -> Remote(PackageSource.Parse(trimmed))
@@ -150,8 +156,9 @@ module DependenciesFileParser =
             | name :: rest -> Package(name,">= 0 " + String.Join(" ",rest))
             | name :: [] -> Package(name,">= 0")
             | _ -> failwithf "could not retrieve nuget package from %s" trimmed
-        | String.StartsWith "references" trimmed -> ReferencesMode(trimmed.Trim() = "strict")
-        | String.StartsWith "content" trimmed -> OmitContent(trimmed.Trim() = "none")
+        | String.StartsWith "references" trimmed -> ParserOptions(ParserOption.ReferencesMode(trimmed.Trim() = "strict"))
+        | String.StartsWith "redirects" trimmed -> ParserOptions(ParserOption.Redirects(trimmed.Trim() = "on"))
+        | String.StartsWith "content" trimmed -> ParserOptions(ParserOption.OmitContent(trimmed.Trim() = "none"))
         | String.StartsWith "gist" _ as trimmed ->
             SourceFile(``parse git source`` trimmed SingleSourceFileOrigin.GistLink "gist")
         | String.StartsWith "github" _ as trimmed  ->
@@ -168,8 +175,9 @@ module DependenciesFileParser =
                 match line with
                 | Remote(newSource) -> lineNo, options, sources @ [newSource], packages, sourceFiles
                 | Blank -> lineNo, options, sources, packages, sourceFiles
-                | ReferencesMode mode -> lineNo, { options with Strict = mode }, sources, packages, sourceFiles
-                | OmitContent omit -> lineNo, { options with OmitContent = omit }, sources, packages, sourceFiles
+                | ParserOptions(ParserOption.ReferencesMode mode) -> lineNo, { options with Strict = mode }, sources, packages, sourceFiles
+                | ParserOptions(ParserOption.Redirects mode) -> lineNo, { options with Redirects = mode }, sources, packages, sourceFiles
+                | ParserOptions(ParserOption.OmitContent omit) -> lineNo, { options with OmitContent = omit }, sources, packages, sourceFiles
                 | Package(name,version) ->
                     lineNo, options, sources, 
                         { Sources = sources

src/Paket.Core/InstallProcess.fs

@@ -128,7 +128,7 @@ let private applyBindingRedirects root extractedPackages =
     |> applyBindingRedirectsToFolder root
 
 /// Installs the given all packages from the lock file.
-let Install(sources,force, hard, lockFile:LockFile) = 
+let Install(sources,force, hard, withBindingRedirects, lockFile:LockFile) = 
     let root = FileInfo(lockFile.FileName).Directory.FullName 
     let extractedPackages = createModel(root,sources,force, lockFile)
 
@@ -185,4 +185,5 @@ let Install(sources,force, hard, lockFile:LockFile) =
 
         project.Save()
 
-    applyBindingRedirects root extractedPackages
+    if withBindingRedirects || lockFile.Options.Redirects then
+        applyBindingRedirects root extractedPackages

src/Paket.Core/LockFile.fs

@@ -26,6 +26,7 @@ module LockFileSerializer =
             let hasReported = ref false
             [ if options.Strict then yield "REFERENCES: STRICT"
               if options.OmitContent then yield "CONTENT: NONE"
+              if options.Redirects then yield "REDIRECTS: ON"
               for (source, _), packages in sources do
                   if not !hasReported then
                     yield "NUGET"
@@ -97,8 +98,11 @@ module LockFileParser =
           SourceFiles : ResolvedSourceFile list
           LastWasPackage : bool
           Options: InstallOptions }
-
-    type private InstallOptionCase = StrictCase | OmitContentCase
+
+    type private ParserOption =
+    | ReferencesMode of bool
+    | OmitContent of bool
+    | Redirects of bool
 
     let private (|Remote|NugetPackage|NugetDependency|SourceFile|RepositoryType|Blank|InstallOption|) (state, line:string) =
         match (state.RepositoryType, line.Trim()) with
@@ -109,8 +113,9 @@ module LockFileParser =
         | _, _ when String.IsNullOrWhiteSpace line -> Blank
         | _, String.StartsWith "remote:" trimmed -> Remote(trimmed.Trim().Split(' ').[0])
         | _, String.StartsWith "specs:" _ -> Blank
-        | _, String.StartsWith "REFERENCES:" trimmed -> InstallOption(StrictCase,trimmed.Trim() = "STRICT")
-        | _, String.StartsWith "CONTENT:" trimmed -> InstallOption(OmitContentCase,trimmed.Trim() = "NONE")
+        | _, String.StartsWith "REFERENCES:" trimmed -> InstallOption(ReferencesMode(trimmed.Trim() = "STRICT"))
+        | _, String.StartsWith "REDIRECTS:" trimmed -> InstallOption(Redirects(trimmed.Trim() = "ON"))
+        | _, String.StartsWith "CONTENT:" trimmed -> InstallOption(OmitContent(trimmed.Trim() = "NONE"))
         | _, trimmed when line.StartsWith "      " ->
             let parts = trimmed.Split '(' 
             NugetDependency (parts.[0].Trim(),parts.[1].Replace("(", "").Replace(")", "").Trim())
@@ -129,8 +134,9 @@ module LockFileParser =
             match (state, line) with
             | Remote(url) -> { state with RemoteUrl = Some url }
             | Blank -> state
-            | InstallOption (StrictCase,mode) -> { state with Options = {state.Options with Strict = mode} }
-            | InstallOption (OmitContentCase,omit) -> { state with Options = {state.Options with OmitContent = omit} }
+            | InstallOption (ReferencesMode(mode)) -> { state with Options = {state.Options with Strict = mode} }
+            | InstallOption (Redirects(mode)) -> { state with Options = {state.Options with Redirects = mode} }
+            | InstallOption (OmitContent(omit)) -> { state with Options = {state.Options with OmitContent = omit} }
             | RepositoryType repoType -> { state with RepositoryType = Some repoType }
             | NugetPackage details ->
                 match state.RemoteUrl with

src/Paket.Core/NugetConvert.fs

@@ -256,4 +256,4 @@ let ConvertFromNuget(dependenciesFileName, force, installAfter, initAutoRestore,
         VSIntegration.InitAutoRestore dependenciesFileName
 
     if installAfter then
-        UpdateProcess.Update(dependenciesFileName,true,false,true)
+        UpdateProcess.Update(dependenciesFileName,true,false,true,true)

src/Paket.Core/PublicAPI.fs

@@ -87,10 +87,16 @@ type Dependencies(dependenciesFileName: string) =
         AddProcess.Add(dependenciesFileName, PackageName package, version, force, hard, interactive, installAfter)
 
     /// Installs all dependencies.
-    member this.Install(force: bool,hard: bool): unit = UpdateProcess.Update(dependenciesFileName,false,force,hard)
+    member this.Install(force: bool,hard: bool,withBindingRedirects:bool): unit = UpdateProcess.Update(dependenciesFileName,false,force,hard,withBindingRedirects)
+
+    /// Installs all dependencies.
+    member this.Install(force: bool,hard: bool): unit = this.Install(force,hard,false)
+
+    /// Updates all dependencies.
+    member this.Update(force: bool,hard: bool,withBindingRedirects:bool): unit = UpdateProcess.Update(dependenciesFileName,true,force,hard,withBindingRedirects)
 
     /// Updates all dependencies.
-    member this.Update(force: bool,hard: bool): unit = UpdateProcess.Update(dependenciesFileName,true,force,hard)
+    member this.Update(force: bool,hard: bool): unit = this.Update(force,hard,false)
 
     /// Updates the given package.
     member this.UpdatePackage(package: string,version: string option,force: bool,hard: bool): unit =

src/Paket.Core/RemoveProcess.fs

@@ -57,4 +57,4 @@ let Remove(dependenciesFileName, package:PackageName, force, hard, interactive,
 
     if installAfter then
         let sources = DependenciesFile.ReadFromFile(dependenciesFileName).GetAllPackageSources()
-        InstallProcess.Install(sources, force, hard, lockFile)
+        InstallProcess.Install(sources, force, hard, false, lockFile)

src/Paket.Core/UpdateProcess.fs

@@ -8,7 +8,7 @@ open Paket.PackageResolver
 open System.Collections.Generic
 
 /// Update command
-let Update(dependenciesFileName, forceResolution, force, hard) = 
+let Update(dependenciesFileName, forceResolution, force, hard, withBindingRedirects) = 
     let lockFileName = DependenciesFile.FindLockfile dependenciesFileName
 
     let sources, lockFile = 
@@ -21,7 +21,7 @@ let Update(dependenciesFileName, forceResolution, force, hard) =
             let sources = dependenciesFile.GetAllPackageSources()
             sources, LockFile.LoadFrom(lockFileName.FullName)
 
-    InstallProcess.Install(sources, force, hard, lockFile)
+    InstallProcess.Install(sources, force, hard, withBindingRedirects, lockFile)
 
 let private fixOldDependencies failOnMissingPackage (dependenciesFile:DependenciesFile) (package:PackageName) (oldLockFile:LockFile) =
     let allDependencies = 
@@ -62,7 +62,7 @@ let updateWithModifiedDependenciesFile(failOnMissingPackage,dependenciesFile:Dep
 /// Update a single package command
 let UpdatePackage(dependenciesFileName, packageName : PackageName, newVersion, force, hard) = 
     let lockFileName = DependenciesFile.FindLockfile dependenciesFileName
-    if not lockFileName.Exists then Update(dependenciesFileName, true, force, hard) else
+    if not lockFileName.Exists then Update(dependenciesFileName, true, force, hard, false) else
 
     let sources, lockFile = 
         let dependenciesFile = 
@@ -76,4 +76,4 @@ let UpdatePackage(dependenciesFileName, packageName : PackageName, newVersion, f
 
         fixOldDependencies true dependenciesFile packageName
         |> update lockFileName.FullName force
-    InstallProcess.Install(sources, force, hard, lockFile)
+    InstallProcess.Install(sources, force, hard, false, lockFile)

src/Paket/Paket.fsproj

@@ -26,12 +26,12 @@
     <WarningLevel>3</WarningLevel>
     <DocumentationFile>
     </DocumentationFile>
-    <StartArguments>update -f</StartArguments>
+    <StartArguments>remove nuget cs-script --interactive</StartArguments>
     <StartAction>Project</StartAction>
     <StartProgram>paket.exe</StartProgram>
     <StartWorkingDirectory>
     </StartWorkingDirectory>
-    <StartWorkingDirectory>d:\code\PaketTest</StartWorkingDirectory>
+    <StartWorkingDirectory>d:\code\paket-dependencies</StartWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>

src/Paket/Program.fs

@@ -43,6 +43,7 @@ type CLIArguments =
     | [<First>][<NoAppSettings>][<Rest>][<CustomCommandLine("find-refs")>] FindRefs of string
     | [<AltCommandLine("-v")>] Verbose
     | [<AltCommandLine("-i")>] Interactive
+    | Redirects
     | [<AltCommandLine("-f")>] Force
     | Hard
     | [<CustomCommandLine("nuget")>] Nuget of string
@@ -117,6 +118,7 @@ try
         let noInstall = results.Contains <@ CLIArguments.No_Install @>
         let noAutoRestore = results.Contains <@ CLIArguments.No_Auto_Restore @>
         let includePrereleases = results.Contains <@ CLIArguments.Include_Prereleases @>
+        let withBindingRedirects = results.Contains <@ CLIArguments.Redirects @>
 
         match command with
         | Command.Init -> Dependencies.Create() |> ignore
@@ -131,7 +133,7 @@ try
         | Command.Remove -> 
             let packageName = results.GetResult <@ CLIArguments.Nuget @>            
             Dependencies.Locate().Remove(packageName,force,hard,interactive,noInstall |> not)
-        | Command.Install -> Dependencies.Locate().Install(force,hard)
+        | Command.Install -> Dependencies.Locate().Install(force,hard,withBindingRedirects)
         | Command.Restore -> 
             let files = results.GetResults <@ CLIArguments.References_Files @> 
             Dependencies.Locate().Restore(force,files)
@@ -140,7 +142,7 @@ try
             | Some packageName -> 
                 let version = results.TryGetResult <@ CLIArguments.Version @>
                 Dependencies.Locate().UpdatePackage(packageName, version, force, hard)
-            | _ -> Dependencies.Locate().Update(force,hard)            
+            | _ -> Dependencies.Locate().Update(force,hard,withBindingRedirects)            
         | Command.Outdated ->         
             let strict = results.Contains <@ CLIArguments.Ignore_Constraints @> |> not
             Dependencies.Locate().ShowOutdated(strict,includePrereleases)

tests/Paket.Tests/DependenciesFile/ParserSpecs.fs

@@ -127,6 +127,37 @@ nuget "FAKE" "~> 3.0"
 let ``should read strict config``() = 
     let cfg = DependenciesFile.FromCode(strictConfig)
     cfg.Options.Strict |> shouldEqual true
+    cfg.Options.Redirects |> shouldEqual false
+
+    (cfg.Packages |> List.find (fun p -> p.Name = PackageName "FAKE")).Sources |> shouldEqual [PackageSource.NugetSource "http://nuget.org/api/v2"]
+
+let redirectsConfig = """
+redirects on
+source "http://nuget.org/api/v2" // first source
+
+nuget "FAKE" "~> 3.0"
+"""
+
+[<Test>]
+let ``should read config with redirects``() = 
+    let cfg = DependenciesFile.FromCode(redirectsConfig)
+    cfg.Options.Strict |> shouldEqual false
+    cfg.Options.Redirects |> shouldEqual true
+
+    (cfg.Packages |> List.find (fun p -> p.Name = PackageName "FAKE")).Sources |> shouldEqual [PackageSource.NugetSource "http://nuget.org/api/v2"]
+
+let noRedirectsConfig = """
+redirects off
+source "http://nuget.org/api/v2" // first source
+
+nuget "FAKE" "~> 3.0"
+"""
+
+[<Test>]
+let ``should read config with no redirects``() = 
+    let cfg = DependenciesFile.FromCode(noRedirectsConfig)
+    cfg.Options.Strict |> shouldEqual false
+    cfg.Options.Redirects |> shouldEqual false
 
     (cfg.Packages |> List.find (fun p -> p.Name = PackageName "FAKE")).Sources |> shouldEqual [PackageSource.NugetSource "http://nuget.org/api/v2"]