empathicqubit/Cake.ArgumentHelpers
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Code formatting settings and normalizing code files.

Browse source
This commit is contained in:
Adam Patridge 2017-07-16 20:43:39 -06:00
parent 39dd89d456
commit 22efc1e2c0
3 changed files with 139 additions and 119 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

188
Cake.ArgumentHelpers.Tests/ArgumentOrEnvironmentVariableAliasTests.cs
View file

@ -2,18 +2,15 @@
using Cake.Core; using Cake.Core;
using Moq; using Moq;
namespace Cake.ArgumentHelpers.Tests namespace Cake.ArgumentHelpers.Tests {
{
[TestFixture()] [TestFixture()]
public class ArgumentOrEnvironmentVariableAliasTests public class ArgumentOrEnvironmentVariableAliasTests {
{
Mock<ICakeContext> cakeContextMock; Mock<ICakeContext> cakeContextMock;
Mock<ICakeArguments> cakeArgumentsMock; Mock<ICakeArguments> cakeArgumentsMock;
Mock<ICakeEnvironment> cakeEnvironmentMock; Mock<ICakeEnvironment> cakeEnvironmentMock;
[SetUp] [SetUp]
public void Setup() public void Setup() {
{
cakeContextMock = new Mock<ICakeContext>(); cakeContextMock = new Mock<ICakeContext>();
cakeArgumentsMock = new Mock<ICakeArguments>(); cakeArgumentsMock = new Mock<ICakeArguments>();
cakeEnvironmentMock = new Mock<ICakeEnvironment>(); cakeEnvironmentMock = new Mock<ICakeEnvironment>();
@ -21,20 +18,17 @@ namespace Cake.ArgumentHelpers.Tests
cakeContextMock.Setup(cakeContext => cakeContext.Environment).Returns(cakeEnvironmentMock.Object); cakeContextMock.Setup(cakeContext => cakeContext.Environment).Returns(cakeEnvironmentMock.Object);
} }
void SetupVariables(string key, string environmentPrefix, bool? argumentValue, bool? environmentValue) void SetupVariables(string key, string environmentPrefix, bool? argumentValue, bool? environmentValue) {
{
bool hasArgument = argumentValue != null; bool hasArgument = argumentValue != null;
cakeArgumentsMock.Setup(x => x.HasArgument(key)).Returns(hasArgument); cakeArgumentsMock.Setup(x => x.HasArgument(key)).Returns(hasArgument);
if (hasArgument) if (hasArgument) {
{
cakeArgumentsMock.Setup(x => x.GetArgument(key)).Returns(argumentValue.ToString()); cakeArgumentsMock.Setup(x => x.GetArgument(key)).Returns(argumentValue.ToString());
} }
cakeEnvironmentMock.Setup(x => x.GetEnvironmentVariable(environmentPrefix + key)).Returns(environmentValue != null ? environmentValue.Value.ToString() : null); cakeEnvironmentMock.Setup(x => x.GetEnvironmentVariable(environmentPrefix + key)).Returns(environmentValue != null ? environmentValue.Value.ToString() : null);
} }
[Test] [Test]
public void TrueArgumentAndNullEnvironment_ReturnsTrue() public void TrueArgumentAndNullEnvironment_ReturnsTrue() {
{
var testKey = "someVariable"; var testKey = "someVariable";
var testKeyEnvironmentPrefix = "somePrefix_"; var testKeyEnvironmentPrefix = "somePrefix_";
bool? testArgumentValue = true; bool? testArgumentValue = true;
@ -47,125 +41,117 @@ namespace Cake.ArgumentHelpers.Tests
Assert.AreEqual(expected, actual, "Didn't find Argument variable."); Assert.AreEqual(expected, actual, "Didn't find Argument variable.");
} }
[Test] [Test]
public void FalseArgumentAndNullEnvironment_ReturnsFalse() public void FalseArgumentAndNullEnvironment_ReturnsFalse() {
{ var testKey = "someVariable";
var testKey = "someVariable"; var testKeyEnvironmentPrefix = "somePrefix_";
var testKeyEnvironmentPrefix = "somePrefix_";
bool? testArgumentValue = false; bool? testArgumentValue = false;
bool? testEnvironmentValue = null; bool? testEnvironmentValue = null;
SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue); SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue);
var expected = false; var expected = false;
var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true); var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true);
Assert.AreEqual(expected, actual, "Didn't find Argument variable."); Assert.AreEqual(expected, actual, "Didn't find Argument variable.");
} }
[Test] [Test]
public void NullArgumentAndTrueEnvironment_ReturnsTrue() public void NullArgumentAndTrueEnvironment_ReturnsTrue() {
{ var testKey = "someVariable";
var testKey = "someVariable"; var testKeyEnvironmentPrefix = "somePrefix_";
var testKeyEnvironmentPrefix = "somePrefix_"; bool? testArgumentValue = null;
bool? testArgumentValue = null; bool? testEnvironmentValue = true;
bool? testEnvironmentValue = true;
SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue); SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue);
var expected = true; var expected = true;
var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true); var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true);
Assert.AreEqual(expected, actual, "Didn't find Environment variable."); Assert.AreEqual(expected, actual, "Didn't find Environment variable.");
} }
[Test] [Test]
public void NullArgumentAndFalseEnvironment_ReturnsFalse() public void NullArgumentAndFalseEnvironment_ReturnsFalse() {
{ var testKey = "someVariable";
var testKey = "someVariable"; var testKeyEnvironmentPrefix = "somePrefix_";
var testKeyEnvironmentPrefix = "somePrefix_"; bool? testArgumentValue = null;
bool? testArgumentValue = null;
bool? testEnvironmentValue = false; bool? testEnvironmentValue = false;
SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue); SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue);
var expected = false; var expected = false;
var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true); var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true);
Assert.AreEqual(expected, actual, "Didn't find Environment variable."); Assert.AreEqual(expected, actual, "Didn't find Environment variable.");
} }
[Test] [Test]
public void NullArgumentAndTrueEnvironmentWithoutPrefix_ReturnsTrue() public void NullArgumentAndTrueEnvironmentWithoutPrefix_ReturnsTrue() {
{ var testKey = "someVariable";
var testKey = "someVariable"; var testKeyEnvironmentPrefix = (string)null;
var testKeyEnvironmentPrefix = (string)null; bool? testArgumentValue = null;
bool? testArgumentValue = null; bool? testEnvironmentValue = true;
bool? testEnvironmentValue = true;
SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue); SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue);
var expected = true; var expected = true;
var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true); var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true);
Assert.AreEqual(expected, actual, "Didn't find Environment variable without prefix."); Assert.AreEqual(expected, actual, "Didn't find Environment variable without prefix.");
} }
[Test] [Test]
public void NullArgumentAndTrueEnvironmentNoPrefixOverload_ReturnsTrue() public void NullArgumentAndTrueEnvironmentNoPrefixOverload_ReturnsTrue() {
{ var testKey = "someVariable";
var testKey = "someVariable"; var testKeyEnvironmentPrefix = (string)null;
var testKeyEnvironmentPrefix = (string)null; bool? testArgumentValue = null;
bool? testArgumentValue = null; bool? testEnvironmentValue = true;
bool? testEnvironmentValue = true;
SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue); SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue);
var expected = true; var expected = true;
var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, true); var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, true);
Assert.AreEqual(expected, actual, "Didn't find Environment variable without prefix."); Assert.AreEqual(expected, actual, "Didn't find Environment variable without prefix.");
} }
[Test] [Test]
public void TrueArgumentAndTrueEnvironment_ReturnsTrue() public void TrueArgumentAndTrueEnvironment_ReturnsTrue() {
{ var testKey = "someVariable";
var testKey = "someVariable"; var testKeyEnvironmentPrefix = "somePrefix_";
var testKeyEnvironmentPrefix = "somePrefix_"; bool? testArgumentValue = true;
bool? testArgumentValue = true; bool? testEnvironmentValue = true;
bool? testEnvironmentValue = true;
SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue); SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue);
var expected = true; var expected = true;
var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true); var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true);
Assert.AreEqual(expected, actual, "Didn't find variable value from either source."); Assert.AreEqual(expected, actual, "Didn't find variable value from either source.");
} }
[Test] [Test]
public void TrueArgumentAndFalseEnvironment_ReturnsTrue() public void TrueArgumentAndFalseEnvironment_ReturnsTrue() {
{ var testKey = "someVariable";
var testKey = "someVariable"; var testKeyEnvironmentPrefix = "somePrefix_";
var testKeyEnvironmentPrefix = "somePrefix_"; bool? testArgumentValue = true;
bool? testArgumentValue = true;
bool? testEnvironmentValue = false; bool? testEnvironmentValue = false;
SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue); SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue);
var expected = true; var expected = true;
var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true); var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true);
Assert.AreEqual(expected, actual, "Explicit argument variable didn't override opposite environment variable."); Assert.AreEqual(expected, actual, "Explicit argument variable didn't override opposite environment variable.");
} }
[Test] [Test]
public void FalseArgumentAndTrueEnvironment_ReturnsFalse() public void FalseArgumentAndTrueEnvironment_ReturnsFalse() {
{ var testKey = "someVariable";
var testKey = "someVariable"; var testKeyEnvironmentPrefix = "somePrefix_";
var testKeyEnvironmentPrefix = "somePrefix_";
bool? testArgumentValue = false; bool? testArgumentValue = false;
bool? testEnvironmentValue = true; bool? testEnvironmentValue = true;
SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue); SetupVariables(testKey, testKeyEnvironmentPrefix, testArgumentValue, testEnvironmentValue);
var expected = false; var expected = false;
var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true); var actual = cakeContextMock.Object.ArgumentOrEnvironmentVariable(testKey, testKeyEnvironmentPrefix, true);
Assert.AreEqual(expected, actual, "Explicit argument variable didn't override opposite environment variable."); Assert.AreEqual(expected, actual, "Explicit argument variable didn't override opposite environment variable.");
} }
} }
} }

