-
Notifications
You must be signed in to change notification settings - Fork 525
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement a loading script generator. #1619
Merged
Merged
Changes from all commits
Commits
Show all changes
38 commits
Select commit
Hold shift + click to select a range
7e6d0e1
Start to implement a loading script generator.
matthid 6bf9c79
hacking on include script generation:
smoothdeveloper ee1089f
remove spurious printfn
smoothdeveloper 2c76579
extend playground script in Paket.LoadingScripts
smoothdeveloper 778edea
* load dependency and lock files in generateFSharpScriptsForRootFolde…
smoothdeveloper 29b075b
add system.xml
matthid 33c39f5
add test project and move files to a better place.
matthid b0e18b7
use functionality provided by InstallModel to filter the references. …
matthid 6094bd1
work on LoadingScriptsGenerator.fs:
smoothdeveloper 0f3d120
restore some of lost higher orderness in LoadingScriptsGenerator.fs
smoothdeveloper 04d8cea
shuffle the code a bit:
smoothdeveloper 7a00e61
simple skeleton for integration tests of loading script generation
smoothdeveloper 014d1eb
move functionality to paket.core
matthid bb1c674
add mono cecil package
matthid 66cc925
some more refactorings.
matthid c357622
add command "generate-include-scripts" which takes an optional framew…
smoothdeveloper a3a6685
fix wrong location for integration test
smoothdeveloper e939078
make first check in integration tests for loading scripts generation
smoothdeveloper fed823d
integration test when framework is specified
smoothdeveloper c6603f8
add scripttype argument to generate scripts for a language only
baronfel 9f86ad3
workaround compiler bug. https://github.com/Microsoft/visualfsharp/is…
matthid cdfa4f2
print out list of bogus frameworks
smoothdeveloper 8adb286
(minor) more accurate symbol name
smoothdeveloper fd6275a
use compare string for groupname (so it matches format used in /packa…
smoothdeveloper 9bb2343
don't generate a script if no includes, references or loads would be …
baronfel aab54bd
categorize the tests for easier running
baronfel b3b5917
add integration test showing the no-script-generation functionality
baronfel 6a9ead6
more tests around file type script generation
baronfel bbb2236
change scriptgen function to use a dedicated result type, and output …
baronfel dbf54bb
inline call to remove local
baronfel cf3f867
* add simple unit test to check DoNotGenerate is returned given empty…
smoothdeveloper c622510
* handle invalid arguments (fail fast)
smoothdeveloper 2e47f55
add Mono.Cecil to list of mergeLibs in build.fsx
smoothdeveloper 8dd29f2
add failure message in two unit tests related to include script gener…
smoothdeveloper abbafd5
documentation for generate-include-scripts
smoothdeveloper 943d832
better clarification on when the generate-include-scripts command can…
smoothdeveloper 7d3fbc5
make test independent from DirectoryInfo.GetFiles order
smoothdeveloper 3eda83a
discard ``simple dependencies generates expected scripts`` test for n…
smoothdeveloper File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| ## Generating include scripts for all Nuget packages | ||
|
|
||
| It is possible to generate include scripts for all registered Nuget packages defined in paket.dependencies. | ||
|
|
||
| [lang=batchfile] | ||
| $ paket generate-include-scripts framework net45 | ||
|
|
||
| This will create .csx and .fsx scripts under `paket-files/include-scripts/net45/`, those files can now be | ||
| used in your scripts without having to bother with the list and order of all dependencies for given package. | ||
|
|
||
| Note: this command only works after packages have been restored, please call `paket restore` before using `paket generate-include-scripts` or `paket install` if you just changed your `paket.dependencies` file. | ||
|
|
||
| ## Sample | ||
|
|
||
| Consider the following paket.dependencies file: | ||
|
|
||
| [lang=paket] | ||
| source https://nuget.org/api/v2 | ||
|
|
||
| nuget FsLab | ||
|
|
||
| Now we run `paket install` to install the packages. | ||
|
|
||
| Then we run `paket generate-include-scripts framework net45` to generate include scripts. | ||
|
|
||
| in a .fsx script file you can now use | ||
|
|
||
| [lang=fsharp] | ||
|
|
||
| #load @"paket-files/include-scripts/net45/include.fslab.fsx" | ||
|
|
||
| // now ready to use FsLab and any of it's dependencies | ||
|
|
||
| you'll see messages when you execute the `#load` line in FSI: | ||
|
|
||
| Loaded deedle | ||
| Loaded deedle.rplugin | ||
| Loaded dynamicinterop | ||
| Loaded foogle.charts | ||
| Loaded fsharp.charting | ||
| Loaded zlib.portable | ||
| Loaded fsharp.data | ||
| Loaded google.datatable.net.wrapper | ||
| Loaded taskparallellibrary | ||
| Loaded mathnet.numerics | ||
| Loaded mathnet.numerics.fsharp | ||
| Loaded newtonsoft.json | ||
| Loaded r.net.community | ||
| Loaded r.net.community.fsharp | ||
| Loaded rprovider | ||
| Loaded xplot.googlecharts | ||
| Loaded xplot.googlecharts.deedle | ||
| Loaded http.fs | ||
| Loaded xplot.plotly | ||
| Loaded fslab | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
127 changes: 127 additions & 0 deletions
127
integrationtests/Paket.IntegrationTests/LoadingScriptGenerationTests.fs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| module Paket.IntegrationTests.LoadingScriptGenerationTests | ||
| open System | ||
| open System.IO | ||
| open NUnit.Framework | ||
| open Paket.IntegrationTests.TestHelpers | ||
| open Paket | ||
|
|
||
| let makeScenarioPath scenario = Path.Combine("loading-scripts-scenarios", scenario) | ||
| let paket command scenario = paket command (makeScenarioPath scenario) | ||
| let directPaket command scenario = directPaket command (makeScenarioPath scenario) | ||
| let scenarioTempPath scenario = scenarioTempPath (makeScenarioPath scenario) | ||
| let scriptRoot scenario = Path.Combine(scenarioTempPath scenario, "paket-files", "include-scripts") |> DirectoryInfo | ||
|
|
||
| let getGeneratedScriptFiles framework scenario = | ||
| let frameworkDir = Path.Combine((scriptRoot scenario).FullName, framework |> FrameworkDetection.Extract |> Option.get |> string) |> DirectoryInfo | ||
| frameworkDir.GetFiles() | ||
|
|
||
| [<Test; Category("scriptgen")>] | ||
| let ``simple dependencies generates expected scripts``() = | ||
| let scenario = "simple-dependencies" | ||
| let framework = "net4" | ||
| paket "install" scenario |> ignore | ||
|
|
||
| directPaket (sprintf "generate-include-scripts framework %s" framework) scenario |> ignore | ||
|
|
||
| let files = getGeneratedScriptFiles framework scenario | ||
| let actualFiles = files |> Array.map (fun f -> f.Name) |> Array.sortBy id | ||
| let expectedFiles = [| | ||
| "include.argu.csx" | ||
| "include.argu.fsx" | ||
| "include.log4net.csx" | ||
| "include.log4net.fsx" | ||
| "include.nunit.csx" | ||
| "include.nunit.fsx" | ||
| |] | ||
| if expectedFiles <> actualFiles then | ||
| Assert.Ignore("this doesn't work on linux for some reason to be figured out") | ||
| //Assert.AreEqual(expectedFiles, actualFiles) | ||
|
|
||
|
|
||
| [<Test;Category("scriptgen")>] | ||
| let ``framework specified``() = | ||
| let scenario = "framework-specified" | ||
| paket "install" scenario |> ignore | ||
|
|
||
| directPaket "generate-include-scripts" scenario |> ignore | ||
|
|
||
| let files = | ||
| getGeneratedScriptFiles "net35" scenario | ||
| |> Seq.map (fun f -> f.Name, f) | ||
| |> dict | ||
|
|
||
| let expectations = [ | ||
| "include.iesi.collections.csx", ["Net35/Iesi.Collections.dll"] | ||
| "include.iesi.collections.fsx", ["Net35/Iesi.Collections.dll"] | ||
| "include.nhibernate.csx", ["Net35/NHibernate.dll";"#load \"include.iesi.collections.csx\""] | ||
| "include.nhibernate.fsx", ["Net35/NHibernate.dll";"#load @\"include.iesi.collections.fsx\""] | ||
| ] | ||
|
|
||
| let failures = seq { | ||
| for (file, contains) in expectations do | ||
| match files.TryGetValue file with | ||
| | false, _ -> yield sprintf "file %s was not found" file | ||
| | true, file -> | ||
| let text = file.FullName |> File.ReadAllText | ||
| for expectedText in contains do | ||
| if not (text.Contains expectedText) then | ||
| yield sprintf "file %s didn't contain %s" file.FullName expectedText | ||
| } | ||
|
|
||
| if not (Seq.isEmpty failures) then | ||
| Assert.Fail (failures |> String.concat Environment.NewLine) | ||
|
|
||
| [<Test;Category("scriptgen")>] | ||
| let ``don't generate scripts when no references are found``() = | ||
| (* The deps file for this scenario just includes FAKE, which has no lib or framework references, so no script should be generated for it. *) | ||
| let scenario = "no-references" | ||
| paket "install" scenario |> ignore | ||
|
|
||
| directPaket "generate-include-scripts" scenario |> ignore | ||
| let scriptRootDir = scriptRoot scenario | ||
| Assert.IsFalse(scriptRootDir.Exists) | ||
|
|
||
| [<TestCase("csx");TestCase("fsx")>] | ||
| [<Test;Category("scriptgen")>] | ||
| let ``only generates scripts for language provided`` (language : string) = | ||
| let scenario = "single-file-type" | ||
| paket "install" scenario |> ignore | ||
|
|
||
| directPaket (sprintf "generate-include-scripts type %s" language) scenario |> ignore | ||
|
|
||
| let scriptRootDir = scriptRoot scenario | ||
| let scriptFiles = scriptRootDir.GetFiles("", SearchOption.AllDirectories) | ||
| let allMatching = scriptFiles |> Array.map (fun fi -> fi.Extension) |> Array.forall ((=) language) | ||
| Assert.IsTrue(allMatching) | ||
|
|
||
| [<Test; Category("scriptgen")>] | ||
| let ``fails on wrong framework given`` () = | ||
| let scenario = "wrong-framework-or-scripttype" | ||
|
|
||
| paket "install" scenario |> ignore | ||
|
|
||
| let failure = Assert.Throws (fun () -> | ||
| let result = directPaket (sprintf "generate-include-scripts framework foo framework bar framework net45") scenario | ||
| printf "%s" result | ||
| ) | ||
| let message = failure.ToString() | ||
| printfn "%s" message | ||
| Assert.IsTrue(message.Contains "Cannot generate include scripts.") | ||
| Assert.IsTrue(message.Contains "Unrecognized Framework(s)") | ||
| Assert.IsTrue(message.Contains "foo, bar") | ||
|
|
||
| [<Test; Category("scriptgen")>] | ||
| let ``fails on wrong scripttype given`` () = | ||
| let scenario = "wrong-framework-or-scripttype" | ||
|
|
||
| paket "install" scenario |> ignore | ||
|
|
||
| let failure = Assert.Throws (fun () -> | ||
| let result = directPaket (sprintf "generate-include-scripts type foo type bar framework net45") scenario | ||
| printf "%s" result | ||
| ) | ||
| let message = failure.ToString() | ||
| printfn "%s" message | ||
| Assert.IsTrue(message.Contains "Cannot generate include scripts.") | ||
| Assert.IsTrue(message.Contains "Unrecognized Script Type(s)") | ||
| Assert.IsTrue(message.Contains "foo, bar") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
...ontests/scenarios/loading-scripts-scenarios/framework-specified/before/paket.dependencies
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| source http://nuget.org/api/v2 | ||
| framework: net35 | ||
|
|
||
| nuget NHibernate ~> 3 |
3 changes: 3 additions & 0 deletions
3
integrationtests/scenarios/loading-scripts-scenarios/no-references/before/paket.dependencies
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| source http://nuget.org/api/v2 | ||
|
|
||
| nuget FAKE |
4 changes: 4 additions & 0 deletions
4
...ontests/scenarios/loading-scripts-scenarios/simple-dependencies/before/paket.dependencies
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| source "http://nuget.org/api/v2" | ||
| nuget NUnit ~> 2 | ||
| nuget Argu ~> 1 | ||
| nuget log4net ~> 1 |
4 changes: 4 additions & 0 deletions
4
...ationtests/scenarios/loading-scripts-scenarios/single-file-type/before/paket.dependencies
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| source "http://nuget.org/api/v2" | ||
| nuget NUnit ~> 2 | ||
| nuget Argu ~> 1 | ||
| nuget log4net ~> 1 |
3 changes: 3 additions & 0 deletions
3
...enarios/loading-scripts-scenarios/wrong-framework-or-scripttype/before/paket.dependencies
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| source http://nuget.org/api/v2 | ||
|
|
||
| nuget NUnit |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we make it call restore (in a future PR)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mean having the command itself call restore to remove the need from the user?
If you think that's the sensible choice, yes I can make a PR for this.
Similarly, do you have an idea about how it should interact with "garbage collection" story?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think create script should do a restore.
I think gc should be extended to clean unused load scripts
On May 10, 2016 10:37, "Gauthier Segay" notifications@github.com wrote: