Development

Development guide

This document describes basics for repository-validator development

Development flow

1. Create branch from test-branch with name feature/my-feature-name-here or fix/my-fix-name-here
2. Make your changes to that branch
3. Create pull request to test-branch
4. Wait for review
5. Make fixes and/or merge the pull request if it was accepted. If you don't have permission for that, wait for a person who does.

Build

This project requires dotnet core, see image used in Jenkinsfile for specific requirements.

dotnet build

Testing

1. To run the unit tests:

dotnet test

1. To run acceptances tests, create .runsettings-file with test parameters using following script

./Deployment/Create-RunSettingsFile -ResourceGroup 'resource-group-name'

1. You can then use the console interface to run the validation locally. See Console interface

2. Finally, Testing development environment can be created by creating your own version of developer-settings.example.json as developer-settings.json and configure the file correctly. Then run .\Deployment\Prepare-Envrionment.ps1. For more details, see the script. Then you can use .\Testing\Test-Validation.ps1 to test the Azure Function. E.g.

./Deployment/Prepare-Environment.ps1
./Testing/Test-Validation.ps1 -ResourceGroup 'resource-group-name'