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

Jump to bottom

GH4006: Add missing GitVersion CLI options #4007

Merged
merged 1 commit into from
Oct 23, 2022
Merged

GH4006: Add missing GitVersion CLI options #4007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
133 changes: 130 additions & 3 deletions src/Cake.Common.Tests/Unit/Tools/GitVersion/GitVersionRunnerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,18 +86,35 @@ public void Should_Set_Working_Directory()
Assert.Equal("/Working", result.Process.WorkingDirectory.FullPath);
}

[Theory]
[InlineData(GitVersionOutput.Json, "-output json")]
[InlineData(GitVersionOutput.File, "-output file")]
public void Should_Add_OutputType_To_Arguments_If_Set(GitVersionOutput outputType, string args)
{
// Given
var fixture = new GitVersionRunnerFixture();
fixture.Settings.OutputType = outputType;

// When
var result = fixture.Run();

// Then
Assert.Equal(args, result.Args);
}

[Fact]
public void Should_Add_OutputType_To_Arguments_If_Set()
public void Should_Add_OutputFile_If_Set_With_OutputType_File()
{
// Given
var fixture = new GitVersionRunnerFixture();
fixture.Settings.OutputType = GitVersionOutput.Json;
fixture.Settings.OutputType = GitVersionOutput.File;
fixture.Settings.OutputFile = "GitVersion.json";

// When
var result = fixture.Run();

// Then
Assert.Equal("-output json", result.Args);
Assert.Equal("-output file -outputfile \"GitVersion.json\"", result.Args);
}

[Fact]
Expand Down Expand Up @@ -158,6 +175,20 @@ public void Should_Add_UpdateAssemblyInfoFilePath_To_Arguments_If_Set()
Assert.Equal("-updateassemblyinfo \"c:/temp/assemblyinfo.cs\"", result.Args);
}

[Fact]
public void Should_Add_ConfigFile_To_Arguments_If_Set()
{
// Given
var fixture = new GitVersionRunnerFixture();
fixture.Settings.ConfigFile = "c:/temp/gitversion.yml";

// When
var result = fixture.Run();

// Then
Assert.Equal("-config \"c:/temp/gitversion.yml\"", result.Args);
}

[Fact]
public void Should_Add_RepositoryPath_To_Arguments_If_Set()
{
Expand Down Expand Up @@ -219,6 +250,102 @@ public void Should_Add_NoFetch_To_Arguments_If_Set(bool nofetch, string args)
Assert.Equal(args, result.Args);
}

[Theory]
[InlineData(true, "-nocache")]
[InlineData(false, "")]
public void Should_Add_NoCache_To_Arguments_If_Set(bool nocache, string args)
{
// Given
var fixture = new GitVersionRunnerFixture();
fixture.Settings.NoCache = nocache;

// When
var result = fixture.Run();

// Then
Assert.Equal(args, result.Args);
}

[Theory]
[InlineData(true, "-nonormalize")]
[InlineData(false, "")]
public void Should_Add_NoNormalize_To_Arguments_If_Set(bool nonormalize, string args)
{
// Given
var fixture = new GitVersionRunnerFixture();
fixture.Settings.NoNormalize = nonormalize;

// When
var result = fixture.Run();

// Then
Assert.Equal(args, result.Args);
}

[Theory]
[InlineData(true, "-diag")]
[InlineData(false, "")]
public void Should_Add_Diag_To_Arguments_If_Set(bool diag, string args)
{
// Given
var fixture = new GitVersionRunnerFixture();
fixture.Settings.Diag = diag;

// When
var result = fixture.Run();

// Then
Assert.Equal(args, result.Args);
}

[Theory]
[InlineData(true, "-updateprojectfiles")]
[InlineData(false, "")]
public void Should_Add_UpdateProjectFiles_To_Arguments_If_Set(bool updateProjectFiles, string args)
{
// Given
var fixture = new GitVersionRunnerFixture();
fixture.Settings.UpdateProjectFiles = updateProjectFiles;

// When
var result = fixture.Run();

// Then
Assert.Equal(args, result.Args);
}

[Theory]
[InlineData(true, "-ensureassemblyinfo")]
[InlineData(false, "")]
public void Should_Add_EnsureAssemblyInfo_To_Arguments_If_Set(bool ensureAssemblyInfo, string args)
{
// Given
var fixture = new GitVersionRunnerFixture();
fixture.Settings.EnsureAssemblyInfo = ensureAssemblyInfo;

// When
var result = fixture.Run();

// Then
Assert.Equal(args, result.Args);
}

[Theory]
[InlineData(true, "-updatewixversionfile")]
[InlineData(false, "")]
public void Should_Add_UpdateWixVersionFile_To_Arguments_If_Set(bool updateWixVersionFile, string args)
{
// Given
var fixture = new GitVersionRunnerFixture();
fixture.Settings.UpdateWixVersionFile = updateWixVersionFile;

// When
var result = fixture.Run();

// Then
Assert.Equal(args, result.Args);
}

