Skip to content

Implement Boxcar evaluations #1

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Implement Boxcar evaluations #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f4ada4e
Boxcar evaluation
patchandthat Jun 17, 2025
9b61864
Rework to request wrapper
patchandthat Jun 17, 2025
87f1ed3
Boxcar request builder
patchandthat Jun 20, 2025
f346ea8
Remove generic request wrapper
patchandthat Jun 23, 2025
6115503
Add documentation
patchandthat Jun 23, 2025
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
343 changes: 343 additions & 0 deletions Rsk.AuthZen.Client.Test/AuthZenBoxcarEvaluationBodyTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,343 @@
using System.Collections.Generic;
using FluentAssertions;
using Xunit;

namespace Rsk.AuthZen.Client.Test;

public class AuthZenBoxcarEvaluationBodyTests
{
[Fact]
public void ToDto_WhenDefaultSubjectIsSet_ShouldPopulateSubject()
{
var defaults = new AuthZenEvaluationBody()
{
Subject = new AuthZenSubject
{
Id = "subject-id",
Type = "subject-type",
Properties = new Dictionary<string, object> { { "key", "value" } }
}
};


var request = new AuthZenBoxcarEvaluationBody
{
DefaultValues = defaults
};

var dto = request.ToDto();

dto.Subject.Should().NotBeNull();
dto.Subject.Id.Should().Be("subject-id");
dto.Subject.Type.Should().Be("subject-type");
dto.Subject.Properties.Keys.Should().Contain("key");
dto.Subject.Properties["key"].Should().Be("value");
}

[Fact]
public void ToDto_WhenDefaultResourceIsSet_ShouldPopulateResource()
{
var defaults = new AuthZenEvaluationBody()
{
Resource = new AuthZenResource
{
Id = "resource-id",
Type = "resource-type",
Properties = new Dictionary<string, object> { { "key", "value" } }
}
};

var request = new AuthZenBoxcarEvaluationBody
{
DefaultValues = defaults
};

var dto = request.ToDto();

dto.Resource.Should().NotBeNull();
dto.Resource.Id.Should().Be("resource-id");
dto.Resource.Type.Should().Be("resource-type");
dto.Resource.Properties.Keys.Should().Contain("key");
dto.Resource.Properties["key"].Should().Be("value");
}

[Fact]
public void ToDto_WhenDefaultActionIsSet_ShouldPopulateAction()
{
var defaults = new AuthZenEvaluationBody()
{
Action = new AuthZenAction
{
Name = "action-name",
Properties = new Dictionary<string, object> { { "key", "value" } }
}
};

var request = new AuthZenBoxcarEvaluationBody
{
DefaultValues = defaults
};

var dto = request.ToDto();

dto.Action.Should().NotBeNull();
dto.Action.Name.Should().Be("action-name");
dto.Action.Properties.Keys.Should().Contain("key");
dto.Action.Properties["key"].Should().Be("value");
}

[Fact]
public void ToDto_WhenDefaultContextIsSet_ShouldPopulateContext()
{
var defaults = new AuthZenEvaluationBody()
{
Context = new Dictionary<string, object>
{
{ "contextKey", "contextValue" }
}
};

var request = new AuthZenBoxcarEvaluationBody
{
DefaultValues = defaults
};

var dto = request.ToDto();

dto.Context.Should().NotBeNull();
dto.Context.Keys.Should().Contain("contextKey");
dto.Context["contextKey"].Should().Be("contextValue");
}

[Fact]
public void ToDto_WhenEvaluationsIsMissing_ShouldNotPopulateEvaluations()
{
var request = new AuthZenBoxcarEvaluationBody
{
Evaluations = null
};

var dto = request.ToDto();

dto.Evaluations.Should().BeNull();
}

[Fact]
public void ToDto_WhenEvaluationsIsEmpty_ShouldNotPopulateEvaluations()
{
var request = new AuthZenBoxcarEvaluationBody
{
Evaluations = new List<AuthZenEvaluationBody>()
};

var dto = request.ToDto();

dto.Evaluations.Should().BeNull();
}

[Fact]
public void ToDto_WhenEvaluationsIsSet_ShouldPopulateEachEvaluation()
{
var request = new AuthZenBoxcarEvaluationBody
{
Evaluations = new List<AuthZenEvaluationBody>
{
new ()
{
Subject = new AuthZenSubject { Id = "eval-subject-id1", Type = "eval-subject-type1" },
Resource = new AuthZenResource { Id = "eval-resource-id1", Type = "eval-resource-type1" },
Action = new AuthZenAction { Name = "eval-action-name1", }
},

new ()
{
Subject = new AuthZenSubject { Id = "eval-subject-id2", Type = "eval-subject-type2" },
Resource = new AuthZenResource { Id = "eval-resource-id2", Type = "eval-resource-type2" },
Action = new AuthZenAction { Name = "eval-action-name2", }
},

new ()
{
Subject = new AuthZenSubject { Id = "eval-subject-id3", Type = "eval-subject-type3" },
Resource = new AuthZenResource { Id = "eval-resource-id3", Type = "eval-resource-type3" },
Action = new AuthZenAction { Name = "eval-action-name3", }
},
}
};

var dto = request.ToDto();

dto.Evaluations.Should().NotBeNull();
dto.Evaluations.Length.Should().Be(3);

dto.Evaluations[0].Subject.Id.Should().Be("eval-subject-id1");
dto.Evaluations[0].Subject.Type.Should().Be("eval-subject-type1");
dto.Evaluations[0].Resource.Id.Should().Be("eval-resource-id1");
dto.Evaluations[0].Resource.Type.Should().Be("eval-resource-type1");
dto.Evaluations[0].Action.Name.Should().Be("eval-action-name1");

dto.Evaluations[1].Subject.Id.Should().Be("eval-subject-id2");
dto.Evaluations[1].Subject.Type.Should().Be("eval-subject-type2");
dto.Evaluations[1].Resource.Id.Should().Be("eval-resource-id2");
dto.Evaluations[1].Resource.Type.Should().Be("eval-resource-type2");
dto.Evaluations[1].Action.Name.Should().Be("eval-action-name2");

dto.Evaluations[2].Subject.Id.Should().Be("eval-subject-id3");
dto.Evaluations[2].Subject.Type.Should().Be("eval-subject-type3");
dto.Evaluations[2].Resource.Id.Should().Be("eval-resource-id3");
dto.Evaluations[2].Resource.Type.Should().Be("eval-resource-type3");
dto.Evaluations[2].Action.Name.Should().Be("eval-action-name3");
}

[Fact]
public void ToDto_WhenEvaluationSubjectIsSet_ShouldPopulateSubject()
{
var request = new AuthZenBoxcarEvaluationBody
{
Evaluations = new List<AuthZenEvaluationBody>()
{
new ()
{
Subject = new AuthZenSubject
{
Id = "subject-id",
Type = "subject-type",
Properties = new Dictionary<string, object> { { "key", "value" } }
}
}
}
};

var dto = request.ToDto();

dto.Evaluations[0].Subject.Should().NotBeNull();
dto.Evaluations[0].Subject.Id.Should().Be("subject-id");
dto.Evaluations[0].Subject.Type.Should().Be("subject-type");
dto.Evaluations[0].Subject.Properties.Keys.Should().Contain("key");
dto.Evaluations[0].Subject.Properties["key"].Should().Be("value");
}

[Fact]
public void ToDto_WhenEvaluationResourceIsSet_ShouldPopulateResource()
{
var request = new AuthZenBoxcarEvaluationBody
{
Evaluations = new List<AuthZenEvaluationBody>()
{
new ()
{
Resource = new AuthZenResource
{
Id = "resource-id",
Type = "resource-type",
Properties = new Dictionary<string, object> { { "key", "value" } }
}
}
}

};

var dto = request.ToDto();

dto.Evaluations[0].Resource.Should().NotBeNull();
dto.Evaluations[0].Resource.Id.Should().Be("resource-id");
dto.Evaluations[0].Resource.Type.Should().Be("resource-type");
dto.Evaluations[0].Resource.Properties.Keys.Should().Contain("key");
dto.Evaluations[0].Resource.Properties["key"].Should().Be("value");
}

[Fact]
public void ToDto_WhenEvaluationActionIsSet_ShouldPopulateAction()
{
var request = new AuthZenBoxcarEvaluationBody
{
Evaluations = new List<AuthZenEvaluationBody>()
{
new ()
{
Action = new AuthZenAction
{
Name = "action-name",
Properties = new Dictionary<string, object> { { "key", "value" } }
}
}
}
};

var dto = request.ToDto();

dto.Evaluations[0].Action.Should().NotBeNull();
dto.Evaluations[0].Action.Name.Should().Be("action-name");
dto.Evaluations[0].Action.Properties.Keys.Should().Contain("key");
dto.Evaluations[0].Action.Properties["key"].Should().Be("value");
}

[Fact]
public void ToDto_WhenEvaluationContextIsSet_ShouldPopulateContext()
{
var request = new AuthZenBoxcarEvaluationBody
{
Evaluations = new List<AuthZenEvaluationBody>()
{
new ()
{
Context = new Dictionary<string, object>
{
{ "contextKey", "contextValue" }
}
}
}
};

var dto = request.ToDto();

dto.Evaluations[0].Context.Should().NotBeNull();
dto.Evaluations[0].Context.Keys.Should().Contain("contextKey");
dto.Evaluations[0].Context["contextKey"].Should().Be("contextValue");
}

[Theory]
[InlineData(BoxcarSemantics.DenyOnFirstDeny)]
[InlineData(BoxcarSemantics.PermitOnFirstPermit)]
[InlineData(BoxcarSemantics.ExecuteAll)]
public void ToDto_OptionsAreProvided_ShouldIncludeOptionsInRequestDto(BoxcarSemantics semantics)
{
var options = new AuthZenBoxcarOptions()
{
Semantics = semantics
};

var request = new AuthZenBoxcarEvaluationBody
{
Evaluations = new List<AuthZenEvaluationBody>
{
new ()
{
Subject = new AuthZenSubject { Id = "eval-subject-id1", Type = "eval-subject-type1" },
Resource = new AuthZenResource { Id = "eval-resource-id1", Type = "eval-resource-type1" },
Action = new AuthZenAction { Name = "eval-action-name1", }
},

new ()
{
Subject = new AuthZenSubject { Id = "eval-subject-id2", Type = "eval-subject-type2" },
Resource = new AuthZenResource { Id = "eval-resource-id2", Type = "eval-resource-type2" },
Action = new AuthZenAction { Name = "eval-action-name2", }
},

new ()
{
Subject = new AuthZenSubject { Id = "eval-subject-id3", Type = "eval-subject-type3" },
Resource = new AuthZenResource { Id = "eval-resource-id3", Type = "eval-resource-type3" },
Action = new AuthZenAction { Name = "eval-action-name3", }
},
},
Options = options
};

var dto = request.ToDto();

dto.Options.Should().NotBeNull();
dto.Options.Should().BeEquivalentTo(options.ToDto());
}
}
Loading