v0.13.0
Lots of updates here! Highlights are
-
DDD promoted entities (private setters, factory methods, associated fakers)
-
Huge permissions upgrade. Significantly simplified setup which resulted in a new library (HeimGuard) that can be used in any .NET project.
-
Message bus scaffolding and testing improvements
-
New register:producer command
-
Added soft delete capability
-
Added Shared Kernel
-
Added Complex example for new:example command
Also, big shout out to @sshquack for his first contributions!
馃殌 Additions and Updates
Added
- Entities will now have private setters, a static
Create
method and anUpdate
method to promote a DDD workflow- This includes base entity and the dbcontext setters for the auditable fields
- A huge permissions overhaul
SuperAdmin
role is added by default and will automatically be given all permissions.- A
User
role with also be created. This role will not have any permissions assigned to it by default and can be removed if you would like as long as you add another role in addition toSuperAdmin
. This will allow for integration tests of theUserPolicyHandler
to be fully scoped. - A permission will be added for each feature with a default name of
CanFEATURENAME
, but can be overridden if desired. - Role-permission mappings outside of this need tobe done manually
- You will be responsible for managing permissions outside of super admin
- Policies are no longer part of the craftsman api, but a single policy will be added with each api boundary to swagger to dictate access to that boundary. It has a default of a snake case of
ProjectName
, but can be overridden- If using the built in auth server, this will be added for you. if not, make sure it mataches an appropriate scope in your auth server for this api boundary
- Features now have a prop for
IsProtected
that, if true, will add an authorization attribute to your endpoint with thePolicyName
and add tests that check for access - Integration tests for
UserPolicyHandler
- Unit tests for
RolePermission
Policies
prop removed from Feature- Added
SetUserRole
andSetUserRoles
methods to integreation tests'TestFixture
for easy role management in integration tests - Functional tests auth helper method now sets
role
instead ofscope
- Alice is a
SuperAdmin
and bob is aUser
- Added a
register:producer
command with CLI prompt - Added
UseSoftDelete
property to theApiTemplate
which is set to true. When adding an entity after the fact, Craftsman will automatically detect whether or not your project is using soft deletion by checking base entity for the appropriate property. - Added a
SharedKernel
project at the root to capture DTOs, exceptions, and roles (if using auth) - Added new
Complex
example fornew:example
Updated
-
Updated FK and basic examples to have more features on the entities
-
Updated tests to work with new private entity workflow
-
CurrentUserServer has a method to get the User from the ClaimsPrincipal
-
Swagger question removed from
add:feature
as it wasn't being used. Will be set to true. -
Removed unused
Unauthorized
andForbidden
MediatR filters -
Test Fixture updated to better handle MassTransit
-
_provider
will always be injected, even when not using MassTransit -
The end of the fixture has been slightly updated to look like this:
// MassTransit Harness Setup -- Do Not Delete Comment _provider = services.BuildServiceProvider(); _scopeFactory = _provider.GetService<IServiceScopeFactory>(); // MassTransit Start Setup -- Do Not Delete Comment
-
Added several helper methods to the test fixture
-
Updated the consumer test to use the helper methods
-
Producer doesn't take in placeholder props
-
Producer test generated
-
-
Minor update to naming of producer in the bus example
-
Default exchange type now
Fanout
for producer and consumer -
Added optional (but recommended)
DomainDirectory
prop to producers and consumers. This will move them from theEventHandlers
directory and keep them directly with features for better colocation. -
Updated the 1:1 relationships to use proper scaffolding.
-
Updated the FK example to show proper 1:1 relationship
-
Entities with a Guid prop will no longer have a default of
Guid.NewGuid()
-
Updated default library from NewtonSoft.Json to System.text.Json (#52)
-
Took audit fields off of DTO
-
Bumped LibGit2Sharp to preview for M1 compatibility
馃悰 Pest Control
- Batch endpoint route updated to
batch
along with a functional testing route - Batch add using update to controller
IHttpContextAccessor
fixted to a singleton in integration tests'TestFixture
- Can enter null for
add:feature
batch list options where needed - Minor formatting fix for indentation in producers and consumers
- Removed extra exception using from patch integration test
- Fixed docker image for integration tests running on macOS + M1 chip (#53)