Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 3.73 KB

Contributing

Please first discuss the change you wish to make via an issue before making a change.

Testing

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 to add intellisense to the .feature files.
  2. [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.
  3. Adjust environment personalization. Our tests expect a UK format for dates, times, and currency so please set this for any configured users (below).
  4. 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 or hold the raw value. We strongly recommend environment variables to avoid committing your credentials. The following properties are required:
    • url
    • applicationUser - 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.
  5. 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. 
      #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.
  • At times when buiding a solution, it fails and you receive some Build.exe errors or warnings. This prevents you from cancelling the build process as it hangs. You can stop or kill the Build.exe proceess by starting the Task Master and ending the process - you can close the Visual Studio and restart it if this doesn't work. You can also run this code (taskkill /f /im chromedriver.exe) on your terminal.

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. 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