Add a Linux build menu #1830

lillo42 · 2018-08-22T02:35:36Z

Hi,

In this PR I'm improving linux support to debug.

I've tested on Ubuntu with IDE Jetbrains Rider, I tried to test on Fedora but I had some problem to run NUnit, the test neve begin.

Add ShowBuildMenu.sh
Modify BuildTool
Modify ShowBuildMenu.bat

I create a new file ShowBuildMenu.sh , this file is similar to ShowBuildMenu.bat, but with less function because I think some function are not useful to linux environment, today with this file is possible create and activated a new Database, build and execute test.

I recreated BuildTool to .NET Core and change ShowBuildMenu.bat to use this project, now to debug on Windows is necessary .NET Core installed

hazzik · 2018-08-22T02:39:20Z

build-common/NHibernate.props

@@ -10,8 +10,10 @@
    <AssemblyVersion>$(VersionMajor).$(VersionMinor).0.0</AssemblyVersion>
    <FileVersion>$(VersionPrefix).0</FileVersion>

-    <NhAppTargetFrameworks>net461;netcoreapp2.0</NhAppTargetFrameworks>
-    <NhLibTargetFrameworks>net461;netcoreapp2.0;netstandard2.0</NhLibTargetFrameworks>
+    <NhAppTargetFrameworks Condition="'$(OS)' == 'Windows_NT'">net461;netcoreapp2.0</NhAppTargetFrameworks>


What is the point of this change? I can debug net461 without problems on my non windows laptop. These days I rarely run Windows at all.

Really? Every time I try to build Nhiberte fail, says I don’t have .Net Framework 4.6.1

Have you installed Mono on your laptop? I didn’t try to install mono

Yes, I do have mono.

To debug NHibernate on Linux , Should be necessary install mono?

… README.md, it's necessery install mono if you is debug on Linux

fredericDelaporte

I am currently testing working under Linux (Debian 9, Stretch).
I have done it only with master current state so far. I will likely update your branch to test it soon.

Some notes about my tests so far:
Under my setup, trying to load the nhibernate-core folder under VS Code triggers failures in Omnisharp (extension required for having basic C# support) if NHibernate project has not been already externally compiled. It tries to compile it but fails loading the ANTLR task. Otherwise once compiled externally, it seems to work.
Compiling under Rider fails on a clean project but succeed when launched a second time, then does no more fail. The failure is due to ANTLR build task too, but this time that is some kind of internal error in the build task: it fails finding some files it is supposed to have generated.

fredericDelaporte · 2018-10-10T10:08:51Z

README.md

+
+If you want to debug NHibernate on Linux, I need install [mono](https://www.mono-project.com/download/stable/)
+
+


Development information is in Contributing.md. I think this should be moved in this other file, likely in "Setting up For Development" section.

Maybe also reword to something like:

Compiling the solution under Linux requires installation of [Mono](https://www.mono-project.com/download/stable) and of the [.NET Core SDK](https://www.microsoft.com/net/download).

fredericDelaporte · 2018-10-10T11:04:49Z

src/NHibernate/NHibernate.csproj

    <PackageReference Include="System.Configuration.ConfigurationManager" Version="4.4.1" />
-    <PackageReference Include="System.Security.Permissions" Version="4.4.1" />


Changes to this files are undue. But merging master in this PR branch should remove them.

fredericDelaporte · 2018-10-10T11:29:08Z

ShowBuildMenu.sh

+	echo "B. Add a test configuration for Firebird."
+	echo "C. Add a test configuration for SQLite."
+	echo "D. Add a test configuration for PostgreSQL."
+	echo "E. Add a test configuration for Oracle(NOT Support yet)."


Better remove unsupported databases.

fredericDelaporte · 2018-10-10T11:31:09Z

ShowBuildMenu.sh

+	echo  "."
+	echo  "--- BUILD ---"
+	echo  "D. Build NHibernate (Debug)"
+	echo  "E. Build NHibernate (Release)"


Since the Contributing.md files references the test menu options by letters, better keep the same letters.

ShowBuildMenu.sh

+	echo  "E. Build NHibernate (Release)"
+	echo  "."
+	echo  "--- Exit ---"
+	echo  "X. Make the beautiful build menu go away."


fredericDelaporte · 2018-10-10T17:32:58Z

.editorconfig

@@ -31,3 +31,6 @@ indent_size = 2
 [*.cshtml]
 indent_style = space
 indent_size = 4
+
+[*.sh]
+end_of_line = LF


Otherwise code editors wrecks the sh file by switching it to CRLF. But maybe we should instead remove end_of_line = CRLF from the start of this file. Normally, this is handled by the .gitattributes file (text=auto) anyway.

Yes, this needs to be in the .gitattributes, but not in for of text=auto (but rather an explicit)

fredericDelaporte · 2018-10-10T17:34:57Z

ShowBuildMenu.sh

+	echo "B. Add a test configuration for Firebird."
+	echo "C. Add a test configuration for SQLite."
+	echo "D. Add a test configuration for PostgreSQL."
+	echo "E. Add a test configuration for SQL Server Compact."


Can SQL Server CE run? It fails on my setup, when tried with Mono. If no one can get it working, we would have better removing it from the menu.

I made a search if is possible run SQL Server CE on Linux, it isn't possible run SQL Server CE:
Stack Overflow

fredericDelaporte · 2018-10-10T17:36:21Z

ShowBuildMenu.sh

+
+testRun(){
+	eval "dotnet test ./src/NHibernate.Test/NHibernate.Test.csproj" -f netcoreapp2.0
+	eval "dotnet test ./src/NHibernate.Test.VisualBasic/NHibernate.Test.VisualBasic.vbproj" -f netcoreapp2.0


Limiting tests to netcoreapp2.0. On Windows, we do limit them to net461 when launched from the build menu.

Why? Isn't better run the tests with netcoreapp2.0 and net461?

Mono has issues running all the NHibernate tests. Many of them always fail with Mono.

Tools/BuildTool/BuildTool.csproj

-    <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
-    <TargetFrameworkProfile>Client</TargetFrameworkProfile>
-    <FileAlignment>512</FileAlignment>
+    <TargetFramework>netcoreapp2.0</TargetFramework>


Remove SQL Server CE from .sh

fredericDelaporte · 2018-10-11T11:42:03Z

ShowBuildMenu.bat

-set BUILD_TOOL_SLN_PATH=%~dp0Tools\BuildTool\BuildTool.sln
-set BUILDTOOL=dotnet run -p %BUILD_TOOL_PATH% -c Release --no-build
+set BUILD_TOOL_PATH=%~dp0Tools\BuildTool\bin\BuildTool.dll
+set BUILDTOOL=dotnet %BUILD_TOOL_PATH%


Be it under Linux or Windows, I was noticing a lag in the build menu for displaying the letter choices prompt. And there was also a startup lag due to relaunching the build.

There were also some differences in the way the build tool was handled between Linux and Windows, without me seeing why they would need to be differently handled.

So I have changed the logic for building only if the binary is not already there, and for running directly the binary (dotnet pathOfBinary) instead of running the project from sources (dotnet run pathToSrc).

This eliminates the lag in the build menu both under Linux and Windows.

For simplicity, I have redirected the build output directly in the bin folder instead of letting it go into Release\netcoreapp2.0.

Let Git handle that, it does a better job of putting the right eol according to the target OS. (editorconfig could have got the option, but this was unfortunately rejected: editorconfig/editorconfig#226)

Unfortunately, async generator fails running on my setup.

It needs it in some case under Windows, better do it under Linux too

fredericDelaporte · 2018-10-11T16:09:31Z

I have added the async generator option.
I am still unable to get it run "out of the box" on my setup, but maybe someone else could see what is wrong, if anything, with the way I am launching it.
I have tried with versions 0.8.2.8, 0.8.2.9, 0.8.2.10 and 0.13.0, all do fail with the same error, being unable to load SQLitePCLRaw.core dependency, seemingly coming from Microsoft.CodeAnalysis.Workspaces.Common, although the generator is supposed to depend on 2.7.0 version of Microsoft.CodeAnalysis.Workspaces.Common while this SQLite dependency seems to be there only since 2.9.2 version.

But when inspecting the 2.7.0 assembly with ILSpy, it actually already depends on it. Manually adding the assembly in the async generator folder solves the trouble.

So it seems this thing is a somewhat "rogue" dependency causing issues only on some setup (Mono version maybe?), and using latest Microsoft.CodeAnalysis.Workspaces.Common versions should solve it since it now explicitly depends on it.

For now I have added a hack for including it in the async generator directory.

In other words, this script now works for launching the async generator, but it would be better to not need the SQLitePCLRaw hack it has.

fredericDelaporte · 2018-10-11T16:11:49Z

Tools/.gitignore

+gitreleasemanager.*
+SQLitePCLRaw.core.*


Required for the Linux/Mono hack I have used to get async generator running.

fredericDelaporte · 2018-10-11T16:16:42Z

ShowBuildMenu.sh

+		wget https://dist.nuget.org/win-x86-commandline/latest/nuget.exe
+	fi
+
+	async_generator_path="CSharpAsyncGenerator.CommandLine.$(cat packages.config | grep id=\"CSharpAsyncGenerator.CommandLine | cut -d\" -f4)/tools"


Hack for parsing the async generator version out of the packages.config file:

Output the content of packages.config

Filter out any line not containing id=\"CSharpAsyncGenerator.CommandLine

Split the remaining line(s) by " and take the fourth string resulting of the split

If you know a better way, of course propose it.
I need it to build the path to the async generator version we have to use.

hazzik · 2018-10-15T02:18:14Z

CONTRIBUTING.md

@@ -20,7 +20,7 @@ The main GitHub repository is at [https://github.com/nhibernate/nhibernate-core]

 ## The Build Menu

-**ShowBuildMenu.bat** will be your friend throughout this journey. He's easiest to work with if you make his box bigger by following these steps: 
+**ShowBuildMenu.bat** will be your friend throughout this journey. A .sh version exists for Linux. He's easiest to work with if you make his box bigger by following these steps: 


Why ShowBuildMenu.bat is referenced as "He"? Shouldn't it be "It"?

hazzik · 2018-10-15T02:24:58Z

ShowBuildMenu.sh

+
+	if [ ! -d $async_generator_path ]
+	then
+		eval "mono nuget.exe install"


Just nuget install should be enough. (Without ".exe", and at least in my installation).

lillo42 and others added 12 commits July 30, 2018 22:03

Update lib

f587f55

building project on Rider

1c511f6

Update Show

4d34da6

Merge branch 'master' into linux-support

14a9ffd

improve problem to setup active database

6a69d95

Improve windows bat

2d7f706

improve on ShowBuildMenu.sh

a4dcfc3

Remove build.cake

843c4e7

improve script

144497c

Improve sh

55af57b

Rollback some change

f812725

Remove unused file

7794b4a

hazzik reviewed Aug 22, 2018

View reviewed changes

lillo42 added 5 commits August 31, 2018 22:07

Fix problem on file ShowBuildMenu.sh

3e1c4c1

Remove Windows condicional on NHibernate.props and add information in…

0578804

… README.md, it's necessery install mono if you is debug on Linux

roll back some files

4b7ca0c

roll back IInterceptor.cs

15211bd

Roll back some files

1d71022

lillo42 changed the title ~~Add Linux support to debug~~ Improve linux support to debug Sep 1, 2018

hazzik added 2 commits September 14, 2018 13:16

Revert files

606dff5

Reduce verbosity on build tool

58a0898

fredericDelaporte reviewed Oct 10, 2018

View reviewed changes

fredericDelaporte and others added 2 commits October 10, 2018 14:48

Merge branch 'master' into linux-support

b9889a7

Fix sh build-menu

78d22df

fredericDelaporte changed the title ~~Improve linux support to debug~~ Add a Linux build menu Oct 10, 2018

fredericDelaporte added 3 commits October 10, 2018 16:31

Move linux instructions to contributing.md

1ccbbc5

Cleanup of buildtool refactoring

91084ca

Fix test option of Linux build menu

170281b

fredericDelaporte reviewed Oct 10, 2018

View reviewed changes

Update ShowBuildMenu.sh

913908b

Remove SQL Server CE from .sh

fredericDelaporte added 3 commits October 11, 2018 11:12

Merge branch 'master' into linux-support

7813826

Adjust SQL Server CE removal

e484a61

Avoid recompiling buildtool

13e3d20

fredericDelaporte reviewed Oct 11, 2018

View reviewed changes

fredericDelaporte added 5 commits October 11, 2018 17:07

Remove editor config forcing windows endline

f5d6177

Let Git handle that, it does a better job of putting the right eol according to the target OS. (editorconfig could have got the option, but this was unfortunately rejected: editorconfig/editorconfig#226)

Add async generator option

31ec297

Unfortunately, async generator fails running on my setup.

Add solution restore in async generator option

0452514

It needs it in some case under Windows, better do it under Linux too

Fix innocuous typo

bb3263a

Fix missing hidden dependency

150123a

fredericDelaporte reviewed Oct 11, 2018

View reviewed changes

Adjust contributing about Mono

f9c8116

fredericDelaporte previously approved these changes Oct 13, 2018

View reviewed changes

fredericDelaporte added t: New Feature c: Tests p: Minor labels Oct 14, 2018

fredericDelaporte added this to the 5.2 milestone Oct 14, 2018

hazzik reviewed Oct 15, 2018

View reviewed changes

hazzik previously approved these changes Oct 15, 2018

View reviewed changes

Do minor adjustments

91b0e3a

fredericDelaporte dismissed stale reviews from hazzik and themself via 91b0e3a October 15, 2018 08:00

Remove all eval

32c21ff

fredericDelaporte approved these changes Oct 15, 2018

View reviewed changes

Merge branch 'master' into linux-support

28b9443

fredericDelaporte merged commit baee90e into nhibernate:master Oct 15, 2018

fredericDelaporte added the r: Fixed label Oct 15, 2018

lillo42 deleted the linux-support branch October 28, 2018 00:38

maca88 mentioned this pull request Feb 26, 2019

Fix travis build maca88/AsyncGenerator#120

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a Linux build menu #1830

Add a Linux build menu #1830

lillo42 commented Aug 22, 2018 •

edited

Loading

hazzik Aug 22, 2018 •

edited

Loading

lillo42 Aug 22, 2018

hazzik Aug 22, 2018

lillo42 Aug 22, 2018

fredericDelaporte left a comment

fredericDelaporte Oct 10, 2018

fredericDelaporte Oct 10, 2018

fredericDelaporte Oct 10, 2018

fredericDelaporte Oct 10, 2018

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

fredericDelaporte Oct 10, 2018

hazzik Oct 10, 2018

fredericDelaporte Oct 10, 2018 •

edited

Loading

lillo42 Oct 11, 2018

fredericDelaporte Oct 10, 2018

lillo42 Oct 11, 2018

fredericDelaporte Oct 11, 2018

This comment was marked as resolved.

fredericDelaporte Oct 11, 2018 •

edited

Loading

fredericDelaporte commented Oct 11, 2018 •

edited

Loading

fredericDelaporte Oct 11, 2018

fredericDelaporte Oct 11, 2018

hazzik Oct 15, 2018

fredericDelaporte Oct 15, 2018

hazzik Oct 15, 2018


		If you want to debug NHibernate on Linux, I need install [mono](https://www.mono-project.com/download/stable/)

		<PackageReference Include="System.Configuration.ConfigurationManager" Version="4.4.1" />
		<PackageReference Include="System.Security.Permissions" Version="4.4.1" />

		gitreleasemanager.*
		SQLitePCLRaw.core.*

Add a Linux build menu #1830

Add a Linux build menu #1830

Conversation

lillo42 commented Aug 22, 2018 • edited Loading

hazzik Aug 22, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fredericDelaporte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fredericDelaporte Oct 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

fredericDelaporte Oct 11, 2018 • edited Loading

Choose a reason for hiding this comment

fredericDelaporte commented Oct 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lillo42 commented Aug 22, 2018 •

edited

Loading

hazzik Aug 22, 2018 •

edited

Loading

fredericDelaporte Oct 10, 2018 •

edited

Loading

fredericDelaporte Oct 11, 2018 •

edited

Loading

fredericDelaporte commented Oct 11, 2018 •

edited

Loading