Skip to content
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.

Sign up for GitHub

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

Auto-generate F# program file #1664

Merged
merged 7 commits into from
Jul 10, 2018
Merged

Auto-generate F# program file #1664

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
72cdfdc
Auto-generate F# program file
saul Jun 29, 2018
4e68110
Update Microsoft.NET.Test.Sdk.targets
saul Jun 29, 2018
13f4d46
Update Microsoft.NET.Test.Sdk.targets
saul Jun 29, 2018
ba470a5
Don't generate a Program.fs if one already exists.
saul Jul 4, 2018
6e1aa3c
Merge branch 'master' into patch-1
saul Jul 4, 2018
c888e5b
Merge branch 'master' into patch-1
smadala Jul 5, 2018
c33be0e
Merge branch 'master' into patch-1
singhsarab Jul 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions src/package/nuspec/Microsoft.NET.Test.Sdk.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
Condition="'$(GenerateProgramFile)' == 'true'" />

<Target Name="CoreGenerateProgramFile"
Condition="'$(Language)'=='VB' or '$(Language)'=='C#'"
Condition="'$(Language)'=='VB' or '$(Language)'=='C#' or '$(Language)'=='F#'"
Inputs="$(MSBuildAllProjects)"
Outputs="$(GeneratedProgramFile)">

Expand All @@ -76,15 +76,26 @@
<Line Include="End Sub"/>
<Line Include="End Module"/>
</ItemGroup>

<ItemGroup Condition="'$(Language)'=='F#'">
<Line Include="module Program"/>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will fail if another module is named Program. It would probably be better to do something like

module ``VSTest-AutoGenerated-Program``

It can still have collisions, but way less likely. Also, both the C# and the VB version is decorated with TestSDKAutoGeneratedCodeAttribute which is probably a good idea.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch - I'll fix that.

<Line Include="[&lt;EntryPoint&gt;]"/>
<Line Include="let main _ = 0"/>
</ItemGroup>

<WriteLinesToFile
File="$(GeneratedProgramFile)" Lines="@(Line)" Overwrite="true" Encoding="Unicode">
</WriteLinesToFile>

<!--
Compile Include the generated Program File
-->
<ItemGroup>
<ItemGroup Condition="'$(Language)'!='F#'">
<Compile Include="$(GeneratedProgramFile)"/>
</ItemGroup>

<ItemGroup Condition="'$(Language)'=='F#'">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure runtimeconfig.*.json will gets generates because CompileAfter?
FYI dotnet/sdk#201 #287.

@saul did you test simple unit test project of F# with your changes?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I understood what is CompileAfter. Now it makes sense after reading issue one more time.

I have checked out your branch and verified E2E scenario. Below are the issue we need to address.

  • Newly created F# unit test project not getting compiled because of below compilation error.
PS C:\Users\samadala\tmp\fs-test-project> dotnet test
Build started, please wait...
C:\Users\samadala\tmp\fs-test-project\Program.fs(1,1): error FS0222: Files in libraries or multiple-file applications must begin with a namespace or module declaration. When using a module declaration at the start of a file the '=' sign is not allowed. If this is a top-level module, consider removing the = to resolve this error. [C:\Users\samadala\tmp\fs-test-project\fs-test-project.fsproj]

This can be fixed by removing <Compile Include="Program.fs" /> from template fsproj here and removing Program.fs, We can address this with separate https://github.com/dotnet/templating PR

  • Test project created with old templates fail to compile with above error on updating to latest Microsoft.NET.Test.Sdk package.

This can be fixed by adding check here that don't include GeneratedProgramFile in CompileAfter if Compile item group contains Program.fs.

@saul Can you please fix the seconds issue in this PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @smadala - I've fixed the second problem.

I've added a warning: A 'Program.fs' file can be automatically generated for F# .NET Core test projects. To fix this warning, either delete the file from the project, or set the <GenerateProgramFile> property to 'false'.

This lets the user either remove their Program.fs, or disables <GenerateProgramFile> if they need a complex Program.fs for whatever reason.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@saul Adding warning is very good idea.

<CompileAfter Include="$(GeneratedProgramFile)"/>
</ItemGroup>
</Target>
</Project>