Skip to content

Commit

Permalink
docs: elaborate on testing process for new contributors
Browse files Browse the repository at this point in the history
Resolves #132
  • Loading branch information
tdashworth committed Sep 26, 2022
1 parent 7fdbc9a commit 9b73b63
Showing 1 changed file with 26 additions and 14 deletions.
40 changes: 26 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,33 @@ Please first discuss the change you wish to make via an issue before making a ch

## Testing

1. Set up powerapps binding
2. Application user may be added with the system admin rights
3. Tests by default is on US datetime format, therefore change it based on your personal location. For example, if you are based in India, set the datetime format to the local time.
- This can be done by going to the Power Apps settings >
- Select Pernalization Settings >
- From the Set Personal Options page, click on the Formats menu >
- Change the Current Format from the dropdown by ther selecting the country of your location >
- Click on the Customize button >
- Click OK button

NB: Running all tests are not required as the CI build will do these. Test and verify only the steps or features you have impacted or made changes to.
For a PR to be successfully merged, we aim for all tests to pass. Sometimes this isn't possible as the Power Platform changes, our tests aren't always kept up to date. We do require that there are tests for new/changed features and these.


In order to test the library locally, please follow these steps:

1. Open the solution in Visual Studio - we've found this has the best developer experience. Install the [SpecFlow extension](https://marketplace.visualstudio.com/items?itemName=TechTalkSpecFlowTeam.SpecFlowForVisualStudio2022) to add intellisense to the `.feature` files.
1. [Optional] Create a PowerApps environment. You need a PowerApps environment to execute the tests against so if you don't have System Administrator access to an existing one, we recommend using the free [Developer Plan](https://powerapps.microsoft.com/en-us/developerplan/).
1. [Adjust environment personalization](https://powerusers.microsoft.com/t5/Building-Power-Apps/Model-driven-app-dates-in-UK-format/td-p/1520165). Our tests expect a UK format for dates, times, and currency so please set this for any configured users (below).
1. Configure the test suite to use your environment. The `power-apps-bindings.yml` file holds these details. Each property value can either point to a [user environment variable](https://www.alphr.com/environment-variables-windows-10/) or hold the raw value. <span style="color: red">**We strongly recommend environment variables to avoid committing your credentials.**</span> The following properties are required:
- `url`
- `applicationUser` - an [Application User](https://learn.microsoft.com/en-us/power-platform/admin/manage-application-users#create-an-application-user) must be added with the System Administrator role to your environment.
- `users` - this can be your account, there is no need to create additional user. All username and password can be identical.
1. Tweak config for local debugging. The `power-apps-bindings.yml` file is configured for use by the build server (that runs all tests before merge a PR) and therefore it is recommended to change the following properties without committing them.
- Change `headless` to `false` so you can observer the tests run.
- Comment `driversPath` as this environment variable won't exist locally e.g.
```yml
#driversPath: ChromeWebDriver
```

Other things to note:

- Running all tests are **not** required as the CI/PR build will do these. Test and verify only the steps or features you have impacted or made changes to.
- The first time you run the test suite, a managed solution will be installed into the environment which takes a couple minutes. If the first test run times out, try again - it was likely due to this.

## Pull request process

1. Ensure that there are automated tests that cover any changes
2. Update the README.md with details of any significant changes to functionality
3. Ensure that your commit messages increment the version using [GitVersion syntax](https://gitversion.readthedocs.io/en/latest/input/docs/more-info/version-increments/). If no message is found then the patch version will be incremented by default.
4. You may merge the pull request once it meets all of the required checks. If you do not have permision, a reviewer will do it for you
1. Update the README.md with details of any significant changes to functionality
1. Ensure that your commit messages increment the version using [GitVersion syntax](https://gitversion.readthedocs.io/en/latest/input/docs/more-info/version-increments/). If no message is found then the patch version will be incremented by default.
1. You may merge the pull request once it meets all of the required checks. If you do not have permision, a reviewer will do it for you

0 comments on commit 9b73b63

Please sign in to comment.