[Theory]
[InlineData(Verbosity.Quiet)]
[InlineData(Verbosity.Minimal)]
Expand Down
7 changes: 6 additions & 1 deletion src/Cake.Common/Tools/GitVersion/GitVersionOutput.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ public enum GitVersionOutput
/// <summary>
/// Outputs to the stdout in a way usable by a detected build server.
/// </summary>
BuildServer
BuildServer,

/// <summary>
/// Outputs to a file, as specified in the OutputFile parameter.
/// </summary>
File
}
}
50 changes: 48 additions & 2 deletions src/Cake.Common/Tools/GitVersion/GitVersionRunner.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,25 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)

if (settings.OutputType.HasValue)
{
builder.Append("-output");

switch (settings.OutputType.Value)
{
case GitVersionOutput.Json:
builder.Append("-output");
builder.Append("json");
break;
case GitVersionOutput.BuildServer:
builder.Append("-output");
builder.Append("buildserver");
break;
case GitVersionOutput.File:
builder.Append("file");

if (settings.OutputFile != null)
{
builder.Append("-outputfile");
builder.AppendQuoted(settings.OutputFile.FullPath);
}

break;
}
}
Expand Down Expand Up @@ -165,11 +175,47 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)
builder.AppendQuoted(settings.LogFilePath.FullPath);
}

if (settings.ConfigFile != null)
{
builder.Append("-config");
builder.AppendQuoted(settings.ConfigFile.FullPath);
}

if (settings.NoFetch)
{
builder.Append("-nofetch");
}

if (settings.NoCache)
{
builder.Append("-nocache");
}

if (settings.NoNormalize)
{
builder.Append("-nonormalize");
}

if (settings.Diag)
{
builder.Append("-diag");
}

if (settings.UpdateProjectFiles)
{
builder.Append("-updateprojectfiles");
}

if (settings.EnsureAssemblyInfo)
{
builder.Append("-ensureassemblyinfo");
}

if (settings.UpdateWixVersionFile)
{
builder.Append("-updatewixversionfile");
}

if (settings.Verbosity.HasValue)
{
switch (settings.Verbosity.Value)
Expand Down
44 changes: 44 additions & 0 deletions src/Cake.Common/Tools/GitVersion/GitVersionSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,17 @@ public sealed class GitVersionSettings : ToolSettings
/// </summary>
public GitVersionOutput? OutputType { get; set; }

/// <summary>
/// Gets or sets the path to a file to store the asserted GitVersion numbers in JSON format.
/// </summary>
public FilePath OutputFile { get; set; }

/// <summary>
/// Gets or sets the path to config file.
/// </summary>
/// <remarks>Defaults to GitVersion.yml.</remarks>
public FilePath ConfigFile { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to update all the AssemblyInfo files.
/// </summary>
Expand All @@ -32,6 +43,23 @@ public sealed class GitVersionSettings : ToolSettings
/// </summary>
public FilePath UpdateAssemblyInfoFilePath { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to recursively search for all project files (.csproj/.vbproj/.fsproj) files in the git repo and update them.
/// </summary>
/// <remarks>This is only compatible with the newer Sdk projects.</remarks>
public bool UpdateProjectFiles { get; set; }

/// <summary>
/// Gets or sets a value indicating whether if the assembly info file specified with /updateassemblyinfo or /updateassemblyinfofilename is not found, it be created with these attributes: AssemblyFileVersion, AssemblyVersion and AssemblyInformationalVersion.
/// </summary>
/// <remarks>Supports writing version info for: C#, F#, VB.</remarks>
public bool EnsureAssemblyInfo { get; set; }

/// <summary>
/// Gets or sets a value indicating whether all the GitVersion variables are written to 'GitVersion_WixVersion.wxi'. The variables can then be referenced in other WiX project files for versioning.
/// </summary>
public bool UpdateWixVersionFile { get; set; }

/// <summary>
/// Gets or sets whether to only show a specific variable.
/// </summary>
Expand Down Expand Up @@ -68,6 +96,22 @@ public sealed class GitVersionSettings : ToolSettings
/// <remarks>If your CI server clones the entire repository you can set this to 'true' to prevent GitVersion attempting any remote repository fetching.</remarks>
public bool NoFetch { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to bypass the cached GitVersion result. Result will not be written to the cache.
/// </summary>
public bool NoCache { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to disable normalize step on a build server.
/// </summary>
public bool NoNormalize { get; set; }

/// <summary>
/// Gets or sets a value indicating whether to run GitVersion with additional diagnostic information.
/// </summary>
/// <remarks>Requires git.exe to be installed.</remarks>
public bool Diag { get; set; }

/// <summary>
/// Gets or sets the dynamic repository path. Defaults to %TEMP%.
/// </summary>
Expand Down