complete-conversions-transfers-changes

Complete application and API (for external services) to help the process of schools converting to academies, transferring between academy trusts or changing their academy status.

Setup

Pre requisites

NodeJS and NPM installed It is recommended you request access to the complete development database by making a service request. You can then use that to connect your local build to a db without installing one locally.

Frontend setup

• In the DfE.Complete project navigate to the directory wwwroot
• Run the commands npm i then npm run build
• Setup db either by running the local migrations or connecting to the dev db
  • To use a Local db simply install MSSQl (You can use a Docker container or local Db, recommened way is MSSQL express)
  • Navigate to the Dfe.Complete.Infrastructure and run dotnet ef database update
• Populate the User secrets file. You will need to use the correct connection string, either your local db or db enviroment of your choice

API setup

• Populate the User secrets file

Authorisation

Frontend

List of all of our policies can be found here. If there's not an auth constant that matches your requirements, you can add it here.

Policies themselves are defined in one of two places:

• for simple policies, pop them in appsettings.json - the two available operators are
  • And - every role must be present on the user
  • Or - at least one of the roles must be present on the user
• for more complex logic, please add the policy into the CustomPolicies

Currently the policies are used in two different ways:

• directly on a model - the permissions are inherited so now that everything extending YourTeamProjectsModel will also have CanViewTeamProjects auth policy check
• using the new asp-policy tag helper. This will hide any html element that isn't authorised

Alternatively in the pages you can just use the authorizationService directly.

API

Basically the same setup but simpler.

End points authorised like so.

Testing If you add a protected route, please add the "Route" and "ExpectedSecurity" to the objects in ExpectedSecurityConfig.json - the rest will handle itself.

If you add a new custom policy, please update the inline data in the tests.