38
Cake.ArgumentHelpers.sln
View file

@ -30,4 +30,42 @@ Global
GlobalSection(SolutionProperties) = preSolution GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE HideSolutionNode = FALSE
EndGlobalSection EndGlobalSection
GlobalSection(MonoDevelopProperties) = preSolution
Policies = $0
$0.TextStylePolicy = $1
$1.NoTabsAfterNonTabs = True
$1.inheritsSet = VisualStudio
$1.inheritsScope = text/plain
$1.scope = text/x-csharp
$0.CSharpFormattingPolicy = $2
$2.NamespaceBraceStyle = EndOfLine
$2.ClassBraceStyle = EndOfLine
$2.InterfaceBraceStyle = EndOfLine
$2.StructBraceStyle = EndOfLine
$2.EnumBraceStyle = EndOfLine
$2.MethodBraceStyle = EndOfLine
$2.ConstructorBraceStyle = EndOfLine
$2.DestructorBraceStyle = EndOfLine
$2.ElseNewLinePlacement = NewLine
$2.BeforeMethodDeclarationParentheses = False
$2.BeforeMethodCallParentheses = False
$2.BeforeConstructorDeclarationParentheses = False
$2.BeforeIndexerDeclarationBracket = False
$2.BeforeDelegateDeclarationParentheses = False
$2.AfterDelegateDeclarationParameterComma = True
$2.NewParentheses = False
$2.SpacesBeforeBrackets = False
$2.inheritsSet = Mono
$2.inheritsScope = text/x-csharp
$2.scope = text/x-csharp
$2.NewLinesForBracesInTypes = False
$2.NewLinesForBracesInMethods = False
$2.SpacingAfterMethodDeclarationName = False
$2.SpaceAfterMethodCallName = False
$2.SpaceBeforeOpenSquareBracket = False
$0.DotNetNamingPolicy = $3
$3.DirectoryNamespaceAssociation = None
$3.ResourceNamePolicy = FileFormatDefault
StartupItem = Smudges.iOS\Smudges.iOS.csproj
EndGlobalSection
EndGlobal EndGlobal

