Merge pull request fsprojects#2428 from bhugot/PaketPackTargetFramework

forki · web-flow · commit 6bdcf80879e9 · 2017-06-18T16:44:55.000+02:00
Implementation for fsprojects#913 Paket.pack: add support for nuget dependencies conditional on target framework
diff --git a/docs/content/template-files.md b/docs/content/template-files.md
@@ -179,6 +179,17 @@ The `LOCKEDVERSION` placeholder allows to reference the currently used dependenc
 	  FSharp.Core >= 4.3.1
 	  Other.Dep ~> LOCKEDVERSION
 
+It's possible to add a line to constrain the targetFramework:
+
+	dependencies
+	  framework: net45
+	    FSharp.Core 4.3.1
+		My.OtherThing
+	  framework: netstandard11
+		FSharp.Core 4.3.1  
+
+Like that the package is only going to be used by a project >= net45 and for >= netstandard11 it will not use My.OtherThing package. 		
+
 In a project file, the following dependencies will be added:
 
 * any Paket dependency with the range specified in the [`paket.dependencies` file](dependencies-file.html).
diff --git a/src/Paket.Core/Packaging/NupkgWriter.fs b/src/Paket.Core/Packaging/NupkgWriter.fs
@@ -8,6 +8,7 @@ open Paket.Xml
 open System.Text
 open System.Text.RegularExpressions
 open System.Xml
+open Paket.Requirements
 
 module internal NupkgWriter =
 
@@ -93,13 +94,34 @@ module internal NupkgWriter =
                 dep.SetAttributeValue(XName.Get "version", version)
             dep
 
+        let buildGroupNode (framework:FrameworkIdentifier, add) = 
+            let g = XElement(ns + "group")
+            g.SetAttributeValue(XName.Get "targetFramework", framework.ToString())
+            add g
+            g
+
+
+        let buildDependencyNodes (excludedDependencies, add, dependencyList)  =
+            dependencyList
+            |> List.filter (fun (a, _, _) -> Set.contains a excludedDependencies |> not)
+            |> List.map  (fun (a,b,_) -> a,b)
+            |> List.iter (buildDependencyNode >> add)
+
+        let buildDependencyNodesByGroup excludedDependencies add dependencyList framework  =
+            let node = buildGroupNode(framework, add)
+            buildDependencyNodes(excludedDependencies, node.Add, dependencyList)
+
         let buildDependenciesNode excludedDependencies dependencyList =
             if List.isEmpty dependencyList then () else
             let d = XElement(ns + "dependencies")
-            dependencyList
-            |> List.filter (fun d -> Set.contains (fst d) excludedDependencies |> not)
-            |> List.iter (buildDependencyNode >> d.Add)
-            metadataNode.Add d
+            let groups = List.groupBy thirdOf3 dependencyList
+            match groups.Length, fst groups.Head with
+            | (1, None) ->
+                buildDependencyNodes(excludedDependencies, d.Add, dependencyList)
+            | _ -> 
+                groups 
+                |> List.iter (fun  a -> buildDependencyNodesByGroup excludedDependencies d.Add (snd a) (fst a).Value)
+            metadataNode.Add d           
 
         let buildReferenceNode (fileName) =
             let dep = XElement(ns + "reference")
@@ -369,7 +391,7 @@ module NuspecExtensions =
                         references.Groups |> Seq.collect (fun kvp -> 
                         kvp.Value.NugetPackages |> List.choose (fun pkg -> 
                             dependencies.TryGetPackage(kvp.Key,pkg.Name)
-                            |> Option.map (fun verreq -> pkg.Name,verreq.VersionRequirement)))
+                            |> Option.map (fun verreq -> pkg.Name,verreq.VersionRequirement, None)))
                         |> List.ofSeq
                     ) |> Option.defaultValue []
                 let projectInfo, optionalInfo = project.GetTemplateMetadata ()
diff --git a/src/Paket.Core/Packaging/PackageMetaData.fs b/src/Paket.Core/Packaging/PackageMetaData.fs
@@ -107,11 +107,14 @@ let (|Valid|Invalid|) md =
                 Symbols = s }
     | _ -> Invalid
 
-let addDependency (templateFile : TemplateFile) (dependency : PackageName * VersionRequirement) = 
+
+
+let addDependency (templateFile : TemplateFile) (dependency : PackageName * VersionRequirement * FrameworkIdentifier option) = 
     match templateFile with
     | CompleteTemplate(core, opt) -> 
+        let packageName = dependency |> (fun (n,_,_) -> n)
         let newDeps = 
