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

Building VFS for Git in 2024 #1804

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Building VFS for Git in 2024 #1804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7ac109d
README: update Windows SDK version expected
derrickstolee Feb 15, 2024
adb77f7
README: VS 2017 no longer available, use 2019 instructions
derrickstolee Feb 15, 2024
2eea62f
README: Build script was renamed
derrickstolee Feb 15, 2024
a62e935
README: test instructions
derrickstolee Feb 15, 2024
db36e37
Version.props: New version number
derrickstolee Feb 15, 2024
1b300b0
GVFSVerb: strip commit id from version, if it exists
derrickstolee Feb 15, 2024
76aa6ce
GVFSVerb: Use core.fsmonitor=false
derrickstolee Feb 15, 2024
d3ff2fa
Tests: disable/redirect tests that no longer work
derrickstolee Feb 15, 2024
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
5 changes: 4 additions & 1 deletion GVFS/GVFS.FunctionalTests/Tests/EnlistmentPerFixture/GitCorruptObjectTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@ public void GitRequestsReplacementForAllNullObject()
this.RunGitCheckoutOnFileWithCorruptObject(allNullObject);
}

[TestCase]
// TODO: This test no longer passes because Git fails on a truncated
// object instead of clearing it and regenerating it over the GVFS
// protocol.
// [TestCase]
public void GitRequestsReplacementForTruncatedObject()
{
Action<string> truncateObject = (string objectPath) =>
Expand Down
6 changes: 5 additions & 1 deletion GVFS/GVFS.FunctionalTests/Tests/EnlistmentPerTestCase/LooseObjectStepTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,11 @@ public void CorruptLooseObjectIsDeleted()
fakeBlobFolder,
"01234567890123456789012345678901234567");
this.fileSystem.CreateDirectory(fakeBlobFolder);
this.fileSystem.CreateEmptyFile(fakeBlob);

// TODO: Fix the problem with zero-length files here.
// this.fileSystem.CreateEmptyFile(fakeBlob);
// Git will complain about an empty file here.
this.fileSystem.WriteAllText(fakeBlob, "bogus content");

// This step should fail to place the objects, but
// succeed in deleting the given file.
Expand Down
2 changes: 1 addition & 1 deletion GVFS/GVFS.FunctionalTests/Tools/ControlGitRepo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public void Initialize()
GitProcess.Invoke(this.RootPath, "config merge.renames false");
GitProcess.Invoke(this.RootPath, "config advice.statusUoption false");
GitProcess.Invoke(this.RootPath, "config core.abbrev 40");
GitProcess.Invoke(this.RootPath, "config core.useBuiltinFSMonitor false");
GitProcess.Invoke(this.RootPath, "config core.fsmonitor false");
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jeffhostetler: Perhaps the old line should stay here, and we just add the core.fsmonitor line, too. Keeping the old config won't hurt, and might help for users still on an older version of Git.

Copy link

Choose a reason for hiding this comment

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

Yeah, leave both. It won't hurt anything. I haven't checked recently to see how many users are still using very old versions of Git, but let's assume we have some...

GitProcess.Invoke(this.RootPath, "config pack.useSparse true");
GitProcess.Invoke(this.RootPath, "config reset.quiet true");
GitProcess.Invoke(this.RootPath, "config status.aheadbehind false");
Expand Down
11 changes: 9 additions & 2 deletions GVFS/GVFS/CommandLine/GVFSVerb.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ public static bool TrySetRequiredGitConfigSettings(Enlistment enlistment)
{ "commitGraph.generationVersion", "1" },

// Disable the builtin FS Monitor in case it was enabled globally.
{ "core.useBuiltinFSMonitor", "false" },
{ "core.fsmonitor", "false" },
Copy link

Choose a reason for hiding this comment

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

same here.

};

if (!TrySetConfig(enlistment, requiredSettings, isRequired: true))
Expand Down Expand Up @@ -926,7 +926,14 @@ private bool TryValidateGVFSVersion(GVFSEnlistment enlistment, ITracer tracer, S

using (ITracer activity = tracer.StartActivity("ValidateGVFSVersion", EventLevel.Informational))
{
Version currentVersion = new Version(ProcessHelper.GetCurrentProcessVersion());
string fullVersion = ProcessHelper.GetCurrentProcessVersion();
int plusPos = fullVersion.IndexOf("+");
if (plusPos >= 0)
{
fullVersion = fullVersion.Substring(0, plusPos);
}

Version currentVersion = new Version(fullVersion);

IEnumerable<ServerGVFSConfig.VersionRange> allowedGvfsClientVersions =
config != null
Expand Down
21 changes: 11 additions & 10 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,32 +42,33 @@ will notify you when new versions are available.
## Building VFS for Git

If you'd like to build your own VFS for Git Windows installer:
* Install Visual Studio 2017 Community Edition or higher (https://www.visualstudio.com/downloads/).
* Install Visual Studio 2019 Community Edition or higher (https://www.visualstudio.com/downloads/).
* Include the following workloads:
* .NET desktop development
* Desktop development with C++
* .NET Core cross-platform development
* Include the following additional components:
* .NET Core runtime
* Windows 10 SDK (10.0.10240.0)
* MSVC v141 VS 2017 C++ build tools. It is under the "Desktop Development with C++" heading.
* Install the Windows 10 SDK (10.0.16299.91) via the archived SDK page: https://developer.microsoft.com/en-us/windows/downloads/sdk-archive
* Install the .NET Core 2.1 SDK (https://www.microsoft.com/net/download/dotnet-core/2.1)
* Install [`nuget.exe`](https://www.nuget.org/downloads)
* Create a folder to clone into, e.g. `C:\Repos\VFSForGit`
* Clone this repo into the `src` subfolder, e.g. `C:\Repos\VFSForGit\src`
* Run `\src\Scripts\BuildGVFSForWindows.bat`
* Run `\src\Scripts\Build.bat`
* You can also build in Visual Studio by opening `src\GVFS.sln` (do not upgrade any projects) and building. However, the very first
build will fail, and the second and subsequent builds will succeed. This is because the build requires a prebuild code generation step.
For details, see the build script in the previous step.

You can also use Visual Studio 2019. There are a couple of options for getting all the dependencies.
* You can install Visual Studio 2017 side by side with Visual Studio 2019, and make sure that you have all the dependencies from Visual Studio 2017 installed
* Alternatively, if you only want to have Visual Studio 2019 installed, install the following extra dependencies:
* MSVC v141 VS 2017 C++ build tools via the optional components in the Visual Studio 2019 installer. It is under the "Desktop Development with C++" heading.
* Windows 10 SDK (10.0.10240.0) via the archived SDK page: https://developer.microsoft.com/en-us/windows/downloads/sdk-archive
Visual Studio 2019 will [automatically prompt you to install these dependencies](https://devblogs.microsoft.com/setup/configure-visual-studio-across-your-organization-with-vsconfig/) when you open the solution. The .vsconfig file that is present in the root of the repository specifies all required components _except_ the Windows 10 SDK (10.0.16299.91) as this component is no longer shipped with VS2019 - **you'll still need to install that separately**.

Visual Studio 2019 will [automatically prompt you to install these dependencies](https://devblogs.microsoft.com/setup/configure-visual-studio-across-your-organization-with-vsconfig/) when you open the solution. The .vsconfig file that is present in the root of the repository specifies all required components _except_ the Windows 10 SDK (10.0.10240.0) as this component is no longer shipped with VS2019 - **you'll still need to install that separately**.
The installer can now be found at `C:\Repos\VFSForGit\BuildOutput\GVFS.Installer.Windows\bin\x64\[Debug|Release]\SetupGVFS.<version>.exe`.

The installer can now be found at `C:\Repos\VFSForGit\BuildOutput\GVFS.Installer.Windows\bin\x64\[Debug|Release]\SetupGVFS.<version>.exe`
### Running Tests

Unit tests can be run after any build using the `scripts\RunUnitTests.bat` script.

Functional tests are much more involved and require you to install your version of VFS for Git and the `microsoft/git` fork of Git. When those are installed, you can then run `scripts\RunFunctionalTests.bat`.

## Trying out VFS for Git

Expand Down
2 changes: 1 addition & 1 deletion Version.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<!-- Default GVFS version number if not specified at build time -->
<GVFSVersion Condition="'$(GVFSVersion)' == ''" >0.2.173.2</GVFSVersion>
<GVFSVersion Condition="'$(GVFSVersion)' == ''" >0.2.253.3</GVFSVersion>

<!--
Update the GitPackageVersion for the version that is shipped and tested with Scalar.
Expand Down
4 changes: 2 additions & 2 deletions scripts/Build.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ IF "%~1"=="" (
)

IF "%~2"=="" (
SET GVFSVERSION=0.2.173.2
SET GVFSVERSION=0.2.253.3
) ELSE (
SET GVFSVERSION=%2
)
Expand Down Expand Up @@ -88,7 +88,7 @@ GOTO :EOF
ECHO usage: %~n0%~x0 [^<configuration^>] [^<version^>] [^<verbosity^>]
ECHO.
ECHO configuration Solution configuration (default: Debug).
ECHO version GVFS version (default: 0.2.173.2).
ECHO version GVFS version (default: 0.2.253.3).
ECHO verbosity MSBuild verbosity (default: minimal).
ECHO.
EXIT 1
Expand Down
Loading