32
Cake.ArgumentHelpers/ArgumentOrEnvironmentVariableAlias.cs
View file

@ -3,38 +3,34 @@ using Cake.Core;
using Cake.Core.Annotations; using Cake.Core.Annotations;
using Cake.Common; using Cake.Common;
namespace Cake.ArgumentHelpers namespace Cake.ArgumentHelpers {
{
/// <summary> /// <summary>
/// Contains Aliases for helping work with combinations of Argument and Environment variables. /// Contains Aliases for helping work with combinations of Argument and Environment variables.
/// </summary> /// </summary>
[CakeAliasCategory("Argument")] [CakeAliasCategory("Argument")]
[CakeAliasCategory("Environment")] [CakeAliasCategory("Environment")]
public static class ArgumentOrEnvironmentVariableAlias public static class ArgumentOrEnvironmentVariableAlias {
{
/// <summary> /// <summary>
/// Get a bool variable from various script inputs: first via Argument, then falling back on EnvironmentVariable, finally falling back on a default. /// Get a bool variable from various script inputs: first via Argument, then falling back on EnvironmentVariable, finally falling back on a default.
/// </summary> /// </summary>
/// <param name="environmentNamePrefix">An optional prefix used to qualify the same variable name when present in EnvironmentVariable form (e.g., "MySetting" command-line argument vs. "MyTool_MySetting" environment variable).</param> /// <param name="environmentNamePrefix">An optional prefix used to qualify the same variable name when present in EnvironmentVariable form (e.g., "MySetting" command-line argument vs. "MyTool_MySetting" environment variable).</param>
/// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns> /// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns>
[CakeMethodAlias] [CakeMethodAlias]
[CakeAliasCategory("Argument")] [CakeAliasCategory("Argument")]
[CakeAliasCategory("Environment")] [CakeAliasCategory("Environment")]
public static bool ArgumentOrEnvironmentVariable(this ICakeContext context, string name, string environmentNamePrefix, bool defaultValue) public static bool ArgumentOrEnvironmentVariable(this ICakeContext context, string name, string environmentNamePrefix, bool defaultValue) {
{
return ArgumentAliases.Argument(context, name, EnvironmentAliases.EnvironmentVariable(context, (environmentNamePrefix ?? "") + name) ?? defaultValue.ToString()).Equals("true", StringComparison.OrdinalIgnoreCase); return ArgumentAliases.Argument(context, name, EnvironmentAliases.EnvironmentVariable(context, (environmentNamePrefix ?? "") + name) ?? defaultValue.ToString()).Equals("true", StringComparison.OrdinalIgnoreCase);
} }
/// <summary> /// <summary>
/// Get a bool variable from various script inputs: first via Argument, then falling back on EnvironmentVariable, finally falling back on a default. /// Get a bool variable from various script inputs: first via Argument, then falling back on EnvironmentVariable, finally falling back on a default.
/// </summary> /// </summary>
/// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns> /// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns>
[CakeMethodAlias] [CakeMethodAlias]
[CakeAliasCategory("Argument")] [CakeAliasCategory("Argument")]
[CakeAliasCategory("Environment")] [CakeAliasCategory("Environment")]
public static bool ArgumentOrEnvironmentVariable(this ICakeContext context, string name, bool defaultValue) public static bool ArgumentOrEnvironmentVariable(this ICakeContext context, string name, bool defaultValue) {
{
return context.ArgumentOrEnvironmentVariable(name, null, defaultValue); return context.ArgumentOrEnvironmentVariable(name, null, defaultValue);
} }
} }
} }