-            match opt.Dependencies |> List.tryFind (fun (n,_) -> n = fst dependency) with
+            match opt.Dependencies |> List.tryFind (fun (n,_,_) -> n = packageName) with
             | None -> dependency :: opt.Dependencies
             | _ -> opt.Dependencies
         { FileName = templateFile.FileName
@@ -253,7 +256,7 @@ let findDependencies (dependenciesFile : DependenciesFile) config platform (temp
                    match core.Version with
                    | Some v -> 
                        let versionConstraint = if lockDependencies || pinProjectReferences then Specific v else Minimum v
-                       PackageName core.Id, VersionRequirement(versionConstraint, getPreReleaseStatus v)
+                       PackageName core.Id, VersionRequirement(versionConstraint, getPreReleaseStatus v), None
                    | None -> failwithf "There was no version given for %s." templateFile.FileName
                | IncompleteTemplate -> 
                    failwithf "You cannot create a dependency on a template file (%s) with incomplete metadata." templateFile.FileName)
@@ -357,7 +360,7 @@ let findDependencies (dependenciesFile : DependenciesFile) config platform (temp
                 | None ->
                     match version with
                     | Some v -> 
-                        np.Name,VersionRequirement.Parse (v.ToString())
+                        np.Name,VersionRequirement.Parse (v.ToString()) , None
                     | None -> 
                         if minimumFromLockFile then
                             let groupName =
@@ -368,7 +371,7 @@ let findDependencies (dependenciesFile : DependenciesFile) config platform (temp
                                 |> Option.map fst
 
                             match groupName with
-                            | None -> np.Name,specificVersionRequirement
+                            | None -> np.Name,specificVersionRequirement, None
                             | Some groupName -> 
                                 let group = lockFile.GetGroup groupName
 
@@ -377,9 +380,9 @@ let findDependencies (dependenciesFile : DependenciesFile) config platform (temp
                                     | Some resolvedPackage -> VersionRequirement(GreaterThan resolvedPackage.Version, getPreReleaseStatus resolvedPackage.Version)
                                     | None -> specificVersionRequirement
 
-                                np.Name,lockedVersion
+                                np.Name,lockedVersion, None
                         else
-                            np.Name,specificVersionRequirement
+                            np.Name,specificVersionRequirement, None
                 | Some groupName ->
                     let dependencyVersionRequirement =
                         if not lockDependencies then
@@ -437,7 +440,8 @@ let findDependencies (dependenciesFile : DependenciesFile) config platform (temp
                         match dependencyVersionRequirement with
                         | Some installed -> installed
                         | None -> failwithf "No package with id '%O' installed in group %O." np.Name groupName
-                    np.Name, dep)
+                     
+                    np.Name, dep, None)
 
         deps
         |> List.fold addDependency withDepsAndIncluded
diff --git a/src/Paket.Core/PaketConfigFiles/TemplateFile.fs b/src/Paket.Core/PaketConfigFiles/TemplateFile.fs
@@ -6,6 +6,7 @@ open System.IO
 open System.Text.RegularExpressions
 open Chessie.ErrorHandling
 open Paket.Domain
+open Paket.Requirements
 
 module private TemplateParser =
     type private ParserState =
@@ -141,7 +142,7 @@ type OptionalPackagingInfo =
       RequireLicenseAcceptance : bool
       Tags : string list
       DevelopmentDependency : bool
-      Dependencies : (PackageName * VersionRequirement) list
+      Dependencies : (PackageName * VersionRequirement * FrameworkIdentifier option) list
       ExcludedDependencies : Set<PackageName>
       ExcludedGroups : Set<GroupName>
       References : string list
@@ -261,45 +262,80 @@ module internal TemplateFile =
         | Some m -> ok m
         | None -> failP file "No description line in paket.template file."
 
+    let private (|Framework|_|) (line:string) =        
+        match line.Trim()  with
+        | String.RemovePrefix "framework:" _ as trimmed -> Some (FrameworkDetection.Extract(trimmed.Replace("framework: ","")))
+        | _ -> None
+
+    let private (|Empty|_|) (line:string) =
+        match line.Trim()  with
+        | _ when String.IsNullOrWhiteSpace line -> Some (Empty line)
+        | String.RemovePrefix "//" _ -> Some (Empty line)
+        | String.RemovePrefix "#" _ -> Some (Empty line)
+        | _ -> None    
+    type TargetFrameworkGroup = 
+        {
+            Framework : FrameworkIdentifier option
+            Dependencies : (PackageName * VersionRequirement * FrameworkIdentifier option) List}
+        static member ForNone = { Framework = None ; Dependencies = [] }
+        static member ForFramework framework = { Framework = framework ; Dependencies = [] }
+   
+    let private getDependencyByLine (fileName, lockFile:LockFile,currentVersion:SemVerInfo option, specificVersions:Map<string, SemVerInfo>, line:string, framework:FrameworkIdentifier option)=      
+        let reg = Regex(@"(?<id>\S+)(?<version>.*)").Match line
+        let name = PackageName reg.Groups.["id"].Value
+        let versionRequirement =
+            let versionString =
+                let s = reg.Groups.["version"].Value.Trim()
+                if s.Contains "CURRENTVERSION" then
+                    match specificVersions.TryFind (string name) with
+                    | Some v -> s.Replace("CURRENTVERSION", string v)
+                    | None ->
+                        match currentVersion with
+                        | Some v -> s.Replace("CURRENTVERSION", string v)
+                        | None -> failwithf "The template file %s contains the placeholder CURRENTVERSION, but no version was given." fileName
+
+                elif s.Contains "LOCKEDVERSION" then
+                    match lockFile.Groups.[Constants.MainDependencyGroup].Resolution |> Map.tryFind name with
+                    | Some p -> s.Replace("LOCKEDVERSION", string p.Version)
+                    | None ->
+                        let packages = 
+                            lockFile.GetGroupedResolution()
+                            |> Seq.filter (fun kv -> snd kv.Key = name)
+                            |> Seq.toList
+
+                        match packages with
+                        | [] -> failwithf "The template file %s contains the placeholder LOCKEDVERSION, but no version was given for package %O in paket.lock." fileName name
+                        | [kv] -> s.Replace("LOCKEDVERSION", string kv.Value.Version)
+                        | _ -> failwithf "The template file %s contains the placeholder LOCKEDVERSION, but more than one group contains package %O in paket.lock." fileName name
+
+                else s
+                                
+            DependenciesFileParser.parseVersionRequirement versionString
+        name, versionRequirement, framework
+
+    let private getDependenciesByTargetFramework fileName lockFile currentVersion  specificVersions  (lineNo, state: TargetFrameworkGroup list) line=
+        match state with
+        | current::other ->
+            let lineNo = lineNo + 1
+            match line with
+            | Framework framework ->
+                let group = TargetFrameworkGroup.ForFramework framework::current::other
+                lineNo, group
+            | Empty  _ -> lineNo, current::other  
+            | _ -> 
+                let dependency = getDependencyByLine(fileName, lockFile, currentVersion, specificVersions, line, current.Framework)
+                lineNo ,{ current with Dependencies = current.Dependencies  @ [dependency] }::other
+        | [] -> failwithf "Error in paket.dependencies line %d" lineNo     
+   
     let private getDependencies (fileName, lockFile:LockFile, info : Map<string, string>,currentVersion:SemVerInfo option, specificVersions:Map<string, SemVerInfo>) =
         match Map.tryFind "dependencies" info with
         | None -> []
         | Some d ->
-            d.Split '\n' 
-            |> Array.map (fun d ->
-                let reg = Regex(@"(?<id>\S+)(?<version>.*)").Match d
-                let name = PackageName reg.Groups.["id"].Value
-                let versionRequirement =
-                    let versionString =
-                        let s = reg.Groups.["version"].Value.Trim()
-                        if s.Contains "CURRENTVERSION" then
-                            match specificVersions.TryFind (string name) with
-                            | Some v -> s.Replace("CURRENTVERSION", string v)
-                            | None ->
-                                match currentVersion with
-                                | Some v -> s.Replace("CURRENTVERSION", string v)
-                                | None -> failwithf "The template file %s contains the placeholder CURRENTVERSION, but no version was given." fileName
-
-                        elif s.Contains "LOCKEDVERSION" then
-                            match lockFile.Groups.[Constants.MainDependencyGroup].Resolution |> Map.tryFind name with
-                            | Some p -> s.Replace("LOCKEDVERSION", string p.Version)
-                            | None ->
-                                let packages = 
-                                    lockFile.GetGroupedResolution()
-                                    |> Seq.filter (fun kv -> snd kv.Key = name)
-                                    |> Seq.toList
-
-                                match packages with
-                                | [] -> failwithf "The template file %s contains the placeholder LOCKEDVERSION, but no version was given for package %O in paket.lock." fileName name
-                                | [kv] -> s.Replace("LOCKEDVERSION", string kv.Value.Version)
-                                | _ -> failwithf "The template file %s contains the placeholder LOCKEDVERSION, but more than one group contains package %O in paket.lock." fileName name
-
-                        else s
-                                        
-                    DependenciesFileParser.parseVersionRequirement versionString
-
-                name, versionRequirement)
-            |> Array.toList
+            d.Split '\n'
+            |> Array.fold (getDependenciesByTargetFramework fileName  lockFile  currentVersion  specificVersions) (0, [TargetFrameworkGroup.ForNone])
+            |> snd
+            |> List.rev
+            |> List.collect (fun a -> a.Dependencies)
         
 
     let private getExcludedDependencies (info : Map<string, string>) =
diff --git a/tests/Paket.Tests/Packaging/NuspecWriterSpecs.fs b/tests/Paket.Tests/Packaging/NuspecWriterSpecs.fs
@@ -7,6 +7,7 @@ open FsUnit
 open NUnit.Framework
 open TestHelpers
 open Paket.Domain
+open Paket.Requirements
 
 [<Test>]
 let ``should serialize core info``() = 
@@ -58,8 +59,89 @@ let ``should serialize dependencies``() =
         { OptionalPackagingInfo.Epmty with 
             Tags = [ "f#"; "rules" ]
             Dependencies = 
-                [ PackageName "Paket.Core", VersionRequirement.Parse "[3.1]"
-                  PackageName "xUnit", VersionRequirement.Parse "2.0" ] }
+                [ PackageName "Paket.Core", VersionRequirement.Parse "[3.1]", None
+                  PackageName "xUnit", VersionRequirement.Parse "2.0", None ] }
+    
+    let doc = NupkgWriter.nuspecDoc (core, optional)
+    doc.ToString() 
+    |> normalizeLineEndings
+    |> shouldEqual (normalizeLineEndings result)
+
+
+[<Test>]
+let ``#913 should serialize dependencies by group``() = 
+    let result = """<package xmlns="http://schemas.microsoft.com/packaging/2011/10/nuspec.xsd">
+  <metadata>
+    <id>Paket.Tests</id>
+    <version>1.0.0.0</version>
+    <authors>Two, Authors</authors>
+    <description>A description</description>
+    <tags>f# rules</tags>
+    <dependencies>
+      <group targetFramework="net35">
+        <dependency id="Paket.Core" version="[3.1.0]" />
+        <dependency id="xUnit" version="2.0.0" />
+      </group>
+    </dependencies>
+  </metadata>
+</package>"""
+
+    let core : CompleteCoreInfo =
+        { Id = "Paket.Tests"
+          Version = SemVer.Parse "1.0.0.0" |> Some
+          Authors = [ "Two"; "Authors" ]
+          Description = "A description"
+          Symbols = false }
+    
+    let optional = 
+        { OptionalPackagingInfo.Epmty with 
+            Tags = [ "f#"; "rules" ]
+            Dependencies = 
+                [ PackageName "Paket.Core", VersionRequirement.Parse "[3.1]", Some(FrameworkIdentifier.DotNetFramework(FrameworkVersion.V3_5))
+                  PackageName "xUnit", VersionRequirement.Parse "2.0", Some(FrameworkIdentifier.DotNetFramework(FrameworkVersion.V3_5)) ] }
+    
+    let doc = NupkgWriter.nuspecDoc (core, optional)
+    doc.ToString() 
+    |> normalizeLineEndings
+    |> shouldEqual (normalizeLineEndings result)
+
+[<Test>]
+let ``#913 should serialize dependencies by group with 2 group``() = 
+    let result = """<package xmlns="http://schemas.microsoft.com/packaging/2011/10/nuspec.xsd">
+  <metadata>
+    <id>Paket.Tests</id>
+    <version>1.0.0.0</version>
+    <authors>Two, Authors</authors>
+    <description>A description</description>
+    <tags>f# rules</tags>
+    <dependencies>
+      <group targetFramework="net35">
+        <dependency id="Paket.Core" version="[3.1.0]" />
+        <dependency id="xUnit" version="2.0.0" />
+      </group>
+      <group targetFramework="netstandard13">
+        <dependency id="Paket.Core" version="[3.1.0]" />
+        <dependency id="xUnit" version="2.0.0" />
+      </group>
+    </dependencies>
+  </metadata>
+</package>"""
+
+    let core : CompleteCoreInfo =
+        { Id = "Paket.Tests"
+          Version = SemVer.Parse "1.0.0.0" |> Some
+          Authors = [ "Two"; "Authors" ]
+          Description = "A description"
+          Symbols = false }
+    
+    let optional = 
+        { OptionalPackagingInfo.Epmty with 
+            Tags = [ "f#"; "rules" ]
+            Dependencies = 
+                [ PackageName "Paket.Core", VersionRequirement.Parse "[3.1]", Some(FrameworkIdentifier.DotNetFramework(FrameworkVersion.V3_5))
+                  PackageName "xUnit", VersionRequirement.Parse "2.0", Some(FrameworkIdentifier.DotNetFramework(FrameworkVersion.V3_5))
+                  PackageName "Paket.Core", VersionRequirement.Parse "[3.1]", Some(FrameworkIdentifier.DotNetStandard(DotNetStandardVersion.V1_3))
+                  PackageName "xUnit", VersionRequirement.Parse "2.0", Some(FrameworkIdentifier.DotNetStandard(DotNetStandardVersion.V1_3)) ] }
     
     let doc = NupkgWriter.nuspecDoc (core, optional)
     doc.ToString() 
diff --git a/tests/Paket.Tests/Packaging/TemplateFileParsing.fs b/tests/Paket.Tests/Packaging/TemplateFileParsing.fs
